eventespresso / event-espresso-core

core/helpers/EEH_Event_View.helper.php

Spacing +19 added lines, -19 removed lines

@@ -38,7 +38,7 @@ 
         }
         // reset property so that the new event is cached.
         EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
+        if ( ! $EVT_ID && $post instanceof EE_Event) {
             EEH_Event_View::$_event = $post;
             return EEH_Event_View::$_event;
         }
@@ -57,7 +57,7 @@ 
             return EEH_Event_View::$_event;
         }
         // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+        if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
             EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
         }
         return EEH_Event_View::$_event;
@@ -164,18 +164,18 @@ 
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
                 // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
+                if ( ! empty($num_words)) {
                     if (empty($more)) {
                         $more_link_text = esc_html__('(more…)', 'event_espresso');
-                        $more           = ' <a href="' . get_permalink() . '"';
+                        $more           = ' <a href="'.get_permalink().'"';
                         $more           .= ' class="more-link"';
                         $more           .= EED_Events_Archive::link_target();
-                        $more           .= '>' . $more_link_text . '</a>';
-                        $more           = apply_filters('the_content_more_link', $more, $more_link_text);
+                        $more           .= '>'.$more_link_text.'</a>';
+                        $more = apply_filters('the_content_more_link', $more, $more_link_text);
                     }
                     $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
 
-                    $content = wp_trim_words($content, $num_words, ' ') . $more;
+                    $content = wp_trim_words($content, $num_words, ' ').$more;
                 } else {
                     $content = get_the_content();
                 }
@@ -257,8 +257,8 @@ 
                             || ! $hide_uncategorized
                         )
                     ) {
-                        $category_links[] = '<a href="' . esc_url_raw($url) . '" '
-                                            . 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
+                        $category_links[] = '<a href="'.esc_url_raw($url).'" '
+                                            . 'rel="tag" '.EED_Events_Archive::link_target().'>'
                                             . esc_html($term->name)
                                             . '</a>';
                     }
@@ -283,8 +283,8 @@ 
     {
         $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
         $format   = ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format . $time_format;
+                ? $date_format.' '.$time_format
+                : $date_format.$time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
@@ -304,7 +304,7 @@ 
         $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
@@ -326,7 +326,7 @@ 
         $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
@@ -348,7 +348,7 @@ 
         $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
@@ -553,7 +553,7 @@ 
             $url = $event->external_url() !== null && $event->external_url() !== ''
                 ? $event->external_url()
                 : get_permalink($event->ID());
-            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
+            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://'.$url;
             return esc_url_raw($url);
         }
         return '';
@@ -614,12 +614,12 @@ 
                 // get edit CPT text
                 $post_type_obj = get_post_type_object('espresso_events');
                 // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+                $link = '<a class="post-edit-link" href="'.$url.'" ';
+                $link .= ' title="'.esc_attr($post_type_obj->labels->edit_item).'"';
                 $link .= EED_Events_Archive::link_target();
-                $link .= '>' . $link_text . '</a>';
+                $link .= '>'.$link_text.'</a>';
                 // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+                return $before.apply_filters('edit_post_link', $link, $event->ID()).$after;
             }
         }
         return '';

Indentation +629 added lines, -629 removed lines

@@ -9,364 +9,364 @@ 
  */
 class EEH_Event_View extends EEH_Base
 {
-    /**
-     * @var EE_Event $_event
-     */
-    private static $_event = null;
-
-
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event($EVT_ID = 0)
-    {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        // reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
-            EEH_Event_View::$_event = $post;
-            return EEH_Event_View::$_event;
-        }
-        // if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-        // then let's just use that cached event on the $post object.
-        if (
-            $post instanceof WP_Post
-            && $post->post_type === 'espresso_events'
-            && isset($post->EE_Event)
-            && (
-                $EVT_ID === 0
-                || $EVT_ID === $post->ID
-            )
-        ) {
-            EEH_Event_View::$_event = $post->EE_Event;
-            return EEH_Event_View::$_event;
-        }
-        // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-            EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        return EEH_Event_View::$_event;
-    }
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @param int $EVT_ID
-     * @return    boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_ticket_selector($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event && $event->display_ticket_selector();
-    }
-
-
-    /**
-     *    event_status
-     *
-     * @param int $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_status($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
-    }
-
-
-    /**
-     *  event_active_status
-     *
-     * @param int $EVT_ID
-     * @return     string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_active_status($EVT_ID = 0, $echo = true)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
-    }
-
-
-    /**
-     *  event_has_content_or_excerpt
-     *
-     * @param int $EVT_ID
-     * @return     bool
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_has_content_or_excerpt($EVT_ID = 0)
-    {
-        $event                  = EEH_Event_View::get_event($EVT_ID);
-        $has_content_or_excerpt = false;
-        if ($event instanceof EE_Event) {
-            $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '';
-        }
-        if (
-            is_archive()
-            && ! (espresso_display_full_description_in_event_list()
-                  || espresso_display_excerpt_in_event_list())
-        ) {
-            $has_content_or_excerpt = false;
-        }
-        return $has_content_or_excerpt;
-    }
-
-
-    /**
-     *    event_active_status
-     *
-     * @param null $num_words
-     * @param null $more
-     * @return    string
-     */
-    public static function event_content_or_excerpt($num_words = null, $more = null)
-    {
-        global $post;
-        ob_start();
-        if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
-            // admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            the_content();
-        } elseif ((is_archive() && espresso_display_excerpt_in_event_list())) {
-            if (has_excerpt($post->ID)) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
-                    if (empty($more)) {
-                        $more_link_text = esc_html__('(more…)', 'event_espresso');
-                        $more           = ' <a href="' . get_permalink() . '"';
-                        $more           .= ' class="more-link"';
-                        $more           .= EED_Events_Archive::link_target();
-                        $more           .= '>' . $more_link_text . '</a>';
-                        $more           = apply_filters('the_content_more_link', $more, $more_link_text);
-                    }
-                    $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
-
-                    $content = wp_trim_words($content, $num_words, ' ') . $more;
-                } else {
-                    $content = get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : [];
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value                 = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content                    = wp_kses($content, $allowedtags);
-                $content                    = strip_shortcodes($content);
-                echo apply_filters('the_content', $content);
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters('the_content', '');
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     *  event_tickets_available
-     *
-     * @param int $EVT_ID
-     * @return     EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_tickets_available($EVT_ID = 0)
-    {
-        $event                          = EEH_Event_View::get_event($EVT_ID);
-        $tickets_available_for_purchase = [];
-        if ($event instanceof EE_Event) {
-            $datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
-            foreach ($datetimes as $datetime) {
-                $tickets_available_for_purchase =
-                    array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
-            }
-        }
-        return $tickets_available_for_purchase;
-    }
-
-
-    /**
-     *    the_event_date
-     *
-     * @param int  $EVT_ID
-     * @param bool $hide_uncategorized
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = [];
-        $event          = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
-            if ($event_categories) {
-                // loop thru terms and create links
-                foreach ($event_categories as $term) {
-                    $url = get_term_link($term, 'espresso_venue_categories');
-                    if (
-                        ! is_wp_error($url)
-                        && (
-                            (
-                                $hide_uncategorized
-                                && strtolower($term->name) != esc_html__('uncategorized', 'event_espresso')
-                            )
-                            || ! $hide_uncategorized
-                        )
-                    ) {
-                        $category_links[] = '<a href="' . esc_url_raw($url) . '" '
-                                            . 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
-                                            . esc_html($term->name)
-                                            . '</a>';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-    /**
-     *    the_event_date - first date by date order
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format   = ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-    /**
-     *    the_event_end_date - last date by date order
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_event_end_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-    /**
-     *    the_earliest_event_date - first date chronologically
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_earliest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-    /**
-     *    the_latest_event_date - latest date chronologically
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_latest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-    /**
-     *    event_date_as_calendar_page
-     *
-     * @param int $EVT_ID
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_date_as_calendar_page($EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            ?>
+	/**
+	 * @var EE_Event $_event
+	 */
+	private static $_event = null;
+
+
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event($EVT_ID = 0)
+	{
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		// reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+		if (! $EVT_ID && $post instanceof EE_Event) {
+			EEH_Event_View::$_event = $post;
+			return EEH_Event_View::$_event;
+		}
+		// if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+		// then let's just use that cached event on the $post object.
+		if (
+			$post instanceof WP_Post
+			&& $post->post_type === 'espresso_events'
+			&& isset($post->EE_Event)
+			&& (
+				$EVT_ID === 0
+				|| $EVT_ID === $post->ID
+			)
+		) {
+			EEH_Event_View::$_event = $post->EE_Event;
+			return EEH_Event_View::$_event;
+		}
+		// If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+		if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+			EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		return EEH_Event_View::$_event;
+	}
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @param int $EVT_ID
+	 * @return    boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_ticket_selector($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event && $event->display_ticket_selector();
+	}
+
+
+	/**
+	 *    event_status
+	 *
+	 * @param int $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_status($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
+	}
+
+
+	/**
+	 *  event_active_status
+	 *
+	 * @param int $EVT_ID
+	 * @return     string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_active_status($EVT_ID = 0, $echo = true)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
+	}
+
+
+	/**
+	 *  event_has_content_or_excerpt
+	 *
+	 * @param int $EVT_ID
+	 * @return     bool
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_has_content_or_excerpt($EVT_ID = 0)
+	{
+		$event                  = EEH_Event_View::get_event($EVT_ID);
+		$has_content_or_excerpt = false;
+		if ($event instanceof EE_Event) {
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '';
+		}
+		if (
+			is_archive()
+			&& ! (espresso_display_full_description_in_event_list()
+				  || espresso_display_excerpt_in_event_list())
+		) {
+			$has_content_or_excerpt = false;
+		}
+		return $has_content_or_excerpt;
+	}
+
+
+	/**
+	 *    event_active_status
+	 *
+	 * @param null $num_words
+	 * @param null $more
+	 * @return    string
+	 */
+	public static function event_content_or_excerpt($num_words = null, $more = null)
+	{
+		global $post;
+		ob_start();
+		if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
+			// admin has chosen "full description"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			the_content();
+		} elseif ((is_archive() && espresso_display_excerpt_in_event_list())) {
+			if (has_excerpt($post->ID)) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if (! empty($num_words)) {
+					if (empty($more)) {
+						$more_link_text = esc_html__('(more&hellip;)', 'event_espresso');
+						$more           = ' <a href="' . get_permalink() . '"';
+						$more           .= ' class="more-link"';
+						$more           .= EED_Events_Archive::link_target();
+						$more           .= '>' . $more_link_text . '</a>';
+						$more           = apply_filters('the_content_more_link', $more, $more_link_text);
+					}
+					$content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
+
+					$content = wp_trim_words($content, $num_words, ' ') . $more;
+				} else {
+					$content = get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: [];
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value                 = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content                    = wp_kses($content, $allowedtags);
+				$content                    = strip_shortcodes($content);
+				echo apply_filters('the_content', $content);
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters('the_content', '');
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 *  event_tickets_available
+	 *
+	 * @param int $EVT_ID
+	 * @return     EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_tickets_available($EVT_ID = 0)
+	{
+		$event                          = EEH_Event_View::get_event($EVT_ID);
+		$tickets_available_for_purchase = [];
+		if ($event instanceof EE_Event) {
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
+			foreach ($datetimes as $datetime) {
+				$tickets_available_for_purchase =
+					array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
+			}
+		}
+		return $tickets_available_for_purchase;
+	}
+
+
+	/**
+	 *    the_event_date
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $hide_uncategorized
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = [];
+		$event          = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
+			if ($event_categories) {
+				// loop thru terms and create links
+				foreach ($event_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if (
+						! is_wp_error($url)
+						&& (
+							(
+								$hide_uncategorized
+								&& strtolower($term->name) != esc_html__('uncategorized', 'event_espresso')
+							)
+							|| ! $hide_uncategorized
+						)
+					) {
+						$category_links[] = '<a href="' . esc_url_raw($url) . '" '
+											. 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
+											. esc_html($term->name)
+											. '</a>';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+	/**
+	 *    the_event_date - first date by date order
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format   = ! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+	/**
+	 *    the_event_end_date - last date by date order
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_event_end_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+	/**
+	 *    the_earliest_event_date - first date chronologically
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_earliest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+	/**
+	 *    the_latest_event_date - latest date chronologically
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_latest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+	/**
+	 *    event_date_as_calendar_page
+	 *
+	 * @param int $EVT_ID
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_date_as_calendar_page($EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			?>
             <div class="event-date-calendar-page-dv">
                 <div class="event-date-calendar-page-month-dv">
                     <?php echo esc_html($datetime->get_i18n_datetime('DTT_EVT_start', 'M')); ?>
@@ -376,275 +376,275 @@ 
                 </div>
             </div>
             <?php
-        }
-    }
-
-
-    /**
-     *    get_primary_date_obj - orders date by DTT_order
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_primary_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_order' => 'ASC'],
-                ]
-            );
-            return reset($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_last_date_obj - orders date by DTT_order
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_last_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_order' => 'DESC'],
-                ]
-            );
-            return end($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_earliest_date_obj - orders date chronologically
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_earliest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_EVT_start' => 'ASC'],
-                ]
-            );
-            return reset($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_latest_date_obj - orders date chronologically
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_latest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_EVT_start' => 'DESC'],
-                ]
-            );
-            return end($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
-     *
-     * @param int $EVT_ID
-     * @return    EE_Datetime|null
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function get_next_upcoming_date_obj($EVT_ID = 0)
-    {
-        $datetime = EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Event.EVT_ID'  => $EVT_ID,
-                    'DTT_EVT_start' => ['>=', current_time('mysql', true)],
-                ],
-                'order_by' => ['DTT_EVT_start' => 'asc'],
-            ]
-        );
-        return $datetime instanceof EE_Datetime ? $datetime : null;
-    }
-
-
-    /**
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
-     *
-     * @param int $DTT_ID
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_date_obj(int $DTT_ID = 0): ?EE_Datetime
-    {
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        return $datetime instanceof EE_Datetime ? $datetime : null;
-    }
-
-
-    /**
-     *    get_all_date_obj
-     *
-     * @param int  $EVT_ID
-     * @param null $include_expired
-     * @param bool $include_deleted
-     * @param null $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_all_date_obj(
-        $EVT_ID = 0,
-        $include_expired = null,
-        $include_deleted = false,
-        $limit = null
-    ) {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($include_expired === null) {
-            if ($event instanceof EE_Event && $event->is_expired()) {
-                $include_expired = true;
-            } else {
-                $include_expired = false;
-            }
-        }
-
-        if ($event instanceof EE_Event) {
-            return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
-        }
-        return [];
-    }
-
-
-    /**
-     *    event_link_url
-     *
-     * @param int $EVT_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_link_url($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $url = $event->external_url() !== null && $event->external_url() !== ''
-                ? $event->external_url()
-                : get_permalink($event->ID());
-            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
-            return esc_url_raw($url);
-        }
-        return '';
-    }
-
-
-    /**
-     *    event_phone
-     *
-     * @param int $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_phone($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            return EEH_Schema::telephone($event->phone());
-        }
-        return null;
-    }
-
-
-    /**
-     *    edit_event_link
-     *
-     * @param int    $EVT_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            // can the user edit this post ?
-            if (current_user_can('edit_post', $event->ID())) {
-                // set link text
-                $link_text = ! empty($link) ? $link : esc_html__('edit this event', 'event_espresso');
-                // generate nonce
-                $nonce = wp_create_nonce('edit_nonce');
-                // generate url to event editor for this event
-                $url =
-                    add_query_arg(
-                        [
-                            'page'       => 'espresso_events',
-                            'action'     => 'edit',
-                            'post'       => $event->ID(),
-                            'edit_nonce' => $nonce,
-                        ],
-                        admin_url()
-                    );
-                // get edit CPT text
-                $post_type_obj = get_post_type_object('espresso_events');
-                // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
-                $link .= EED_Events_Archive::link_target();
-                $link .= '>' . $link_text . '</a>';
-                // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function event_archive_url()
-    {
-        return get_post_type_archive_link('espresso_events');
-    }
+		}
+	}
+
+
+	/**
+	 *    get_primary_date_obj - orders date by DTT_order
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_primary_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_order' => 'ASC'],
+				]
+			);
+			return reset($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_last_date_obj - orders date by DTT_order
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_last_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_order' => 'DESC'],
+				]
+			);
+			return end($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_earliest_date_obj - orders date chronologically
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_earliest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_EVT_start' => 'ASC'],
+				]
+			);
+			return reset($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_latest_date_obj - orders date chronologically
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_latest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_EVT_start' => 'DESC'],
+				]
+			);
+			return end($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
+	 *
+	 * @param int $EVT_ID
+	 * @return    EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function get_next_upcoming_date_obj($EVT_ID = 0)
+	{
+		$datetime = EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Event.EVT_ID'  => $EVT_ID,
+					'DTT_EVT_start' => ['>=', current_time('mysql', true)],
+				],
+				'order_by' => ['DTT_EVT_start' => 'asc'],
+			]
+		);
+		return $datetime instanceof EE_Datetime ? $datetime : null;
+	}
+
+
+	/**
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
+	 *
+	 * @param int $DTT_ID
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_date_obj(int $DTT_ID = 0): ?EE_Datetime
+	{
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		return $datetime instanceof EE_Datetime ? $datetime : null;
+	}
+
+
+	/**
+	 *    get_all_date_obj
+	 *
+	 * @param int  $EVT_ID
+	 * @param null $include_expired
+	 * @param bool $include_deleted
+	 * @param null $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_all_date_obj(
+		$EVT_ID = 0,
+		$include_expired = null,
+		$include_deleted = false,
+		$limit = null
+	) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($include_expired === null) {
+			if ($event instanceof EE_Event && $event->is_expired()) {
+				$include_expired = true;
+			} else {
+				$include_expired = false;
+			}
+		}
+
+		if ($event instanceof EE_Event) {
+			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
+		}
+		return [];
+	}
+
+
+	/**
+	 *    event_link_url
+	 *
+	 * @param int $EVT_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_link_url($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$url = $event->external_url() !== null && $event->external_url() !== ''
+				? $event->external_url()
+				: get_permalink($event->ID());
+			$url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
+			return esc_url_raw($url);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    event_phone
+	 *
+	 * @param int $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_phone($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			return EEH_Schema::telephone($event->phone());
+		}
+		return null;
+	}
+
+
+	/**
+	 *    edit_event_link
+	 *
+	 * @param int    $EVT_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			// can the user edit this post ?
+			if (current_user_can('edit_post', $event->ID())) {
+				// set link text
+				$link_text = ! empty($link) ? $link : esc_html__('edit this event', 'event_espresso');
+				// generate nonce
+				$nonce = wp_create_nonce('edit_nonce');
+				// generate url to event editor for this event
+				$url =
+					add_query_arg(
+						[
+							'page'       => 'espresso_events',
+							'action'     => 'edit',
+							'post'       => $event->ID(),
+							'edit_nonce' => $nonce,
+						],
+						admin_url()
+					);
+				// get edit CPT text
+				$post_type_obj = get_post_type_object('espresso_events');
+				// build final link html
+				$link = '<a class="post-edit-link" href="' . $url . '" ';
+				$link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+				$link .= EED_Events_Archive::link_target();
+				$link .= '>' . $link_text . '</a>';
+				// put it all together
+				return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function event_archive_url()
+	{
+		return get_post_type_archive_link('espresso_events');
+	}
 }

core/services/progress_steps/ProgressStep.php

Spacing +5 added lines, -5 removed lines

@@ -121,7 +121,7 @@ 
      */
     protected function setId($id = '')
     {
-        if (! is_string($id)) {
+        if ( ! is_string($id)) {
             throw new InvalidDataTypeException('$id', $id, 'string');
         }
         $this->id = $id;
@@ -144,7 +144,7 @@ 
      */
     protected function setOrder($order = 0)
     {
-        if (! is_int($order)) {
+        if ( ! is_int($order)) {
             throw new InvalidDataTypeException('$order', $order, 'integer');
         }
         $this->order = absint($order);
@@ -173,11 +173,11 @@ 
      */
     protected function setHtmlClass($html_class)
     {
-        if (! is_string($html_class)) {
+        if ( ! is_string($html_class)) {
             throw new InvalidDataTypeException('$html_class', $html_class, 'string');
         }
         if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
+            $html_class = 'progress-step-'.$html_class;
         }
         $this->html_class = $html_class;
     }
@@ -199,7 +199,7 @@ 
      */
     protected function setText($text)
     {
-        if (! is_string($text)) {
+        if ( ! is_string($text)) {
             throw new InvalidDataTypeException('$text', $text, 'string');
         }
         $this->text = sanitize_text_field($text);

Indentation +186 added lines, -186 removed lines

@@ -16,190 +16,190 @@
  */
 class ProgressStep implements ProgressStepInterface
 {
-    /**
-     * @var boolean $current
-     */
-    private $current = false;
-
-
-    /**
-     * @var boolean $completed
-     */
-    private $completed = false;
-
-
-    /**
-     * @var string $html_class
-     */
-    private $html_class;
-
-    /**
-     * @var string $id
-     */
-    private $id = '';
-
-    /**
-     * @var int $order
-     */
-    private $order = 0;
-
-    /**
-     * @var string $text
-     */
-    private $text = '';
-
-
-    /**
-     * ProgressStep constructor
-     *
-     * @param int    $order
-     * @param string $id
-     * @param string $html_class
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($order, $id, $html_class, $text)
-    {
-        $this->setOrder($order);
-        $this->setId($id);
-        $this->setHtmlClass($html_class);
-        $this->setText($text);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCurrent()
-    {
-        return $this->current;
-    }
-
-
-    /**
-     * @param boolean $current
-     */
-    public function setIsCurrent($current = true)
-    {
-        $this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCompleted()
-    {
-        return $this->completed;
-    }
-
-
-    /**
-     * @param boolean $completed
-     */
-    public function setIsCompleted($completed = true)
-    {
-        $this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function id()
-    {
-        return $this->id;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $id
-     * @throws InvalidDataTypeException
-     */
-    protected function setId($id = '')
-    {
-        if (! is_string($id)) {
-            throw new InvalidDataTypeException('$id', $id, 'string');
-        }
-        $this->id = $id;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-    /**
-     * @access protected
-     * @param int $order
-     * @throws InvalidDataTypeException
-     */
-    protected function setOrder($order = 0)
-    {
-        if (! is_int($order)) {
-            throw new InvalidDataTypeException('$order', $order, 'integer');
-        }
-        $this->order = absint($order);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function htmlClass()
-    {
-        $html_class = $this->html_class;
-        if ($this->isCurrent()) {
-            $html_class .= ' progress-step-active';
-        } elseif ($this->isCompleted()) {
-            $html_class .= ' progress-step-completed';
-        }
-        return $html_class;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $html_class
-     * @throws InvalidDataTypeException
-     */
-    protected function setHtmlClass($html_class)
-    {
-        if (! is_string($html_class)) {
-            throw new InvalidDataTypeException('$html_class', $html_class, 'string');
-        }
-        if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
-        }
-        $this->html_class = $html_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function text()
-    {
-        return $this->text;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    protected function setText($text)
-    {
-        if (! is_string($text)) {
-            throw new InvalidDataTypeException('$text', $text, 'string');
-        }
-        $this->text = sanitize_text_field($text);
-    }
+	/**
+	 * @var boolean $current
+	 */
+	private $current = false;
+
+
+	/**
+	 * @var boolean $completed
+	 */
+	private $completed = false;
+
+
+	/**
+	 * @var string $html_class
+	 */
+	private $html_class;
+
+	/**
+	 * @var string $id
+	 */
+	private $id = '';
+
+	/**
+	 * @var int $order
+	 */
+	private $order = 0;
+
+	/**
+	 * @var string $text
+	 */
+	private $text = '';
+
+
+	/**
+	 * ProgressStep constructor
+	 *
+	 * @param int    $order
+	 * @param string $id
+	 * @param string $html_class
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($order, $id, $html_class, $text)
+	{
+		$this->setOrder($order);
+		$this->setId($id);
+		$this->setHtmlClass($html_class);
+		$this->setText($text);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCurrent()
+	{
+		return $this->current;
+	}
+
+
+	/**
+	 * @param boolean $current
+	 */
+	public function setIsCurrent($current = true)
+	{
+		$this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCompleted()
+	{
+		return $this->completed;
+	}
+
+
+	/**
+	 * @param boolean $completed
+	 */
+	public function setIsCompleted($completed = true)
+	{
+		$this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function id()
+	{
+		return $this->id;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $id
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setId($id = '')
+	{
+		if (! is_string($id)) {
+			throw new InvalidDataTypeException('$id', $id, 'string');
+		}
+		$this->id = $id;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param int $order
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setOrder($order = 0)
+	{
+		if (! is_int($order)) {
+			throw new InvalidDataTypeException('$order', $order, 'integer');
+		}
+		$this->order = absint($order);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function htmlClass()
+	{
+		$html_class = $this->html_class;
+		if ($this->isCurrent()) {
+			$html_class .= ' progress-step-active';
+		} elseif ($this->isCompleted()) {
+			$html_class .= ' progress-step-completed';
+		}
+		return $html_class;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $html_class
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setHtmlClass($html_class)
+	{
+		if (! is_string($html_class)) {
+			throw new InvalidDataTypeException('$html_class', $html_class, 'string');
+		}
+		if (strpos($html_class, 'progress-step-') === false) {
+			$html_class = 'progress-step-' . $html_class;
+		}
+		$this->html_class = $html_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function text()
+	{
+		return $this->text;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setText($text)
+	{
+		if (! is_string($text)) {
+			throw new InvalidDataTypeException('$text', $text, 'string');
+		}
+		$this->text = sanitize_text_field($text);
+	}
 }

core/libraries/shortcodes/EE_Shortcodes.lib.php

Spacing +13 added lines, -13 removed lines

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

Indentation +452 added lines, -452 removed lines

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

core/libraries/messages/EE_Message_Type_Collection.lib.php

Spacing +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
             $this->rewind();
             while ($this->valid()) {
                 echo '<h5 style="color:#2EA2CC;">
-                    ' . __CLASS__ . ' class : <span style="color:#E76700">' . esc_html($this->getInfo()) . '</span>
+                    ' . __CLASS__.' class : <span style="color:#E76700">'.esc_html($this->getInfo()).'</span>
                     </h5>';
                 $this->next();
             }

Indentation +137 added lines, -137 removed lines

@@ -13,143 +13,143 @@
  */
 class EE_Message_Type_Collection extends EE_Object_Collection
 {
-    /**
-     * EE_Message_Type_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_message_type';
-    }
-
-
-
-    /**
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = ''): bool
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::add($object, $info);
-    }
-
-
-
-    /**
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = ''): bool
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::set_info($object, $info);
-    }
-
-
-
-    /**
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info = '')
-    {
-        return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
-    }
-
-
-
-    /**
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @param object $object
-     * @return bool
-     */
-    public function has($object): bool
-    {
-        return parent::has($object);
-    }
-
-
-
-    /**
-     * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
-     *
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function has_by_name(string $message_type_name): bool
-    {
-        return $this->get_by_info($message_type_name) instanceof $this->interface;
-    }
-
-
-
-    /**
-     * detaches an object from the Collection
-     *
-     * @param $object
-     * @return bool
-     */
-    public function remove($object): bool
-    {
-        return parent::remove($object);
-    }
-
-
-
-    /**
-     * advances pointer to the provided object
-     *
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        parent::set_current($object);
-    }
-
-
-
-    /**
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        parent::set_current_by_info($info);
-    }
-
-
-
-    /**
-     * displays list of collection classes if WP_DEBUG is on
-     *
-     * @return void
-     */
-    public function show_collection_classes()
-    {
-        if (WP_DEBUG) {
-            $this->rewind();
-            while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">
+	/**
+	 * EE_Message_Type_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_message_type';
+	}
+
+
+
+	/**
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = ''): bool
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::add($object, $info);
+	}
+
+
+
+	/**
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = ''): bool
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::set_info($object, $info);
+	}
+
+
+
+	/**
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info = '')
+	{
+		return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
+	}
+
+
+
+	/**
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object): bool
+	{
+		return parent::has($object);
+	}
+
+
+
+	/**
+	 * returns TRUE or FALSE depending on whether the supplied message_type classname is within the Collection
+	 *
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function has_by_name(string $message_type_name): bool
+	{
+		return $this->get_by_info($message_type_name) instanceof $this->interface;
+	}
+
+
+
+	/**
+	 * detaches an object from the Collection
+	 *
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object): bool
+	{
+		return parent::remove($object);
+	}
+
+
+
+	/**
+	 * advances pointer to the provided object
+	 *
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		parent::set_current($object);
+	}
+
+
+
+	/**
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		parent::set_current_by_info($info);
+	}
+
+
+
+	/**
+	 * displays list of collection classes if WP_DEBUG is on
+	 *
+	 * @return void
+	 */
+	public function show_collection_classes()
+	{
+		if (WP_DEBUG) {
+			$this->rewind();
+			while ($this->valid()) {
+				echo '<h5 style="color:#2EA2CC;">
                     ' . __CLASS__ . ' class : <span style="color:#E76700">' . esc_html($this->getInfo()) . '</span>
                     </h5>';
-                $this->next();
-            }
-        }
-    }
+				$this->next();
+			}
+		}
+	}
 }

core/libraries/messages/defaults/default/html_receipt_ticket_list.template.php

Spacing +3 added lines, -3 removed lines

@@ -24,14 +24,14 @@ 
         <div class="ticket-time-and-place-details">
             <div class="ticket-time-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'clock-16x16.png'); ?>">
+                    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL.'clock-16x16.png'); ?>">
                     <?php esc_html_e('Date/Time:', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-dates">[DATETIME_LIST]</ul>
             </div>
             <div class="ticket-place-details">
                 <h4 class="sub-section-title no-bottom-margin">
-                    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>">
+                    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL.'location-pin-16x16.png'); ?>">
                     <?php esc_html_e('Venue', 'event_espresso'); ?>
                 </h4>
                 <ul class="event-venues">
@@ -45,7 +45,7 @@ 
         </div>
         <div class="ticket-registrations-area">
             <h4 class="sub-section-title">
-                <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>">
+                <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL.'users-16x16.png'); ?>">
                 <?php esc_html_e("Registration Details", "event_espresso"); ?>
                 <span class="small-text link">
                     ( <a class="print_button noPrint" href="[PRIMARY_REGISTRANT_FRONTEND_EDIT_REG_LINK]">

core/libraries/messages/defaults/default/html_receipt_event_list.template.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 
 ?>
 <h3 class="section-title event-name">
-    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'calendar_year-24x24.png'); ?>">
+    <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL.'calendar_year-24x24.png'); ?>">
     <?php esc_html_e("Event Name:", "event_espresso") ?>
     <span class="plain-text">[EVENT_NAME]</span>
     <span class="small-text link">

core/libraries/messages/defaults/default/html_receipt_attendee_list.template.php

Spacing +2 added lines, -2 removed lines

@@ -8,11 +8,11 @@
 <li class="ticket-registration">
     <table class="registration-details">
         <tr class="odd">
-            <th><?php	_e('Attendee', 'event_espresso');?></th>
+            <th><?php	_e('Attendee', 'event_espresso'); ?></th>
             <td>[FNAME] [LNAME] ([ATTENDEE_EMAIL])</td>
         </tr>
         <tr>
-            <th><?php esc_html_e("Registration Code:", "event_espresso");?></th>
+            <th><?php esc_html_e("Registration Code:", "event_espresso"); ?></th>
             <td>[REGISTRATION_CODE] - <span class="[REGISTRATION_STATUS_ID]">[REGISTRATION_STATUS_LABEL]</span></td>
         </tr>
     </table>

modules/thank_you_page/templates/thank-you-page-registration-details.template.php

Spacing +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
     $event_name    = '';
     $wait_list     = false;
     foreach ($registrations as $registration) {
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             continue;
         }
         if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
@@ -55,7 +55,7 @@ 
             <tbody>
             <?php
         }
-        if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
+        if ($is_primary || ( ! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
             <tr>
                 <td width="40%">
                     <?php

Indentation +62 added lines, -62 removed lines

@@ -14,24 +14,24 @@ 
 
 <div class="ee-registration-details-dv">
     <?php
-    $registrations = $transaction->registrations();
-    $registrations = is_array($registrations) ? $registrations : [];
-    $reg_count     = count($registrations);
-    $reg_cntr      = 0;
-    $event_name    = '';
-    $wait_list     = false;
-    foreach ($registrations as $registration) {
-        if (! $registration instanceof EE_Registration) {
-            continue;
-        }
-        if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
+	$registrations = $transaction->registrations();
+	$registrations = is_array($registrations) ? $registrations : [];
+	$reg_count     = count($registrations);
+	$reg_cntr      = 0;
+	$event_name    = '';
+	$wait_list     = false;
+	foreach ($registrations as $registration) {
+		if (! $registration instanceof EE_Registration) {
+			continue;
+		}
+		if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
             </tbody>
             </table>
             <?php
-        }
-        $reg_cntr++;
-        if ($event_name != $registration->event_name()) {
-            ?>
+		}
+		$reg_cntr++;
+		if ($event_name != $registration->event_name()) {
+			?>
             <h5>
                 <span class="smaller-text grey-text">
                     <?php esc_html_e('for', 'event_espresso'); ?> :
@@ -54,23 +54,23 @@ 
             </thead>
             <tbody>
             <?php
-        }
-        if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
+		}
+		if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
             <tr>
                 <td width="40%">
                     <?php
-                    if ($registration->attendee() instanceof EE_Attendee) {
-                        echo esc_html($registration->attendee()->full_name(true));
-                    }
-                    ?>
+					if ($registration->attendee() instanceof EE_Attendee) {
+						echo esc_html($registration->attendee()->full_name(true));
+					}
+					?>
                     <p class="tiny-text" style="margin: .75em 0 0;">
                         <?php if ($registration->count_question_groups()) { ?>
                             <a class="ee-icon-only-lnk"
                                href="<?php echo esc_url_raw($registration->edit_attendee_information_url()); ?>"
                                title="<?php esc_attr_e(
-                                   'Click here to edit Attendee Information',
-                                   'event_espresso'
-                               ); ?>"
+								   'Click here to edit Attendee Information',
+								   'event_espresso'
+							   ); ?>"
                             >
                                 <span class="dashicons dashicons-groups"></span>
                                 <?php esc_html_e('edit info', 'event_espresso'); ?>
@@ -78,15 +78,15 @@ 
                         <?php } ?>
                         <a class="ee-resend-reg-confirmation-email ee-icon-only-lnk"
                            href="<?php echo esc_url_raw(
-                               add_query_arg(
-                                   ['token' => $registration->reg_url_link(), 'resend_reg_confirmation' => 'true'],
-                                   EE_Registry::instance()->CFG->core->thank_you_page_url()
-                               )
-                           ); ?>"
+							   add_query_arg(
+								   ['token' => $registration->reg_url_link(), 'resend_reg_confirmation' => 'true'],
+								   EE_Registry::instance()->CFG->core->thank_you_page_url()
+							   )
+						   ); ?>"
                            title="<?php esc_attr_e(
-                               'Click here to resend the Registration Confirmation email',
-                               'event_espresso'
-                           ); ?>"
+							   'Click here to resend the Registration Confirmation email',
+							   'event_espresso'
+						   ); ?>"
                            rel="<?php echo esc_attr($registration->reg_url_link()); ?>"
                         >
                             <span class="dashicons dashicons-email-alt"></span>
@@ -100,27 +100,27 @@ 
                 <td width="35%" class="jst-left">
                     <?php $registration->e_pretty_status(true) ?>
                     <?php
-                    if ($registration->status_ID() === EEM_Registration::status_id_wait_list) {
-                        $wait_list = true;
-                    }
-                    ?>
+					if ($registration->status_ID() === EEM_Registration::status_id_wait_list) {
+						$wait_list = true;
+					}
+					?>
                 </td>
             </tr>
             <?php do_action(
-                'AHEE__thank_you_page_registration_details_template__after_registration_table_row',
-                $registration
-            ); ?>
+				'AHEE__thank_you_page_registration_details_template__after_registration_table_row',
+				$registration
+			); ?>
             <?php
-            $event_name = $registration->event_name();
-        }
-        if ($reg_cntr >= $reg_count) {
-            ?>
+			$event_name = $registration->event_name();
+		}
+		if ($reg_cntr >= $reg_count) {
+			?>
             </tbody>
             </table>
             <?php
-        }
-    }
-    ?>
+		}
+	}
+	?>
     <?php if ($is_primary && $SPCO_attendee_information_url) { ?>
         <p class="small-text jst-rght">
             <a href='<?php echo esc_url_raw($SPCO_attendee_information_url) ?>'>
@@ -129,22 +129,22 @@ 
         </p>
     <?php } ?>
     <?php
-    if ($wait_list) {
-        echo apply_filters(
-            'AFEE__thank_you_page_registration_details_template__wait_list_notice',
-            sprintf(
-                esc_html__(
-                    '%1$sre: Wait List Registrations%2$sPlease note that the total cost listed below in the Transaction Details is for ALL registrations, including those that are on the wait list, even though they can not be currently paid for. If any spaces become available however, you may be notified by the Event admin and have the opportunity to secure the remaining tickets by making a payment for them.%3$s',
-                    'event_espresso'
-                ),
-                '<h6 class="" style="margin-bottom:.25em;"><span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>',
-                '</h6 ><p class="ee-wait-list-notice">',
-                '</p ><br />'
-            )
-        );
-    }
-    do_action('AHEE__thank_you_page_registration_details_template__after_registration_details');
-    ?>
+	if ($wait_list) {
+		echo apply_filters(
+			'AFEE__thank_you_page_registration_details_template__wait_list_notice',
+			sprintf(
+				esc_html__(
+					'%1$sre: Wait List Registrations%2$sPlease note that the total cost listed below in the Transaction Details is for ALL registrations, including those that are on the wait list, even though they can not be currently paid for. If any spaces become available however, you may be notified by the Event admin and have the opportunity to secure the remaining tickets by making a payment for them.%3$s',
+					'event_espresso'
+				),
+				'<h6 class="" style="margin-bottom:.25em;"><span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>',
+				'</h6 ><p class="ee-wait-list-notice">',
+				'</p ><br />'
+			)
+		);
+	}
+	do_action('AHEE__thank_you_page_registration_details_template__after_registration_details');
+	?>
 
 </div>
 <!-- end of .registration-details -->

modules/single_page_checkout/templates/registration_page_wrapper.template.php

Spacing +3 added lines, -3 removed lines

@@ -14,7 +14,7 @@ 
 
 <div id="ee-single-page-checkout-dv" class="">
     <?php
-    if (! $empty_cart) {
+    if ( ! $empty_cart) {
         if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice"
                style="display: none;">
@@ -31,7 +31,7 @@ 
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+        if ( ! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
             ?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
@@ -77,7 +77,7 @@ 
         foreach ($reg_steps as $reg_step) {
             if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
                 $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+                do_action('AHEE__'.$slug.'__reg_step_start', $reg_step);
                 // todo: deprecate hook AHEE__registration_page_attendee_information__start
                 ?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"

Indentation +43 added lines, -43 removed lines

@@ -16,38 +16,38 @@ 
 
 <div id="ee-single-page-checkout-dv" class="">
     <?php
-    if (! $empty_cart) {
-        if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
+	if (! $empty_cart) {
+		if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice"
                style="display: none;">
                 <?php echo sprintf(
-                    apply_filters(
-                        'FHEE__registration_page_wrapper_template___time_limit',
-                        esc_html__('You have %1$s to complete your registration.', 'event_espresso')
-                    ),
-                    '<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
-                    . $registration_time_limit
-                    . '</span>'
-                );
-                ?>
+					apply_filters(
+						'FHEE__registration_page_wrapper_template___time_limit',
+						esc_html__('You have %1$s to complete your registration.', 'event_espresso')
+					),
+					'<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
+					. $registration_time_limit
+					. '</span>'
+				);
+				?>
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
-            ?>
+		if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+			?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
             </h2>
 
             <div id="spco-steps-display-dv">
                 <?php
-                $step_nmbr = 1;
-                $total_steps = count($reg_steps) - 1;
-                foreach ($reg_steps as $reg_step) {
-                    if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                        $slug = $reg_step->slug();
-                        $step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
-                        ?>
+				$step_nmbr = 1;
+				$total_steps = count($reg_steps) - 1;
+				foreach ($reg_steps as $reg_step) {
+					if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+						$slug = $reg_step->slug();
+						$step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
+						?>
                         <div id="spco-step-<?php echo esc_attr($slug); ?>-display-dv"
                              class="spco-step-display-dv <?php echo esc_attr($step_display_dv_class); ?> steps-<?php echo esc_attr($total_steps); ?>"
                         >
@@ -60,28 +60,28 @@ 
                         </div>
 
                         <?php
-                        if ($step_nmbr < $total_steps) { ?>
+						if ($step_nmbr < $total_steps) { ?>
                             <div class="spco-step-arrow-dv">&raquo;</div>
                             <?php
-                        }
-                        $step_nmbr++;
-                    }
-                }
-                ?>
+						}
+						$step_nmbr++;
+					}
+				}
+				?>
                 <div class="clear-float"></div>
             </div>
 
             <?php
-        }
+		}
 
-        do_action('AHEE__SPCO__before_registration_steps');
-        $step_nmbr = 1;
-        foreach ($reg_steps as $reg_step) {
-            if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
-                // todo: deprecate hook AHEE__registration_page_attendee_information__start
-                ?>
+		do_action('AHEE__SPCO__before_registration_steps');
+		$step_nmbr = 1;
+		foreach ($reg_steps as $reg_step) {
+			if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+				$slug = $reg_step->slug();
+				do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+				// todo: deprecate hook AHEE__registration_page_attendee_information__start
+				?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"
                      class="spco-step-dv <?php echo esc_attr($reg_step->div_class()); ?>"
                 >
@@ -89,20 +89,20 @@ 
                     <?php do_action('AHEE__SPCO_after_reg_step_form', $slug, $next_step); ?>
                 </div>
                 <?php $step_nmbr++;
-            }
-        }
-        do_action('AHEE__SPCO__after_registration_steps');
-    } else {
-        ?>
+			}
+		}
+		do_action('AHEE__SPCO__after_registration_steps');
+	} else {
+		?>
         <h3 id="spco-empty-cart-hdr" class="spco-step-title-hdr">
             <?php esc_html_e('Nothing in your Event Queue', 'event_espresso'); ?>
         </h3>
         <p><?php echo wp_kses($empty_msg, AllowedTags::getWithFormTags()); ?></p>
         <?php echo wp_kses($cookies_not_set_msg, AllowedTags::getWithFormTags()); ?>
         <?php
-    }
-    do_action('AHEE__SPCO__reg_form_footer');
-    ?>
+	}
+	do_action('AHEE__SPCO__reg_form_footer');
+	?>
 
 </div>