eventespresso / event-espresso-core

core/helpers/EEH_Event_View.helper.php

Doc Comments +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
      * get_event
      * attempts to retrieve an EE_Event object any way it can
      *
-     * @param int|WP_Post $EVT_ID
+     * @param integer $EVT_ID
      * @return EE_Event|null
      * @throws \EE_Error
      */
@@ -115,7 +115,7 @@ 
      *
      *  @access     public
      * @param    int $EVT_ID
-     *  @return     string
+     *  @return     boolean
      */
     public static function event_has_content_or_excerpt($EVT_ID = 0)
     {
@@ -136,7 +136,7 @@ 
      *    event_active_status
      *
      * @access    public
-     * @param null $num_words
+     * @param integer $num_words
      * @param null $more
      * @return    string
      */
@@ -478,7 +478,7 @@ 
      *
      * @access    public
      * @param int $EVT_ID
-     * @param null $include_expired
+     * @param false|null $include_expired
      * @param bool $include_deleted
      * @param null $limit
      * @return EE_Datetime[]

Spacing +31 added lines, -31 removed lines

@@ -39,7 +39,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;
@@ -124,7 +124,7 @@ 
         if ($event instanceof EE_Event) {
             $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
         }
-        if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
+        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;
@@ -144,11 +144,11 @@ 
     {
         global $post;
         ob_start();
-        if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
+        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() )) {
+        } 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
@@ -158,20 +158,20 @@ 
                 // 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 = __('(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 .= '>'.$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();
+                    $content = get_the_content();
                 }
                 global $allowedtags;
                 // make sure links are allowed
@@ -240,8 +240,8 @@ 
                 // 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) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
-                        $category_links[] = '<a href="' . esc_url($url)
+                    if ( ! is_wp_error($url) && (($hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized)) {
+                        $category_links[] = '<a href="'.esc_url($url)
                                             . '" rel="tag"'
                                             . \EED_Events_Archive::link_target()
                                             .'>'
@@ -268,8 +268,8 @@ 
     public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
 
@@ -286,7 +286,7 @@ 
     public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
     }
 
@@ -304,8 +304,8 @@ 
     public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
 
@@ -322,8 +322,8 @@ 
     public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
     {
         $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
     }
 
 
@@ -341,8 +341,8 @@ 
         if ($datetime instanceof EE_Datetime) {
     ?>
         <div class="event-date-calendar-page-dv">
-            <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M');?></div>
-            <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d');?></div>
+            <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M'); ?></div>
+            <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d'); ?></div>
         </div>
     <?php
         }
@@ -365,7 +365,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'ASC' )
+                    'order_by' => array('DTT_order' => 'ASC')
                 )
             );
             return reset($datetimes);
@@ -391,7 +391,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'DESC' )
+                    'order_by' => array('DTT_order' => 'DESC')
                 )
             );
             return end($datetimes);
@@ -417,7 +417,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+                    'order_by' => array('DTT_EVT_start' => 'ASC')
                 )
             );
             return reset($datetimes);
@@ -443,7 +443,7 @@ 
                 'Datetime',
                 array(
                     'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+                    'order_by' => array('DTT_EVT_start' => 'DESC')
                 )
             );
             return end($datetimes);
@@ -515,7 +515,7 @@ 
         $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());
-            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
+            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://'.$url;
         }
         return null;
     }
@@ -561,16 +561,16 @@ 
                 // generate nonce
                 $nonce = wp_create_nonce('edit_nonce');
                 // generate url to event editor for this event
-                $url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
+                $url = add_query_arg(array('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 = '<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 +569 added lines, -569 removed lines

@@ -11,578 +11,578 @@
 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
-     */
-    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
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @return    boolean
-     */
-    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() : false;
-    }
-
-
-
-    /**
-     *    event_status
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @return    string
-     */
-    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
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     string
-     */
-    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
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     string
-     */
-    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) != '' ? true : false;
-        }
-        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
-     *
-     * @access    public
-     * @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 = __('(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']
-                    : array();
-                // 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
-     *
-     *  @access     public
-     * @param    int $EVT_ID
-     *  @return     EE_Ticket[]
-     */
-    public static function event_tickets_available($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        $tickets_available_for_purchase = array();
-        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
-     *
-     * @access    public
-     * @param    int $EVT_ID
-     * @param     bool   $hide_uncategorized
-     * @return    string
-     */
-    public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = array();
-        $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) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
-                        $category_links[] = '<a href="' . esc_url($url)
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-
-    /**
-     *    the_event_date - first date by date order
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
-    }
-
-
-
-    /**
-     *    the_event_end_date - last date by date order
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-
-    /**
-     *    the_earliest_event_date - first date chronologically
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-
-    /**
-     *    the_latest_event_date - latest date chronologically
-     *
-     * @access    public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param int    $EVT_ID
-     * @return    string
-     */
-    public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-
-    /**
-     *    event_date_as_calendar_page
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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
+	 */
+	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
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @return    boolean
+	 */
+	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() : false;
+	}
+
+
+
+	/**
+	 *    event_status
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @return    string
+	 */
+	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
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     string
+	 */
+	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
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     string
+	 */
+	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) != '' ? true : false;
+		}
+		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
+	 *
+	 * @access    public
+	 * @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 = __('(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']
+					: array();
+				// 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
+	 *
+	 *  @access     public
+	 * @param    int $EVT_ID
+	 *  @return     EE_Ticket[]
+	 */
+	public static function event_tickets_available($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		$tickets_available_for_purchase = array();
+		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
+	 *
+	 * @access    public
+	 * @param    int $EVT_ID
+	 * @param     bool   $hide_uncategorized
+	 * @return    string
+	 */
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = array();
+		$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) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
+						$category_links[] = '<a href="' . esc_url($url)
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+
+	/**
+	 *    the_event_date - first date by date order
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
+	}
+
+
+
+	/**
+	 *    the_event_end_date - last date by date order
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+
+	/**
+	 *    the_earliest_event_date - first date chronologically
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+
+	/**
+	 *    the_latest_event_date - latest date chronologically
+	 *
+	 * @access    public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param int    $EVT_ID
+	 * @return    string
+	 */
+	public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+
+	/**
+	 *    event_date_as_calendar_page
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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 $datetime->get_i18n_datetime('DTT_EVT_start', 'M');?></div>
             <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d');?></div>
         </div>
     <?php
-        }
-    }
-
-
-
-    /**
-     *    get_primary_date_obj - orders date by DTT_order
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'ASC' )
-                )
-            );
-            return reset($datetimes);
-        } else {
-             return false;
-        }
-    }
-
-
-
-    /**
-     *    get_last_date_obj - orders date by DTT_order
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_order' => 'DESC' )
-                )
-            );
-            return end($datetimes);
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *    get_earliest_date_obj - orders date chronologically
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'ASC' )
-                )
-            );
-            return reset($datetimes);
-        } else {
-             return false;
-        }
-    }
-
-
-
-    /**
-     *    get_latest_date_obj - orders date chronologically
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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',
-                array(
-                    'limit' => 1,
-                    'order_by' => array( 'DTT_EVT_start' => 'DESC' )
-                )
-            );
-            return end($datetimes);
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    EE_Datetime|null
-     */
-    public static function get_next_upcoming_date_obj($EVT_ID = 0)
-    {
-        $datetime = EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Event.EVT_ID' => $EVT_ID,
-                    'DTT_EVT_start' => array('>=', current_time('mysql', true))
-                ),
-                'order_by' => array('DTT_EVT_start' => 'asc')
-            )
-        );
-        return $datetime instanceof EE_Datetime ? $datetime : null;
-    }
-
-    /**
-     *    get_all_date_obj
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @param null $include_expired
-     * @param bool $include_deleted
-     * @param null $limit
-     * @return EE_Datetime[]
-     */
-    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);
-        } else {
-             return array();
-        }
-    }
-
-
-
-    /**
-     *    event_link_url
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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());
-            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
-        }
-        return null;
-    }
-
-
-
-    /**
-     *    event_phone
-     *
-     * @access    public
-     * @param int $EVT_ID
-     * @return    string
-     */
-    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
-     *
-     * @access    public
-     * @param int    $EVT_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return    string
-     */
-    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 : __('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(array( '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
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_order' => 'ASC' )
+				)
+			);
+			return reset($datetimes);
+		} else {
+			 return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_last_date_obj - orders date by DTT_order
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_order' => 'DESC' )
+				)
+			);
+			return end($datetimes);
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_earliest_date_obj - orders date chronologically
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+				)
+			);
+			return reset($datetimes);
+		} else {
+			 return false;
+		}
+	}
+
+
+
+	/**
+	 *    get_latest_date_obj - orders date chronologically
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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',
+				array(
+					'limit' => 1,
+					'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+				)
+			);
+			return end($datetimes);
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    EE_Datetime|null
+	 */
+	public static function get_next_upcoming_date_obj($EVT_ID = 0)
+	{
+		$datetime = EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Event.EVT_ID' => $EVT_ID,
+					'DTT_EVT_start' => array('>=', current_time('mysql', true))
+				),
+				'order_by' => array('DTT_EVT_start' => 'asc')
+			)
+		);
+		return $datetime instanceof EE_Datetime ? $datetime : null;
+	}
+
+	/**
+	 *    get_all_date_obj
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @param null $include_expired
+	 * @param bool $include_deleted
+	 * @param null $limit
+	 * @return EE_Datetime[]
+	 */
+	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);
+		} else {
+			 return array();
+		}
+	}
+
+
+
+	/**
+	 *    event_link_url
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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());
+			return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 *    event_phone
+	 *
+	 * @access    public
+	 * @param int $EVT_ID
+	 * @return    string
+	 */
+	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
+	 *
+	 * @access    public
+	 * @param int    $EVT_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return    string
+	 */
+	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 : __('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(array( '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/helpers/EEH_File.helper.php

Doc Comments -2 removed lines

@@ -673,8 +673,6 @@
      * converts it into a "remote" filepath (the filepath the currently-in-use
      * $wp_filesystem needs to use access the folder or file).
      * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
-     * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
-     * is in use, so you need to provide it
      * @param string $local_filepath the filepath to the folder/file locally
      * @throws EE_Error if filesystem credentials are required
      * @return string the remote filepath (eg the filepath the filesystem method, eg

Indentation +662 added lines, -662 removed lines

@@ -24,666 +24,666 @@
 class EEH_File extends EEH_Base implements EEHI_File
 {
 
-    /**
-     * @var string $_credentials_form
-     */
-    private static $_credentials_form;
-
-    protected static $_wp_filesystem_direct;
-
-    /**
-     * @param string|null $filepath the filepath we want to work in. If its in the
-     * wp uploads directory, we'll want to just use the filesystem directly.
-     * If not provided, we have to assume its not in the uploads directory
-     * @throws EE_Error if filesystem credentials are required
-     * @return WP_Filesystem_Base
-     */
-    private static function _get_wp_filesystem($filepath = null)
-    {
-        if (apply_filters(
-            'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
-            $filepath && EEH_File::is_in_uploads_folder($filepath),
-            $filepath
-        ) ) {
-            if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
-                require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
-                $method = 'direct';
-                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
-                // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-                if (! defined('FS_CHMOD_DIR')) {
-                    define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
-                }
-                if (! defined('FS_CHMOD_FILE')) {
-                    define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
-                }
-                require_once($wp_filesystem_direct_file);
-                EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
-            }
-            return EEH_File::$_wp_filesystem_direct;
-        }
-        global $wp_filesystem;
-        // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
-            // if some eager beaver's just trying to get in there too early...
-            // let them do it, because we are one of those eager beavers! :P
-            /**
-             * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
-             * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
-             * is setup to mostly happen on 'init', and refactoring to have it happen on
-             * 'wp_loaded' is too much work on a BETA milestone.
-             * So this fix is expected to work if the WP files are owned by the server user,
-             * but probably not if the user needs to enter their FTP credentials to modify files
-             * and there may be troubles if the WP files are owned by a different user
-             * than the server user. But both of these issues should exist in 4.4 and earlier too
-             */
-            if (false && ! did_action('wp_loaded')) {
-                $msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
-                if (WP_DEBUG) {
-                    $msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
-                }
-                throw new EE_Error($msg);
-            } else {
-                // should be loaded if we are past the wp_loaded hook...
-                if (! function_exists('WP_Filesystem')) {
-                    require_once(ABSPATH . 'wp-admin/includes/file.php');
-                    require_once(ABSPATH . 'wp-admin/includes/template.php');
-                }
-                // turn on output buffering so that we can capture the credentials form
-                ob_start();
-                $credentials = request_filesystem_credentials('');
-                // store credentials form for the time being
-                EEH_File::$_credentials_form = ob_get_clean();
-                // basically check for direct or previously configured access
-                if (! WP_Filesystem($credentials)) {
-                    // if credentials do NOT exist
-                    if ($credentials === false) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
-                        throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
-                    } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
-                        throw new EE_Error(
-                            sprintf(
-                                __('WP Filesystem Error: $1%s', 'event_espresso'),
-                                $wp_filesystem->errors->get_error_message()
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $wp_filesystem;
-    }
-
-    /**
-     * display_request_filesystem_credentials_form
-     */
-    public static function display_request_filesystem_credentials_form()
-    {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
-        }
-    }
-
-
-
-    /**
-     *    verify_filepath_and_permissions
-     *    checks that a file is readable and has sufficient file permissions set to access
-     *
-     * @access public
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $file_name      - name of file if checking a file
-     * @param string $file_ext       - file extension (ie: "php") if checking a file
-     * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
-            $file_name .= ! empty($file_ext) ? ' file' : ' folder';
-            $msg = sprintf(
-                __('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
-                $file_name,
-                '<br />'
-            );
-            if (EEH_File::exists($full_file_path)) {
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
-            } else {
-                // no file permissions means the file was not found
-                $msg .= sprintf(
-                    __('Please ensure the following path is correct: "%s".', 'event_espresso'),
-                    $full_file_path
-                );
-            }
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
-     *
-     * @access private
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
-     * @throws EE_Error if filesystem credentials are required
-     * @return string
-     */
-    private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // check file permissions
-        $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        if ($perms) {
-            // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
-            $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
-            return sprintf(
-                __('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
-                $type_of_file,
-                $perms
-            );
-        } else {
-            // file exists but file permissions could not be read ?!?!
-            return sprintf(
-                __('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
-                $full_file_path
-            );
-        }
-    }
-
-
-
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * Also, if this function creates the folder, adds a .htaccess file and index.html file
-     * @param string $folder
-     * @throws EE_Error if the folder exists and is writeable, but for some reason we
-     * can't write to it
-     * @return bool false if folder isn't writable; true if it exists and is writeable,
-     */
-    public static function ensure_folder_exists_and_is_writable($folder = '')
-    {
-        if (empty($folder)) {
-            return false;
-        }
-        // remove ending DS
-        $folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
-        $parent_folder = EEH_File::get_parent_folder($folder);
-        // add DS to folder
-        $folder = EEH_File::end_with_directory_separator($folder);
-        $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
-        if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
-            // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
-                return false;
-            } else {
-                if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
-                    if (defined('WP_DEBUG') && WP_DEBUG) {
-                        $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
-                        $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
-                        throw new EE_Error($msg);
-                    }
-                    return false;
-                }
-                EEH_File::add_index_file($folder);
-            }
-        } elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * verify_is_writable - checks if a file or folder is writable
-     * @param string $full_path      - full server path to file or folder
-     * @param string $file_or_folder - whether checking a file or folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function verify_is_writable($full_path = '', $file_or_folder = 'folder')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
-        $full_path = EEH_File::standardise_directory_separators($full_path);
-        if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist.
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function ensure_file_exists_and_is_writable($full_file_path = '')
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $parent_folder = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-                if (defined('WP_DEBUG') && WP_DEBUG) {
-                    $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
-                    $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                    throw new EE_Error($msg);
-                }
-                return false;
-            }
-        }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Gets the parent folder. If provided with file, gets the folder that contains it.
-     * If provided a folder, gets its parent folder.
-     * @param string $file_or_folder_path
-     * @return string parent folder, ENDING with a directory separator
-     */
-    public static function get_parent_folder($file_or_folder_path)
-    {
-        // find the last DS, ignoring a DS on the very end
-        // eg if given "/var/something/somewhere/", we want to get "somewhere"'s
-        // parent folder, "/var/something/"
-        $ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, DS, -2)
-            : strlen($file_or_folder_path);
-        return substr($file_or_folder_path, 0, $ds + 1);
-    }
-
-    // public static function ensure_folder_exists_recursively( $folder ) {
-    //
-    // }
-
-
-
-    /**
-     * get_file_contents
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return string
-     */
-    public static function get_file_contents($full_file_path = '')
-    {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
-            // load WP_Filesystem and set file permissions
-            $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-            return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        }
-        return '';
-    }
-
-
-
-    /**
-     * write_file
-     * @param string $full_file_path
-     * @param string $file_contents - the content to be written to the file
-     * @param string $file_type
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
-    {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
-        $folder = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // write the file
-        if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Wrapper for WP_Filesystem_Base::delete
-     *
-     * @param string $filepath
-     * @param boolean $recursive
-     * @param boolean|string $type 'd' for directory, 'f' for file
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean
-     */
-    public static function delete($filepath, $recursive = false, $type = false)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem();
-        return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false;
-    }
-
-
-
-    /**
-     * exists
-     * checks if a file exists using the WP filesystem
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function exists($full_file_path = '')
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false;
-    }
-
-
-
-    /**
-     * is_readable
-     * checks if a file is_readable using the WP filesystem
-     *
-     * @param string $full_file_path
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function is_readable($full_file_path = '')
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * remove_filename_from_filepath
-     * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function remove_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_DIRNAME);
-    }
-
-
-    /**
-     * get_filename_from_filepath. Arguably the same as basename()
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_filename_from_filepath($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_BASENAME);
-    }
-
-
-    /**
-     * get_file_extension
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_file_extension($full_file_path = '')
-    {
-        return pathinfo($full_file_path, PATHINFO_EXTENSION);
-    }
-
-
-
-    /**
-     * add_htaccess_deny_from_all so the webserver cannot access this folder
-     * @param string $folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return bool
-     */
-    public static function add_htaccess_deny_from_all($folder = '')
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Adds an index file to this folder, so folks can't list all the file's contents
-     * @param string $folder
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean
-     */
-    public static function add_index_file($folder)
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
-     * extract that classname.
-     * @param string $file_path
-     * @return string
-     */
-    public static function get_classname_from_filepath_with_standard_filename($file_path)
-    {
-        // extract file from path
-        $filename = basename($file_path);
-        // now remove the first period and everything after
-        $pos_of_first_period = strpos($filename, '.');
-        return substr($filename, 0, $pos_of_first_period);
-    }
-
-
-
-    /**
-     * standardise_directory_separators
-     *  convert all directory separators in a file path to whatever is set for DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function standardise_directory_separators($file_path)
-    {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
-    }
-
-
-
-    /**
-     * end_with_directory_separator
-     *  ensures that file path ends with DS
-     * @param string $file_path
-     * @return string
-     */
-    public static function end_with_directory_separator($file_path)
-    {
-        return rtrim($file_path, '/\\') . DS;
-    }
-
-
-
-    /**
-     * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
-     * @param $file_path
-     * @return string
-     */
-    public static function standardise_and_end_with_directory_separator($file_path)
-    {
-        return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
-    }
-
-
-
-    /**
-     * takes the folder name (with or without trailing slash) and finds the files it in,
-     * and what the class's name inside of each should be.
-     * @param array $folder_paths
-     * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
-     *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
-     *      Set it TRUE if you know there are files in the directory with the same name but different extensions
-     * @throws EE_Error if filesystem credentials are required
-     * @return array if $index_numerically == TRUE keys are numeric ,
-     *      if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
-     *       and values are their filepaths
-     */
-    public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false)
-    {
-        $class_to_folder_path = array();
-        foreach ($folder_paths as $folder_path) {
-            $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
-            // load WP_Filesystem and set file permissions
-            $files_in_folder = glob($folder_path . '*');
-            $class_to_folder_path = array();
-            if ($files_in_folder) {
-                foreach ($files_in_folder as $file_path) {
-                    // only add files, not folders
-                    if (! is_dir($file_path)) {
-                        if ($index_numerically) {
-                            $class_to_folder_path[] = $file_path;
-                        } else {
-                            $classname = self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
-                        }
-                    }
-                }
-            }
-        }
-        return $class_to_folder_path;
-    }
-
-
-
-    /**
-     * Copies a file. Mostly a wrapper of WP_Filesystem::copy
-     * @param string $source_file
-     * @param string $destination_file
-     * @param boolean $overwrite
-     * @throws EE_Error if filesystem credentials are required
-     * @return boolean success
-     */
-    public static function copy($source_file, $destination_file, $overwrite = false)
-    {
-        $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-
-        $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
-        $folder = EEH_File::remove_filename_from_filepath($full_dest_path);
-        EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
-        // write the file
-        if (! $wp_filesystem->copy(
-            EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
-            EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
-            $overwrite
-        )) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
-                throw new EE_Error($msg);
-            }
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * Reports whether or not the filepath is in the EE uploads folder or not
-     * @param string $filepath
-     * @return boolean
-     */
-    public static function is_in_uploads_folder($filepath)
-    {
-        $uploads = wp_upload_dir();
-        return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
-    }
-
-    /**
-     * Given a "local" filepath (what you probably thought was the only filepath),
-     * converts it into a "remote" filepath (the filepath the currently-in-use
-     * $wp_filesystem needs to use access the folder or file).
-     * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
-     * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
-     * is in use, so you need to provide it
-     * @param string $local_filepath the filepath to the folder/file locally
-     * @throws EE_Error if filesystem credentials are required
-     * @return string the remote filepath (eg the filepath the filesystem method, eg
-     * ftp or ssh, will use to access the folder
-     */
-    public static function convert_local_filepath_to_remote_filepath($local_filepath)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath);
-    }
+	/**
+	 * @var string $_credentials_form
+	 */
+	private static $_credentials_form;
+
+	protected static $_wp_filesystem_direct;
+
+	/**
+	 * @param string|null $filepath the filepath we want to work in. If its in the
+	 * wp uploads directory, we'll want to just use the filesystem directly.
+	 * If not provided, we have to assume its not in the uploads directory
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return WP_Filesystem_Base
+	 */
+	private static function _get_wp_filesystem($filepath = null)
+	{
+		if (apply_filters(
+			'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
+			$filepath && EEH_File::is_in_uploads_folder($filepath),
+			$filepath
+		) ) {
+			if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+				$method = 'direct';
+				$wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+				// check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
+				if (! defined('FS_CHMOD_DIR')) {
+					define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
+				}
+				if (! defined('FS_CHMOD_FILE')) {
+					define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
+				}
+				require_once($wp_filesystem_direct_file);
+				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
+			}
+			return EEH_File::$_wp_filesystem_direct;
+		}
+		global $wp_filesystem;
+		// no filesystem setup ???
+		if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+			// if some eager beaver's just trying to get in there too early...
+			// let them do it, because we are one of those eager beavers! :P
+			/**
+			 * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
+			 * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
+			 * is setup to mostly happen on 'init', and refactoring to have it happen on
+			 * 'wp_loaded' is too much work on a BETA milestone.
+			 * So this fix is expected to work if the WP files are owned by the server user,
+			 * but probably not if the user needs to enter their FTP credentials to modify files
+			 * and there may be troubles if the WP files are owned by a different user
+			 * than the server user. But both of these issues should exist in 4.4 and earlier too
+			 */
+			if (false && ! did_action('wp_loaded')) {
+				$msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
+				if (WP_DEBUG) {
+					$msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+				}
+				throw new EE_Error($msg);
+			} else {
+				// should be loaded if we are past the wp_loaded hook...
+				if (! function_exists('WP_Filesystem')) {
+					require_once(ABSPATH . 'wp-admin/includes/file.php');
+					require_once(ABSPATH . 'wp-admin/includes/template.php');
+				}
+				// turn on output buffering so that we can capture the credentials form
+				ob_start();
+				$credentials = request_filesystem_credentials('');
+				// store credentials form for the time being
+				EEH_File::$_credentials_form = ob_get_clean();
+				// basically check for direct or previously configured access
+				if (! WP_Filesystem($credentials)) {
+					// if credentials do NOT exist
+					if ($credentials === false) {
+						add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+						throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
+					} elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
+						add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+						throw new EE_Error(
+							sprintf(
+								__('WP Filesystem Error: $1%s', 'event_espresso'),
+								$wp_filesystem->errors->get_error_message()
+							)
+						);
+					}
+				}
+			}
+		}
+		return $wp_filesystem;
+	}
+
+	/**
+	 * display_request_filesystem_credentials_form
+	 */
+	public static function display_request_filesystem_credentials_form()
+	{
+		if (! empty(EEH_File::$_credentials_form)) {
+			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+		}
+	}
+
+
+
+	/**
+	 *    verify_filepath_and_permissions
+	 *    checks that a file is readable and has sufficient file permissions set to access
+	 *
+	 * @access public
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $file_name      - name of file if checking a file
+	 * @param string $file_ext       - file extension (ie: "php") if checking a file
+	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			$file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
+			$msg = sprintf(
+				__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
+				$file_name,
+				'<br />'
+			);
+			if (EEH_File::exists($full_file_path)) {
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
+			} else {
+				// no file permissions means the file was not found
+				$msg .= sprintf(
+					__('Please ensure the following path is correct: "%s".', 'event_espresso'),
+					$full_file_path
+				);
+			}
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				throw new EE_Error($msg . '||' . $msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder
+	 *
+	 * @access private
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string
+	 */
+	private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// check file permissions
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		if ($perms) {
+			// file permissions exist, but way be set incorrectly
+			$type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
+			return sprintf(
+				__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
+				$type_of_file,
+				$perms
+			);
+		} else {
+			// file exists but file permissions could not be read ?!?!
+			return sprintf(
+				__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
+				$full_file_path
+			);
+		}
+	}
+
+
+
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * Also, if this function creates the folder, adds a .htaccess file and index.html file
+	 * @param string $folder
+	 * @throws EE_Error if the folder exists and is writeable, but for some reason we
+	 * can't write to it
+	 * @return bool false if folder isn't writable; true if it exists and is writeable,
+	 */
+	public static function ensure_folder_exists_and_is_writable($folder = '')
+	{
+		if (empty($folder)) {
+			return false;
+		}
+		// remove ending DS
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
+		// add DS to folder
+		$folder = EEH_File::end_with_directory_separator($folder);
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
+		if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+			// ok so it doesn't exist. Does its parent? Can we write to it?
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
+				return false;
+			} else {
+				if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+					if (defined('WP_DEBUG') && WP_DEBUG) {
+						$msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
+						$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
+						throw new EE_Error($msg);
+					}
+					return false;
+				}
+				EEH_File::add_index_file($folder);
+			}
+		} elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * verify_is_writable - checks if a file or folder is writable
+	 * @param string $full_path      - full server path to file or folder
+	 * @param string $file_or_folder - whether checking a file or folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function verify_is_writable($full_path = '', $file_or_folder = 'folder')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
+		$full_path = EEH_File::standardise_directory_separators($full_path);
+		if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist.
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function ensure_file_exists_and_is_writable($full_file_path = '')
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$parent_folder = EEH_File::get_parent_folder($full_file_path);
+		if (! EEH_File::exists($full_file_path)) {
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+					throw new EE_Error($msg);
+				}
+				return false;
+			}
+		}
+		if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Gets the parent folder. If provided with file, gets the folder that contains it.
+	 * If provided a folder, gets its parent folder.
+	 * @param string $file_or_folder_path
+	 * @return string parent folder, ENDING with a directory separator
+	 */
+	public static function get_parent_folder($file_or_folder_path)
+	{
+		// find the last DS, ignoring a DS on the very end
+		// eg if given "/var/something/somewhere/", we want to get "somewhere"'s
+		// parent folder, "/var/something/"
+		$ds = strlen($file_or_folder_path) > 1
+			? strrpos($file_or_folder_path, DS, -2)
+			: strlen($file_or_folder_path);
+		return substr($file_or_folder_path, 0, $ds + 1);
+	}
+
+	// public static function ensure_folder_exists_recursively( $folder ) {
+	//
+	// }
+
+
+
+	/**
+	 * get_file_contents
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string
+	 */
+	public static function get_file_contents($full_file_path = '')
+	{
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
+			// load WP_Filesystem and set file permissions
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * write_file
+	 * @param string $full_file_path
+	 * @param string $file_contents - the content to be written to the file
+	 * @param string $file_type
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
+	{
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+		$folder = EEH_File::remove_filename_from_filepath($full_file_path);
+		if (! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// write the file
+		if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Wrapper for WP_Filesystem_Base::delete
+	 *
+	 * @param string $filepath
+	 * @param boolean $recursive
+	 * @param boolean|string $type 'd' for directory, 'f' for file
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean
+	 */
+	public static function delete($filepath, $recursive = false, $type = false)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem();
+		return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false;
+	}
+
+
+
+	/**
+	 * exists
+	 * checks if a file exists using the WP filesystem
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function exists($full_file_path = '')
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false;
+	}
+
+
+
+	/**
+	 * is_readable
+	 * checks if a file is_readable using the WP filesystem
+	 *
+	 * @param string $full_file_path
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function is_readable($full_file_path = '')
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * remove_filename_from_filepath
+	 * given a full path to a file including the filename itself, this removes  the filename and returns the path, up to, but NOT including the filename OR slash
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function remove_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
+	}
+
+
+	/**
+	 * get_filename_from_filepath. Arguably the same as basename()
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_filename_from_filepath($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
+	}
+
+
+	/**
+	 * get_file_extension
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_file_extension($full_file_path = '')
+	{
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
+	}
+
+
+
+	/**
+	 * add_htaccess_deny_from_all so the webserver cannot access this folder
+	 * @param string $folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return bool
+	 */
+	public static function add_htaccess_deny_from_all($folder = '')
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . '.htaccess')) {
+			if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Adds an index file to this folder, so folks can't list all the file's contents
+	 * @param string $folder
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean
+	 */
+	public static function add_index_file($folder)
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . 'index.php')) {
+			if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
+	 * extract that classname.
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function get_classname_from_filepath_with_standard_filename($file_path)
+	{
+		// extract file from path
+		$filename = basename($file_path);
+		// now remove the first period and everything after
+		$pos_of_first_period = strpos($filename, '.');
+		return substr($filename, 0, $pos_of_first_period);
+	}
+
+
+
+	/**
+	 * standardise_directory_separators
+	 *  convert all directory separators in a file path to whatever is set for DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function standardise_directory_separators($file_path)
+	{
+		return str_replace(array( '\\', '/' ), DS, $file_path);
+	}
+
+
+
+	/**
+	 * end_with_directory_separator
+	 *  ensures that file path ends with DS
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function end_with_directory_separator($file_path)
+	{
+		return rtrim($file_path, '/\\') . DS;
+	}
+
+
+
+	/**
+	 * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
+	 * @param $file_path
+	 * @return string
+	 */
+	public static function standardise_and_end_with_directory_separator($file_path)
+	{
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
+	}
+
+
+
+	/**
+	 * takes the folder name (with or without trailing slash) and finds the files it in,
+	 * and what the class's name inside of each should be.
+	 * @param array $folder_paths
+	 * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
+	 *      if FALSE (Default), returned array will be indexed by the filenames minus extensions.
+	 *      Set it TRUE if you know there are files in the directory with the same name but different extensions
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return array if $index_numerically == TRUE keys are numeric ,
+	 *      if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
+	 *       and values are their filepaths
+	 */
+	public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false)
+	{
+		$class_to_folder_path = array();
+		foreach ($folder_paths as $folder_path) {
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
+			// load WP_Filesystem and set file permissions
+			$files_in_folder = glob($folder_path . '*');
+			$class_to_folder_path = array();
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
+					// only add files, not folders
+					if (! is_dir($file_path)) {
+						if ($index_numerically) {
+							$class_to_folder_path[] = $file_path;
+						} else {
+							$classname = self::get_classname_from_filepath_with_standard_filename($file_path);
+							$class_to_folder_path[ $classname ] = $file_path;
+						}
+					}
+				}
+			}
+		}
+		return $class_to_folder_path;
+	}
+
+
+
+	/**
+	 * Copies a file. Mostly a wrapper of WP_Filesystem::copy
+	 * @param string $source_file
+	 * @param string $destination_file
+	 * @param boolean $overwrite
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return boolean success
+	 */
+	public static function copy($source_file, $destination_file, $overwrite = false)
+	{
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
+		if (! EEH_File::exists($full_source_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
+		$folder = EEH_File::remove_filename_from_filepath($full_dest_path);
+		EEH_File::ensure_folder_exists_and_is_writable($folder);
+		if (! EEH_File::verify_is_writable($folder, 'folder')) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
+		// write the file
+		if (! $wp_filesystem->copy(
+			EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
+			EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
+			$overwrite
+		)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
+				throw new EE_Error($msg);
+			}
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Reports whether or not the filepath is in the EE uploads folder or not
+	 * @param string $filepath
+	 * @return boolean
+	 */
+	public static function is_in_uploads_folder($filepath)
+	{
+		$uploads = wp_upload_dir();
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
+	}
+
+	/**
+	 * Given a "local" filepath (what you probably thought was the only filepath),
+	 * converts it into a "remote" filepath (the filepath the currently-in-use
+	 * $wp_filesystem needs to use access the folder or file).
+	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
+	 * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
+	 * is in use, so you need to provide it
+	 * @param string $local_filepath the filepath to the folder/file locally
+	 * @throws EE_Error if filesystem credentials are required
+	 * @return string the remote filepath (eg the filepath the filesystem method, eg
+	 * ftp or ssh, will use to access the folder
+	 */
+	public static function convert_local_filepath_to_remote_filepath($local_filepath)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
+		return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -44,17 +44,17 @@ 
             'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
             $filepath && EEH_File::is_in_uploads_folder($filepath),
             $filepath
-        ) ) {
-            if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
-                require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+        )) {
+            if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
+                require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
                 $method = 'direct';
-                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+                $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method);
                 // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
-                if (! defined('FS_CHMOD_DIR')) {
-                    define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 ));
+                if ( ! defined('FS_CHMOD_DIR')) {
+                    define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755));
                 }
-                if (! defined('FS_CHMOD_FILE')) {
-                    define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 ));
+                if ( ! defined('FS_CHMOD_FILE')) {
+                    define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644));
                 }
                 require_once($wp_filesystem_direct_file);
                 EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
@@ -63,7 +63,7 @@ 
         }
         global $wp_filesystem;
         // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+        if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
             // if some eager beaver's just trying to get in there too early...
             // let them do it, because we are one of those eager beavers! :P
             /**
@@ -79,14 +79,14 @@ 
             if (false && ! did_action('wp_loaded')) {
                 $msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
                 if (WP_DEBUG) {
-                    $msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
+                    $msg .= '<br />'.__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
                 }
                 throw new EE_Error($msg);
             } else {
                 // should be loaded if we are past the wp_loaded hook...
-                if (! function_exists('WP_Filesystem')) {
-                    require_once(ABSPATH . 'wp-admin/includes/file.php');
-                    require_once(ABSPATH . 'wp-admin/includes/template.php');
+                if ( ! function_exists('WP_Filesystem')) {
+                    require_once(ABSPATH.'wp-admin/includes/file.php');
+                    require_once(ABSPATH.'wp-admin/includes/template.php');
                 }
                 // turn on output buffering so that we can capture the credentials form
                 ob_start();
@@ -94,13 +94,13 @@ 
                 // store credentials form for the time being
                 EEH_File::$_credentials_form = ob_get_clean();
                 // basically check for direct or previously configured access
-                if (! WP_Filesystem($credentials)) {
+                if ( ! WP_Filesystem($credentials)) {
                     // if credentials do NOT exist
                     if ($credentials === false) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+                        add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
                         throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
                     } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
-                        add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999);
+                        add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
                         throw new EE_Error(
                             sprintf(
                                 __('WP Filesystem Error: $1%s', 'event_espresso'),
@@ -119,8 +119,8 @@ 
      */
     public static function display_request_filesystem_credentials_form()
     {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+        if ( ! empty(EEH_File::$_credentials_form)) {
+            echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
         }
     }
 
@@ -143,8 +143,8 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+        if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            $file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
             $file_name .= ! empty($file_ext) ? ' file' : ' folder';
             $msg = sprintf(
                 __('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
@@ -161,7 +161,7 @@ 
                 );
             }
             if (defined('WP_DEBUG') && WP_DEBUG) {
-                throw new EE_Error($msg . '||' . $msg);
+                throw new EE_Error($msg.'||'.$msg);
             }
             return false;
         }
@@ -187,7 +187,7 @@ 
         $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
         if ($perms) {
             // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+            $type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
             $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
             return sprintf(
                 __('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
@@ -226,15 +226,15 @@ 
         // add DS to folder
         $folder = EEH_File::end_with_directory_separator($folder);
         $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
-        if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+        if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
             // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! EEH_File::verify_is_writable($parent_folder, 'folder')) {
+            if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) {
                 return false;
             } else {
-                if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+                if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
                     if (defined('WP_DEBUG') && WP_DEBUG) {
                         $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
                         $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
@@ -244,7 +244,7 @@ 
                 }
                 EEH_File::add_index_file($folder);
             }
-        } elseif (! EEH_File::verify_is_writable($folder, 'folder')) {
+        } elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             return false;
         }
         return true;
@@ -264,7 +264,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
         $full_path = EEH_File::standardise_directory_separators($full_path);
-        if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
+        if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
@@ -291,11 +291,11 @@ 
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
         $parent_folder = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+        if ( ! EEH_File::exists($full_file_path)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
                 if (defined('WP_DEBUG') && WP_DEBUG) {
                     $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
                     $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -304,7 +304,7 @@ 
                 return false;
             }
         }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+        if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
             return false;
         }
         return true;
@@ -363,9 +363,9 @@ 
     public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '')
     {
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+        $file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
         $folder = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
+        if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -376,7 +376,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         // write the file
-        if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
+        if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
@@ -486,8 +486,8 @@ 
     public static function add_htaccess_deny_from_all($folder = '')
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+        if ( ! EEH_File::exists($folder.'.htaccess')) {
+            if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
                 return false;
             }
         }
@@ -504,8 +504,8 @@ 
     public static function add_index_file($folder)
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) {
+        if ( ! EEH_File::exists($folder.'index.php')) {
+            if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) {
                 return false;
             }
         }
@@ -539,7 +539,7 @@ 
      */
     public static function standardise_directory_separators($file_path)
     {
-        return str_replace(array( '\\', '/' ), DS, $file_path);
+        return str_replace(array('\\', '/'), DS, $file_path);
     }
 
 
@@ -552,7 +552,7 @@ 
      */
     public static function end_with_directory_separator($file_path)
     {
-        return rtrim($file_path, '/\\') . DS;
+        return rtrim($file_path, '/\\').DS;
     }
 
 
@@ -587,17 +587,17 @@ 
         foreach ($folder_paths as $folder_path) {
             $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
             // load WP_Filesystem and set file permissions
-            $files_in_folder = glob($folder_path . '*');
+            $files_in_folder = glob($folder_path.'*');
             $class_to_folder_path = array();
             if ($files_in_folder) {
                 foreach ($files_in_folder as $file_path) {
                     // only add files, not folders
-                    if (! is_dir($file_path)) {
+                    if ( ! is_dir($file_path)) {
                         if ($index_numerically) {
                             $class_to_folder_path[] = $file_path;
                         } else {
                             $classname = self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
+                            $class_to_folder_path[$classname] = $file_path;
                         }
                     }
                 }
@@ -619,7 +619,7 @@ 
     public static function copy($source_file, $destination_file, $overwrite = false)
     {
         $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
+        if ( ! EEH_File::exists($full_source_path)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
@@ -631,7 +631,7 @@ 
         $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
         $folder = EEH_File::remove_filename_from_filepath($full_dest_path);
         EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder, 'folder')) {
+        if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
@@ -643,7 +643,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
         // write the file
-        if (! $wp_filesystem->copy(
+        if ( ! $wp_filesystem->copy(
             EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
             EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
             $overwrite
@@ -684,6 +684,6 @@ 
     public static function convert_local_filepath_to_remote_filepath($local_filepath)
     {
         $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath);
+        return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
     }
 }

core/helpers/EEH_Form_Fields.helper.php

Doc Comments +5 added lines, -5 removed lines

@@ -777,7 +777,7 @@ 
      *
      * @param mixed $opt_group
      * @param mixed $QSOs
-     * @param mixed $answer
+     * @param string $answer
      * @param boolean $use_html_entities
      * @return string
      */
@@ -1134,7 +1134,7 @@ 
     /**
      *  prep_required
      * @param string|array  $required
-     * @return array
+     * @return string
      */
     public static function prep_required($required = array())
     {
@@ -1187,8 +1187,8 @@ 
 
     /**
      *  _load_system_dropdowns
-     * @param array     $QFI
-     * @return array
+     * @param EE_Question_Form_Input     $QFI
+     * @return EE_Question_Form_Input
      */
     private static function _load_system_dropdowns($QFI)
     {
@@ -1491,7 +1491,7 @@ 
      * @param    string   $nonce_action     - if using nonces
      * @param    bool|string $input_only       - whether to print form header and footer. TRUE returns the input without the form
      * @param    string   $extra_attributes - any extra attributes that need to be attached to the form input
-     * @return    void
+     * @return    string
      */
     public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = false, $extra_attributes = '')
     {

Indentation +1461 added lines, -1461 removed lines

@@ -29,1034 +29,1034 @@ 
 {
 
 
-    /**
-     *  Generates HTML for the forms used on admin pages
-     *
-     *
-     *  @static
-     *  @access public
-     *  @param  array $input_vars - array of input field details
-     *  format:
-     *  $template_form_fields['field-id'] = array(
-     *      'name' => 'name_attribute',
-     *      'label' => __('Field Label', 'event_espresso'), //or false
-     *      'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden', 'checkbox', 'wp_editor'
-     *      'type' => 'int', //what "type" the value is (i.e. string, int etc)
-     *      'required' => false, //boolean for whether the field is required
-     *      'validation' => true, //boolean, whether to validate the field (todo)
-     *      'value' => 'some_value_for_field', //what value is used for field
-     *      'format' => '%d', //what format the value is (%d, %f, or %s)
-     *      'db-col' => 'column_in_db' //used to indicate which column the field corresponds with in the db
-     *      'options' => optiona, optionb || array('value' => 'label', '') //if the input type is "select", this allows you to set the args for the different <option> tags.
-     *      'tabindex' => 1 //this allows you to set the tabindex for the field.
-     *      'append_content' => '' //this allows you to send in html content to append to the field.
-     *  )
-     *  @param  array $id - used for defining unique identifiers for the form.
-     *  @return string
-     *  @todo: at some point we can break this down into other static methods to abstract it a bit better.
-     */
-    public static function get_form_fields($input_vars = array(), $id = false)
-    {
+	/**
+	 *  Generates HTML for the forms used on admin pages
+	 *
+	 *
+	 *  @static
+	 *  @access public
+	 *  @param  array $input_vars - array of input field details
+	 *  format:
+	 *  $template_form_fields['field-id'] = array(
+	 *      'name' => 'name_attribute',
+	 *      'label' => __('Field Label', 'event_espresso'), //or false
+	 *      'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden', 'checkbox', 'wp_editor'
+	 *      'type' => 'int', //what "type" the value is (i.e. string, int etc)
+	 *      'required' => false, //boolean for whether the field is required
+	 *      'validation' => true, //boolean, whether to validate the field (todo)
+	 *      'value' => 'some_value_for_field', //what value is used for field
+	 *      'format' => '%d', //what format the value is (%d, %f, or %s)
+	 *      'db-col' => 'column_in_db' //used to indicate which column the field corresponds with in the db
+	 *      'options' => optiona, optionb || array('value' => 'label', '') //if the input type is "select", this allows you to set the args for the different <option> tags.
+	 *      'tabindex' => 1 //this allows you to set the tabindex for the field.
+	 *      'append_content' => '' //this allows you to send in html content to append to the field.
+	 *  )
+	 *  @param  array $id - used for defining unique identifiers for the form.
+	 *  @return string
+	 *  @todo: at some point we can break this down into other static methods to abstract it a bit better.
+	 */
+	public static function get_form_fields($input_vars = array(), $id = false)
+	{
         
-        if (empty($input_vars)) {
-            EE_Error::add_error(__('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // if you don't behave - this is what you're gonna get !!!
-        $close = true;
-        $output = '<ul>'; // this is for using built-in wp styles... watch carefully...
-
-        // cycle thru inputs
-        foreach ($input_vars as $input_key => $input_value) {
-            $defaults = array(
-                'name' => $input_key,
-                'label' => __('No label', 'event_espresso'),
-                'input' => 'hidden',
-                'type' => 'int',
-                'required' => false,
-                'validation' => true,
-                'value' => 'some_value_for_field',
-                'format' => '%d',
-                'db-col' => 'column_in_db',
-                'options' => array(),
-                'tabindex' => '',
-                'append_content' => ''
-                );
-
-            $input_value = wp_parse_args($input_value, $defaults);
-
-            // required fields get a *
-            $required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
-            // and the css class "required"
-            $css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
-            $styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
-
-            $field_id = ($id) ? $id . '-' . $input_key : $input_key;
-            $tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
-
-            // rows or cols?
-            $rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
-            $cols = isset($input_value['cols']) ? $input_value['cols'] : '80';
-
-            // any content?
-            $append_content = $input_value['append_content'];
-
-            $output .= (!$close) ? '<ul>' : '';
-            $output .= '<li>';
-
-            // what type of input are we dealing with ?
-            switch ($input_value['input']) {
-                // text inputs
-                case 'text':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
-                    break;
-
-                // dropdowns
-                case 'select':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
-
-                    if (is_array($input_value['options'])) {
-                        $options = $input_value['options'];
-                    } else {
-                        $options = explode(',', $input_value['options']);
-                    }
-
-                    foreach ($options as $key => $value) {
-                        $selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
-                        // $key = str_replace( ' ', '_', sanitize_key( $value ));
-                        $output .= "\n\t\t\t\t" . '<option '. $selected . ' value="' . $key . '">' . $value . '</option>';
-                    }
-                    $output .= "\n\t\t\t" . '</select>';
-
-                    break;
-
-                case 'textarea':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="'.$rows.'" cols="'.$cols.'" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
-                    break;
-
-                case 'hidden':
-                    $close = false;
-                    $output .= "</li></ul>";
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
-                    break;
-
-                case 'checkbox':
-                    $checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id. '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
-                    break;
-
-                case 'wp_editor':
-                    $close = false;
-                    $editor_settings = array(
-                        'textarea_name' => $input_value['name'],
-                        'textarea_rows' => $rows,
-                        'editor_class' => $styles,
-                        'tabindex' => $input_value['tabindex']
-                    );
-                    $output .= '</li>';
-                    $output .= '</ul>';
-                    $output .= '<h4>' . $input_value['label'] . '</h4>';
-                    if ($append_content) {
-                        $output .= $append_content;
-                    }
-                    ob_start();
-                    wp_editor($input_value['value'], $field_id, $editor_settings);
-                    $editor = ob_get_contents();
-                    ob_end_clean();
-                    $output .= $editor;
-                    break;
-            }
-            if ($append_content && $input_value['input'] !== 'wp_editor') {
-                $output .= $append_content;
-            }
-                $output .= ($close) ? '</li>' : '';
-        } // end foreach( $input_vars as $input_key => $input_value )
-        $output .= ($close) ? '</ul>' : '';
-
-        return $output;
-    }
-
-    /**
-     * form_fields_array
-     * This utility function assembles form fields from a given structured array with field information.
-     * //TODO: This is an alternate generator that we may want to use instead.
-     *
-     * @param  array $fields structured array of fields to assemble in the following format:
-     * [field_name] => array(
-     *      ['label'] => 'label for field',
-     *      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select type of field you can indicated the labels for each option via this index
-     *      ['extra_desc'] => 'extra description for the field', //optional
-     *      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults to text
-     *      ['value'] => 'value that goes in the field', //(if multi then this is an array of values and the 'default' paramater will be used for what is selected)
-     *      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
-     *      ['class'] => 'name-of-class(es)-for-input',
-     *      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi select type of field you can indicate the css class for each option via this index.
-     *      ['id'] => 'css-id-for-input') //defaults to 'field_name'
-     *      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields generated are going to be used in a loop and you want to make sure that the field identifiers are unique from each other.
-     *      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types such as textarea to indicate cols/rows.
-     *      ['tabindex'] => '' //this allows you to set the tabindex for the field.
-     *      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally contain an array of arguments for the editor setup.
-     *
-     * @return array         an array of inputs for form indexed by field name, and in the following structure:
-     *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
-     */
-    public static function get_form_fields_array($fields)
-    {
-
-        $form_fields = array();
-        $fields = (array) $fields;
-
-        foreach ($fields as $field_name => $field_atts) {
-            // defaults:
-            $defaults = array(
-                'label' => '',
-                'labels' => '',
-                'extra_desc' => '',
-                'type' => 'text',
-                'value' => '',
-                'default' => '',
-                'class' => '',
-                'classes' => '',
-                'id' => $field_name,
-                'unique_id' => '',
-                'dimensions' => array('10', '5'),
-                'tabindex' => '',
-                'wpeditor_args' => array()
-                );
-            // merge defaults with passed arguments
-            $_fields = wp_parse_args($field_atts, $defaults);
-            extract($_fields);
-            // generate label
-            $label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
-            // generate field name
-            $f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
-
-            // tabindex
-            $tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
-
-            // we determine what we're building based on the type
-            switch ($type) {
-                case 'textarea':
-                        $fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
-                        $fld .= $extra_desc;
-                    break;
-
-                case 'checkbox':
-                        $c_input = '';
-                    if (is_array($value)) {
-                        foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
-                        }
-                        $fld = $c_input;
-                    } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
-                    }
-                    break;
-
-                case 'radio':
-                        $c_input = '';
-                    if (is_array($value)) {
-                        foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
-                        }
-                        $fld = $c_input;
-                    } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
-                    }
-                    break;
-
-                case 'hidden':
-                        $fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
-                    break;
-
-                case 'select':
-                        $fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
-                    foreach ($value as $key => $val) {
-                        $checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
-                        $fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
-                    }
-                        $fld .= '</select>';
-                    break;
-
-                case 'wp_editor':
-                        $editor_settings = array(
-                            'textarea_name' => $f_name,
-                            'textarea_rows' => $dimensions[1],
-                            'editor_class' => $class,
-                            'tabindex' => $tabindex
-                            );
-                        $editor_settings = array_merge($wpeditor_args, $editor_settings);
-                        ob_start();
-                        wp_editor($value, $id, $editor_settings);
-                        $editor = ob_get_contents();
-                        ob_end_clean();
-                        $fld = $editor;
-                    break;
-
-                default: // 'text fields'
-                        $fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
-                        $fld .= $extra_desc;
-            }
-
-            $form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
-        }
-
-        return $form_fields;
-    }
-
-
-
-
-
-
-    /**
-     * espresso admin page select_input
-     * Turns an array into a select fields
-     *
-     * @static
-     * @access public
-     * @param  string  $name       field name
-     * @param  array  $values     option values, numbered array starting at 0, where each value is an array with a key 'text' (meaning text to display' and 'id' (meaning the internal value)
-     * eg: array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or as an array of key-value pairs, where the key is to be used for the
-     * select input's name, and the value will be the text shown to the user.  Optionally you can also include an additional key of "class" which will add a specific class to the option for that value.
-     * @param  string  $default    default value
-     * @param  string  $parameters extra paramaters
-     * @param  string  $class      css class
-     * @param  boolean $autosize   whether to autosize the select or not
-     * @return string              html string for the select input
-     */
-    public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
-    {
-        // if $values was submitted in the wrong format, convert it over
-        if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
-            $converted_values=array();
-            foreach ($values as $id => $text) {
-                $converted_values[]=array('id'=>$id,'text'=>$text);
-            }
-            $values=$converted_values;
-        }
-
-        $field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
-        // Debug
-        // EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
-        }
-        if ($autosize) {
-            $size = 'med';
-            for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
-                        $size = 'wide';
-                    }
-                }
-            }
-        } else {
-            $size = '';
-        }
-
-        $field .= ' class="' . $class . ' ' . $size . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-
-        for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
-                $field .= ' selected = "selected"';
-            }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
-            }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
-        }
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-
-
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param string $question_groups
-     * @return string HTML
-     */
-    public static function generate_question_groups_html($question_groups = array(), $group_wrapper = 'fieldset')
-    {
-
-        $html = '';
-        $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        if (! empty($question_groups)) {
-            // EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
-                    // use fieldsets
-                    $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
-                    // group_name
-                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
-                    // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
-
-                    $html .= $before_question_group_questions;
-                    // loop thru questions
-                    foreach ($QSG['QSG_questions'] as $question) {
+		if (empty($input_vars)) {
+			EE_Error::add_error(__('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// if you don't behave - this is what you're gonna get !!!
+		$close = true;
+		$output = '<ul>'; // this is for using built-in wp styles... watch carefully...
+
+		// cycle thru inputs
+		foreach ($input_vars as $input_key => $input_value) {
+			$defaults = array(
+				'name' => $input_key,
+				'label' => __('No label', 'event_espresso'),
+				'input' => 'hidden',
+				'type' => 'int',
+				'required' => false,
+				'validation' => true,
+				'value' => 'some_value_for_field',
+				'format' => '%d',
+				'db-col' => 'column_in_db',
+				'options' => array(),
+				'tabindex' => '',
+				'append_content' => ''
+				);
+
+			$input_value = wp_parse_args($input_value, $defaults);
+
+			// required fields get a *
+			$required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
+			// and the css class "required"
+			$css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
+			$styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
+
+			$field_id = ($id) ? $id . '-' . $input_key : $input_key;
+			$tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
+
+			// rows or cols?
+			$rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
+			$cols = isset($input_value['cols']) ? $input_value['cols'] : '80';
+
+			// any content?
+			$append_content = $input_value['append_content'];
+
+			$output .= (!$close) ? '<ul>' : '';
+			$output .= '<li>';
+
+			// what type of input are we dealing with ?
+			switch ($input_value['input']) {
+				// text inputs
+				case 'text':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+					break;
+
+				// dropdowns
+				case 'select':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+
+					if (is_array($input_value['options'])) {
+						$options = $input_value['options'];
+					} else {
+						$options = explode(',', $input_value['options']);
+					}
+
+					foreach ($options as $key => $value) {
+						$selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
+						// $key = str_replace( ' ', '_', sanitize_key( $value ));
+						$output .= "\n\t\t\t\t" . '<option '. $selected . ' value="' . $key . '">' . $value . '</option>';
+					}
+					$output .= "\n\t\t\t" . '</select>';
+
+					break;
+
+				case 'textarea':
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="'.$rows.'" cols="'.$cols.'" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
+					break;
+
+				case 'hidden':
+					$close = false;
+					$output .= "</li></ul>";
+					$output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
+					break;
+
+				case 'checkbox':
+					$checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
+					$output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
+					$output .= "\n\t\t\t" . '<input id="' . $field_id. '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
+					break;
+
+				case 'wp_editor':
+					$close = false;
+					$editor_settings = array(
+						'textarea_name' => $input_value['name'],
+						'textarea_rows' => $rows,
+						'editor_class' => $styles,
+						'tabindex' => $input_value['tabindex']
+					);
+					$output .= '</li>';
+					$output .= '</ul>';
+					$output .= '<h4>' . $input_value['label'] . '</h4>';
+					if ($append_content) {
+						$output .= $append_content;
+					}
+					ob_start();
+					wp_editor($input_value['value'], $field_id, $editor_settings);
+					$editor = ob_get_contents();
+					ob_end_clean();
+					$output .= $editor;
+					break;
+			}
+			if ($append_content && $input_value['input'] !== 'wp_editor') {
+				$output .= $append_content;
+			}
+				$output .= ($close) ? '</li>' : '';
+		} // end foreach( $input_vars as $input_key => $input_value )
+		$output .= ($close) ? '</ul>' : '';
+
+		return $output;
+	}
+
+	/**
+	 * form_fields_array
+	 * This utility function assembles form fields from a given structured array with field information.
+	 * //TODO: This is an alternate generator that we may want to use instead.
+	 *
+	 * @param  array $fields structured array of fields to assemble in the following format:
+	 * [field_name] => array(
+	 *      ['label'] => 'label for field',
+	 *      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select type of field you can indicated the labels for each option via this index
+	 *      ['extra_desc'] => 'extra description for the field', //optional
+	 *      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults to text
+	 *      ['value'] => 'value that goes in the field', //(if multi then this is an array of values and the 'default' paramater will be used for what is selected)
+	 *      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
+	 *      ['class'] => 'name-of-class(es)-for-input',
+	 *      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi select type of field you can indicate the css class for each option via this index.
+	 *      ['id'] => 'css-id-for-input') //defaults to 'field_name'
+	 *      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields generated are going to be used in a loop and you want to make sure that the field identifiers are unique from each other.
+	 *      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types such as textarea to indicate cols/rows.
+	 *      ['tabindex'] => '' //this allows you to set the tabindex for the field.
+	 *      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally contain an array of arguments for the editor setup.
+	 *
+	 * @return array         an array of inputs for form indexed by field name, and in the following structure:
+	 *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
+	 */
+	public static function get_form_fields_array($fields)
+	{
+
+		$form_fields = array();
+		$fields = (array) $fields;
+
+		foreach ($fields as $field_name => $field_atts) {
+			// defaults:
+			$defaults = array(
+				'label' => '',
+				'labels' => '',
+				'extra_desc' => '',
+				'type' => 'text',
+				'value' => '',
+				'default' => '',
+				'class' => '',
+				'classes' => '',
+				'id' => $field_name,
+				'unique_id' => '',
+				'dimensions' => array('10', '5'),
+				'tabindex' => '',
+				'wpeditor_args' => array()
+				);
+			// merge defaults with passed arguments
+			$_fields = wp_parse_args($field_atts, $defaults);
+			extract($_fields);
+			// generate label
+			$label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
+			// generate field name
+			$f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+
+			// tabindex
+			$tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
+
+			// we determine what we're building based on the type
+			switch ($type) {
+				case 'textarea':
+						$fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
+						$fld .= $extra_desc;
+					break;
+
+				case 'checkbox':
+						$c_input = '';
+					if (is_array($value)) {
+						foreach ($value as $key => $val) {
+							$c_id = $field_name . '_' . $value;
+							$c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
+							$c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
+							$checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
+							$c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+						}
+						$fld = $c_input;
+					} else {
+						$checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
+						$fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+					}
+					break;
+
+				case 'radio':
+						$c_input = '';
+					if (is_array($value)) {
+						foreach ($value as $key => $val) {
+							$c_id = $field_name . '_' . $value;
+							$c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
+							$c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
+							$checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
+							$c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+						}
+						$fld = $c_input;
+					} else {
+						$checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
+						$fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+					}
+					break;
+
+				case 'hidden':
+						$fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
+					break;
+
+				case 'select':
+						$fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
+					foreach ($value as $key => $val) {
+						$checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
+						$fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
+					}
+						$fld .= '</select>';
+					break;
+
+				case 'wp_editor':
+						$editor_settings = array(
+							'textarea_name' => $f_name,
+							'textarea_rows' => $dimensions[1],
+							'editor_class' => $class,
+							'tabindex' => $tabindex
+							);
+						$editor_settings = array_merge($wpeditor_args, $editor_settings);
+						ob_start();
+						wp_editor($value, $id, $editor_settings);
+						$editor = ob_get_contents();
+						ob_end_clean();
+						$fld = $editor;
+					break;
+
+				default: // 'text fields'
+						$fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
+						$fld .= $extra_desc;
+			}
+
+			$form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
+		}
+
+		return $form_fields;
+	}
+
+
+
+
+
+
+	/**
+	 * espresso admin page select_input
+	 * Turns an array into a select fields
+	 *
+	 * @static
+	 * @access public
+	 * @param  string  $name       field name
+	 * @param  array  $values     option values, numbered array starting at 0, where each value is an array with a key 'text' (meaning text to display' and 'id' (meaning the internal value)
+	 * eg: array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or as an array of key-value pairs, where the key is to be used for the
+	 * select input's name, and the value will be the text shown to the user.  Optionally you can also include an additional key of "class" which will add a specific class to the option for that value.
+	 * @param  string  $default    default value
+	 * @param  string  $parameters extra paramaters
+	 * @param  string  $class      css class
+	 * @param  boolean $autosize   whether to autosize the select or not
+	 * @return string              html string for the select input
+	 */
+	public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
+	{
+		// if $values was submitted in the wrong format, convert it over
+		if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
+			$converted_values=array();
+			foreach ($values as $id => $text) {
+				$converted_values[]=array('id'=>$id,'text'=>$text);
+			}
+			$values=$converted_values;
+		}
+
+		$field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
+		// Debug
+		// EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		if (EEH_Formatter::ee_tep_not_null($parameters)) {
+			$field .= ' ' . $parameters;
+		}
+		if ($autosize) {
+			$size = 'med';
+			for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
+				if ($values[ $ii ]['text']) {
+					if (strlen($values[ $ii ]['text']) > 5) {
+						$size = 'wide';
+					}
+				}
+			}
+		} else {
+			$size = '';
+		}
+
+		$field .= ' class="' . $class . ' ' . $size . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+
+		for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
+			$field .= '<option value="' . $values[ $i ]['id'] . '"';
+			if ($default == $values[ $i ]['id']) {
+				$field .= ' selected = "selected"';
+			}
+			if (isset($values[ $i ]['class'])) {
+				$field .= ' class="' . $values[ $i ]['class'] . '"';
+			}
+			$field .= '>' . $values[ $i ]['text'] . '</option>';
+		}
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+
+
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param string $question_groups
+	 * @return string HTML
+	 */
+	public static function generate_question_groups_html($question_groups = array(), $group_wrapper = 'fieldset')
+	{
+
+		$html = '';
+		$before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		if (! empty($question_groups)) {
+			// EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				// check that questions exist
+				if (! empty($QSG['QSG_questions'])) {
+					// use fieldsets
+					$html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
+					// group_name
+					$html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
+					// group_desc
+					$html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
+
+					$html .= $before_question_group_questions;
+					// loop thru questions
+					foreach ($QSG['QSG_questions'] as $question) {
 //                      EEH_Debug_Tools::printr( $question, '$question  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                        $QFI = new EE_Question_Form_Input(
-                            $question['qst_obj'],
-                            $question['ans_obj'],
-                            $question
-                        );
-                        $html .= self::generate_form_input($QFI);
-                    }
-                    $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
-                }
-            }
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array         $question_groups
-     * @param array        $q_meta
-     * @param bool         $from_admin
-     * @param string       $group_wrapper
-     * @return string HTML
-     */
-    public static function generate_question_groups_html2($question_groups = array(), $q_meta = array(), $from_admin = false, $group_wrapper = 'fieldset')
-    {
-
-        $html = '';
-        $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        $default_q_meta = array(
-                'att_nmbr' => 1,
-                'ticket_id' => '',
-                'input_name' => '',
-                'input_id' => '',
-                'input_class' => ''
-        );
-        $q_meta = array_merge($default_q_meta, $q_meta);
-        // EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-
-        if (! empty($question_groups)) {
+						$QFI = new EE_Question_Form_Input(
+							$question['qst_obj'],
+							$question['ans_obj'],
+							$question
+						);
+						$html .= self::generate_form_input($QFI);
+					}
+					$html .= $after_question_group_questions;
+					$html .= "\n\t" . '</' . $group_wrapper . '>';
+				}
+			}
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array         $question_groups
+	 * @param array        $q_meta
+	 * @param bool         $from_admin
+	 * @param string       $group_wrapper
+	 * @return string HTML
+	 */
+	public static function generate_question_groups_html2($question_groups = array(), $q_meta = array(), $from_admin = false, $group_wrapper = 'fieldset')
+	{
+
+		$html = '';
+		$before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		$default_q_meta = array(
+				'att_nmbr' => 1,
+				'ticket_id' => '',
+				'input_name' => '',
+				'input_id' => '',
+				'input_class' => ''
+		);
+		$q_meta = array_merge($default_q_meta, $q_meta);
+		// EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+
+		if (! empty($question_groups)) {
 //          EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                if ($QSG instanceof EE_Question_Group) {
-                    // check that questions exist
-
-                    $where = array( 'QST_deleted' => 0 );
-                    if (! $from_admin) {
-                        $where['QST_admin_only'] = 0;
-                    }
-                    $questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
-                    if (! empty($questions)) {
-                        // use fieldsets
-                        $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
-                        // group_name
-                        if ($QSG->show_group_name()) {
-                            $html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
-                        }
-                        // group_desc
-                        if ($QSG->show_group_desc()) {
-                            $html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
-                        }
-
-                        $html .= $before_question_group_questions;
-                        // loop thru questions
-                        foreach ($questions as $QST) {
-                            $qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
-
-                            $answer = null;
-
-                            if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
-                                // check for answer in $_GET in case we are reprocessing a form after an error
-                                if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
-                                }
-                            } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
-                                // attendee data from the session
-                                $answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
-                            }
-
-
-
-                            $QFI = new EE_Question_Form_Input(
-                                $QST,
-                                EE_Answer::new_instance(array(
-                                            'ANS_ID'=> 0,
-                                            'QST_ID'=> 0,
-                                            'REG_ID'=> 0,
-                                            'ANS_value'=> $answer
-                                    )),
-                                $q_meta
-                            );
-                            // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                            $html .= self::generate_form_input($QFI);
-                        }
-                        $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
-                    }
-                }
-            }
-        }
-        return $html;
-    }
-
-
-
-
-
-
-    /**
-     * generate_form_input
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return string HTML
-     */
-    public static function generate_form_input(EE_Question_Form_Input $QFI)
-    {
-        if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
-            return '';
-        }
-
-        $QFI = self::_load_system_dropdowns($QFI);
-        $QFI = self::_load_specialized_dropdowns($QFI);
-
-        // we also need to verify
-
-        $display_text = $QFI->get('QST_display_text');
-        $input_name = $QFI->get('QST_input_name');
-        $answer = EE_Registry::instance()->REQ->is_set($input_name) ? EE_Registry::instance()->REQ->get($input_name) : $QFI->get('ANS_value');
-        $input_id = $QFI->get('QST_input_id');
-        $input_class = $QFI->get('QST_input_class');
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				if ($QSG instanceof EE_Question_Group) {
+					// check that questions exist
+
+					$where = array( 'QST_deleted' => 0 );
+					if (! $from_admin) {
+						$where['QST_admin_only'] = 0;
+					}
+					$questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
+					if (! empty($questions)) {
+						// use fieldsets
+						$html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
+						// group_name
+						if ($QSG->show_group_name()) {
+							$html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
+						}
+						// group_desc
+						if ($QSG->show_group_desc()) {
+							$html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
+						}
+
+						$html .= $before_question_group_questions;
+						// loop thru questions
+						foreach ($questions as $QST) {
+							$qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
+
+							$answer = null;
+
+							if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+								// check for answer in $_GET in case we are reprocessing a form after an error
+								if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
+									$answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
+								}
+							} elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
+								// attendee data from the session
+								$answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+							}
+
+
+
+							$QFI = new EE_Question_Form_Input(
+								$QST,
+								EE_Answer::new_instance(array(
+											'ANS_ID'=> 0,
+											'QST_ID'=> 0,
+											'REG_ID'=> 0,
+											'ANS_value'=> $answer
+									)),
+								$q_meta
+							);
+							// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+							$html .= self::generate_form_input($QFI);
+						}
+						$html .= $after_question_group_questions;
+						$html .= "\n\t" . '</' . $group_wrapper . '>';
+					}
+				}
+			}
+		}
+		return $html;
+	}
+
+
+
+
+
+
+	/**
+	 * generate_form_input
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return string HTML
+	 */
+	public static function generate_form_input(EE_Question_Form_Input $QFI)
+	{
+		if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
+			return '';
+		}
+
+		$QFI = self::_load_system_dropdowns($QFI);
+		$QFI = self::_load_specialized_dropdowns($QFI);
+
+		// we also need to verify
+
+		$display_text = $QFI->get('QST_display_text');
+		$input_name = $QFI->get('QST_input_name');
+		$answer = EE_Registry::instance()->REQ->is_set($input_name) ? EE_Registry::instance()->REQ->get($input_name) : $QFI->get('ANS_value');
+		$input_id = $QFI->get('QST_input_id');
+		$input_class = $QFI->get('QST_input_class');
 //      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
-        $disabled = $QFI->get('QST_disabled') ? true : false;
-        $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
-        $QST_required = $QFI->get('QST_required');
-        $required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
-        $use_html_entities = $QFI->get_meta('htmlentities');
-        $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
-        $required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
-        $label_class = 'espresso-form-input-lbl';
-        $QST_options = $QFI->options(true, $answer);
-        $options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
-        $system_ID = $QFI->get('QST_system');
-        $label_b4 = $QFI->get_meta('label_b4');
-        $use_desc_4_label = $QFI->get_meta('use_desc_4_label');
-
-
-        switch ($QFI->get('QST_type')) {
-            case 'TEXTAREA':
-                return EEH_Form_Fields::textarea($display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-
-            case 'DROPDOWN':
-                return EEH_Form_Fields::select($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, true);
-                break;
-
-
-            case 'RADIO_BTN':
-                return EEH_Form_Fields::radio($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label);
-                break;
-
-            case 'CHECKBOX':
-                return EEH_Form_Fields::checkbox($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities);
-                break;
-
-            case 'DATE':
-                return EEH_Form_Fields::datepicker($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-
-            case 'TEXT':
-            default:
-                return EEH_Form_Fields::text($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
-                break;
-        }
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form text input
-     *
-     * @param string $question  label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled .' ' . $extra . '/>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-    /**
-     * generates HTML for a form textarea
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $dimensions array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // make sure $dimensions is an array
-        $dimensions = is_array($dimensions) ? $dimensions : array();
-        // and set some defaults
-        $dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form select input
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param array $options            array of answer options where array key = option value and array value = option display text
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function select($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $add_please_select_option = false)
-    {
-
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? self::prep_answer(array_shift($answer), $use_html_entities) : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
-        // recursively count array elements, to determine total number of options
-        $only_option = count($options, 1) == 1 ? true : false;
-        if (! $only_option) {
-            // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected = $answer === null ? ' selected="selected"' : '';
-            $input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
-        }
-        foreach ($options as $key => $value) {
-            // if value is an array, then create option groups, else create regular ol' options
-            $input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
-        }
-
-        $input_html .= "\n\t\t\t" . '</select>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-    /**
-     *  _generate_select_option_group
-     *
-     *  if  $value for a select box is an array, then the key will be used as the optgroup label
-     *  and the value array will be looped thru and the elements sent to _generate_select_option
-     *
-     * @param mixed $opt_group
-     * @param mixed $QSOs
-     * @param mixed $answer
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
-    {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
-        foreach ($QSOs as $QSO) {
-            $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
-        }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
-        return $html;
-    }
-
-
-
-    /**
-     *  _generate_select_option
-     * @param mixed $key
-     * @param mixed $value
-     * @param mixed $answer
-     * @param int $only_option
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option($key, $value, $answer, $only_option = false, $use_html_entities = true)
-    {
-        $key = self::prep_answer($key, $use_html_entities);
-        $value = self::prep_answer($value, $use_html_entities);
-        $value = ! empty($value) ? $value : $key;
-        $selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
-        return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
-    }
-
-
-
-    /**
-     * generates HTML for form radio button inputs
-     *
-     * @param bool|string $question    label content
-     * @param string      $answer      form input value attribute
-     * @param array|bool  $options     array of answer options where array key = option value and array value = option display text
-     * @param bool|string $name        form input name attribute
-     * @param string      $id          form input css id attribute
-     * @param string      $class       form input css class attribute
-     * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string      $required_text
-     * @param string      $label_class css class attribute for the label
-     * @param bool|string $disabled    disabled="disabled" or null
-     * @param bool        $system_ID
-     * @param bool        $use_html_entities
-     * @param bool        $label_b4
-     * @param bool        $use_desc_4_label
-     * @return string HTML
-     */
-    public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
-    {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            if ($OPT instanceof EE_Question_Option) {
-                $value = self::prep_option_value($OPT->value());
-                $label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
-                $desc = $OPT->desc();// no self::prep_answer
-                $answer = is_numeric($value) && empty($answer) ? 0 : $answer;
-                $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
-            }
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for form checkbox inputs
-     *
-     * @param string $question      label content
-     * @param string $answer        form input value attribute
-     * @param array $options            array of options where array key = option value and array value = option display text
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        $answer = maybe_unserialize($answer);
-
-        // prep the answer(s)
-        $answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
-
-        foreach ($answer as $key => $value) {
-            $key = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
-        }
-
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class = empty($class) ? 'espresso-radio-btn-inp' : $class;
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
-            $text = self::prep_answer($OPT->value());
-            $desc = $OPT->desc() ;
-            $opt = '-' . sanitize_key($value);
-
-            $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
-
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
-            }
-            $input_html .= "\n\t\t\t\t" . '</li>';
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-
-
-
-    /**
-     * generates HTML for a form datepicker input
-     *
-     * @param string $question  label content
-     * @param string $answer        form input value attribute
-     * @param string $name          form input name attribute
-     * @param string $id                form input css id attribute
-     * @param string $class             form input css class attribute
-     * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
-     * @param string $label_class   css class attribute for the label
-     * @param string $disabled      disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
-    {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
-        $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        // enqueue scripts
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('jquery-ui-datepicker');
-
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
-    }
-
-
-
-    /**
-     *  remove_label_keep_required_msg
-     *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
-     *  @access public
-     *  @return     string
-     */
-    public static function remove_label_keep_required_msg($label_html, $required_text)
-    {
-        return $required_text;
-    }
-
-
-
-
-
-    /**
-     * Simply return sthe HTML for a hidden input of the given name and value.
-     * @param string $name
-     * @param string $value
-     * @return string HTML
-     */
-    public static function hidden_input($name, $value, $id = '')
-    {
-        $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="'.$name.'" value="' .  $value . '"/>';
-    }
-
-
-
-
-
-    /**
-     * prep_question
-     * @param string $question
-     * @return string
-     */
-    public static function prep_question($question)
-    {
-        return $question;
+		$disabled = $QFI->get('QST_disabled') ? true : false;
+		$required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
+		$QST_required = $QFI->get('QST_required');
+		$required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
+		$use_html_entities = $QFI->get_meta('htmlentities');
+		$required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
+		$required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
+		$label_class = 'espresso-form-input-lbl';
+		$QST_options = $QFI->options(true, $answer);
+		$options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
+		$system_ID = $QFI->get('QST_system');
+		$label_b4 = $QFI->get_meta('label_b4');
+		$use_desc_4_label = $QFI->get_meta('use_desc_4_label');
+
+
+		switch ($QFI->get('QST_type')) {
+			case 'TEXTAREA':
+				return EEH_Form_Fields::textarea($display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+
+			case 'DROPDOWN':
+				return EEH_Form_Fields::select($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, true);
+				break;
+
+
+			case 'RADIO_BTN':
+				return EEH_Form_Fields::radio($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label);
+				break;
+
+			case 'CHECKBOX':
+				return EEH_Form_Fields::checkbox($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities);
+				break;
+
+			case 'DATE':
+				return EEH_Form_Fields::datepicker($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+
+			case 'TEXT':
+			default:
+				return EEH_Form_Fields::text($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities);
+				break;
+		}
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form text input
+	 *
+	 * @param string $question  label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled .' ' . $extra . '/>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+	/**
+	 * generates HTML for a form textarea
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $dimensions array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// make sure $dimensions is an array
+		$dimensions = is_array($dimensions) ? $dimensions : array();
+		// and set some defaults
+		$dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form select input
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param array $options            array of answer options where array key = option value and array value = option display text
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function select($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $add_please_select_option = false)
+	{
+
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? self::prep_answer(array_shift($answer), $use_html_entities) : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+		// recursively count array elements, to determine total number of options
+		$only_option = count($options, 1) == 1 ? true : false;
+		if (! $only_option) {
+			// if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
+			$selected = $answer === null ? ' selected="selected"' : '';
+			$input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
+		}
+		foreach ($options as $key => $value) {
+			// if value is an array, then create option groups, else create regular ol' options
+			$input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
+		}
+
+		$input_html .= "\n\t\t\t" . '</select>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+	/**
+	 *  _generate_select_option_group
+	 *
+	 *  if  $value for a select box is an array, then the key will be used as the optgroup label
+	 *  and the value array will be looped thru and the elements sent to _generate_select_option
+	 *
+	 * @param mixed $opt_group
+	 * @param mixed $QSOs
+	 * @param mixed $answer
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
+	{
+		$html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+		foreach ($QSOs as $QSO) {
+			$html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
+		}
+		$html .= "\n\t\t\t\t" . '</optgroup>';
+		return $html;
+	}
+
+
+
+	/**
+	 *  _generate_select_option
+	 * @param mixed $key
+	 * @param mixed $value
+	 * @param mixed $answer
+	 * @param int $only_option
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option($key, $value, $answer, $only_option = false, $use_html_entities = true)
+	{
+		$key = self::prep_answer($key, $use_html_entities);
+		$value = self::prep_answer($value, $use_html_entities);
+		$value = ! empty($value) ? $value : $key;
+		$selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
+		return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
+	}
+
+
+
+	/**
+	 * generates HTML for form radio button inputs
+	 *
+	 * @param bool|string $question    label content
+	 * @param string      $answer      form input value attribute
+	 * @param array|bool  $options     array of answer options where array key = option value and array value = option display text
+	 * @param bool|string $name        form input name attribute
+	 * @param string      $id          form input css id attribute
+	 * @param string      $class       form input css class attribute
+	 * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string      $required_text
+	 * @param string      $label_class css class attribute for the label
+	 * @param bool|string $disabled    disabled="disabled" or null
+	 * @param bool        $system_ID
+	 * @param bool        $use_html_entities
+	 * @param bool        $label_b4
+	 * @param bool        $use_desc_4_label
+	 * @return string HTML
+	 */
+	public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
+	{
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			if ($OPT instanceof EE_Question_Option) {
+				$value = self::prep_option_value($OPT->value());
+				$label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
+				$size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
+				$desc = $OPT->desc();// no self::prep_answer
+				$answer = is_numeric($value) && empty($answer) ? 0 : $answer;
+				$checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
+				$opt = '-' . sanitize_key($value);
+
+				$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+				$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
+				$input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t" . '</label>';
+				$input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
+				$input_html .= "\n\t\t\t\t" . '</li>';
+			}
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for form checkbox inputs
+	 *
+	 * @param string $question      label content
+	 * @param string $answer        form input value attribute
+	 * @param array $options            array of options where array key = option value and array value = option display text
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		$answer = maybe_unserialize($answer);
+
+		// prep the answer(s)
+		$answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
+
+		foreach ($answer as $key => $value) {
+			$key = self::prep_option_value($key);
+			$answer[ $key ] = self::prep_answer($value, $use_html_entities);
+		}
+
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class = empty($class) ? 'espresso-radio-btn-inp' : $class;
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			$value = $OPT->value();// self::prep_option_value( $OPT->value() );
+			$size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+			$text = self::prep_answer($OPT->value());
+			$desc = $OPT->desc() ;
+			$opt = '-' . sanitize_key($value);
+
+			$checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
+
+			$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+			$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
+			$input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t" . '</label>';
+			if (! empty($desc) && $desc != $text) {
+				$input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
+			}
+			$input_html .= "\n\t\t\t\t" . '</li>';
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+
+
+
+	/**
+	 * generates HTML for a form datepicker input
+	 *
+	 * @param string $question  label content
+	 * @param string $answer        form input value attribute
+	 * @param string $name          form input name attribute
+	 * @param string $id                form input css id attribute
+	 * @param string $class             form input css class attribute
+	 * @param array $required       'label', 'class', and 'msg' - array of values for required "label" content, css required 'class', and required 'msg' attribute
+	 * @param string $label_class   css class attribute for the label
+	 * @param string $disabled      disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
+	{
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
+		$class = empty($class) ? $txt_class : $class;
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		// enqueue scripts
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('jquery-ui-datepicker');
+
+		$input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return  $label_html . $input_html;
+	}
+
+
+
+	/**
+	 *  remove_label_keep_required_msg
+	 *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
+	 *  @access public
+	 *  @return     string
+	 */
+	public static function remove_label_keep_required_msg($label_html, $required_text)
+	{
+		return $required_text;
+	}
+
+
+
+
+
+	/**
+	 * Simply return sthe HTML for a hidden input of the given name and value.
+	 * @param string $name
+	 * @param string $value
+	 * @return string HTML
+	 */
+	public static function hidden_input($name, $value, $id = '')
+	{
+		$id = ! empty($id) ? $id : $name;
+		return '<input id="' . $id . '" type="hidden" name="'.$name.'" value="' .  $value . '"/>';
+	}
+
+
+
+
+
+	/**
+	 * prep_question
+	 * @param string $question
+	 * @return string
+	 */
+	public static function prep_question($question)
+	{
+		return $question;
 //      $link = '';
 //      // does this label have a help link attached ?
 //      if ( strpos( $question, '<a ' ) !== FALSE ) {
@@ -1068,447 +1068,447 @@ 
 //          $link = '<a ' . $link;
 //      }
 //      return htmlspecialchars( trim( stripslashes( str_replace( '&#039;', "'", $question ))), ENT_QUOTES, 'UTF-8' ) . ' ' . $link;
-    }
-
-
-
-
-    /**
-     *  prep_answer
-     * @param mixed $answer
-     * @return string
-     */
-    public static function prep_answer($answer, $use_html_entities = true)
-    {
-        // make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired, we want "0".
-        if (is_bool($answer)) {
-            $answer = $answer ? 1 : 0;
-        }
-        $answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
-        return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
-    }
-
-
-
-    /**
-     *  prep_answer_options
-     *  @param array $QSOs  array of EE_Question_Option objects
-     *  @return array
-     */
-    public static function prep_answer_options($QSOs = array())
-    {
-        $prepped_answer_options = array();
-        if (is_array($QSOs) && ! empty($QSOs)) {
-            foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
-                    $QSO = EE_Question_Option::new_instance(array(
-                        'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
-                        'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
-                    ));
-                }
-                if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
-                } else {
-                    $prepped_answer_options[] = $QSO;
-                }
-            }
-        }
+	}
+
+
+
+
+	/**
+	 *  prep_answer
+	 * @param mixed $answer
+	 * @return string
+	 */
+	public static function prep_answer($answer, $use_html_entities = true)
+	{
+		// make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired, we want "0".
+		if (is_bool($answer)) {
+			$answer = $answer ? 1 : 0;
+		}
+		$answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
+		return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
+	}
+
+
+
+	/**
+	 *  prep_answer_options
+	 *  @param array $QSOs  array of EE_Question_Option objects
+	 *  @return array
+	 */
+	public static function prep_answer_options($QSOs = array())
+	{
+		$prepped_answer_options = array();
+		if (is_array($QSOs) && ! empty($QSOs)) {
+			foreach ($QSOs as $key => $QSO) {
+				if (! $QSO instanceof EE_Question_Option) {
+					$QSO = EE_Question_Option::new_instance(array(
+						'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
+						'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
+					));
+				}
+				if ($QSO->opt_group()) {
+					$prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+				} else {
+					$prepped_answer_options[] = $QSO;
+				}
+			}
+		}
 //      d( $prepped_answer_options );
-        return $prepped_answer_options;
-    }
-
-
-    /**
-     *  prep_option_value
-     * @param string $option_value
-     * @return string
-     */
-    public static function prep_option_value($option_value)
-    {
-        return esc_attr(trim(stripslashes($option_value)));
-    }
-
-
-
-
-    /**
-     *  prep_required
-     * @param string|array  $required
-     * @return array
-     */
-    public static function prep_required($required = array())
-    {
-        // make sure required is an array
-        $required = is_array($required) ? $required : array();
-        // and set some defaults
-        $required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
-        return $required;
-    }
-
-
-
-    /**
-     *  get_label_size_class
-     * @param string    $value
-     * @return string
-     */
-    public static function get_label_size_class($value = false)
-    {
-        if ($value === false || $value == '') {
-            return ' class="medium-lbl"';
-        }
-            // determine length of option value
-            $val_size = strlen($value);
-        switch ($val_size) {
-            case $val_size < 3:
-                $size =  ' class="nano-lbl"';
-                break;
-            case $val_size < 6:
-                $size =  ' class="micro-lbl"';
-                break;
-            case $val_size < 12:
-                $size =  ' class="tiny-lbl"';
-                break;
-            case $val_size < 25:
-                $size =  ' class="small-lbl"';
-                break;
-            case $val_size > 100:
-                $size =  ' class="big-lbl"';
-                break;
-            default:
-                $size =  ' class="medium-lbl"';
-                break;
-        }
-        return $size;
-    }
-
-
-
-
-    /**
-     *  _load_system_dropdowns
-     * @param array     $QFI
-     * @return array
-     */
-    private static function _load_system_dropdowns($QFI)
-    {
-        $QST_system = $QFI->get('QST_system');
-        switch ($QST_system) {
-            case 'state':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'country':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-            case 'admin-state':
-                $QFI = self::generate_state_dropdown($QFI, true);
-                break;
-            case 'admin-country':
-                $QFI = self::generate_country_dropdown($QFI, true);
-                break;
-        }
-        return $QFI;
-    }
-
-
-
-    /**
-     * This preps dropdowns that are specialized.
-     *
-     * @since  4.6.0
-     *
-     * @param EE_Question_Form_Input $QFI
-     *
-     * @return EE_Question_Form_Input
-     */
-    protected static function _load_specialized_dropdowns($QFI)
-    {
-        switch ($QFI->get('QST_type')) {
-            case 'STATE':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'COUNTRY':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-        }
-        return $QFI;
-    }
-
-
-
-    /**
-     *    generate_state_dropdown
-     * @param array $QST
-     * @param bool  $get_all
-     * @return array
-     */
-    public static function generate_state_dropdown($QST, $get_all = false)
-    {
-        $states = $get_all ? EEM_State::instance()->get_all_states() : EEM_State::instance()->get_all_states_of_active_countries();
-        if ($states && count($states) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // if multiple countries, we'll create option groups within the dropdown
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(array (
-                        'QSO_value' => $state->ID(),
-                        'QSO_desc' => $state->name(),
-                        'QST_ID' => $QST->get('QST_ID'),
-                        'QSO_deleted' => false
-                    ));
-                    // set option group
-                    $QSO->set_opt_group($state->country()->name());
-                    // add option to question
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-
-    /**
-     *    generate_country_dropdown
-     * @param      $QST
-     * @param bool $get_all
-     * @internal param array $question
-     * @return array
-     */
-    public static function generate_country_dropdown($QST, $get_all = false)
-    {
-        $countries = $get_all ? EEM_Country::instance()->get_all_countries() : EEM_Country::instance()->get_all_active_countries();
-        if ($countries && count($countries) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // now add countries
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(array (
-                        'QSO_value' => $country->ID(),
-                        'QSO_desc' => $country->name(),
-                        'QST_ID' => $QST->get('QST_ID'),
-                        'QSO_deleted' => false
-                    ));
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-
-
-
-    /**
-     *  generates options for a month dropdown selector with numbers from 01 to 12
-     *  @return array()
-     */
-    public static function two_digit_months_dropdown_options()
-    {
-        $options = array();
-        for ($x = 1; $x <= 12; $x++) {
-            $mm = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $mm ] = (string) $mm;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-
-
-
-    /**
-     *  generates a year dropdown selector with numbers for the next ten years
-     *  @return object
-     */
-    public static function next_decade_two_digit_year_dropdown_options()
-    {
-        $options = array();
-        $current_year = date('y');
-        $next_decade = $current_year + 10;
-        for ($x = $current_year; $x <= $next_decade; $x++) {
-            $yy = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $yy ] = (string) $yy;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-
-
-
-    /**
-     * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for list table filter.
-     * @param  string  $cur_date     any currently selected date can be entered here.
-     * @param  string  $status       Registration status
-     * @param  integer $evt_category Event Category ID if the Event Category filter is selected
-     * @return string                html
-     */
-    public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
-    {
-        $_where = array();
-        if (!empty($status)) {
-            $_where['STS_ID'] = $status;
-        }
-
-        if ($evt_category > 0) {
-            $_where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
-
-        $regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
-
-        // setup vals for select input helper
-        $options = array(
-            0 => array(
-                'text' => __('Select a Month/Year', 'event_espresso'),
-                'id' => ''
-                )
-            );
-
-        foreach ($regdtts as $regdtt) {
-            $date = $regdtt->reg_month. ' ' . $regdtt->reg_year;
-            $options[] = array(
-                'text' => $date,
-                'id' => $date
-                );
-        }
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-
-    /**
-     * generates a month/year dropdown selector for all events matching the given criteria
-     * Typically used for list table filter
-     * @param  string $cur_date          any currently selected date can be entered here.
-     * @param  string $status            "view" (i.e. all, today, month, draft)
-     * @param  int    $evt_category      category event belongs to
-     * @param  string $evt_active_status "upcoming", "expired", "active", or "inactive"
-     * @return string                    html
-     */
-    public static function generate_event_months_dropdown($cur_date = '', $status = null, $evt_category = null, $evt_active_status = null)
-    {
-        // determine what post_status our condition will have for the query.
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                $where['Event.status'] = array( 'NOT IN', array('trash') );
-                break;
-
-            case 'draft':
-                $where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
-
-            default:
-                $where['Event.status'] = $status;
-        }
-
-        // phpcs:enable
-
-        // categories?
-
+		return $prepped_answer_options;
+	}
+
+
+	/**
+	 *  prep_option_value
+	 * @param string $option_value
+	 * @return string
+	 */
+	public static function prep_option_value($option_value)
+	{
+		return esc_attr(trim(stripslashes($option_value)));
+	}
+
+
+
+
+	/**
+	 *  prep_required
+	 * @param string|array  $required
+	 * @return array
+	 */
+	public static function prep_required($required = array())
+	{
+		// make sure required is an array
+		$required = is_array($required) ? $required : array();
+		// and set some defaults
+		$required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
+		return $required;
+	}
+
+
+
+	/**
+	 *  get_label_size_class
+	 * @param string    $value
+	 * @return string
+	 */
+	public static function get_label_size_class($value = false)
+	{
+		if ($value === false || $value == '') {
+			return ' class="medium-lbl"';
+		}
+			// determine length of option value
+			$val_size = strlen($value);
+		switch ($val_size) {
+			case $val_size < 3:
+				$size =  ' class="nano-lbl"';
+				break;
+			case $val_size < 6:
+				$size =  ' class="micro-lbl"';
+				break;
+			case $val_size < 12:
+				$size =  ' class="tiny-lbl"';
+				break;
+			case $val_size < 25:
+				$size =  ' class="small-lbl"';
+				break;
+			case $val_size > 100:
+				$size =  ' class="big-lbl"';
+				break;
+			default:
+				$size =  ' class="medium-lbl"';
+				break;
+		}
+		return $size;
+	}
+
+
+
+
+	/**
+	 *  _load_system_dropdowns
+	 * @param array     $QFI
+	 * @return array
+	 */
+	private static function _load_system_dropdowns($QFI)
+	{
+		$QST_system = $QFI->get('QST_system');
+		switch ($QST_system) {
+			case 'state':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'country':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+			case 'admin-state':
+				$QFI = self::generate_state_dropdown($QFI, true);
+				break;
+			case 'admin-country':
+				$QFI = self::generate_country_dropdown($QFI, true);
+				break;
+		}
+		return $QFI;
+	}
+
+
+
+	/**
+	 * This preps dropdowns that are specialized.
+	 *
+	 * @since  4.6.0
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 *
+	 * @return EE_Question_Form_Input
+	 */
+	protected static function _load_specialized_dropdowns($QFI)
+	{
+		switch ($QFI->get('QST_type')) {
+			case 'STATE':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'COUNTRY':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+		}
+		return $QFI;
+	}
+
+
+
+	/**
+	 *    generate_state_dropdown
+	 * @param array $QST
+	 * @param bool  $get_all
+	 * @return array
+	 */
+	public static function generate_state_dropdown($QST, $get_all = false)
+	{
+		$states = $get_all ? EEM_State::instance()->get_all_states() : EEM_State::instance()->get_all_states_of_active_countries();
+		if ($states && count($states) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// if multiple countries, we'll create option groups within the dropdown
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$QSO = EE_Question_Option::new_instance(array (
+						'QSO_value' => $state->ID(),
+						'QSO_desc' => $state->name(),
+						'QST_ID' => $QST->get('QST_ID'),
+						'QSO_deleted' => false
+					));
+					// set option group
+					$QSO->set_opt_group($state->country()->name());
+					// add option to question
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+
+	/**
+	 *    generate_country_dropdown
+	 * @param      $QST
+	 * @param bool $get_all
+	 * @internal param array $question
+	 * @return array
+	 */
+	public static function generate_country_dropdown($QST, $get_all = false)
+	{
+		$countries = $get_all ? EEM_Country::instance()->get_all_countries() : EEM_Country::instance()->get_all_active_countries();
+		if ($countries && count($countries) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// now add countries
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$QSO = EE_Question_Option::new_instance(array (
+						'QSO_value' => $country->ID(),
+						'QSO_desc' => $country->name(),
+						'QST_ID' => $QST->get('QST_ID'),
+						'QSO_deleted' => false
+					));
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+
+
+
+	/**
+	 *  generates options for a month dropdown selector with numbers from 01 to 12
+	 *  @return array()
+	 */
+	public static function two_digit_months_dropdown_options()
+	{
+		$options = array();
+		for ($x = 1; $x <= 12; $x++) {
+			$mm = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ (string) $mm ] = (string) $mm;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+
+
+
+	/**
+	 *  generates a year dropdown selector with numbers for the next ten years
+	 *  @return object
+	 */
+	public static function next_decade_two_digit_year_dropdown_options()
+	{
+		$options = array();
+		$current_year = date('y');
+		$next_decade = $current_year + 10;
+		for ($x = $current_year; $x <= $next_decade; $x++) {
+			$yy = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ (string) $yy ] = (string) $yy;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+
+
+
+	/**
+	 * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for list table filter.
+	 * @param  string  $cur_date     any currently selected date can be entered here.
+	 * @param  string  $status       Registration status
+	 * @param  integer $evt_category Event Category ID if the Event Category filter is selected
+	 * @return string                html
+	 */
+	public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
+	{
+		$_where = array();
+		if (!empty($status)) {
+			$_where['STS_ID'] = $status;
+		}
+
+		if ($evt_category > 0) {
+			$_where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
+
+		$regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
+
+		// setup vals for select input helper
+		$options = array(
+			0 => array(
+				'text' => __('Select a Month/Year', 'event_espresso'),
+				'id' => ''
+				)
+			);
+
+		foreach ($regdtts as $regdtt) {
+			$date = $regdtt->reg_month. ' ' . $regdtt->reg_year;
+			$options[] = array(
+				'text' => $date,
+				'id' => $date
+				);
+		}
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+
+	/**
+	 * generates a month/year dropdown selector for all events matching the given criteria
+	 * Typically used for list table filter
+	 * @param  string $cur_date          any currently selected date can be entered here.
+	 * @param  string $status            "view" (i.e. all, today, month, draft)
+	 * @param  int    $evt_category      category event belongs to
+	 * @param  string $evt_active_status "upcoming", "expired", "active", or "inactive"
+	 * @return string                    html
+	 */
+	public static function generate_event_months_dropdown($cur_date = '', $status = null, $evt_category = null, $evt_active_status = null)
+	{
+		// determine what post_status our condition will have for the query.
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				$where['Event.status'] = array( 'NOT IN', array('trash') );
+				break;
+
+			case 'draft':
+				$where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
+
+			default:
+				$where['Event.status'] = $status;
+		}
+
+		// phpcs:enable
+
+		// categories?
+
 
-        if (!empty($evt_category)) {
-            $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
+		if (!empty($evt_category)) {
+			$where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
 
 
 //      $where['DTT_is_primary'] = 1;
 
-        $DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status);
-
-        // let's setup vals for select input helper
-        $options = array(
-            0 => array(
-                'text' => __('Select a Month/Year', 'event_espresso'),
-                'id' => ""
-                )
-            );
-
-
-
-        // translate month and date
-        global $wp_locale;
-
-        foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
-            $options[] = array(
-                'text' => $localized_date,
-                'id' => $id
-                );
-        }
-
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-
-    /**
-     * generates the dropdown selector for event categories
-     * typically used as a filter on list tables.
-     * @param  integer $current_cat currently selected category
-     * @return string               html for dropdown
-     */
-    public static function generate_event_category_dropdown($current_cat = -1)
-    {
-        $categories = EEM_Term::instance()->get_all_ee_categories(true);
-        $options = array(
-            '0' => array(
-                'text' => __('All Categories', 'event_espresso'),
-                'id' => -1
-                )
-            );
-
-        // setup categories for dropdown
-        foreach ($categories as $category) {
-            $options[] = array(
-                'text' => $category->get('name'),
-                'id' => $category->ID()
-                );
-        }
-
-        return self::select_input('EVT_CAT', $options, $current_cat);
-    }
-
-
-
-    /**
-     *    generate a submit button with or without it's own microform
-     *    this is the only way to create buttons that are compatible across all themes
-     *
-     * @access    public
-     * @param    string   $url              - the form action
-     * @param    string   $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm" for the form
-     * @param    string   $class            - css classes (separated by spaces if more than one)
-     * @param    string   $text             - what appears on the button
-     * @param    string   $nonce_action     - if using nonces
-     * @param    bool|string $input_only       - whether to print form header and footer. TRUE returns the input without the form
-     * @param    string   $extra_attributes - any extra attributes that need to be attached to the form input
-     * @return    void
-     */
-    public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = false, $extra_attributes = '')
-    {
-        $btn = '';
-        if (empty($url) || empty($ID)) {
-            return $btn;
-        }
-        $text = ! empty($text) ? $text : __('Submit', 'event_espresso');
-        $btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
-            $btn_frm .= $btn;
-            $btn_frm .= '</form>';
-            $btn = $btn_frm;
-            unset($btn_frm);
-        }
-        return $btn;
-    }
+		$DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status);
+
+		// let's setup vals for select input helper
+		$options = array(
+			0 => array(
+				'text' => __('Select a Month/Year', 'event_espresso'),
+				'id' => ""
+				)
+			);
+
+
+
+		// translate month and date
+		global $wp_locale;
+
+		foreach ($DTTS as $DTT) {
+			$localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
+			$id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+			$options[] = array(
+				'text' => $localized_date,
+				'id' => $id
+				);
+		}
+
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+
+	/**
+	 * generates the dropdown selector for event categories
+	 * typically used as a filter on list tables.
+	 * @param  integer $current_cat currently selected category
+	 * @return string               html for dropdown
+	 */
+	public static function generate_event_category_dropdown($current_cat = -1)
+	{
+		$categories = EEM_Term::instance()->get_all_ee_categories(true);
+		$options = array(
+			'0' => array(
+				'text' => __('All Categories', 'event_espresso'),
+				'id' => -1
+				)
+			);
+
+		// setup categories for dropdown
+		foreach ($categories as $category) {
+			$options[] = array(
+				'text' => $category->get('name'),
+				'id' => $category->ID()
+				);
+		}
+
+		return self::select_input('EVT_CAT', $options, $current_cat);
+	}
+
+
+
+	/**
+	 *    generate a submit button with or without it's own microform
+	 *    this is the only way to create buttons that are compatible across all themes
+	 *
+	 * @access    public
+	 * @param    string   $url              - the form action
+	 * @param    string   $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm" for the form
+	 * @param    string   $class            - css classes (separated by spaces if more than one)
+	 * @param    string   $text             - what appears on the button
+	 * @param    string   $nonce_action     - if using nonces
+	 * @param    bool|string $input_only       - whether to print form header and footer. TRUE returns the input without the form
+	 * @param    string   $extra_attributes - any extra attributes that need to be attached to the form input
+	 * @return    void
+	 */
+	public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = false, $extra_attributes = '')
+	{
+		$btn = '';
+		if (empty($url) || empty($ID)) {
+			return $btn;
+		}
+		$text = ! empty($text) ? $text : __('Submit', 'event_espresso');
+		$btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
+		if (! $input_only) {
+			$btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+			$btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
+			$btn_frm .= $btn;
+			$btn_frm .= '</form>';
+			$btn = $btn_frm;
+			unset($btn_frm);
+		}
+		return $btn;
+	}
 }

Spacing +185 added lines, -185 removed lines

@@ -90,10 +90,10 @@ 
             $required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': ';
             // and the css class "required"
             $css_class = isset($input_value['css_class']) ? $input_value['css_class'] : '';
-            $styles = $input_value['required'] ? 'required ' . $css_class : $css_class;
+            $styles = $input_value['required'] ? 'required '.$css_class : $css_class;
 
-            $field_id = ($id) ? $id . '-' . $input_key : $input_key;
-            $tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : '';
+            $field_id = ($id) ? $id.'-'.$input_key : $input_key;
+            $tabindex = ! empty($input_value['tabindex']) ? ' tabindex="'.$input_value['tabindex'].'"' : '';
 
             // rows or cols?
             $rows = isset($input_value['rows']) ? $input_value['rows'] : '10';
@@ -102,21 +102,21 @@ 
             // any content?
             $append_content = $input_value['append_content'];
 
-            $output .= (!$close) ? '<ul>' : '';
+            $output .= ( ! $close) ? '<ul>' : '';
             $output .= '<li>';
 
             // what type of input are we dealing with ?
             switch ($input_value['input']) {
                 // text inputs
                 case 'text':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" class="'.$styles.'" type="text" value="'.esc_textarea($input_value['value']).'" name="'.$input_value['name'].'"'.$tabindex.'>';
                     break;
 
                 // dropdowns
                 case 'select':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<select id="'.$field_id.'" class="'.$styles.'" name="'.$input_value['name'].'"'.$tabindex.'>';
 
                     if (is_array($input_value['options'])) {
                         $options = $input_value['options'];
@@ -127,27 +127,27 @@ 
                     foreach ($options as $key => $value) {
                         $selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : '';
                         // $key = str_replace( ' ', '_', sanitize_key( $value ));
-                        $output .= "\n\t\t\t\t" . '<option '. $selected . ' value="' . $key . '">' . $value . '</option>';
+                        $output .= "\n\t\t\t\t".'<option '.$selected.' value="'.$key.'">'.$value.'</option>';
                     }
-                    $output .= "\n\t\t\t" . '</select>';
+                    $output .= "\n\t\t\t".'</select>';
 
                     break;
 
                 case 'textarea':
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="'.$rows.'" cols="'.$cols.'" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<textarea id="'.$field_id.'" class="'.$styles.'" rows="'.$rows.'" cols="'.$cols.'" name="'.$input_value['name'].'"'.$tabindex.'>'.esc_textarea($input_value['value']).'</textarea>';
                     break;
 
                 case 'hidden':
                     $close = false;
                     $output .= "</li></ul>";
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="hidden" name="'.$input_value['name'].'" value="'.$input_value['value'].'">';
                     break;
 
                 case 'checkbox':
-                    $checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : '';
-                    $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>';
-                    $output .= "\n\t\t\t" . '<input id="' . $field_id. '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />';
+                    $checked = ($input_value['value'] == 1) ? 'checked="checked"' : '';
+                    $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>';
+                    $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="checkbox" name="'.$input_value['name'].'" value="1"'.$checked.$tabindex.' />';
                     break;
 
                 case 'wp_editor':
@@ -160,7 +160,7 @@ 
                     );
                     $output .= '</li>';
                     $output .= '</ul>';
-                    $output .= '<h4>' . $input_value['label'] . '</h4>';
+                    $output .= '<h4>'.$input_value['label'].'</h4>';
                     if ($append_content) {
                         $output .= $append_content;
                     }
@@ -232,17 +232,17 @@ 
             $_fields = wp_parse_args($field_atts, $defaults);
             extract($_fields);
             // generate label
-            $label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>';
+            $label = empty($label) ? '' : '<label for="'.$id.'">'.$label.'</label>';
             // generate field name
-            $f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+            $f_name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name;
 
             // tabindex
-            $tabindex_str = !empty($tabindex) ? ' tabindex="' . $tabindex . '"' : '';
+            $tabindex_str = ! empty($tabindex) ? ' tabindex="'.$tabindex.'"' : '';
 
             // we determine what we're building based on the type
             switch ($type) {
                 case 'textarea':
-                        $fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>';
+                        $fld = '<textarea id="'.$id.'" class="'.$class.'" rows="'.$dimensions[1].'" cols="'.$dimensions[0].'" name="'.$f_name.'"'.$tabindex_str.'>'.$value.'</textarea>';
                         $fld .= $extra_desc;
                     break;
 
@@ -250,16 +250,16 @@ 
                         $c_input = '';
                     if (is_array($value)) {
                         foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? ' class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+                            $c_id = $field_name.'_'.$value;
+                            $c_class = isset($classes[$key]) ? ' class="'.$classes[$key].'" ' : '';
+                            $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : '';
+                            $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : '';
+                            $c_input .= '<input name="'.$f_name.'[]" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label;
                         }
                         $fld = $c_input;
                     } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+                        $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : '';
+                        $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n";
                     }
                     break;
 
@@ -267,28 +267,28 @@ 
                         $c_input = '';
                     if (is_array($value)) {
                         foreach ($value as $key => $val) {
-                            $c_id = $field_name . '_' . $value;
-                            $c_class = isset($classes[ $key ]) ? 'class="' . $classes[ $key ] . '" ' : '';
-                            $c_label = isset($labels[ $key ]) ? '<label for="' . $c_id . '">' . $labels[ $key ] . '</label>' : '';
-                            $checked = !empty($default) && $default == $val ? ' checked="checked" ' : '';
-                            $c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label;
+                            $c_id = $field_name.'_'.$value;
+                            $c_class = isset($classes[$key]) ? 'class="'.$classes[$key].'" ' : '';
+                            $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : '';
+                            $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : '';
+                            $c_input .= '<input name="'.$f_name.'" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label;
                         }
                         $fld = $c_input;
                     } else {
-                        $checked = !empty($default) && $default == $val ? 'checked="checked" ' : '';
-                        $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n";
+                        $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : '';
+                        $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n";
                     }
                     break;
 
                 case 'hidden':
-                        $fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n";
+                        $fld = '<input name="'.$f_name.'" type="hidden" id="'.$id.'" class="'.$class.'" value="'.$value.'" />'."\n";
                     break;
 
                 case 'select':
-                        $fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n";
+                        $fld = '<select name="'.$f_name.'" class="'.$class.'" id="'.$id.'"'.$tabindex_str.'>'."\n";
                     foreach ($value as $key => $val) {
-                        $checked = !empty($default) && $default == $val ? ' selected="selected"' : '';
-                        $fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[ $key ] . '</option>' . "\n";
+                        $checked = ! empty($default) && $default == $val ? ' selected="selected"' : '';
+                        $fld .= "\t".'<option value="'.$val.'"'.$checked.'>'.$labels[$key].'</option>'."\n";
                     }
                         $fld .= '</select>';
                     break;
@@ -309,11 +309,11 @@ 
                     break;
 
                 default: // 'text fields'
-                        $fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n";
+                        $fld = '<input name="'.$f_name.'" type="text" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$tabindex_str.' />'."\n";
                         $fld .= $extra_desc;
             }
 
-            $form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld );
+            $form_fields[$field_name] = array('label' => $label, 'field' => $fld);
         }
 
         return $form_fields;
@@ -343,25 +343,25 @@ 
     public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
     {
         // if $values was submitted in the wrong format, convert it over
-        if (!empty($values) && (!array_key_exists(0, $values) || !is_array($values[0]))) {
-            $converted_values=array();
+        if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) {
+            $converted_values = array();
             foreach ($values as $id => $text) {
-                $converted_values[]=array('id'=>$id,'text'=>$text);
+                $converted_values[] = array('id'=>$id, 'text'=>$text);
             }
-            $values=$converted_values;
+            $values = $converted_values;
         }
 
-        $field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"';
+        $field = '<select id="'.EEH_Formatter::ee_tep_output_string($name).'" name="'.EEH_Formatter::ee_tep_output_string($name).'"';
         // Debug
         // EEH_Debug_Tools::printr( $values, '$values  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
         if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
+            $field .= ' '.$parameters;
         }
         if ($autosize) {
             $size = 'med';
             for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
+                if ($values[$ii]['text']) {
+                    if (strlen($values[$ii]['text']) > 5) {
                         $size = 'wide';
                     }
                 }
@@ -370,22 +370,22 @@ 
             $size = '';
         }
 
-        $field .= ' class="' . $class . ' ' . $size . '">';
+        $field .= ' class="'.$class.' '.$size.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
 
         for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
+            $field .= '<option value="'.$values[$i]['id'].'"';
+            if ($default == $values[$i]['id']) {
                 $field .= ' selected = "selected"';
             }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
+            if (isset($values[$i]['class'])) {
+                $field .= ' class="'.$values[$i]['class'].'"';
             }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
+            $field .= '>'.$values[$i]['text'].'</option>';
         }
         $field .= '</select>';
 
@@ -410,18 +410,18 @@ 
         $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
         $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
+                if ( ! empty($QSG['QSG_questions'])) {
                     // use fieldsets
-                    $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">';
+                    $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG['QSG_identifier'].'">';
                     // group_name
-                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer($QSG['QSG_name']) . '</h5>' : '';
+                    $html .= $QSG['QSG_show_group_name'] ? "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.self::prep_answer($QSG['QSG_name']).'</h5>' : '';
                     // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer($QSG['QSG_desc']) . '</div>' : '';
+                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">'.self::prep_answer($QSG['QSG_desc']).'</div>' : '';
 
                     $html .= $before_question_group_questions;
                     // loop thru questions
@@ -435,7 +435,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -471,28 +471,28 @@ 
         $q_meta = array_merge($default_q_meta, $q_meta);
         // EEH_Debug_Tools::printr( $q_meta, '$q_meta  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
 //          EEH_Debug_Tools::printr( $question_groups, '$question_groups  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 if ($QSG instanceof EE_Question_Group) {
                     // check that questions exist
 
-                    $where = array( 'QST_deleted' => 0 );
-                    if (! $from_admin) {
+                    $where = array('QST_deleted' => 0);
+                    if ( ! $from_admin) {
                         $where['QST_admin_only'] = 0;
                     }
-                    $questions = $QSG->questions(array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' )));
-                    if (! empty($questions)) {
+                    $questions = $QSG->questions(array($where, 'order_by' => array('Question_Group_Question.QGQ_order' => 'ASC')));
+                    if ( ! empty($questions)) {
                         // use fieldsets
-                        $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get('QSG_identifier') . '">';
+                        $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG->get('QSG_identifier').'">';
                         // group_name
                         if ($QSG->show_group_name()) {
-                            $html .=  "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty('QSG_name') . '</h5>';
+                            $html .= "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.$QSG->get_pretty('QSG_name').'</h5>';
                         }
                         // group_desc
                         if ($QSG->show_group_desc()) {
-                            $html .=  '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty('QSG_desc') . '</div>';
+                            $html .= '<div class="espresso-question-group-desc-pg">'.$QSG->get_pretty('QSG_desc').'</div>';
                         }
 
                         $html .= $before_question_group_questions;
@@ -504,12 +504,12 @@ 
 
                             if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
                                 // check for answer in $_GET in case we are reprocessing a form after an error
-                                if (isset($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field($_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ]);
+                                if (isset($_GET['qstn'][$q_meta['input_id']][$qstn_id])) {
+                                    $answer = is_array($_GET['qstn'][$q_meta['input_id']][$qstn_id]) ? $_GET['qstn'][$q_meta['input_id']][$qstn_id] : sanitize_text_field($_GET['qstn'][$q_meta['input_id']][$qstn_id]);
                                 }
                             } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
                                 // attendee data from the session
-                                $answer = isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+                                $answer = isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : null;
                             }
 
 
@@ -528,7 +528,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -567,10 +567,10 @@ 
         $disabled = $QFI->get('QST_disabled') ? true : false;
         $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
         $QST_required = $QFI->get('QST_required');
-        $required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array();
+        $required = $QST_required ? array('label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required) : array();
         $use_html_entities = $QFI->get_meta('htmlentities');
         $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso');
-        $required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer($required_text, $use_html_entities) . '</div>' : '';
+        $required_text = $QST_required ? "\n\t\t\t".'<div class="required-text hidden">'.self::prep_answer($required_text, $use_html_entities).'</div>' : '';
         $label_class = 'espresso-form-input-lbl';
         $QST_options = $QFI->options(true, $answer);
         $options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array();
@@ -629,7 +629,7 @@ 
     public static function text($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -637,21 +637,21 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled .' ' . $extra . '/>';
+        $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" value="'.esc_attr($answer).'"  title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -675,7 +675,7 @@ 
     public static function textarea($question = false, $answer = null, $name = false, $id = '', $class = '', $dimensions = false, $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -685,23 +685,23 @@ 
         // make sure $dimensions is an array
         $dimensions = is_array($dimensions) ? $dimensions : array();
         // and set some defaults
-        $dimensions = array_merge(array( 'rows' => 3, 'cols' => 40 ), $dimensions);
+        $dimensions = array_merge(array('rows' => 3, 'cols' => 40), $dimensions);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>';
+        $input_html = "\n\t\t\t".'<textarea name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  title="'.$required['msg'].'" '.$disabled.' '.$extra.'>'.$answer.'</textarea>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -727,7 +727,7 @@ 
     {
 
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -735,36 +735,36 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+        $input_html = "\n\t\t\t".'<select name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" title="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>';
         // recursively count array elements, to determine total number of options
         $only_option = count($options, 1) == 1 ? true : false;
-        if (! $only_option) {
+        if ( ! $only_option) {
             // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
             $selected = $answer === null ? ' selected="selected"' : '';
-            $input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : '';
+            $input_html .= $add_please_select_option ? "\n\t\t\t\t".'<option value=""'.$selected.'>'.__(' - please select - ', 'event_espresso').'</option>' : '';
         }
         foreach ($options as $key => $value) {
             // if value is an array, then create option groups, else create regular ol' options
             $input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities);
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID);
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -783,11 +783,11 @@ 
      */
     private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
     {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+        $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">';
         foreach ($QSOs as $QSO) {
             $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
         }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
+        $html .= "\n\t\t\t\t".'</optgroup>';
         return $html;
     }
 
@@ -807,8 +807,8 @@ 
         $key = self::prep_answer($key, $use_html_entities);
         $value = self::prep_answer($value, $use_html_entities);
         $value = ! empty($value) ? $value : $key;
-        $selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : '';
-        return "\n\t\t\t\t" . '<option value="' . self::prep_option_value($key) . '"' . $selected . '> ' . $value . '&nbsp;&nbsp;&nbsp;</option>';
+        $selected = ($answer == $key || $only_option) ? ' selected="selected"' : '';
+        return "\n\t\t\t\t".'<option value="'.self::prep_option_value($key).'"'.$selected.'> '.$value.'&nbsp;&nbsp;&nbsp;</option>';
     }
 
 
@@ -835,7 +835,7 @@ 
     public static function radio($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true, $label_b4 = false, $use_desc_4_label = false)
     {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -843,46 +843,46 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
         $class = ! empty($class) ? $class : 'espresso-radio-btn-inp';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+        $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> ';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+        $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
             if ($OPT instanceof EE_Question_Option) {
                 $value = self::prep_option_value($OPT->value());
                 $label = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc()) : self::get_label_size_class($OPT->value());
-                $desc = $OPT->desc();// no self::prep_answer
+                $size = $use_desc_4_label ? self::get_label_size_class($OPT->value().' '.$OPT->desc()) : self::get_label_size_class($OPT->value());
+                $desc = $OPT->desc(); // no self::prep_answer
                 $answer = is_numeric($value) && empty($answer) ? 0 : $answer;
                 $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
+                $opt = '-'.sanitize_key($value);
+
+                $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+                $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">';
+                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>' : '';
+                $input_html .= "\n\t\t\t\t\t\t".'<input type="radio" name="'.$name.'" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+                $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span class="espresso-radio-btn-desc">'.$label.'</span>' : '';
+                $input_html .= "\n\t\t\t\t\t".'</label>';
+                $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>';
+                $input_html .= "\n\t\t\t\t".'</li>';
             }
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -907,62 +907,62 @@ 
     public static function checkbox($question = false, $answer = null, $options = false, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $label_b4 = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         $answer = maybe_unserialize($answer);
 
         // prep the answer(s)
-        $answer = is_array($answer) ? $answer : array( sanitize_key($answer) => $answer );
+        $answer = is_array($answer) ? $answer : array(sanitize_key($answer) => $answer);
 
         foreach ($answer as $key => $value) {
             $key = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
+            $answer[$key] = self::prep_answer($value, $use_html_entities);
         }
 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
         $class = empty($class) ? 'espresso-radio-btn-inp' : $class;
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label> ';
+        $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> ';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+        $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+            $value = $OPT->value(); // self::prep_option_value( $OPT->value() );
+            $size = self::get_label_size_class($OPT->value().' '.$OPT->desc());
             $text = self::prep_answer($OPT->value());
-            $desc = $OPT->desc() ;
-            $opt = '-' . sanitize_key($value);
+            $desc = $OPT->desc();
+            $opt = '-'.sanitize_key($value);
 
             $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
 
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4  ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t" . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>';
+            $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+            $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">';
+            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t\t".'<input type="checkbox" name="'.$name.'['.$OPT->ID().']" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t".'</label>';
+            if ( ! empty($desc) && $desc != $text) {
+                $input_html .= "\n\t\t\t\t\t".' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'.$desc.'</div>';
             }
-            $input_html .= "\n\t\t\t\t" . '</li>';
+            $input_html .= "\n\t\t\t\t".'</li>';
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -986,7 +986,7 @@ 
     public static function datepicker($question = false, $answer = null, $name = false, $id = '', $class = '', $required = false, $required_text = '', $label_class = '', $disabled = false, $system_ID = false, $use_html_entities = true)
     {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -994,26 +994,26 @@ 
         // prep the required array
         $required = self::prep_required($required);
         // set disabled tag
-        $disabled = $answer === null || ! $disabled  ? '' : ' disabled="disabled"';
+        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
         $class = empty($class) ? $txt_class : $class;
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
-        $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question($question) . $required['label'] . '</label><br/>';
+        $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>';
         // filter label but ensure required text comes before it
         $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
 
-        $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+        $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         // enqueue scripts
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso-ui-theme');
         wp_enqueue_script('jquery-ui-datepicker');
 
-        $input_html =  apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return  $label_html . $input_html;
+        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+        return  $label_html.$input_html;
     }
 
 
@@ -1042,7 +1042,7 @@ 
     public static function hidden_input($name, $value, $id = '')
     {
         $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="'.$name.'" value="' .  $value . '"/>';
+        return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>';
     }
 
 
@@ -1100,14 +1100,14 @@ 
         $prepped_answer_options = array();
         if (is_array($QSOs) && ! empty($QSOs)) {
             foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
+                if ( ! $QSO instanceof EE_Question_Option) {
                     $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key,
                         'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO
                     ));
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1141,7 +1141,7 @@ 
         // make sure required is an array
         $required = is_array($required) ? $required : array();
         // and set some defaults
-        $required = array_merge(array( 'label' => '', 'class' => '', 'msg' => '' ), $required);
+        $required = array_merge(array('label' => '', 'class' => '', 'msg' => ''), $required);
         return $required;
     }
 
@@ -1161,22 +1161,22 @@ 
             $val_size = strlen($value);
         switch ($val_size) {
             case $val_size < 3:
-                $size =  ' class="nano-lbl"';
+                $size = ' class="nano-lbl"';
                 break;
             case $val_size < 6:
-                $size =  ' class="micro-lbl"';
+                $size = ' class="micro-lbl"';
                 break;
             case $val_size < 12:
-                $size =  ' class="tiny-lbl"';
+                $size = ' class="tiny-lbl"';
                 break;
             case $val_size < 25:
-                $size =  ' class="small-lbl"';
+                $size = ' class="small-lbl"';
                 break;
             case $val_size > 100:
-                $size =  ' class="big-lbl"';
+                $size = ' class="big-lbl"';
                 break;
             default:
-                $size =  ' class="medium-lbl"';
+                $size = ' class="medium-lbl"';
                 break;
         }
         return $size;
@@ -1250,7 +1250,7 @@ 
             // if multiple countries, we'll create option groups within the dropdown
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(array (
+                    $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => $state->ID(),
                         'QSO_desc' => $state->name(),
                         'QST_ID' => $QST->get('QST_ID'),
@@ -1283,7 +1283,7 @@ 
             // now add countries
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(array (
+                    $QSO = EE_Question_Option::new_instance(array(
                         'QSO_value' => $country->ID(),
                         'QSO_desc' => $country->name(),
                         'QST_ID' => $QST->get('QST_ID'),
@@ -1309,7 +1309,7 @@ 
         $options = array();
         for ($x = 1; $x <= 12; $x++) {
             $mm = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $mm ] = (string) $mm;
+            $options[(string) $mm] = (string) $mm;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1329,7 +1329,7 @@ 
         $next_decade = $current_year + 10;
         for ($x = $current_year; $x <= $next_decade; $x++) {
             $yy = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ (string) $yy ] = (string) $yy;
+            $options[(string) $yy] = (string) $yy;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1348,7 +1348,7 @@ 
     public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
     {
         $_where = array();
-        if (!empty($status)) {
+        if ( ! empty($status)) {
             $_where['STS_ID'] = $status;
         }
 
@@ -1367,7 +1367,7 @@ 
             );
 
         foreach ($regdtts as $regdtt) {
-            $date = $regdtt->reg_month. ' ' . $regdtt->reg_year;
+            $date = $regdtt->reg_month.' '.$regdtt->reg_year;
             $options[] = array(
                 'text' => $date,
                 'id' => $date
@@ -1397,11 +1397,11 @@ 
             case 'today':
             case null:
             case 'all':
-                $where['Event.status'] = array( 'NOT IN', array('trash') );
+                $where['Event.status'] = array('NOT IN', array('trash'));
                 break;
 
             case 'draft':
-                $where['Event.status'] = array( 'IN', array('draft', 'auto-draft') );
+                $where['Event.status'] = array('IN', array('draft', 'auto-draft'));
 
             default:
                 $where['Event.status'] = $status;
@@ -1412,7 +1412,7 @@ 
         // categories?
 
 
-        if (!empty($evt_category)) {
+        if ( ! empty($evt_category)) {
             $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
             $where['Event.Term_Taxonomy.term_id'] = $evt_category;
         }
@@ -1436,8 +1436,8 @@ 
         global $wp_locale;
 
         foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+            $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year;
+            $id = $DTT->dtt_month.' '.$DTT->dtt_year;
             $options[] = array(
                 'text' => $localized_date,
                 'id' => $id
@@ -1500,10 +1500,10 @@ 
             return $btn;
         }
         $text = ! empty($text) ? $text : __('Submit', 'event_espresso');
-        $btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false) : '';
+        $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" type="submit" value="'.$text.'" '.$extra_attributes.'/>';
+        if ( ! $input_only) {
+            $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">';
+            $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', true, false) : '';
             $btn_frm .= $btn;
             $btn_frm .= '</form>';
             $btn = $btn_frm;

core/helpers/EEH_Formatter.helper.php

Doc Comments +1 added lines

@@ -73,6 +73,7 @@
      * [ee_tep_not_null description]
      *
      * @param  string | array $value [description]
+     * @param string $value
      * @return bool       [description]
      */
     public static function ee_tep_not_null($value)

Indentation +92 added lines, -92 removed lines

@@ -12,108 +12,108 @@
 {
 
 
-    /**
-     * _admin_format_content
-     * Text formatting function for wp_editor.
-     * This should fix all of the formatting issues of text output from the database.
-     *
-     * @static
-     * @access public
-     * @param  string $content content to format
-     * @return string          formatted content
-     */
-    public static function admin_format_content($content = '')
-    {
-        return wpautop(stripslashes_deep(html_entity_decode($content, ENT_QUOTES, "UTF-8")));
-    }
+	/**
+	 * _admin_format_content
+	 * Text formatting function for wp_editor.
+	 * This should fix all of the formatting issues of text output from the database.
+	 *
+	 * @static
+	 * @access public
+	 * @param  string $content content to format
+	 * @return string          formatted content
+	 */
+	public static function admin_format_content($content = '')
+	{
+		return wpautop(stripslashes_deep(html_entity_decode($content, ENT_QUOTES, "UTF-8")));
+	}
 
 
 
-    /**
-     * ee_tep_output_string
-     * todo: we need a description for this.
-     *
-     * @static
-     * @access public
-     * @param  string  $string    string to handle
-     * @param  boolean $translate //todo what is this for?
-     * @param  boolean $protected true then we run htmlspecialchars and return
-     * @return string
-     */
-    public static function ee_tep_output_string($string, $translate = false, $protected = false)
-    {
-        if ($protected === true) {
-            return htmlspecialchars($string);
-        } else {
-            if ($translate === false) {
-                return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
-            } else {
-                return self::ee_tep_parse_input_field_data($string, $translate);
-            }
-        }
-    }
+	/**
+	 * ee_tep_output_string
+	 * todo: we need a description for this.
+	 *
+	 * @static
+	 * @access public
+	 * @param  string  $string    string to handle
+	 * @param  boolean $translate //todo what is this for?
+	 * @param  boolean $protected true then we run htmlspecialchars and return
+	 * @return string
+	 */
+	public static function ee_tep_output_string($string, $translate = false, $protected = false)
+	{
+		if ($protected === true) {
+			return htmlspecialchars($string);
+		} else {
+			if ($translate === false) {
+				return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
+			} else {
+				return self::ee_tep_parse_input_field_data($string, $translate);
+			}
+		}
+	}
 
 
 
-    /**
-     * ee_tep_parse_input_field_data
-     *
-     * @param  string $data string to be "translated"
-     * @param         array ] $parse array in the form array( 'from' => 'to', ... )
-     * @return string
-     */
-    public static function ee_tep_parse_input_field_data($data, $parse)
-    {
-        return strtr(trim($data), $parse);
-    }
+	/**
+	 * ee_tep_parse_input_field_data
+	 *
+	 * @param  string $data string to be "translated"
+	 * @param         array ] $parse array in the form array( 'from' => 'to', ... )
+	 * @return string
+	 */
+	public static function ee_tep_parse_input_field_data($data, $parse)
+	{
+		return strtr(trim($data), $parse);
+	}
 
 
 
-    /**
-     * [ee_tep_not_null description]
-     *
-     * @param  string | array $value [description]
-     * @return bool       [description]
-     */
-    public static function ee_tep_not_null($value)
-    {
-        if (is_array($value)) {
-            if (count($value) > 0) {
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
-                return true;
-            } else {
-                return false;
-            }
-        }
-    }
+	/**
+	 * [ee_tep_not_null description]
+	 *
+	 * @param  string | array $value [description]
+	 * @return bool       [description]
+	 */
+	public static function ee_tep_not_null($value)
+	{
+		if (is_array($value)) {
+			if (count($value) > 0) {
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
+				return true;
+			} else {
+				return false;
+			}
+		}
+	}
 
 
 
-    /**
-     * Formats a date
-     *
-     * @param string $date
-     * @param string $format - format for the date
-     * @deprecated 4.6.12  Note, a search revealed this was not used anywhere in core or in our
-     *                       addons at time of writing this.  So just deprecated in case of third party use.
-     * @return string
-     * @deprecated v4.6.21
-     */
-    public static function event_date_display($date, $format = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'This method is deprecated as of EE 4.6.12.  Currently it does not reformat as with prior behaviour but just returns the incoming string.  Please use the EE_Datetime helpers for Datetime on the event to display as desired.',
-                'event_espresso'
-            ),
-            '4.6.21'
-        );
-        return $date;
-    }
+	/**
+	 * Formats a date
+	 *
+	 * @param string $date
+	 * @param string $format - format for the date
+	 * @deprecated 4.6.12  Note, a search revealed this was not used anywhere in core or in our
+	 *                       addons at time of writing this.  So just deprecated in case of third party use.
+	 * @return string
+	 * @deprecated v4.6.21
+	 */
+	public static function event_date_display($date, $format = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'This method is deprecated as of EE 4.6.12.  Currently it does not reformat as with prior behaviour but just returns the incoming string.  Please use the EE_Datetime helpers for Datetime on the event to display as desired.',
+				'event_espresso'
+			),
+			'4.6.21'
+		);
+		return $date;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
             return htmlspecialchars($string);
         } else {
             if ($translate === false) {
-                return self::ee_tep_parse_input_field_data($string, array( '"' => '"' ));
+                return self::ee_tep_parse_input_field_data($string, array('"' => '"'));
             } else {
                 return self::ee_tep_parse_input_field_data($string, $translate);
             }
@@ -84,7 +84,7 @@ 
                 return false;
             }
         } else {
-            if (( $value !== '' ) && ( strtolower($value) !== 'null' ) && ( strlen(trim($value)) > 0 )) {
+            if (($value !== '') && (strtolower($value) !== 'null') && (strlen(trim($value)) > 0)) {
                 return true;
             } else {
                 return false;

core/helpers/EEH_Inflector.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
 
     /**
      * @param string $word
-     * @return mixed
+     * @return string
      */
     public static function singularize_and_upper($word)
     {
@@ -246,7 +246,7 @@ 
     /**
      * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
      * with the new PSR-based naming conventions
-     * @param $word
+     * @param string $word
      * @return string
      */
     public static function camelize_all_but_first($word)
@@ -401,7 +401,7 @@ 
 
 
     /**
-     * @param $string
+     * @param string $string
      * @return string
      */
     public static function add_indefinite_article($string)

Indentation +378 added lines, -378 removed lines

@@ -33,382 +33,382 @@
  */
 class EEH_Inflector
 {
-    // ------ CLASS METHODS ------ //
-    // ---- Public methods ---- //
-    // {{{ pluralize()
-
-    /**
-     * Just calls self::pluralize and strtolower on $word and returns it
-     * @param string $word
-     * @return string
-     */
-    public static function pluralize_and_lower($word)
-    {
-        return strtolower(self::pluralize($word));
-    }
-
-
-
-    /**
-     * @param string $word
-     * @return mixed
-     */
-    public static function singularize_and_upper($word)
-    {
-        return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
-    }
-
-
-
-    /**
-     * Pluralizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to pluralize
-     * @return string Plural noun
-     */
-    public static function pluralize($word)
-    {
-        $plural = array(
-            '/(quiz)$/i'               => '\1zes',
-            '/^(ox)$/i'                => '\1en',
-            '/([m|l])ouse$/i'          => '\1ice',
-            '/(matr|vert|ind)ix|ex$/i' => '\1ices',
-            '/(x|ch|ss|sh)$/i'         => '\1es',
-            '/([^aeiouy]|qu)ies$/i'    => '\1y',
-            '/([^aeiouy]|qu)y$/i'      => '\1ies',
-            '/(hive)$/i'               => '\1s',
-            '/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
-            '/sis$/i'                  => 'ses',
-            '/([ti])um$/i'             => '\1a',
-            '/(buffal|tomat)o$/i'      => '\1oes',
-            '/(bu)s$/i'                => '\1ses',
-            '/(alias|status)/i'        => '\1es',
-            '/(octop|vir)us$/i'        => '\1i',
-            '/(ax|test)is$/i'          => '\1es',
-            '/s$/i'                    => 's',
-            '/$/'                      => 's');
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-
-        foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ]) ) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
-            }
-        }
-
-        foreach ($plural as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-        return false;
-    }
-
-    // }}}
-    // {{{ singularize()
-
-    /**
-     * Singularizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to singularize
-     * @return string Singular noun.
-     */
-    public static function singularize($word)
-    {
-        $singular = array(
-            '/(quiz)zes$/i'                                                    => '\1',
-            '/(matr)ices$/i'                                                   => '\1ix',
-            '/(vert|ind)ices$/i'                                               => '\1ex',
-            '/^(ox)en/i'                                                       => '\1',
-            '/(alias|status)es$/i'                                             => '\1',
-            '/([octop|vir])i$/i'                                               => '\1us',
-            '/(cris|ax|test)es$/i'                                             => '\1is',
-            '/(shoe)s$/i'                                                      => '\1',
-            '/(o)es$/i'                                                        => '\1',
-            '/(bus)es$/i'                                                      => '\1',
-            '/([m|l])ice$/i'                                                   => '\1ouse',
-            '/(x|ch|ss|sh)es$/i'                                               => '\1',
-            '/(m)ovies$/i'                                                     => '\1ovie',
-            '/(s)eries$/i'                                                     => '\1eries',
-            '/([^aeiouy]|qu)ies$/i'                                            => '\1y',
-            '/([lr])ves$/i'                                                    => '\1f',
-            '/(tive)s$/i'                                                      => '\1',
-            '/(hive)s$/i'                                                      => '\1',
-            '/([^f])ves$/i'                                                    => '\1fe',
-            '/(^analy)ses$/i'                                                  => '\1sis',
-            '/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
-            '/([ti])a$/i'                                                      => '\1um',
-            '/(n)ews$/i'                                                       => '\1ews',
-            '/s$/i'                                                            => '',
-        );
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-        foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
-            }
-        }
-
-        foreach ($singular as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-
-        return $word;
-    }
-
-    // }}}
-    // {{{ titleize()
-
-    /**
-     * Converts an underscored or CamelCase word into a English
-     * sentence.
-     *
-     * The titleize static function converts text like "WelcomePage",
-     * "welcome_page" or  "welcome page" to this "Welcome
-     * Page".
-     * If second parameter is set to 'first' it will only
-     * capitalize the first character of the title.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to format as tile
-     * @param    string    $uppercase    If set to 'first' it will only uppercase the
-     * first character. Otherwise it will uppercase all
-     * the words in the title.
-     * @return string Text formatted as title
-     */
-    public static function titleize($word, $uppercase = '')
-    {
-        $uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
-        return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
-    }
-
-    // }}}
-    // {{{ camelize()
-
-    /**
-     * Returns given word as CamelCased
-     *
-     * Converts a word like "send_email" to "SendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "WhoSOnline"
-     *
-     * @access public
-     * @static
-     * @see variablize
-     * @param    string    $word    Word to convert to camel case
-     * @return string UpperCamelCasedWord
-     */
-    public static function camelize($word)
-    {
-        return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
-    }
-
-
-
-    /**
-     * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
-     * with the new PSR-based naming conventions
-     * @param $word
-     * @return string
-     */
-    public static function camelize_all_but_first($word)
-    {
-        return lcfirst(EEH_Inflector::camelize($word));
-    }
-    // }}}
-    // {{{ underscore()
-
-    /**
-     * Converts a word "into_it_s_underscored_version"
-     *
-     * Convert any "CamelCased" or "ordinary Word" into an
-     * "underscored_word".
-     *
-     * This can be really useful for creating friendly URLs.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to underscore
-     * @return string Underscored word
-     */
-    public static function underscore($word)
-    {
-        return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
-    }
-
-    // }}}
-    // {{{ humanize()
-
-    /**
-     * Returns a human-readable string from $word
-     *
-     * Returns a human-readable string from $word, by replacing
-     * underscores with a space, and by upper-casing the initial
-     * character by default.
-     *
-     * If you need to uppercase all the words you just have to
-     * pass 'all' as a second parameter.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    String to "humanize"
-     * @param    string    $uppercase    If set to 'all' it will uppercase all the words
-     * instead of just the first one.
-     * @return string Human-readable word
-     */
-    public static function humanize($word, $uppercase = '')
-    {
-        // make special exceptions for acronyms
-        $word = str_replace('wp_', 'WP_', $word);
-        $uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
-        return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
-    }
-
-    // }}}
-    // {{{ variablize()
-
-    /**
-     * Same as camelize but first char is underscored
-     *
-     * Converts a word like "send_email" to "sendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "whoSOnline"
-     *
-     * @access public
-     * @static
-     * @see camelize
-     * @param    string    $word    Word to lowerCamelCase
-     * @return string Returns a lowerCamelCasedWord
-     */
-    public static function variablize($word)
-    {
-        $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
-    }
-
-    // }}}
-    // {{{ tableize()
-
-    /**
-     * Converts a class name to its table name according to rails
-     * naming conventions.
-     *
-     * Converts "Person" to "people"
-     *
-     * @access public
-     * @static
-     * @see classify
-     * @param    string    $class_name    Class name for getting related table_name.
-     * @return string plural_table_name
-     */
-    public static function tableize($class_name)
-    {
-        return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
-    }
-
-    // }}}
-    // {{{ classify()
-
-    /**
-     * Converts a table name to its class name according to rails
-     * naming conventions.
-     *
-     * Converts "people" to "Person"
-     *
-     * @access public
-     * @static
-     * @see tableize
-     * @param    string    $table_name    Table name for getting related ClassName.
-     * @return string SingularClassName
-     */
-    public static function classify($table_name)
-    {
-        return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
-    }
-
-    // }}}
-    // {{{ ordinalize()
-
-    /**
-     * Converts number to its ordinal English form.
-     *
-     * This method converts 13 to 13th, 2 to 2nd ...
-     *
-     * @access public
-     * @static
-     * @param    integer    $number    Number to get its ordinal value
-     * @return string Ordinal representation of given string.
-     */
-    public static function ordinalize($number)
-    {
-        if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
-        } else {
-            switch (($number % 10)) {
-                case 1:
-                    return $number . 'st';
-                    break;
-                case 2:
-                    return $number . 'nd';
-                    break;
-                case 3:
-                    return $number . 'rd';
-                default:
-                    return $number . 'th';
-                    break;
-            }
-        }
-    }
-
-
-
-    /**
-     * @param $string
-     * @return string
-     */
-    public static function add_indefinite_article($string)
-    {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+	// ------ CLASS METHODS ------ //
+	// ---- Public methods ---- //
+	// {{{ pluralize()
+
+	/**
+	 * Just calls self::pluralize and strtolower on $word and returns it
+	 * @param string $word
+	 * @return string
+	 */
+	public static function pluralize_and_lower($word)
+	{
+		return strtolower(self::pluralize($word));
+	}
+
+
+
+	/**
+	 * @param string $word
+	 * @return mixed
+	 */
+	public static function singularize_and_upper($word)
+	{
+		return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
+	}
+
+
+
+	/**
+	 * Pluralizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to pluralize
+	 * @return string Plural noun
+	 */
+	public static function pluralize($word)
+	{
+		$plural = array(
+			'/(quiz)$/i'               => '\1zes',
+			'/^(ox)$/i'                => '\1en',
+			'/([m|l])ouse$/i'          => '\1ice',
+			'/(matr|vert|ind)ix|ex$/i' => '\1ices',
+			'/(x|ch|ss|sh)$/i'         => '\1es',
+			'/([^aeiouy]|qu)ies$/i'    => '\1y',
+			'/([^aeiouy]|qu)y$/i'      => '\1ies',
+			'/(hive)$/i'               => '\1s',
+			'/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
+			'/sis$/i'                  => 'ses',
+			'/([ti])um$/i'             => '\1a',
+			'/(buffal|tomat)o$/i'      => '\1oes',
+			'/(bu)s$/i'                => '\1ses',
+			'/(alias|status)/i'        => '\1es',
+			'/(octop|vir)us$/i'        => '\1i',
+			'/(ax|test)is$/i'          => '\1es',
+			'/s$/i'                    => 's',
+			'/$/'                      => 's');
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
+					! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ]) ) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+			}
+		}
+
+		foreach ($plural as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+		return false;
+	}
+
+	// }}}
+	// {{{ singularize()
+
+	/**
+	 * Singularizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to singularize
+	 * @return string Singular noun.
+	 */
+	public static function singularize($word)
+	{
+		$singular = array(
+			'/(quiz)zes$/i'                                                    => '\1',
+			'/(matr)ices$/i'                                                   => '\1ix',
+			'/(vert|ind)ices$/i'                                               => '\1ex',
+			'/^(ox)en/i'                                                       => '\1',
+			'/(alias|status)es$/i'                                             => '\1',
+			'/([octop|vir])i$/i'                                               => '\1us',
+			'/(cris|ax|test)es$/i'                                             => '\1is',
+			'/(shoe)s$/i'                                                      => '\1',
+			'/(o)es$/i'                                                        => '\1',
+			'/(bus)es$/i'                                                      => '\1',
+			'/([m|l])ice$/i'                                                   => '\1ouse',
+			'/(x|ch|ss|sh)es$/i'                                               => '\1',
+			'/(m)ovies$/i'                                                     => '\1ovie',
+			'/(s)eries$/i'                                                     => '\1eries',
+			'/([^aeiouy]|qu)ies$/i'                                            => '\1y',
+			'/([lr])ves$/i'                                                    => '\1f',
+			'/(tive)s$/i'                                                      => '\1',
+			'/(hive)s$/i'                                                      => '\1',
+			'/([^f])ves$/i'                                                    => '\1fe',
+			'/(^analy)ses$/i'                                                  => '\1sis',
+			'/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
+			'/([ti])a$/i'                                                      => '\1um',
+			'/(n)ews$/i'                                                       => '\1ews',
+			'/s$/i'                                                            => '',
+		);
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+			}
+		}
+
+		foreach ($singular as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+
+		return $word;
+	}
+
+	// }}}
+	// {{{ titleize()
+
+	/**
+	 * Converts an underscored or CamelCase word into a English
+	 * sentence.
+	 *
+	 * The titleize static function converts text like "WelcomePage",
+	 * "welcome_page" or  "welcome page" to this "Welcome
+	 * Page".
+	 * If second parameter is set to 'first' it will only
+	 * capitalize the first character of the title.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to format as tile
+	 * @param    string    $uppercase    If set to 'first' it will only uppercase the
+	 * first character. Otherwise it will uppercase all
+	 * the words in the title.
+	 * @return string Text formatted as title
+	 */
+	public static function titleize($word, $uppercase = '')
+	{
+		$uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
+		return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
+	}
+
+	// }}}
+	// {{{ camelize()
+
+	/**
+	 * Returns given word as CamelCased
+	 *
+	 * Converts a word like "send_email" to "SendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "WhoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see variablize
+	 * @param    string    $word    Word to convert to camel case
+	 * @return string UpperCamelCasedWord
+	 */
+	public static function camelize($word)
+	{
+		return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
+	}
+
+
+
+	/**
+	 * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
+	 * with the new PSR-based naming conventions
+	 * @param $word
+	 * @return string
+	 */
+	public static function camelize_all_but_first($word)
+	{
+		return lcfirst(EEH_Inflector::camelize($word));
+	}
+	// }}}
+	// {{{ underscore()
+
+	/**
+	 * Converts a word "into_it_s_underscored_version"
+	 *
+	 * Convert any "CamelCased" or "ordinary Word" into an
+	 * "underscored_word".
+	 *
+	 * This can be really useful for creating friendly URLs.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to underscore
+	 * @return string Underscored word
+	 */
+	public static function underscore($word)
+	{
+		return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
+	}
+
+	// }}}
+	// {{{ humanize()
+
+	/**
+	 * Returns a human-readable string from $word
+	 *
+	 * Returns a human-readable string from $word, by replacing
+	 * underscores with a space, and by upper-casing the initial
+	 * character by default.
+	 *
+	 * If you need to uppercase all the words you just have to
+	 * pass 'all' as a second parameter.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    String to "humanize"
+	 * @param    string    $uppercase    If set to 'all' it will uppercase all the words
+	 * instead of just the first one.
+	 * @return string Human-readable word
+	 */
+	public static function humanize($word, $uppercase = '')
+	{
+		// make special exceptions for acronyms
+		$word = str_replace('wp_', 'WP_', $word);
+		$uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
+		return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
+	}
+
+	// }}}
+	// {{{ variablize()
+
+	/**
+	 * Same as camelize but first char is underscored
+	 *
+	 * Converts a word like "send_email" to "sendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "whoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see camelize
+	 * @param    string    $word    Word to lowerCamelCase
+	 * @return string Returns a lowerCamelCasedWord
+	 */
+	public static function variablize($word)
+	{
+		$word = EEH_Inflector::camelize($word);
+		return strtolower($word[0]) . substr($word, 1);
+	}
+
+	// }}}
+	// {{{ tableize()
+
+	/**
+	 * Converts a class name to its table name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "Person" to "people"
+	 *
+	 * @access public
+	 * @static
+	 * @see classify
+	 * @param    string    $class_name    Class name for getting related table_name.
+	 * @return string plural_table_name
+	 */
+	public static function tableize($class_name)
+	{
+		return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
+	}
+
+	// }}}
+	// {{{ classify()
+
+	/**
+	 * Converts a table name to its class name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "people" to "Person"
+	 *
+	 * @access public
+	 * @static
+	 * @see tableize
+	 * @param    string    $table_name    Table name for getting related ClassName.
+	 * @return string SingularClassName
+	 */
+	public static function classify($table_name)
+	{
+		return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
+	}
+
+	// }}}
+	// {{{ ordinalize()
+
+	/**
+	 * Converts number to its ordinal English form.
+	 *
+	 * This method converts 13 to 13th, 2 to 2nd ...
+	 *
+	 * @access public
+	 * @static
+	 * @param    integer    $number    Number to get its ordinal value
+	 * @return string Ordinal representation of given string.
+	 */
+	public static function ordinalize($number)
+	{
+		if (in_array(($number % 100), range(11, 13))) {
+			return $number . 'th';
+		} else {
+			switch (($number % 10)) {
+				case 1:
+					return $number . 'st';
+					break;
+				case 2:
+					return $number . 'nd';
+					break;
+				case 3:
+					return $number . 'rd';
+				default:
+					return $number . 'th';
+					break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	public static function add_indefinite_article($string)
+	{
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -103,14 +103,14 @@ 
 
         foreach ($uncountable as $_uncountable) {
             if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ]) ) {
+                    ! ctype_alpha($lowercased_word[strlen($lowercased_word) - strlen($_uncountable)])) {
                 return $word;
             }
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+            if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
             }
         }
 
@@ -179,8 +179,8 @@ 
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+            if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
             }
         }
 
@@ -321,7 +321,7 @@ 
     public static function variablize($word)
     {
         $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
+        return strtolower($word[0]).substr($word, 1);
     }
 
     // }}}
@@ -380,19 +380,19 @@ 
     public static function ordinalize($number)
     {
         if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
+            return $number.'th';
         } else {
             switch (($number % 10)) {
                 case 1:
-                    return $number . 'st';
+                    return $number.'st';
                     break;
                 case 2:
-                    return $number . 'nd';
+                    return $number.'nd';
                     break;
                 case 3:
-                    return $number . 'rd';
+                    return $number.'rd';
                 default:
-                    return $number . 'th';
+                    return $number.'th';
                     break;
             }
         }
@@ -409,6 +409,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }

core/helpers/EEH_MSG_Template.helper.php

Doc Comments +4 added lines, -3 removed lines

@@ -131,7 +131,7 @@ 
      * Updates all message templates matching the incoming messengers and message types to active status.
      *
      * @static
-     * @param  array  $messenger_names     Messenger slug
+     * @param  string[]  $messenger_names     Messenger slug
      * @param  array  $message_type_names  Message type slug
      * @return  int                         count of updated records.
      */
@@ -451,6 +451,7 @@ 
      * @param EE_Registration | null $registration  The registration object must be included if this
      *                                              is going to be a registration trigger url.
      * @param string $sending_messenger             The (optional) sending messenger for the url.
+     * @param EE_Registration $registration
      *
      * @return string
      * @throws EE_Error
@@ -1018,8 +1019,8 @@ 
     /**
      * @param \EE_messenger    $messenger
      * @param \EE_message_type $message_type
-     * @param                  $GRP_ID
-     * @param                  $global
+     * @param                  integer $GRP_ID
+     * @param                  boolean $global
      * @return array|mixed
      */
     protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)

Indentation +1227 added lines, -1227 removed lines

@@ -14,1231 +14,1231 @@
 {
 
 
-    /**
-     * Holds a collection of EE_Message_Template_Pack objects.
-     * @type EE_Messages_Template_Pack_Collection
-     */
-    protected static $_template_pack_collection;
-
-
-
-
-    private static function _set_autoloader()
-    {
-        EED_Messages::set_autoloaders();
-    }
-
-
-    /**
-     * generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will automatically create the defaults for the event.  The user would then be redirected to edit the default context for the event.
-     *
-     * @access protected
-     * @param  string $messenger     the messenger we are generating templates for
-     * @param array   $message_types array of message types that the templates are generated for.
-     * @param int     $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID to use as the base for the new generated template.
-     * @param bool    $global        true indicates generating templates on messenger activation. false requires GRP_ID for event specific template generation.
-     * @throws \EE_Error
-     * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array for templates
-     *                that are generated.  If this is an empty array then it means no templates were generated which usually
-     *                means there was an error.  Anything in the array with an empty value for `MTP_context` means that it
-     *                was not a new generated template but just reactivated (which only happens for global templates that
-     *                already exist in the database.
-     */
-    public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        // make sure message_type is an array.
-        $message_types = (array) $message_types;
-        $templates = array();
-
-        if (empty($messenger)) {
-            throw new EE_Error(__('We need a messenger to generate templates!', 'event_espresso'));
-        }
-
-        // if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-        if (empty($message_types)) {
-            throw new EE_Error(__('We need at least one message type to generate templates!', 'event_espresso'));
-        }
-
-        EEH_MSG_Template::_set_autoloader();
-        foreach ($message_types as $message_type) {
-            // if global then let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-            if ($global && empty($GRP_ID)) {
-                $GRP_ID = EEM_Message_Template_Group::instance()->get_one(
-                    array(
-                        array(
-                            'MTP_messenger'    => $messenger,
-                            'MTP_message_type' => $message_type,
-                            'MTP_is_global'    => true,
-                        ),
-                    )
-                );
-                $GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
-            }
-            // if this is global template generation.
-            // First let's determine if we already HAVE global templates for this messenger and message_type combination.
-            //  If we do then NO generation!!
-            if ($global && EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
-                $templates[] = array(
-                    'GRP_ID' => $GRP_ID,
-                    'MTP_context' => '',
-                );
-                // we already have generated templates for this so let's go to the next message type.
-                continue;
-            }
-            $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
-
-            if (! $new_message_template_group) {
-                continue;
-            }
-            $templates[] = $new_message_template_group;
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * The purpose of this method is to determine if there are already generated templates in the database for the given variables.
-     * @param  string $messenger     messenger
-     * @param  string $message_type message type
-     * @param  int $GRP_ID        GRP ID ( if a custom template) (if not provided then we're just doing global template check)
-     * @return bool                true = generated, false = hasn't been generated.
-     */
-    public static function already_generated($messenger, $message_type, $GRP_ID = 0)
-    {
-        EEH_MSG_Template::_set_autoloader();
-        // what method we use depends on whether we have an GRP_ID or not
-        $count = empty($GRP_ID)
-            ? EEM_Message_Template::instance()->count(
-                array(
-                    array(
-                        'Message_Template_Group.MTP_messenger'    => $messenger,
-                        'Message_Template_Group.MTP_message_type' => $message_type,
-                        'Message_Template_Group.MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
-
-        return $count > 0;
-    }
-
-
-
-
-    /**
-     * Updates all message templates matching the incoming messengers and message types to active status.
-     *
-     * @static
-     * @param  array  $messenger_names     Messenger slug
-     * @param  array  $message_type_names  Message type slug
-     * @return  int                         count of updated records.
-     */
-    public static function update_to_active($messenger_names, $message_type_names)
-    {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
-        return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
-            array(
-                array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @static
-     * @param array $messenger_names    The messenger slugs.
-     *                              If empty then all templates matching the message types are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names     The message type slugs.
-     *                              If empty then all templates matching the messengers are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     */
-    public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
-    {
-        return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
-            $messenger_names,
-            $message_type_names
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to return all installed message objects
-     * (messengers and message type regardless of whether they are ACTIVE or not)
-     *
-     * @deprecated 4.9.0
-     * @static
-     * @param string $type
-     * @return array array consisting of installed messenger objects and installed message type objects.
-     */
-    public static function get_installed_message_objects($type = 'all')
-    {
-        self::_set_autoloader();
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return array(
-            'messenger' => $message_resource_manager->installed_messengers(),
-            'message_type' => $message_resource_manager->installed_message_types()
-        );
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the
-     * messenger and message_type objects associated with this
-     * template.
-     *
-     * @since 4.3.0
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param array  $fields    What fields we're returning valid shortcodes for.
-     *                          If empty then we assume all fields are to be returned. Optional.
-     * @param string $context   What context we're going to return shortcodes for. Optional.
-     * @param bool $merged      If TRUE then we don't return shortcodes indexed by field,
-     *                          but instead an array of the unique shortcodes for all the given ( or all) fields.
-     *                          Optional.
-     * @throws \EE_Error
-     * @return mixed (array|bool) an array of shortcodes in the format
-     *                                              array( '[shortcode] => 'label')
-     *                                              OR
-     *                                              FALSE if no shortcodes found.
-     */
-    public static function get_shortcodes(
-        $message_type,
-        $messenger,
-        $fields = array(),
-        $context = 'admin',
-        $merged = false
-    ) {
-        $messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
-        $mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // convert slug to object
-        $messenger = $message_resource_manager->get_messenger($messenger);
-
-        // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
-            return array();
-        }
-
-        // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
-            $msg[] = __('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                __('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        /** @type EE_Messages_Validator $_VLD */
-        $_VLD = new $classname(array(), $context);
-        $valid_shortcodes = $_VLD->get_validators();
-
-        // let's make sure we're only getting the shortcode part of the validators
-        $shortcodes = array();
-        foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
-        }
-        $valid_shortcodes = $shortcodes;
-
-        // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
-            $specified_shortcodes = array();
-            foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
-                }
-            }
-            $valid_shortcodes = $specified_shortcodes;
-        }
-
-        // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
-            // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
-            $field_settings = $messenger->get_template_fields();
-            $localized = array();
-            foreach ($valid_shortcodes as $field => $shortcodes) {
-                // get localized field label
-                if (isset($field_settings[ $field ])) {
-                    // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    } else {
-                        $_field = $field_settings[ $field ]['label'];
-                    }
-                } elseif (isset($field_settings['extra'])) {
-                    // loop through extra "main fields" and see if any of their children have our field
-                    foreach ($field_settings['extra'] as $main_field => $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    }
-                } else {
-                    $_field = $field;
-                }
-                if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
-                }
-            }
-            $valid_shortcodes = $localized;
-        }
-
-        // if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-        if ($merged) {
-            $merged_codes = array();
-            foreach ($valid_shortcodes as $field => $shortcode) {
-                foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
-                        continue;
-                    } else {
-                        $merged_codes[ $code ] = $label;
-                    }
-                }
-            }
-            $valid_shortcodes = $merged_codes;
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    /**
-     * Get Messenger object.
-     *
-     * @since 4.3.0
-     * @deprecated 4.9.0
-     * @param string $messenger messenger slug for the messenger object we want to retrieve.
-     * @throws \EE_Error
-     * @return EE_messenger
-     */
-    public static function messenger_obj($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_messenger($messenger);
-    }
-
-
-    /**
-     * get Message type object
-     *
-     * @since 4.3.0
-     * @deprecated 4.9.0
-     * @param string $message_type the slug for the message type object to retrieve
-     * @throws \EE_Error
-     * @return EE_message_type
-     */
-    public static function message_type_obj($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_message_type($message_type);
-    }
-
-
-
-
-
-    /**
-     * Given a message_type slug, will return whether that message type is active in the system or not.
-     *
-     * @since    4.3.0
-     * @param  string   $message_type message type to check for.
-     * @return boolean
-     */
-    public static function is_mt_active($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts = $Message_Resource_Manager->list_of_active_message_types();
-        return in_array($message_type, $active_mts);
-    }
-
-
-
-    /**
-     * Given a messenger slug, will return whether that messenger is active in the system or not.
-     *
-     * @since    4.3.0
-     *
-     * @param  string  $messenger slug for messenger to check.
-     * @return boolean
-     */
-    public static function is_messenger_active($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
-        return $active_messenger instanceof EE_messenger ? true : false;
-    }
-
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @deprecated 4.9
-     * @since 4.3.1
-     *
-     * @return array
-     */
-    public static function get_active_messengers_in_db()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_active_messengers_option();
-    }
-
-
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @since 4.3.1
-     * @deprecated 4.9.0
-     *
-     * @param array $data_to_save Incoming data to save.
-     *
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public static function update_active_messengers_in_db($data_to_save)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
-    }
-
-
-    /**
-     * This does some validation of incoming params, determines what type of url is being prepped and returns the
-     * appropriate url trigger
-     *
-     * @param EE_message_type $message_type
-     * @param EE_Message $message
-     * @param EE_Registration | null $registration  The registration object must be included if this
-     *                                              is going to be a registration trigger url.
-     * @param string $sending_messenger             The (optional) sending messenger for the url.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_url_trigger(
-        EE_message_type $message_type,
-        EE_Message $message,
-        $registration = null,
-        $sending_messenger = ''
-    ) {
-        // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
-            return EEH_MSG_Template::generate_browser_trigger($message);
-        }
-
-        // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                __('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
-            );
-        }
-
-        // validate given context
-        $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $message->context(),
-                    get_class($message_type)
-                )
-            );
-        }
-
-        // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
-            $with_messengers = $message_type->with_messengers();
-            if (! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ]) ) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                            'event_espresso'
-                        ),
-                        $sending_messenger,
-                        get_class($message_type)
-                    )
-                );
-            }
-        } else {
-            $sending_messenger = $message->messenger();
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $message->messenger(),
-            $message->context(),
-            $message->message_type(),
-            $registration,
-            $message->GRP_ID()
-        );
-    }
-
-
-    /**
-     * This returns the url for triggering a in browser view of a specific EE_Message object.
-     * @param EE_Message $message
-     * @return string.
-     */
-    public static function generate_browser_trigger(EE_Message $message)
-    {
-        $query_args = array(
-            'ee' => 'msg_browser_trigger',
-            'token' => $message->MSG_token()
-        );
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_browser_trigger',
-            add_query_arg($query_args, site_url()),
-            $message
-        );
-    }
-
-
-
-
-
-
-    /**
-     * This returns the url for triggering an in browser view of the error saved on the incoming message object.
-     * @param EE_Message $message
-     * @return string
-     */
-    public static function generate_error_display_trigger(EE_Message $message)
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_error_display_trigger',
-            add_query_arg(
-                array(
-                    'ee' => 'msg_browser_error_trigger',
-                    'token' => $message->MSG_token()
-                ),
-                site_url()
-            ),
-            $message
-        );
-    }
-
-
-
-
-
-
-    /**
-     * This generates a url trigger for the msg_url_trigger route using the given arguments
-     *
-     * @param string          $sending_messenger    The sending messenger slug.
-     * @param string          $generating_messenger The generating messenger slug.
-     * @param string          $context              The context for the template.
-     * @param string          $message_type         The message type slug
-     * @param EE_Registration $registration
-     * @param integer          $message_template_group id   The EE_Message_Template_Group ID for the template.
-     * @param integer          $data_id     The id to the EE_Base_Class for getting the data used by the trigger.
-     * @return string          The generated url.
-     */
-    public static function generate_url_trigger(
-        $sending_messenger,
-        $generating_messenger,
-        $context,
-        $message_type,
-        EE_Registration $registration,
-        $message_template_group,
-        $data_id = 0
-    ) {
-        $query_args = array(
-            'ee' => 'msg_url_trigger',
-            'snd_msgr' => $sending_messenger,
-            'gen_msgr' => $generating_messenger,
-            'message_type' => $message_type,
-            'context' => $context,
-            'token' => $registration->reg_url_link(),
-            'GRP_ID' => $message_template_group,
-            'id' => $data_id
-            );
-        $url = add_query_arg($query_args, get_home_url());
-
-        // made it here so now we can just get the url and filter it.  Filtered globally and by message type.
-        $url = apply_filters(
-            'FHEE__EEH_MSG_Template__generate_url_trigger',
-            $url,
-            $sending_messenger,
-            $generating_messenger,
-            $context,
-            $message_type,
-            $registration,
-            $message_template_group,
-            $data_id
-        );
-        return $url;
-    }
-
-
-
-
-    /**
-     * Return the specific css for the action icon given.
-     *
-     * @since 4.9.0
-     *
-     * @param string $type  What action to return.
-     * @return string
-     */
-    public static function get_message_action_icon($type)
-    {
-        $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : '';
-    }
-
-
-    /**
-     * This is used for retrieving the css classes used for the icons representing message actions.
-     *
-     * @since 4.9.0
-     *
-     * @return array
-     */
-    public static function get_message_action_icons()
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__message_action_icons',
-            array(
-                'view' => array(
-                    'label' => __('View Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-welcome-view-site',
-                ),
-                'error' => array(
-                    'label' => __('View Error Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-info',
-                ),
-                'see_notifications_for' => array(
-                    'label' => __('View Related Messages', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-megaphone',
-                ),
-                'generate_now' => array(
-                    'label' => __('Generate the message now.', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-admin-tools',
-                ),
-                'send_now' => array(
-                    'label' => __('Send Immediately', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-forward',
-                ),
-                'queue_for_resending' => array(
-                    'label' => __('Queue for Resending', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-repeat',
-                ),
-                'view_transaction' => array(
-                    'label' => __('View related Transaction', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-cart',
-                )
-            )
-        );
-    }
-
-
-    /**
-     * This returns the url for a given action related to EE_Message.
-     *
-     * @since 4.9.0
-     *
-     * @param string $type  What type of action to return the url for.
-     * @param EE_Message $message   Required for generating the correct url for some types.
-     * @param array  $query_params   Any additional query params to be included with the generated url.
-     *
-     * @return string
-     */
-    public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
-    {
-        $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
-    }
-
-
-
-    /**
-     * This returns all the current urls for EE_Message actions.
-     *
-     * @since 4.9.0
-     *
-     * @param  EE_Message   $message    The EE_Message object required to generate correct urls for some types.
-     * @param  array    $query_params   Any additional query_params to be included with the generated url.
-     *
-     * @return array
-     */
-    public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
-    {
-        EE_Registry::instance()->load_helper('URL');
-        // if $message is not an instance of EE_Message then let's just do a dummy.
-        $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_url',
-            array(
-                'view' => EEH_MSG_Template::generate_browser_trigger($message),
-                'error' => EEH_MSG_Template::generate_error_display_trigger($message),
-                'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
-                    array_merge(
-                        array(
-                            'page' => 'espresso_messages',
-                            'action' => 'default',
-                            'filterby' => 1,
-                        ),
-                        $query_params
-                    ),
-                    admin_url('admin.php')
-                ),
-                'generate_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'generate_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'send_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'send_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'queue_for_resending',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-            )
-        );
-        if ($message->TXN_ID() > 0
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_default',
-                $message->TXN_ID()
-            )
-        ) {
-            $action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page' => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $message->TXN_ID()
-                ),
-                admin_url('admin.php')
-            );
-        } else {
-            $action_urls['view_transaction'] = '';
-        }
-        return $action_urls;
-    }
-
-
-    /**
-     * This returns a generated link html including the icon used for the action link for EE_Message actions.
-     *
-     * @since 4.9.0
-     *
-     * @param string $type What type of action the link is for (if invalid type is passed in then an
-     *                     empty string is returned)
-     * @param EE_Message|null $message  The EE_Message object (required for some actions to generate correctly)
-     * @param array           $query_params Any extra query params to include in the generated link.
-     *
-     * @return string
-     */
-    public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
-    {
-        $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
-        $icon_css = EEH_MSG_Template::get_message_action_icon($type);
-        $title = isset($icon_css['label']) ? 'title="' . $icon_css['label'] . '"' : '';
-
-        if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
-            return '';
-        }
-
-        $icon_css['css_class'] .= esc_attr(
-            apply_filters(
-                'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-                ' js-ee-message-action-link ee-message-action-link-' . $type,
-                $type,
-                $message,
-                $query_params
-            )
-        );
-
-        return '<a href="' . $url . '"' . $title . '><span class="' . esc_attr($icon_css['css_class']) . '"></span></a>';
-    }
-
-
-
-
-
-    /**
-     * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function reg_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
-            array(
-                EEM_Registration::status_id_approved => 'registration',
-                EEM_Registration::status_id_pending_payment => 'pending_approval',
-                EEM_Registration::status_id_not_approved => 'not_approved_registration',
-                EEM_Registration::status_id_cancelled => 'cancelled_registration',
-                EEM_Registration::status_id_declined => 'declined_registration'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding registration message type slug to the given reg status. If there isn't a
-     * match, then returns an empty string.
-     *
-     * @since 4.9.0
-     * @param $reg_status
-     * @return string
-     */
-    public static function convert_reg_status_to_message_type($reg_status)
-    {
-        $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
-    }
-
-
-    /**
-     * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function payment_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
-            array(
-                EEM_Payment::status_id_approved => 'payment',
-                EEM_Payment::status_id_pending => 'payment_pending',
-                EEM_Payment::status_id_cancelled => 'payment_cancelled',
-                EEM_Payment::status_id_declined => 'payment_declined',
-                EEM_Payment::status_id_failed => 'payment_failed'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
-     * an empty string is returned
-     *
-     * @since 4.9.0
-     * @param $payment_status
-     * @return string
-     */
-    public static function convert_payment_status_to_message_type($payment_status)
-    {
-        $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     *
-     * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
-     *
-     * @return EE_Messages_Template_Pack
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-        }
-
-        // first see if in collection already
-        $template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
-
-        if ($template_pack instanceof EE_Messages_Template_Pack) {
-            return $template_pack;
-        }
-
-        // nope...let's get it.
-        // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-            ' ',
-            '_',
-            ucwords(
-                str_replace('_', ' ', $template_pack_name)
-            )
-        );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
-            return self::get_template_pack('default');
-        } else {
-            $template_pack = new $pack_class_name;
-            self::$_template_pack_collection->add($template_pack);
-            return $template_pack;
-        }
-    }
-
-
-
-
-    /**
-     * Globs template packs installed in core and returns the template pack collection with all installed template packs
-     * in it.
-     *
-     * @since 4.9.0
-     *
-     * @return EE_Messages_Template_Pack_Collection
-     */
-    public static function get_template_pack_collection()
-    {
-        $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-            $new_collection = true;
-        }
-
-        // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
-        foreach ($templates as $template_path) {
-            // grab folder name
-            $template = basename($template_path);
-
-            if (! $new_collection) {
-                // already have it?
-                if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
-                    continue;
-                }
-            }
-
-            // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-                ' ',
-                '_',
-                ucwords(
-                    str_replace(
-                        '_',
-                        ' ',
-                        $template
-                    )
-                )
-            );
-            if (! class_exists($template_pack_class_name)) {
-                continue;
-            }
-            self::$_template_pack_collection->add(new $template_pack_class_name);
-        }
-
-        /**
-         * Filter for plugins to add in any additional template packs
-         * Note the filter name here is for backward compat, this used to be found in EED_Messages.
-         */
-        $additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
-        foreach ((array) $additional_template_packs as $template_pack) {
-            if (self::$_template_pack_collection->get_by_name(
-                $template_pack->dbref
-            ) instanceof EE_Messages_Template_Pack
-            ) {
-                continue;
-            }
-            self::$_template_pack_collection->add($template_pack);
-        }
-        return self::$_template_pack_collection;
-    }
-
-
-
-    /**
-     * This is a wrapper for the protected _create_new_templates function
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name message type that the templates are being created for
-     * @param int    $GRP_ID
-     * @param bool   $global
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
-            return array();
-        }
-        // whew made it this far!  Okay, let's go ahead and create the templates then
-        return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
-    }
-
-
-
-    /**
-     * @param \EE_messenger    $messenger
-     * @param \EE_message_type $message_type
-     * @param                  $GRP_ID
-     * @param                  $global
-     * @return array|mixed
-     */
-    protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
-    {
-        // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
-            return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
-        }
-        /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
-        $Message_Template_Defaults = EE_Registry::factory(
-            'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
-        );
-        // generate templates
-        $success = $Message_Template_Defaults->create_new_templates();
-
-        // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
-        // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
-        // attempts.
-        if (! $success) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
-        }
-
-        /**
-         * $success is in an array in the following format
-         * array(
-         *    'GRP_ID' => $new_grp_id,
-         *    'MTP_context' => $first_context_in_new_templates,
-         * )
-         */
-        return $success;
-    }
-
-
-
-    /**
-     * This creates a custom template using the incoming GRP_ID
-     *
-     * @param \EE_messenger    $messenger
-     * @param \EE_message_type $message_type
-     * @param  int             $GRP_ID      GRP_ID for the template_group being used as the base
-     * @return  array $success              This will be an array in the format:
-     *                                      array(
-     *                                          'GRP_ID' => $new_grp_id,
-     *                                          'MTP_context' => $first_context_in_created_template
-     *                                      )
-     * @access private
-     */
-    private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
-    {
-        // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
-        // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-        $Message_Template_Group = empty($GRP_ID)
-            ? EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $messenger->name,
-                        'MTP_message_type' => $message_type->name,
-                        'MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-        // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
-                        'event_espresso'
-                    ),
-                    $GRP_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return $success;
-        }
-        // let's get all the related message_template objects for this group.
-        $message_templates = $Message_Template_Group->message_templates();
-        // now we have what we need to setup the new template
-        $new_mtg = clone $Message_Template_Group;
-        $new_mtg->set('GRP_ID', 0);
-        $new_mtg->set('MTP_is_global', false);
-        $template_name = defined('DOING_AJAX') && ! empty($_POST['templateName'])
-            ? $_POST['templateName']
-            : __(
-                'New Custom Template',
-                'event_espresso'
-            );
-        $template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription'])
-            ? $_POST['templateDescription']
-            : sprintf(
-                __(
-                    'This is a custom template that was created for the %s messenger and %s message type.',
-                    'event_espresso'
-                ),
-                $new_mtg->messenger_obj()->label['singular'],
-                $new_mtg->message_type_obj()->label['singular']
-            );
-        $new_mtg->set('MTP_name', $template_name);
-        $new_mtg->set('MTP_description', $template_description);
-        // remove ALL relations on this template group so they don't get saved!
-        $new_mtg->_remove_relations('Message_Template');
-        $new_mtg->save();
-        $success['GRP_ID'] = $new_mtg->ID();
-        $success['template_name'] = $template_name;
-        // add new message templates and add relation to.
-        foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
-                continue;
-            }
-            $new_message_template = clone $message_template;
-            $new_message_template->set('MTP_ID', 0);
-            $new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
-            $new_message_template->save();
-            if (empty($success['MTP_context'])) {
-                $success['MTP_context'] = $new_message_template->get('MTP_context');
-            }
-        }
-        return $success;
-    }
-
-
-
-    /**
-     * message_type_has_active_templates_for_messenger
-     *
-     * @param \EE_messenger    $messenger
-     * @param \EE_message_type $message_type
-     * @param bool             $global
-     * @return bool
-     */
-    public static function message_type_has_active_templates_for_messenger(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $global = false
-    ) {
-        // is given message_type valid for given messenger (if this is not a global save)
-        if ($global) {
-            return true;
-        }
-        $active_templates = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'MTP_is_active'    => true,
-                    'MTP_messenger'    => $messenger->name,
-                    'MTP_message_type' => $message_type->name
-                )
-            )
-        );
-        if ($active_templates > 0) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                __(
-                    'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
-                    'event_espresso'
-                ),
-                $message_type->name,
-                $messenger->name
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-
-    /**
-     * get_fields
-     * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
-     *
-     * @param  string $messenger_name    name of EE_messenger
-     * @param  string $message_type_name name of EE_message_type
-     * @return array
-     */
-    public static function get_fields($messenger_name, $message_type_name)
-    {
-        $template_fields = array();
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
-            return array();
-        }
-
-        $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
-
-        // okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-        foreach ($message_type->get_contexts() as $context => $details) {
-            foreach ($messenger->get_template_fields() as $field => $value) {
-                if (in_array($field, $excluded_fields_for_messenger, true)) {
-                    continue;
-                }
-                $template_fields[ $context ][ $field ] = $value;
-            }
-        }
-        if (empty($template_fields)) {
-            EE_Error::add_error(
-                __('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return array();
-        }
-        return $template_fields;
-    }
+	/**
+	 * Holds a collection of EE_Message_Template_Pack objects.
+	 * @type EE_Messages_Template_Pack_Collection
+	 */
+	protected static $_template_pack_collection;
+
+
+
+
+	private static function _set_autoloader()
+	{
+		EED_Messages::set_autoloaders();
+	}
+
+
+	/**
+	 * generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will automatically create the defaults for the event.  The user would then be redirected to edit the default context for the event.
+	 *
+	 * @access protected
+	 * @param  string $messenger     the messenger we are generating templates for
+	 * @param array   $message_types array of message types that the templates are generated for.
+	 * @param int     $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID to use as the base for the new generated template.
+	 * @param bool    $global        true indicates generating templates on messenger activation. false requires GRP_ID for event specific template generation.
+	 * @throws \EE_Error
+	 * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array for templates
+	 *                that are generated.  If this is an empty array then it means no templates were generated which usually
+	 *                means there was an error.  Anything in the array with an empty value for `MTP_context` means that it
+	 *                was not a new generated template but just reactivated (which only happens for global templates that
+	 *                already exist in the database.
+	 */
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+		// make sure message_type is an array.
+		$message_types = (array) $message_types;
+		$templates = array();
+
+		if (empty($messenger)) {
+			throw new EE_Error(__('We need a messenger to generate templates!', 'event_espresso'));
+		}
+
+		// if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
+		if (empty($message_types)) {
+			throw new EE_Error(__('We need at least one message type to generate templates!', 'event_espresso'));
+		}
+
+		EEH_MSG_Template::_set_autoloader();
+		foreach ($message_types as $message_type) {
+			// if global then let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
+			if ($global && empty($GRP_ID)) {
+				$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
+					array(
+						array(
+							'MTP_messenger'    => $messenger,
+							'MTP_message_type' => $message_type,
+							'MTP_is_global'    => true,
+						),
+					)
+				);
+				$GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
+			}
+			// if this is global template generation.
+			// First let's determine if we already HAVE global templates for this messenger and message_type combination.
+			//  If we do then NO generation!!
+			if ($global && EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
+				$templates[] = array(
+					'GRP_ID' => $GRP_ID,
+					'MTP_context' => '',
+				);
+				// we already have generated templates for this so let's go to the next message type.
+				continue;
+			}
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
+
+			if (! $new_message_template_group) {
+				continue;
+			}
+			$templates[] = $new_message_template_group;
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * The purpose of this method is to determine if there are already generated templates in the database for the given variables.
+	 * @param  string $messenger     messenger
+	 * @param  string $message_type message type
+	 * @param  int $GRP_ID        GRP ID ( if a custom template) (if not provided then we're just doing global template check)
+	 * @return bool                true = generated, false = hasn't been generated.
+	 */
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0)
+	{
+		EEH_MSG_Template::_set_autoloader();
+		// what method we use depends on whether we have an GRP_ID or not
+		$count = empty($GRP_ID)
+			? EEM_Message_Template::instance()->count(
+				array(
+					array(
+						'Message_Template_Group.MTP_messenger'    => $messenger,
+						'Message_Template_Group.MTP_message_type' => $message_type,
+						'Message_Template_Group.MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+
+		return $count > 0;
+	}
+
+
+
+
+	/**
+	 * Updates all message templates matching the incoming messengers and message types to active status.
+	 *
+	 * @static
+	 * @param  array  $messenger_names     Messenger slug
+	 * @param  array  $message_type_names  Message type slug
+	 * @return  int                         count of updated records.
+	 */
+	public static function update_to_active($messenger_names, $message_type_names)
+	{
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+		return EEM_Message_Template_Group::instance()->update(
+			array( 'MTP_is_active' => 1 ),
+			array(
+				array(
+					'MTP_messenger'     => array( 'IN', $messenger_names ),
+					'MTP_message_type'  => array( 'IN', $message_type_names )
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @static
+	 * @param array $messenger_names    The messenger slugs.
+	 *                              If empty then all templates matching the message types are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names     The message type slugs.
+	 *                              If empty then all templates matching the messengers are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 */
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
+	{
+		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
+			$messenger_names,
+			$message_type_names
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to return all installed message objects
+	 * (messengers and message type regardless of whether they are ACTIVE or not)
+	 *
+	 * @deprecated 4.9.0
+	 * @static
+	 * @param string $type
+	 * @return array array consisting of installed messenger objects and installed message type objects.
+	 */
+	public static function get_installed_message_objects($type = 'all')
+	{
+		self::_set_autoloader();
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return array(
+			'messenger' => $message_resource_manager->installed_messengers(),
+			'message_type' => $message_resource_manager->installed_message_types()
+		);
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the
+	 * messenger and message_type objects associated with this
+	 * template.
+	 *
+	 * @since 4.3.0
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param array  $fields    What fields we're returning valid shortcodes for.
+	 *                          If empty then we assume all fields are to be returned. Optional.
+	 * @param string $context   What context we're going to return shortcodes for. Optional.
+	 * @param bool $merged      If TRUE then we don't return shortcodes indexed by field,
+	 *                          but instead an array of the unique shortcodes for all the given ( or all) fields.
+	 *                          Optional.
+	 * @throws \EE_Error
+	 * @return mixed (array|bool) an array of shortcodes in the format
+	 *                                              array( '[shortcode] => 'label')
+	 *                                              OR
+	 *                                              FALSE if no shortcodes found.
+	 */
+	public static function get_shortcodes(
+		$message_type,
+		$messenger,
+		$fields = array(),
+		$context = 'admin',
+		$merged = false
+	) {
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// convert slug to object
+		$messenger = $message_resource_manager->get_messenger($messenger);
+
+		// if messenger isn't a EE_messenger resource then bail.
+		if (! $messenger instanceof EE_messenger) {
+			return array();
+		}
+
+		// validate class for getting our list of shortcodes
+		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
+		if (! class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		/** @type EE_Messages_Validator $_VLD */
+		$_VLD = new $classname(array(), $context);
+		$valid_shortcodes = $_VLD->get_validators();
+
+		// let's make sure we're only getting the shortcode part of the validators
+		$shortcodes = array();
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[ $field ] = $validators['shortcodes'];
+		}
+		$valid_shortcodes = $shortcodes;
+
+		// if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
+		if (! empty($fields)) {
+			$specified_shortcodes = array();
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[ $field ])) {
+					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+				}
+			}
+			$valid_shortcodes = $specified_shortcodes;
+		}
+
+		// if not merged then let's replace the fields with the localized fields
+		if (! $merged) {
+			// let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
+			$field_settings = $messenger->get_template_fields();
+			$localized = array();
+			foreach ($valid_shortcodes as $field => $shortcodes) {
+				// get localized field label
+				if (isset($field_settings[ $field ])) {
+					// possible that this is used as a main field.
+					if (empty($field_settings[ $field ])) {
+						if (isset($field_settings['extra'][ $field ])) {
+							$_field = $field_settings['extra'][ $field ]['main']['label'];
+						} else {
+							$_field = $field;
+						}
+					} else {
+						$_field = $field_settings[ $field ]['label'];
+					}
+				} elseif (isset($field_settings['extra'])) {
+					// loop through extra "main fields" and see if any of their children have our field
+					foreach ($field_settings['extra'] as $main_field => $fields) {
+						if (isset($fields[ $field ])) {
+							$_field = $fields[ $field ]['label'];
+						} else {
+							$_field = $field;
+						}
+					}
+				} else {
+					$_field = $field;
+				}
+				if (isset($_field)) {
+					$localized[ (string) $_field ] = $shortcodes;
+				}
+			}
+			$valid_shortcodes = $localized;
+		}
+
+		// if $merged then let's merge all the shortcodes into one list NOT indexed by field.
+		if ($merged) {
+			$merged_codes = array();
+			foreach ($valid_shortcodes as $field => $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[ $code ])) {
+						continue;
+					} else {
+						$merged_codes[ $code ] = $label;
+					}
+				}
+			}
+			$valid_shortcodes = $merged_codes;
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	/**
+	 * Get Messenger object.
+	 *
+	 * @since 4.3.0
+	 * @deprecated 4.9.0
+	 * @param string $messenger messenger slug for the messenger object we want to retrieve.
+	 * @throws \EE_Error
+	 * @return EE_messenger
+	 */
+	public static function messenger_obj($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
+	}
+
+
+	/**
+	 * get Message type object
+	 *
+	 * @since 4.3.0
+	 * @deprecated 4.9.0
+	 * @param string $message_type the slug for the message type object to retrieve
+	 * @throws \EE_Error
+	 * @return EE_message_type
+	 */
+	public static function message_type_obj($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
+	}
+
+
+
+
+
+	/**
+	 * Given a message_type slug, will return whether that message type is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 * @param  string   $message_type message type to check for.
+	 * @return boolean
+	 */
+	public static function is_mt_active($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
+		return in_array($message_type, $active_mts);
+	}
+
+
+
+	/**
+	 * Given a messenger slug, will return whether that messenger is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param  string  $messenger slug for messenger to check.
+	 * @return boolean
+	 */
+	public static function is_messenger_active($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
+		return $active_messenger instanceof EE_messenger ? true : false;
+	}
+
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @deprecated 4.9
+	 * @since 4.3.1
+	 *
+	 * @return array
+	 */
+	public static function get_active_messengers_in_db()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_active_messengers_option();
+	}
+
+
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @since 4.3.1
+	 * @deprecated 4.9.0
+	 *
+	 * @param array $data_to_save Incoming data to save.
+	 *
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public static function update_active_messengers_in_db($data_to_save)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
+	}
+
+
+	/**
+	 * This does some validation of incoming params, determines what type of url is being prepped and returns the
+	 * appropriate url trigger
+	 *
+	 * @param EE_message_type $message_type
+	 * @param EE_Message $message
+	 * @param EE_Registration | null $registration  The registration object must be included if this
+	 *                                              is going to be a registration trigger url.
+	 * @param string $sending_messenger             The (optional) sending messenger for the url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_url_trigger(
+		EE_message_type $message_type,
+		EE_Message $message,
+		$registration = null,
+		$sending_messenger = ''
+	) {
+		// first determine if the url can be to the EE_Message object.
+		if (! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
+		}
+
+		// if $registration object is not valid then exit early because there's nothing that can be generated.
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
+			);
+		}
+
+		// validate given context
+		$contexts = $message_type->get_contexts();
+		if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$message->context(),
+					get_class($message_type)
+				)
+			);
+		}
+
+		// valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
+		if (! empty($sending_messenger)) {
+			$with_messengers = $message_type->with_messengers();
+			if (! isset($with_messengers[ $message->messenger() ])
+				 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ]) ) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+							'event_espresso'
+						),
+						$sending_messenger,
+						get_class($message_type)
+					)
+				);
+			}
+		} else {
+			$sending_messenger = $message->messenger();
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$message->messenger(),
+			$message->context(),
+			$message->message_type(),
+			$registration,
+			$message->GRP_ID()
+		);
+	}
+
+
+	/**
+	 * This returns the url for triggering a in browser view of a specific EE_Message object.
+	 * @param EE_Message $message
+	 * @return string.
+	 */
+	public static function generate_browser_trigger(EE_Message $message)
+	{
+		$query_args = array(
+			'ee' => 'msg_browser_trigger',
+			'token' => $message->MSG_token()
+		);
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_browser_trigger',
+			add_query_arg($query_args, site_url()),
+			$message
+		);
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the url for triggering an in browser view of the error saved on the incoming message object.
+	 * @param EE_Message $message
+	 * @return string
+	 */
+	public static function generate_error_display_trigger(EE_Message $message)
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
+			add_query_arg(
+				array(
+					'ee' => 'msg_browser_error_trigger',
+					'token' => $message->MSG_token()
+				),
+				site_url()
+			),
+			$message
+		);
+	}
+
+
+
+
+
+
+	/**
+	 * This generates a url trigger for the msg_url_trigger route using the given arguments
+	 *
+	 * @param string          $sending_messenger    The sending messenger slug.
+	 * @param string          $generating_messenger The generating messenger slug.
+	 * @param string          $context              The context for the template.
+	 * @param string          $message_type         The message type slug
+	 * @param EE_Registration $registration
+	 * @param integer          $message_template_group id   The EE_Message_Template_Group ID for the template.
+	 * @param integer          $data_id     The id to the EE_Base_Class for getting the data used by the trigger.
+	 * @return string          The generated url.
+	 */
+	public static function generate_url_trigger(
+		$sending_messenger,
+		$generating_messenger,
+		$context,
+		$message_type,
+		EE_Registration $registration,
+		$message_template_group,
+		$data_id = 0
+	) {
+		$query_args = array(
+			'ee' => 'msg_url_trigger',
+			'snd_msgr' => $sending_messenger,
+			'gen_msgr' => $generating_messenger,
+			'message_type' => $message_type,
+			'context' => $context,
+			'token' => $registration->reg_url_link(),
+			'GRP_ID' => $message_template_group,
+			'id' => $data_id
+			);
+		$url = add_query_arg($query_args, get_home_url());
+
+		// made it here so now we can just get the url and filter it.  Filtered globally and by message type.
+		$url = apply_filters(
+			'FHEE__EEH_MSG_Template__generate_url_trigger',
+			$url,
+			$sending_messenger,
+			$generating_messenger,
+			$context,
+			$message_type,
+			$registration,
+			$message_template_group,
+			$data_id
+		);
+		return $url;
+	}
+
+
+
+
+	/**
+	 * Return the specific css for the action icon given.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param string $type  What action to return.
+	 * @return string
+	 */
+	public static function get_message_action_icon($type)
+	{
+		$action_icons = self::get_message_action_icons();
+		return isset($action_icons[ $type ]) ? $action_icons[ $type ] : '';
+	}
+
+
+	/**
+	 * This is used for retrieving the css classes used for the icons representing message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return array
+	 */
+	public static function get_message_action_icons()
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__message_action_icons',
+			array(
+				'view' => array(
+					'label' => __('View Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-welcome-view-site',
+				),
+				'error' => array(
+					'label' => __('View Error Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-info',
+				),
+				'see_notifications_for' => array(
+					'label' => __('View Related Messages', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-megaphone',
+				),
+				'generate_now' => array(
+					'label' => __('Generate the message now.', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-admin-tools',
+				),
+				'send_now' => array(
+					'label' => __('Send Immediately', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-forward',
+				),
+				'queue_for_resending' => array(
+					'label' => __('Queue for Resending', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-repeat',
+				),
+				'view_transaction' => array(
+					'label' => __('View related Transaction', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-cart',
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns the url for a given action related to EE_Message.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param string $type  What type of action to return the url for.
+	 * @param EE_Message $message   Required for generating the correct url for some types.
+	 * @param array  $query_params   Any additional query params to be included with the generated url.
+	 *
+	 * @return string
+	 */
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
+	{
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+	}
+
+
+
+	/**
+	 * This returns all the current urls for EE_Message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param  EE_Message   $message    The EE_Message object required to generate correct urls for some types.
+	 * @param  array    $query_params   Any additional query_params to be included with the generated url.
+	 *
+	 * @return array
+	 */
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
+	{
+		EE_Registry::instance()->load_helper('URL');
+		// if $message is not an instance of EE_Message then let's just do a dummy.
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls =  apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_url',
+			array(
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
+				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
+					array_merge(
+						array(
+							'page' => 'espresso_messages',
+							'action' => 'default',
+							'filterby' => 1,
+						),
+						$query_params
+					),
+					admin_url('admin.php')
+				),
+				'generate_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'generate_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'send_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'send_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'queue_for_resending',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+			)
+		);
+		if ($message->TXN_ID() > 0
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_default',
+				$message->TXN_ID()
+			)
+		) {
+			$action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
+				array(
+					'page' => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $message->TXN_ID()
+				),
+				admin_url('admin.php')
+			);
+		} else {
+			$action_urls['view_transaction'] = '';
+		}
+		return $action_urls;
+	}
+
+
+	/**
+	 * This returns a generated link html including the icon used for the action link for EE_Message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param string $type What type of action the link is for (if invalid type is passed in then an
+	 *                     empty string is returned)
+	 * @param EE_Message|null $message  The EE_Message object (required for some actions to generate correctly)
+	 * @param array           $query_params Any extra query params to include in the generated link.
+	 *
+	 * @return string
+	 */
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
+	{
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$title = isset($icon_css['label']) ? 'title="' . $icon_css['label'] . '"' : '';
+
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
+			return '';
+		}
+
+		$icon_css['css_class'] .= esc_attr(
+			apply_filters(
+				'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
+				' js-ee-message-action-link ee-message-action-link-' . $type,
+				$type,
+				$message,
+				$query_params
+			)
+		);
+
+		return '<a href="' . $url . '"' . $title . '><span class="' . esc_attr($icon_css['css_class']) . '"></span></a>';
+	}
+
+
+
+
+
+	/**
+	 * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function reg_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
+			array(
+				EEM_Registration::status_id_approved => 'registration',
+				EEM_Registration::status_id_pending_payment => 'pending_approval',
+				EEM_Registration::status_id_not_approved => 'not_approved_registration',
+				EEM_Registration::status_id_cancelled => 'cancelled_registration',
+				EEM_Registration::status_id_declined => 'declined_registration'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding registration message type slug to the given reg status. If there isn't a
+	 * match, then returns an empty string.
+	 *
+	 * @since 4.9.0
+	 * @param $reg_status
+	 * @return string
+	 */
+	public static function convert_reg_status_to_message_type($reg_status)
+	{
+		$reg_status_array = self::reg_status_to_message_type_array();
+		return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+	}
+
+
+	/**
+	 * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function payment_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
+			array(
+				EEM_Payment::status_id_approved => 'payment',
+				EEM_Payment::status_id_pending => 'payment_pending',
+				EEM_Payment::status_id_cancelled => 'payment_cancelled',
+				EEM_Payment::status_id_declined => 'payment_declined',
+				EEM_Payment::status_id_failed => 'payment_failed'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
+	 * an empty string is returned
+	 *
+	 * @since 4.9.0
+	 * @param $payment_status
+	 * @return string
+	 */
+	public static function convert_payment_status_to_message_type($payment_status)
+	{
+		$payment_status_array = self::payment_status_to_message_type_array();
+		return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 *
+	 * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
+	 *
+	 * @return EE_Messages_Template_Pack
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+		}
+
+		// first see if in collection already
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
+
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
+			return $template_pack;
+		}
+
+		// nope...let's get it.
+		// not set yet so let's attempt to get it.
+		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			' ',
+			'_',
+			ucwords(
+				str_replace('_', ' ', $template_pack_name)
+			)
+		);
+		if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
+		} else {
+			$template_pack = new $pack_class_name;
+			self::$_template_pack_collection->add($template_pack);
+			return $template_pack;
+		}
+	}
+
+
+
+
+	/**
+	 * Globs template packs installed in core and returns the template pack collection with all installed template packs
+	 * in it.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return EE_Messages_Template_Pack_Collection
+	 */
+	public static function get_template_pack_collection()
+	{
+		$new_collection = false;
+		if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+			$new_collection = true;
+		}
+
+		// glob the defaults directory for messages
+		$templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
+			// grab folder name
+			$template = basename($template_path);
+
+			if (! $new_collection) {
+				// already have it?
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
+					continue;
+				}
+			}
+
+			// setup classname.
+			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+				' ',
+				'_',
+				ucwords(
+					str_replace(
+						'_',
+						' ',
+						$template
+					)
+				)
+			);
+			if (! class_exists($template_pack_class_name)) {
+				continue;
+			}
+			self::$_template_pack_collection->add(new $template_pack_class_name);
+		}
+
+		/**
+		 * Filter for plugins to add in any additional template packs
+		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
+		 */
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if (self::$_template_pack_collection->get_by_name(
+				$template_pack->dbref
+			) instanceof EE_Messages_Template_Pack
+			) {
+				continue;
+			}
+			self::$_template_pack_collection->add($template_pack);
+		}
+		return self::$_template_pack_collection;
+	}
+
+
+
+	/**
+	 * This is a wrapper for the protected _create_new_templates function
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name message type that the templates are being created for
+	 * @param int    $GRP_ID
+	 * @param bool   $global
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+			return array();
+		}
+		// whew made it this far!  Okay, let's go ahead and create the templates then
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
+	}
+
+
+
+	/**
+	 * @param \EE_messenger    $messenger
+	 * @param \EE_message_type $message_type
+	 * @param                  $GRP_ID
+	 * @param                  $global
+	 * @return array|mixed
+	 */
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
+	{
+		// if we're creating a custom template then we don't need to use the defaults class
+		if (! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
+		}
+		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
+		$Message_Template_Defaults = EE_Registry::factory(
+			'EE_Messages_Template_Defaults',
+			array( $messenger, $message_type, $GRP_ID )
+		);
+		// generate templates
+		$success = $Message_Template_Defaults->create_new_templates();
+
+		// if creating the template failed.  Then we should deactivate the related message_type for the messenger because
+		// its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
+		// attempts.
+		if (! $success) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
+		}
+
+		/**
+		 * $success is in an array in the following format
+		 * array(
+		 *    'GRP_ID' => $new_grp_id,
+		 *    'MTP_context' => $first_context_in_new_templates,
+		 * )
+		 */
+		return $success;
+	}
+
+
+
+	/**
+	 * This creates a custom template using the incoming GRP_ID
+	 *
+	 * @param \EE_messenger    $messenger
+	 * @param \EE_message_type $message_type
+	 * @param  int             $GRP_ID      GRP_ID for the template_group being used as the base
+	 * @return  array $success              This will be an array in the format:
+	 *                                      array(
+	 *                                          'GRP_ID' => $new_grp_id,
+	 *                                          'MTP_context' => $first_context_in_created_template
+	 *                                      )
+	 * @access private
+	 */
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
+	{
+		// defaults
+		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		// get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
+		$Message_Template_Group = empty($GRP_ID)
+			? EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $messenger->name,
+						'MTP_message_type' => $message_type->name,
+						'MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		// if we don't have a mtg at this point then we need to bail.
+		if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
+						'event_espresso'
+					),
+					$GRP_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return $success;
+		}
+		// let's get all the related message_template objects for this group.
+		$message_templates = $Message_Template_Group->message_templates();
+		// now we have what we need to setup the new template
+		$new_mtg = clone $Message_Template_Group;
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+		$template_name = defined('DOING_AJAX') && ! empty($_POST['templateName'])
+			? $_POST['templateName']
+			: __(
+				'New Custom Template',
+				'event_espresso'
+			);
+		$template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription'])
+			? $_POST['templateDescription']
+			: sprintf(
+				__(
+					'This is a custom template that was created for the %s messenger and %s message type.',
+					'event_espresso'
+				),
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
+			);
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
+		// remove ALL relations on this template group so they don't get saved!
+		$new_mtg->_remove_relations('Message_Template');
+		$new_mtg->save();
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
+		// add new message templates and add relation to.
+		foreach ($message_templates as $message_template) {
+			if (! $message_template instanceof EE_Message_Template) {
+				continue;
+			}
+			$new_message_template = clone $message_template;
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
+			$new_message_template->save();
+			if (empty($success['MTP_context'])) {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
+			}
+		}
+		return $success;
+	}
+
+
+
+	/**
+	 * message_type_has_active_templates_for_messenger
+	 *
+	 * @param \EE_messenger    $messenger
+	 * @param \EE_message_type $message_type
+	 * @param bool             $global
+	 * @return bool
+	 */
+	public static function message_type_has_active_templates_for_messenger(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$global = false
+	) {
+		// is given message_type valid for given messenger (if this is not a global save)
+		if ($global) {
+			return true;
+		}
+		$active_templates = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'MTP_is_active'    => true,
+					'MTP_messenger'    => $messenger->name,
+					'MTP_message_type' => $message_type->name
+				)
+			)
+		);
+		if ($active_templates > 0) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				__(
+					'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
+					'event_espresso'
+				),
+				$message_type->name,
+				$messenger->name
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+
+	/**
+	 * get_fields
+	 * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
+	 *
+	 * @param  string $messenger_name    name of EE_messenger
+	 * @param  string $message_type_name name of EE_message_type
+	 * @return array
+	 */
+	public static function get_fields($messenger_name, $message_type_name)
+	{
+		$template_fields = array();
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+			return array();
+		}
+
+		$excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
+
+		// okay now let's assemble an array with the messenger template fields added to the message_type contexts.
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
+				if (in_array($field, $excluded_fields_for_messenger, true)) {
+					continue;
+				}
+				$template_fields[ $context ][ $field ] = $value;
+			}
+		}
+		if (empty($template_fields)) {
+			EE_Error::add_error(
+				__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return array();
+		}
+		return $template_fields;
+	}
 }

Spacing +56 added lines, -56 removed lines

@@ -88,7 +88,7 @@ 
             }
             $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
 
-            if (! $new_message_template_group) {
+            if ( ! $new_message_template_group) {
                 continue;
             }
             $templates[] = $new_message_template_group;
@@ -119,7 +119,7 @@ 
                     )
                 )
             )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+            : EEM_Message_Template::instance()->count(array(array('GRP_ID' => $GRP_ID)));
 
         return $count > 0;
     }
@@ -137,14 +137,14 @@ 
      */
     public static function update_to_active($messenger_names, $message_type_names)
     {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+        $messenger_names = is_array($messenger_names) ? $messenger_names : array($messenger_names);
+        $message_type_names = is_array($message_type_names) ? $message_type_names : array($message_type_names);
         return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
+            array('MTP_is_active' => 1),
             array(
                 array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
+                    'MTP_messenger'     => array('IN', $messenger_names),
+                    'MTP_message_type'  => array('IN', $message_type_names)
                 )
             )
         );
@@ -230,13 +230,13 @@ 
         $messenger = $message_resource_manager->get_messenger($messenger);
 
         // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
+        if ( ! $messenger instanceof EE_messenger) {
             return array();
         }
 
         // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
+        $classname = 'EE_Messages_'.$messenger_name.'_'.$mt_name.'_Validator';
+        if ( ! class_exists($classname)) {
             $msg[] = __('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 __('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
@@ -252,44 +252,44 @@ 
         // let's make sure we're only getting the shortcode part of the validators
         $shortcodes = array();
         foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
+            $shortcodes[$field] = $validators['shortcodes'];
         }
         $valid_shortcodes = $shortcodes;
 
         // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
+        if ( ! empty($fields)) {
             $specified_shortcodes = array();
             foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+                if (isset($valid_shortcodes[$field])) {
+                    $specified_shortcodes[$field] = $valid_shortcodes[$field];
                 }
             }
             $valid_shortcodes = $specified_shortcodes;
         }
 
         // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
+        if ( ! $merged) {
             // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
             $field_settings = $messenger->get_template_fields();
             $localized = array();
             foreach ($valid_shortcodes as $field => $shortcodes) {
                 // get localized field label
-                if (isset($field_settings[ $field ])) {
+                if (isset($field_settings[$field])) {
                     // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
+                    if (empty($field_settings[$field])) {
+                        if (isset($field_settings['extra'][$field])) {
+                            $_field = $field_settings['extra'][$field]['main']['label'];
                         } else {
                             $_field = $field;
                         }
                     } else {
-                        $_field = $field_settings[ $field ]['label'];
+                        $_field = $field_settings[$field]['label'];
                     }
                 } elseif (isset($field_settings['extra'])) {
                     // loop through extra "main fields" and see if any of their children have our field
                     foreach ($field_settings['extra'] as $main_field => $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
+                        if (isset($fields[$field])) {
+                            $_field = $fields[$field]['label'];
                         } else {
                             $_field = $field;
                         }
@@ -298,7 +298,7 @@ 
                     $_field = $field;
                 }
                 if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
+                    $localized[(string) $_field] = $shortcodes;
                 }
             }
             $valid_shortcodes = $localized;
@@ -309,10 +309,10 @@ 
             $merged_codes = array();
             foreach ($valid_shortcodes as $field => $shortcode) {
                 foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
+                    if (isset($merged_codes[$code])) {
                         continue;
                     } else {
-                        $merged_codes[ $code ] = $label;
+                        $merged_codes[$code] = $label;
                     }
                 }
             }
@@ -462,12 +462,12 @@ 
         $sending_messenger = ''
     ) {
         // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
+        if ( ! $message_type->always_generate()) {
             return EEH_MSG_Template::generate_browser_trigger($message);
         }
 
         // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(
                 __('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
             );
@@ -475,7 +475,7 @@ 
 
         // validate given context
         $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+        if ($message->context() !== '' && ! isset($contexts[$message->context()])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -486,10 +486,10 @@ 
         }
 
         // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
+        if ( ! empty($sending_messenger)) {
             $with_messengers = $message_type->with_messengers();
-            if (! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ]) ) {
+            if ( ! isset($with_messengers[$message->messenger()])
+                 || ! in_array($sending_messenger, $with_messengers[$message->messenger()])) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -625,7 +625,7 @@ 
     public static function get_message_action_icon($type)
     {
         $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : '';
+        return isset($action_icons[$type]) ? $action_icons[$type] : '';
     }
 
 
@@ -688,7 +688,7 @@ 
     public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
     {
         $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+        return isset($action_urls[$type]) ? $action_urls[$type] : '';
     }
 
 
@@ -708,7 +708,7 @@ 
         EE_Registry::instance()->load_helper('URL');
         // if $message is not an instance of EE_Message then let's just do a dummy.
         $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
+        $action_urls = apply_filters(
             'FHEE__EEH_MSG_Template__get_message_action_url',
             array(
                 'view' => EEH_MSG_Template::generate_browser_trigger($message),
@@ -788,7 +788,7 @@ 
     {
         $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
         $icon_css = EEH_MSG_Template::get_message_action_icon($type);
-        $title = isset($icon_css['label']) ? 'title="' . $icon_css['label'] . '"' : '';
+        $title = isset($icon_css['label']) ? 'title="'.$icon_css['label'].'"' : '';
 
         if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
             return '';
@@ -797,14 +797,14 @@ 
         $icon_css['css_class'] .= esc_attr(
             apply_filters(
                 'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-                ' js-ee-message-action-link ee-message-action-link-' . $type,
+                ' js-ee-message-action-link ee-message-action-link-'.$type,
                 $type,
                 $message,
                 $query_params
             )
         );
 
-        return '<a href="' . $url . '"' . $title . '><span class="' . esc_attr($icon_css['css_class']) . '"></span></a>';
+        return '<a href="'.$url.'"'.$title.'><span class="'.esc_attr($icon_css['css_class']).'"></span></a>';
     }
 
 
@@ -845,7 +845,7 @@ 
     public static function convert_reg_status_to_message_type($reg_status)
     {
         $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+        return isset($reg_status_array[$reg_status]) ? $reg_status_array[$reg_status] : '';
     }
 
 
@@ -883,7 +883,7 @@ 
     public static function convert_payment_status_to_message_type($payment_status)
     {
         $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+        return isset($payment_status_array[$payment_status]) ? $payment_status_array[$payment_status] : '';
     }
 
 
@@ -896,7 +896,7 @@ 
      */
     public static function get_template_pack($template_pack_name)
     {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+        if ( ! self::$_template_pack_collection instanceof EE_Object_Collection) {
             self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
         }
 
@@ -909,14 +909,14 @@ 
 
         // nope...let's get it.
         // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+        $pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
             ' ',
             '_',
             ucwords(
                 str_replace('_', ' ', $template_pack_name)
             )
         );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+        if ( ! class_exists($pack_class_name) && $template_pack_name !== 'default') {
             return self::get_template_pack('default');
         } else {
             $template_pack = new $pack_class_name;
@@ -939,18 +939,18 @@ 
     public static function get_template_pack_collection()
     {
         $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+        if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
             self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
             $new_collection = true;
         }
 
         // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+        $templates = glob(EE_LIBRARIES.'messages/defaults/*', GLOB_ONLYDIR);
         foreach ($templates as $template_path) {
             // grab folder name
             $template = basename($template_path);
 
-            if (! $new_collection) {
+            if ( ! $new_collection) {
                 // already have it?
                 if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
                     continue;
@@ -958,7 +958,7 @@ 
             }
 
             // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+            $template_pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
                 ' ',
                 '_',
                 ucwords(
@@ -969,7 +969,7 @@ 
                     )
                 )
             );
-            if (! class_exists($template_pack_class_name)) {
+            if ( ! class_exists($template_pack_class_name)) {
                 continue;
             }
             self::$_template_pack_collection->add(new $template_pack_class_name);
@@ -1010,7 +1010,7 @@ 
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
         $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+        if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
             return array();
         }
         // whew made it this far!  Okay, let's go ahead and create the templates then
@@ -1029,13 +1029,13 @@ 
     protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
     {
         // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
+        if ( ! $global) {
             return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
         }
         /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
         $Message_Template_Defaults = EE_Registry::factory(
             'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
+            array($messenger, $message_type, $GRP_ID)
         );
         // generate templates
         $success = $Message_Template_Defaults->create_new_templates();
@@ -1043,7 +1043,7 @@ 
         // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
         // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
         // attempts.
-        if (! $success) {
+        if ( ! $success) {
             /** @var EE_Message_Resource_Manager $message_resource_manager */
             $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
             $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
@@ -1077,7 +1077,7 @@ 
     private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
     {
         // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+        $success = array('GRP_ID' => null, 'MTP_context' => '');
         // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
         $Message_Template_Group = empty($GRP_ID)
             ? EEM_Message_Template_Group::instance()->get_one(
@@ -1091,7 +1091,7 @@ 
             )
             : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
         // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+        if ( ! $Message_Template_Group instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -1137,7 +1137,7 @@ 
         $success['template_name'] = $template_name;
         // add new message templates and add relation to.
         foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
+            if ( ! $message_template instanceof EE_Message_Template) {
                 continue;
             }
             $new_message_template = clone $message_template;
@@ -1215,7 +1215,7 @@ 
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
         $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+        if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
             return array();
         }
 
@@ -1227,7 +1227,7 @@ 
                 if (in_array($field, $excluded_fields_for_messenger, true)) {
                     continue;
                 }
-                $template_fields[ $context ][ $field ] = $value;
+                $template_fields[$context][$field] = $value;
             }
         }
         if (empty($template_fields)) {

core/helpers/EEH_Qtip_Loader.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
      * - registers and enqueues the qtip scripts and styles.
      *
      * @access public
-     * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
+     * @param  string[]  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
      * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
      * @return void
      */

Indentation +225 added lines, -225 removed lines

@@ -11,229 +11,229 @@
 class EEH_Qtip_Loader extends EEH_Base
 {
 
-    /**
-     * EEH_Qtip_Loader Object
-     * @var EEH_Qtip_Loader
-     * @access private
-     */
-    private static $_instance = null;
-
-    /**
-     * array of qtip config objects
-     * @var EE_Qtip_Config[]
-     */
-    private $_qtips = array();
-
-
-
-    /**
-     *@singleton method used to instantiate class object
-     *@access public
-     *@return EEH_Qtip_Loader instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     * @Constructor
-     * @access private
-     * @return \EEH_Qtip_Loader
-     */
-    private function __construct()
-    {
-        // let's just make sure this is instantiated in the right place.
-        if (did_action('wp_print_styles') || did_action('admin_head')) {
-            EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
-        }
-    }
-
-
-    /**
-     * Call this from wp_enqueue_scripts or admin_enqueue_scripts to setup and enqueue the qtip library
-     *
-     * @access public
-     * @return void
-     */
-    public function register_and_enqueue()
-    {
-        $qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-        $qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-        $qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
-
-        wp_register_script('qtip-map', $qtip_map, array(), '3', true);
-        wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
-        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
-
-        wp_register_style('qtip-css', $qtipcss, array(), '2.2');
-
-        // k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-        if (!empty($this->_qtips)) {
-            wp_enqueue_script('ee-qtip-helper');
-            wp_enqueue_style('qtip-css');
-            $qtips = array();
-            foreach ($this->_qtips as $qtip) {
-                $qts = $qtip->get_tips();
-                foreach ($qts as $qt) {
-                    if (! $qt instanceof EE_Qtip) {
-                        continue;
-                    }
-                    $qtips[] = array(
-                        'content_id' => $qt->content_id,
-                        'options' => $qt->options,
-                        'target' => $qt->target,
-                        );
-                }
-            }
-            if (!empty($qtips)) {
-                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
-            }
-        } else {
-            // qtips has been requested without any registration (so assuming its just directly used in the admin).
-            wp_enqueue_script('qtip');
-            wp_enqueue_style('qtip-css');
-        }
-    }
-
-
-
-    /**
-     * This simply registers the given qtip config and:
-     * - adds it to the $_qtips property array.
-     * - sets up the content containers for all qtips in the config,
-     * - registers and enqueues the qtip scripts and styles.
-     *
-     * @access public
-     * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
-     * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
-     * @return void
-     */
-    public function register($configname, $paths = array())
-    {
-
-        // let's just make sure this is instantiated in the right place.
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
-        }
-
-        $configname = (array) $configname; // typecast to array
-        foreach ($configname as $config) {
-            $this->_register($config, $paths);
-        }
-
-        // hook into appropriate footer
-        $footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
-        add_action($footer_action, array($this, 'setup_qtip'), 10);
-
-        // make sure we "turn on" qtip js.
-        add_filter('FHEE_load_qtip', '__return_true');
-    }
-
-
-
-    /**
-     * private utility for registering and setting up qtip config objects
-     *
-     * @access private
-     * @param  string $config the short name of the class (will be used to generate the expected classname)
-     * @param  array  $paths  array of paths to check (or if empty we check core/libraries/qtips or assume its loaded)
-     * @throws EE_Error
-     * @return void
-     */
-    private function _register($config, $paths)
-    {
-        // before doing anything we have to make sure that EE_Qtip_Config parent is required.
-        EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
-
-        if (!empty($paths)) {
-            $paths = (array) $paths;
-            foreach ($paths as $path) {
-                $path = $path . $config . '.lib.php';
-                if (!is_readable($path)) {
-                    continue;
-                } else {
-                    require_once $path;
-                }
-            }
-        }
-
-        // does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-        if (!class_exists($config)) {
-            $path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-            if (!is_readable($path)) {
-                throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
-            } else {
-                require_once $path;
-            }
-        }
-
-        // now we attempt a class_exists one more time.
-        if (!class_exists($config)) {
-            throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
-        }
-
-        // made it HERE?  FINALLY, let's get things setup.
-        $a = new ReflectionClass($config);
-        $qtip = $a->newInstance();
-
-        // verify that $qtip is a valid object
-        if (! $qtip instanceof EE_Qtip_Config) {
-            throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
-        }
-
-        $this->_qtips[] = $a->newInstance();
-    }
-
-
-
-    /**
-     * This takes care of generating the qtip content containers.
-     * Output gets put in the appropriate page footer (depending on context (either admin_footer or wp_footer) )
-     *
-     * @access public
-     * @return void
-     */
-    public function setup_qtip()
-    {
-        if (empty($this->_qtips)) {
-            return; // no qtips!
-        }
-
-        $content = array();
-
-        foreach ($this->_qtips as $qtip) {
-            $content[] = $this->_generate_content_container($qtip);
-        }
-
-        echo implode('<br />', $content);
-    }
-
-
-    /**
-     * Generates a content container from a given EE_Qtip_Config object.
-     *
-     * @param  EE_Qtip_Config $qtip
-     * @return string  (html content container for qtip);
-     */
-    private function _generate_content_container($qtip)
-    {
-        $qts = $qtip->get_tips();
-        $content = array();
-        foreach ($qts as $qt) {
-            if (! $qt instanceof EE_Qtip) {
-                continue;
-            }
-            $content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
-        }
-
-        return implode('<br />', $content);
-    }
+	/**
+	 * EEH_Qtip_Loader Object
+	 * @var EEH_Qtip_Loader
+	 * @access private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * array of qtip config objects
+	 * @var EE_Qtip_Config[]
+	 */
+	private $_qtips = array();
+
+
+
+	/**
+	 *@singleton method used to instantiate class object
+	 *@access public
+	 *@return EEH_Qtip_Loader instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 * @Constructor
+	 * @access private
+	 * @return \EEH_Qtip_Loader
+	 */
+	private function __construct()
+	{
+		// let's just make sure this is instantiated in the right place.
+		if (did_action('wp_print_styles') || did_action('admin_head')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
+		}
+	}
+
+
+	/**
+	 * Call this from wp_enqueue_scripts or admin_enqueue_scripts to setup and enqueue the qtip library
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_and_enqueue()
+	{
+		$qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
+		$qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
+		$qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+
+		wp_register_script('qtip-map', $qtip_map, array(), '3', true);
+		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
+		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
+
+		wp_register_style('qtip-css', $qtipcss, array(), '2.2');
+
+		// k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
+		if (!empty($this->_qtips)) {
+			wp_enqueue_script('ee-qtip-helper');
+			wp_enqueue_style('qtip-css');
+			$qtips = array();
+			foreach ($this->_qtips as $qtip) {
+				$qts = $qtip->get_tips();
+				foreach ($qts as $qt) {
+					if (! $qt instanceof EE_Qtip) {
+						continue;
+					}
+					$qtips[] = array(
+						'content_id' => $qt->content_id,
+						'options' => $qt->options,
+						'target' => $qt->target,
+						);
+				}
+			}
+			if (!empty($qtips)) {
+				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
+			}
+		} else {
+			// qtips has been requested without any registration (so assuming its just directly used in the admin).
+			wp_enqueue_script('qtip');
+			wp_enqueue_style('qtip-css');
+		}
+	}
+
+
+
+	/**
+	 * This simply registers the given qtip config and:
+	 * - adds it to the $_qtips property array.
+	 * - sets up the content containers for all qtips in the config,
+	 * - registers and enqueues the qtip scripts and styles.
+	 *
+	 * @access public
+	 * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
+	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
+	 * @return void
+	 */
+	public function register($configname, $paths = array())
+	{
+
+		// let's just make sure this is instantiated in the right place.
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
+		}
+
+		$configname = (array) $configname; // typecast to array
+		foreach ($configname as $config) {
+			$this->_register($config, $paths);
+		}
+
+		// hook into appropriate footer
+		$footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
+		add_action($footer_action, array($this, 'setup_qtip'), 10);
+
+		// make sure we "turn on" qtip js.
+		add_filter('FHEE_load_qtip', '__return_true');
+	}
+
+
+
+	/**
+	 * private utility for registering and setting up qtip config objects
+	 *
+	 * @access private
+	 * @param  string $config the short name of the class (will be used to generate the expected classname)
+	 * @param  array  $paths  array of paths to check (or if empty we check core/libraries/qtips or assume its loaded)
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _register($config, $paths)
+	{
+		// before doing anything we have to make sure that EE_Qtip_Config parent is required.
+		EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
+
+		if (!empty($paths)) {
+			$paths = (array) $paths;
+			foreach ($paths as $path) {
+				$path = $path . $config . '.lib.php';
+				if (!is_readable($path)) {
+					continue;
+				} else {
+					require_once $path;
+				}
+			}
+		}
+
+		// does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
+		if (!class_exists($config)) {
+			$path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
+			if (!is_readable($path)) {
+				throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
+			} else {
+				require_once $path;
+			}
+		}
+
+		// now we attempt a class_exists one more time.
+		if (!class_exists($config)) {
+			throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
+		}
+
+		// made it HERE?  FINALLY, let's get things setup.
+		$a = new ReflectionClass($config);
+		$qtip = $a->newInstance();
+
+		// verify that $qtip is a valid object
+		if (! $qtip instanceof EE_Qtip_Config) {
+			throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
+		}
+
+		$this->_qtips[] = $a->newInstance();
+	}
+
+
+
+	/**
+	 * This takes care of generating the qtip content containers.
+	 * Output gets put in the appropriate page footer (depending on context (either admin_footer or wp_footer) )
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function setup_qtip()
+	{
+		if (empty($this->_qtips)) {
+			return; // no qtips!
+		}
+
+		$content = array();
+
+		foreach ($this->_qtips as $qtip) {
+			$content[] = $this->_generate_content_container($qtip);
+		}
+
+		echo implode('<br />', $content);
+	}
+
+
+	/**
+	 * Generates a content container from a given EE_Qtip_Config object.
+	 *
+	 * @param  EE_Qtip_Config $qtip
+	 * @return string  (html content container for qtip);
+	 */
+	private function _generate_content_container($qtip)
+	{
+		$qts = $qtip->get_tips();
+		$content = array();
+		foreach ($qts as $qt) {
+			if (! $qt instanceof EE_Qtip) {
+				continue;
+			}
+			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+		}
+
+		return implode('<br />', $content);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -34,7 +34,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EEH_Qtip_Loader)) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -65,25 +65,25 @@ 
      */
     public function register_and_enqueue()
     {
-        $qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-        $qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-        $qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+        $qtips_js = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.js';
+        $qtip_map = EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.map';
+        $qtipcss = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.css';
 
         wp_register_script('qtip-map', $qtip_map, array(), '3', true);
         wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
-        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS.'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
 
         wp_register_style('qtip-css', $qtipcss, array(), '2.2');
 
         // k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-        if (!empty($this->_qtips)) {
+        if ( ! empty($this->_qtips)) {
             wp_enqueue_script('ee-qtip-helper');
             wp_enqueue_style('qtip-css');
             $qtips = array();
             foreach ($this->_qtips as $qtip) {
                 $qts = $qtip->get_tips();
                 foreach ($qts as $qt) {
-                    if (! $qt instanceof EE_Qtip) {
+                    if ( ! $qt instanceof EE_Qtip) {
                         continue;
                     }
                     $qtips[] = array(
@@ -93,8 +93,8 @@ 
                         );
                 }
             }
-            if (!empty($qtips)) {
-                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
+            if ( ! empty($qtips)) {
+                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array('qtips' => $qtips));
             }
         } else {
             // qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -153,11 +153,11 @@ 
         // before doing anything we have to make sure that EE_Qtip_Config parent is required.
         EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
 
-        if (!empty($paths)) {
+        if ( ! empty($paths)) {
             $paths = (array) $paths;
             foreach ($paths as $path) {
-                $path = $path . $config . '.lib.php';
-                if (!is_readable($path)) {
+                $path = $path.$config.'.lib.php';
+                if ( ! is_readable($path)) {
                     continue;
                 } else {
                     require_once $path;
@@ -166,9 +166,9 @@ 
         }
 
         // does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-        if (!class_exists($config)) {
-            $path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-            if (!is_readable($path)) {
+        if ( ! class_exists($config)) {
+            $path = EE_LIBRARIES.'qtips/'.$config.'.lib.php';
+            if ( ! is_readable($path)) {
                 throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
             } else {
                 require_once $path;
@@ -176,7 +176,7 @@ 
         }
 
         // now we attempt a class_exists one more time.
-        if (!class_exists($config)) {
+        if ( ! class_exists($config)) {
             throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
         }
 
@@ -185,7 +185,7 @@ 
         $qtip = $a->newInstance();
 
         // verify that $qtip is a valid object
-        if (! $qtip instanceof EE_Qtip_Config) {
+        if ( ! $qtip instanceof EE_Qtip_Config) {
             throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
         }
 
@@ -228,10 +228,10 @@ 
         $qts = $qtip->get_tips();
         $content = array();
         foreach ($qts as $qt) {
-            if (! $qt instanceof EE_Qtip) {
+            if ( ! $qt instanceof EE_Qtip) {
                 continue;
             }
-            $content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+            $content[] = '<div class="ee-qtip-helper-content hidden" id="'.$qt->content_id.'">'.$qt->content.'</div>';
         }
 
         return implode('<br />', $content);

core/helpers/EEH_Template.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -308,7 +308,7 @@ 
      * _find_common_base_path
      * given two paths, this determines if there is a common base path between the two
      *
-     * @param array $paths
+     * @param string[] $paths
      * @return string
      */
     protected static function _find_common_base_path($paths)
@@ -338,7 +338,7 @@ 
      * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
      * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
      *                                      not found or is not readable
-     * @return mixed string
+     * @return string string
      * @throws \DomainException
      */
     public static function display_template(

Indentation +962 added lines, -962 removed lines

@@ -5,35 +5,35 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 if (! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @return string        the html output for the formatted money value
-     */
-    function espresso_get_template_part($slug = null, $name = null)
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @return string        the html output for the formatted money value
+	 */
+	function espresso_get_template_part($slug = null, $name = null)
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if (! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -48,672 +48,672 @@ 
 class EEH_Template
 {
 
-    private static $_espresso_themes = array();
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
-    }
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load it's functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes()
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return array();
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
-            }
-            EEH_Template::$_espresso_themes = array();
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = null,
-        $name = null,
-        $template_args = array(),
-        $return_string = false
-    ) {
-        do_action("get_template_part_{$slug}-{$name}", $slug, $name);
-        $templates = array();
-        $name      = (string) $name;
-        if ($name != '') {
-            $templates[] = "{$slug}-{$name}.php";
-        }
-        // allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
-            EEH_Template::locate_template($templates, $template_args, true, $return_string);
-        }
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param  array       $template_args   an array of arguments to be extracted for use in the template
-     * @param  boolean     $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return mixed
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function locate_template(
-        $templates = array(),
-        $template_args = array(),
-        $load = true,
-        $return_string = true,
-        $check_if_custom = false
-    ) {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = locate_template($templates);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                // get post_type
-                $post_type = EE_Registry::instance()->REQ->get('post_type');
-                /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-                $custom_post_types = LoaderFactory::getLoader()->getShared(
-                    'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-                );
-                // get array of EE Custom Post Types
-                $EE_CPTs = $custom_post_types->getDefinitions();
-                // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-
-            // array of paths to folders that may contain templates
-            $template_folder_paths = array(
-                // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
-                // then in the root of the /wp-content/uploads/espresso/templates/ folder
-                EVENT_ESPRESSO_TEMPLATE_DIR,
-            );
-
-            // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = array(
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                );
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths
-            );
-            $templates             = is_array($templates) ? $templates : array($templates);
-            $template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
-            // array to hold all possible template paths
-            $full_template_paths = array();
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        array($template_folder_path, $template_path_minus_file_name)
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths,
-                $file_name
-            );
-            // now loop through our final array of template location paths and check each location
-            foreach ((array) $full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
-                    break;
-                }
-            }
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            } else {
-                EEH_Template::display_template($template_path, $template_args, false);
-            }
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path server path to the file to be loaded, including file name and extension
-     * @param  array      $template_args an array of arguments to be extracted for use in the template
-     * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return mixed string
-     * @throws \DomainException
-     */
-    public static function display_template(
-        $template_path = false,
-        $template_args = array(),
-        $return_string = false,
-        $throw_exceptions = false
-    ) {
-
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
-            return '';
-        }
-        // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
-            $template_args = array($template_args);
-        }
-        extract($template_args, EXTR_SKIP);
-        // ignore whether template is accessible ?
-        if ($throw_exceptions && ! is_readable($template_path)) {
-            throw new \DomainException(
-                esc_html__(
-                    'Invalid, unreadable, or missing file.',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        if ($return_string) {
-            // because we want to return a string, we are going to capture the output
-            ob_start();
-            include($template_path);
-            return ob_get_clean();
-        } else {
-            include($template_path);
-        }
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            switch ($obj_class) {
-                // no specifics just yet...
-                default:
-                    $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-            }
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param  float   $amount       raw money value
-     * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string   $CNT_ISO      2 letter ISO code for a country
-     * @param string   $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     * @throws \EE_Error
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        // ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number or was amount converted to a string like "free" ?
-        if (is_float($amount_formatted)) {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-            // verify results
-            if (! $mny instanceof EE_Currency_Config) {
-                // set default config country currency settings
-                $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                    ? EE_Registry::instance()->CFG->currency
-                    : new EE_Currency_Config();
-            }
-            // format float
-            $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-            // add formatting ?
-            if (! $return_raw) {
-                // add currency sign
-                if ($mny->sign_b4) {
-                    if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
-                    } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                    }
-                } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
-                }
-
-                // filter to allow global setting of display_code
-                $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
-
-                // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
-            }
-            // filter results
-            $amount_formatted = apply_filters(
-                'FHEE__EEH_Template__format_currency__amount_formatted',
-                $amount_formatted,
-                $mny,
-                $return_raw
-            );
-        }
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param  boolean $plural    Whether to return plural or not
-     * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        /** @type EEM_Status $EEM_Status */
-        $EEM_Status = EE_Registry::instance()->load_model('Status');
-        $status     = $EEM_Status->localized_status(
-            array($status_id => __('unknown', 'event_espresso')),
-            $plural,
-            $schema
-        );
-        return $status[ $status_id ];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param  string $url   the url for the link, note that `esc_url` will be called on it
-     * @param  string $label What is the label you want displayed for the button
-     * @param  string $class what class is used for the button (defaults to 'button-primary')
-     * @param string  $icon
-     * @param string  $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if (! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
-        return $button;
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param  string     $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-
-        if (! $page) {
-            $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
-        }
-
-        if (! $action) {
-            $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
-        }
-
-        $action = empty($action) ? 'default' : $action;
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
-            'Click to open the \'Help\' tab for more information about this feature.',
-            'event_espresso'
-        ) . '" > ' . $help_text . ' </a>';
-    }
-
-
-    /**
-     * This helper generates the html structure for the jquery joyride plugin with the given params.
-     *
-     * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
-     * @param EE_Help_Tour
-     * @return string         html
-     */
-    public static function help_tour_stops_generator(EE_Help_Tour $tour)
-    {
-        $id    = $tour->get_slug();
-        $stops = $tour->get_stops();
-
-        $content = '<ol style="display:none" id="' . $id . '">';
-
-        foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
-
-            // if container is set to modal then let's make sure we set the options accordingly
-            if (empty($data_id) && empty($data_class)) {
-                $stop['options']['modal']  = true;
-                $stop['options']['expose'] = true;
-            }
-
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
-            $inner_content = isset($stop['content']) ? $stop['content'] : '';
-
-            // options
-            if (isset($stop['options']) && is_array($stop['options'])) {
-                $options = ' data-options="';
-                foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
-                }
-                $options .= '"';
-            } else {
-                $options = '';
-            }
-
-            // let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
-        }
-
-        $content .= '</ol>';
-        return $content;
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param  array  $status_array  array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @throws EE_Error
-     * @return string               html structure for status.
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if (! is_array($status_array)) {
-            throw new EE_Error(esc_html__(
-                'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                'event_espresso'
-            ));
-        }
-
-        $setup_array = array();
-        foreach ($status_array as $item => $status) {
-            $setup_array[ $item ] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
-                'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
-                'status' => $status,
-            );
-        }
-
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
-        foreach ($setup_array as $item => $details) {
-            $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
-        }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array) $data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) {
-                ?>
+	private static $_espresso_themes = array();
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
+	}
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load it's functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes()
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return array();
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[ $key ]);
+			}
+			EEH_Template::$_espresso_themes = array();
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = null,
+		$name = null,
+		$template_args = array(),
+		$return_string = false
+	) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
+		$templates = array();
+		$name      = (string) $name;
+		if ($name != '') {
+			$templates[] = "{$slug}-{$name}.php";
+		}
+		// allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
+			EEH_Template::locate_template($templates, $template_args, true, $return_string);
+		}
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param  array       $template_args   an array of arguments to be extracted for use in the template
+	 * @param  boolean     $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function locate_template(
+		$templates = array(),
+		$template_args = array(),
+		$load = true,
+		$return_string = true,
+		$check_if_custom = false
+	) {
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = locate_template($templates);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				// get post_type
+				$post_type = EE_Registry::instance()->REQ->get('post_type');
+				/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+				$custom_post_types = LoaderFactory::getLoader()->getShared(
+					'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+				);
+				// get array of EE Custom Post Types
+				$EE_CPTs = $custom_post_types->getDefinitions();
+				// build template name based on request
+				if (isset($EE_CPTs[ $post_type ])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates         = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+
+			// array of paths to folders that may contain templates
+			$template_folder_paths = array(
+				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
+				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				// then in the root of the /wp-content/uploads/espresso/templates/ folder
+				EVENT_ESPRESSO_TEMPLATE_DIR,
+			);
+
+			// add core plugin folders for checking only if we're not $check_if_custom
+			if (! $check_if_custom) {
+				$core_paths            = array(
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				);
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths
+			);
+			$templates             = is_array($templates) ? $templates : array($templates);
+			$template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
+			// array to hold all possible template paths
+			$full_template_paths = array();
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						array($template_folder_path, $template_path_minus_file_name)
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths,
+				$file_name
+			);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
+					break;
+				}
+			}
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			} else {
+				EEH_Template::display_template($template_path, $template_args, false);
+			}
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path server path to the file to be loaded, including file name and extension
+	 * @param  array      $template_args an array of arguments to be extracted for use in the template
+	 * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return mixed string
+	 * @throws \DomainException
+	 */
+	public static function display_template(
+		$template_path = false,
+		$template_args = array(),
+		$return_string = false,
+		$throw_exceptions = false
+	) {
+
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if (! $template_path || ! is_readable($template_path)) {
+			return '';
+		}
+		// if $template_args are not in an array, then make it so
+		if (! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = array($template_args);
+		}
+		extract($template_args, EXTR_SKIP);
+		// ignore whether template is accessible ?
+		if ($throw_exceptions && ! is_readable($template_path)) {
+			throw new \DomainException(
+				esc_html__(
+					'Invalid, unreadable, or missing file.',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		if ($return_string) {
+			// because we want to return a string, we are going to capture the output
+			ob_start();
+			include($template_path);
+			return ob_get_clean();
+		} else {
+			include($template_path);
+		}
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			switch ($obj_class) {
+				// no specifics just yet...
+				default:
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+			}
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param  float   $amount       raw money value
+	 * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string   $CNT_ISO      2 letter ISO code for a country
+	 * @param string   $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 * @throws \EE_Error
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		// ensure amount is float
+		$amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number or was amount converted to a string like "free" ?
+		if (is_float($amount_formatted)) {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+			// verify results
+			if (! $mny instanceof EE_Currency_Config) {
+				// set default config country currency settings
+				$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+					? EE_Registry::instance()->CFG->currency
+					: new EE_Currency_Config();
+			}
+			// format float
+			$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+			// add formatting ?
+			if (! $return_raw) {
+				// add currency sign
+				if ($mny->sign_b4) {
+					if ($amount >= 0) {
+						$amount_formatted = $mny->sign . $amount_formatted;
+					} else {
+						$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+					}
+				} else {
+					$amount_formatted = $amount_formatted . $mny->sign;
+				}
+
+				// filter to allow global setting of display_code
+				$display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
+
+				// add currency code ?
+				$amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+			}
+			// filter results
+			$amount_formatted = apply_filters(
+				'FHEE__EEH_Template__format_currency__amount_formatted',
+				$amount_formatted,
+				$mny,
+				$return_raw
+			);
+		}
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param  boolean $plural    Whether to return plural or not
+	 * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		/** @type EEM_Status $EEM_Status */
+		$EEM_Status = EE_Registry::instance()->load_model('Status');
+		$status     = $EEM_Status->localized_status(
+			array($status_id => __('unknown', 'event_espresso')),
+			$plural,
+			$schema
+		);
+		return $status[ $status_id ];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param  string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param  string $label What is the label you want displayed for the button
+	 * @param  string $class what class is used for the button (defaults to 'button-primary')
+	 * @param string  $icon
+	 * @param string  $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if (! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		$label  = ! empty($icon) ? $icon_html . $label : $label;
+		$button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+		return $button;
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param  string     $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+
+		if (! $page) {
+			$page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
+		}
+
+		if (! $action) {
+			$action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
+		}
+
+		$action = empty($action) ? 'default' : $action;
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
+			'Click to open the \'Help\' tab for more information about this feature.',
+			'event_espresso'
+		) . '" > ' . $help_text . ' </a>';
+	}
+
+
+	/**
+	 * This helper generates the html structure for the jquery joyride plugin with the given params.
+	 *
+	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
+	 * @param EE_Help_Tour
+	 * @return string         html
+	 */
+	public static function help_tour_stops_generator(EE_Help_Tour $tour)
+	{
+		$id    = $tour->get_slug();
+		$stops = $tour->get_stops();
+
+		$content = '<ol style="display:none" id="' . $id . '">';
+
+		foreach ($stops as $stop) {
+			$data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
+			$data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+
+			// if container is set to modal then let's make sure we set the options accordingly
+			if (empty($data_id) && empty($data_class)) {
+				$stop['options']['modal']  = true;
+				$stop['options']['expose'] = true;
+			}
+
+			$custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
+			$button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+			$inner_content = isset($stop['content']) ? $stop['content'] : '';
+
+			// options
+			if (isset($stop['options']) && is_array($stop['options'])) {
+				$options = ' data-options="';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= $option . ':' . $value . ';';
+				}
+				$options .= '"';
+			} else {
+				$options = '';
+			}
+
+			// let's put all together
+			$content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+		}
+
+		$content .= '</ol>';
+		return $content;
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param  array  $status_array  array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @throws EE_Error
+	 * @return string               html structure for status.
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if (! is_array($status_array)) {
+			throw new EE_Error(esc_html__(
+				'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+				'event_espresso'
+			));
+		}
+
+		$setup_array = array();
+		foreach ($status_array as $item => $status) {
+			$setup_array[ $item ] = array(
+				'class'  => 'ee-status-legend ee-status-legend-' . $status,
+				'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
+				'status' => $status,
+			);
+		}
+
+		$content = '<div class="ee-list-table-legend-container">' . "\n";
+		$content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
+		$content .= '<dl class="ee-list-table-legend">' . "\n\t";
+		foreach ($setup_array as $item => $details) {
+			$active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
+			$content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
+			$content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
+			$content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
+			$content .= '</dt>' . "\n";
+		}
+		$content .= '</dl>' . "\n";
+		$content .= '</div>' . "\n";
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array) $data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) {
+				?>
                 <table class="widefat">
                     <tbody>
                     <?php
-                    foreach ($data as $data_key => $data_values) {
-                        ?>
+					foreach ($data as $data_key => $data_values) {
+						?>
                         <tr>
                             <td>
                                 <?php echo $data_key; ?>
@@ -723,291 +723,291 @@ 
                             </td>
                         </tr>
                         <?php
-                    } ?>
+					} ?>
                     </tbody>
                 </table>
                 <?php
-            } else {
-                ?>
+			} else {
+				?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
                 <?php
-            }
-        } else {
-            // simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @since 4.4.0
-     * @see   self:get_paging_html() for argument docs.
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @return string
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        echo self::get_paging_html(
-            $total_items,
-            $current,
-            $per_page,
-            $url,
-            $show_num_field,
-            $paged_arg_name,
-            $items_label
-        );
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     * @param  integer $total_items     How many total items there are to page.
-     * @param  integer $current         What the current page is.
-     * @param  integer $per_page        How many items per page.
-     * @param  string  $url             What the base url for page links is.
-     * @param  boolean $show_num_field  Whether to show the input for changing page number.
-     * @param  string  $paged_arg_name  The name of the key for the paged query argument.
-     * @param  array   $items_label     An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     */
-    public static function get_paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        $page_links     = array();
-        $disable_first  = $disable_last = '';
-        $total_items    = (int) $total_items;
-        $per_page       = (int) $per_page;
-        $current        = (int) $current;
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        // filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = array(
-                'single' => __('1 item', 'event_espresso'),
-                'plural' => __('%s items', 'event_espresso'),
-            );
-        } else {
-            $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            );
-        }
-
-        $total_pages = ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        if ($current === 1) {
-            $disable_first = ' disabled';
-        }
-        if ($current == $total_pages) {
-            $disable_last = ' disabled';
-        }
-
-        $page_links[] = sprintf(
-            "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
-            esc_attr__('Go to the first page', 'event_espresso'),
-            esc_url(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
-            esc_attr__('Go to the previous page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        if (! $show_num_field) {
-            $html_current_page = $current;
-        } else {
-            $html_current_page = sprintf(
-                "<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page', 'event_espresso'),
-                $current,
-                strlen($total_pages)
-            );
-        }
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
-            $html_current_page,
-            $html_total_pages,
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
-            esc_attr__('Go to the next page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
-            esc_attr__('Go to the last page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-        // set page class
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        } else {
-            $page_class = ' no-pages';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @return string
-     */
-    public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
-    {
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (! $admin &&
-            ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            array(
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ),
-            $query_args
-        );
-        $powered_by = apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
-        );
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string) apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<{$tag}{$attributes}>",
-                "<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-    }
+			}
+		} else {
+			// simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @since 4.4.0
+	 * @see   self:get_paging_html() for argument docs.
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @return string
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		echo self::get_paging_html(
+			$total_items,
+			$current,
+			$per_page,
+			$url,
+			$show_num_field,
+			$paged_arg_name,
+			$items_label
+		);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 * @param  integer $total_items     How many total items there are to page.
+	 * @param  integer $current         What the current page is.
+	 * @param  integer $per_page        How many items per page.
+	 * @param  string  $url             What the base url for page links is.
+	 * @param  boolean $show_num_field  Whether to show the input for changing page number.
+	 * @param  string  $paged_arg_name  The name of the key for the paged query argument.
+	 * @param  array   $items_label     An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 */
+	public static function get_paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		$page_links     = array();
+		$disable_first  = $disable_last = '';
+		$total_items    = (int) $total_items;
+		$per_page       = (int) $per_page;
+		$current        = (int) $current;
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		// filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = array(
+				'single' => __('1 item', 'event_espresso'),
+				'plural' => __('%s items', 'event_espresso'),
+			);
+		} else {
+			$items_label = array(
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			);
+		}
+
+		$total_pages = ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		if ($current === 1) {
+			$disable_first = ' disabled';
+		}
+		if ($current == $total_pages) {
+			$disable_last = ' disabled';
+		}
+
+		$page_links[] = sprintf(
+			"<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page' . $disable_first,
+			esc_attr__('Go to the first page', 'event_espresso'),
+			esc_url(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'prev-page' . $disable_first,
+			esc_attr__('Go to the previous page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		if (! $show_num_field) {
+			$html_current_page = $current;
+		} else {
+			$html_current_page = sprintf(
+				"<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page', 'event_espresso'),
+				$current,
+				strlen($total_pages)
+			);
+		}
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
+			$html_current_page,
+			$html_total_pages,
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'next-page' . $disable_last,
+			esc_attr__('Go to the next page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'last-page' . $disable_last,
+			esc_attr__('Go to the last page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+		// set page class
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		} else {
+			$page_class = ' no-pages';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @return string
+	 */
+	public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
+	{
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (! $admin &&
+			! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			array(
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			),
+			$query_args
+		);
+		$powered_by = apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+		);
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		return (string) apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<{$tag}{$attributes}>",
+				"<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+	}
 }
 
 
 
 
 if (! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            array(
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            )
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			array(
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			)
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }
\ No newline at end of file

Spacing +74 added lines, -74 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
-if (! function_exists('espresso_get_template_part')) {
+if ( ! function_exists('espresso_get_template_part')) {
     /**
      * espresso_get_template_part
      * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -21,7 +21,7 @@ 
 }
 
 
-if (! function_exists('espresso_get_object_css_class')) {
+if ( ! function_exists('espresso_get_object_css_class')) {
     /**
      * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
      *
@@ -69,9 +69,9 @@ 
      */
     public static function load_espresso_theme_functions()
     {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php');
             }
         }
     }
@@ -85,16 +85,16 @@ 
     public static function get_espresso_themes()
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return array();
             }
             if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
+                unset($espresso_themes[$key]);
             }
             EEH_Template::$_espresso_themes = array();
             foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
             }
         }
         return EEH_Template::$_espresso_themes;
@@ -205,10 +205,10 @@ 
                 // get array of EE Custom Post Types
                 $EE_CPTs = $custom_post_types->getDefinitions();
                 // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
+                if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
+                    $templates         = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -217,18 +217,18 @@ 
             // array of paths to folders that may contain templates
             $template_folder_paths = array(
                 // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+                EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
                 // then in the root of the /wp-content/uploads/espresso/templates/ folder
                 EVENT_ESPRESSO_TEMPLATE_DIR,
             );
 
             // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = array(
+            if ( ! $check_if_custom) {
+                $core_paths = array(
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 );
@@ -261,10 +261,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -272,7 +272,7 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().DS.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters(
@@ -361,11 +361,11 @@ 
         $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
 
         // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
+        if ( ! $template_path || ! is_readable($template_path)) {
             return '';
         }
         // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
+        if ( ! is_array($template_args) && ! is_object($template_args)) {
             $template_args = array($template_args);
         }
         extract($template_args, EXTR_SKIP);
@@ -403,11 +403,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -417,10 +417,10 @@ 
                 // no specifics just yet...
                 default:
                     $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+                    $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
             }
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -461,7 +461,7 @@ 
             // was a country ISO code passed ? if so generate currency config object for that country
             $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
             // verify results
-            if (! $mny instanceof EE_Currency_Config) {
+            if ( ! $mny instanceof EE_Currency_Config) {
                 // set default config country currency settings
                 $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                     ? EE_Registry::instance()->CFG->currency
@@ -470,23 +470,23 @@ 
             // format float
             $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
             // add formatting ?
-            if (! $return_raw) {
+            if ( ! $return_raw) {
                 // add currency sign
                 if ($mny->sign_b4) {
                     if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
+                        $amount_formatted = $mny->sign.$amount_formatted;
                     } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                        $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                     }
                 } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
+                    $amount_formatted = $amount_formatted.$mny->sign;
                 }
 
                 // filter to allow global setting of display_code
                 $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
 
                 // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+                $amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted;
             }
             // filter results
             $amount_formatted = apply_filters(
@@ -523,7 +523,7 @@ 
             $plural,
             $schema
         );
-        return $status[ $status_id ];
+        return $status[$status_id];
     }
 
 
@@ -540,19 +540,19 @@ 
     public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
     {
         $icon_html = '';
-        if (! empty($icon)) {
+        if ( ! empty($icon)) {
             $dashicons = preg_split("(ee-icon |dashicons )", $icon);
             $dashicons = array_filter($dashicons);
             $count     = count($dashicons);
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
                 $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+        $label  = ! empty($icon) ? $icon_html.$label : $label;
+        $button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.esc_url($url).'" class="'.$class.'" title="'.$title.'">'.$label.'</a>';
         return $button;
     }
 
@@ -575,24 +575,24 @@ 
         $help_text = false
     ) {
 
-        if (! $page) {
+        if ( ! $page) {
             $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
         }
 
-        if (! $action) {
+        if ( ! $action) {
             $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
         }
 
         $action = empty($action) ? 'default' : $action;
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
+        return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__(
             'Click to open the \'Help\' tab for more information about this feature.',
             'event_espresso'
-        ) . '" > ' . $help_text . ' </a>';
+        ).'" > '.$help_text.' </a>';
     }
 
 
@@ -609,11 +609,11 @@ 
         $id    = $tour->get_slug();
         $stops = $tour->get_stops();
 
-        $content = '<ol style="display:none" id="' . $id . '">';
+        $content = '<ol style="display:none" id="'.$id.'">';
 
         foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+            $data_id    = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : '';
+            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : '';
 
             // if container is set to modal then let's make sure we set the options accordingly
             if (empty($data_id) && empty($data_class)) {
@@ -621,15 +621,15 @@ 
                 $stop['options']['expose'] = true;
             }
 
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+            $custom_class  = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : '';
+            $button_text   = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : '';
             $inner_content = isset($stop['content']) ? $stop['content'] : '';
 
             // options
             if (isset($stop['options']) && is_array($stop['options'])) {
                 $options = ' data-options="';
                 foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
+                    $options .= $option.':'.$value.';';
                 }
                 $options .= '"';
             } else {
@@ -637,7 +637,7 @@ 
             }
 
             // let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+            $content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>';
         }
 
         $content .= '</ol>';
@@ -661,7 +661,7 @@ 
      */
     public static function status_legend($status_array, $active_status = '')
     {
-        if (! is_array($status_array)) {
+        if ( ! is_array($status_array)) {
             throw new EE_Error(esc_html__(
                 'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
                 'event_espresso'
@@ -670,25 +670,25 @@ 
 
         $setup_array = array();
         foreach ($status_array as $item => $status) {
-            $setup_array[ $item ] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
+            $setup_array[$item] = array(
+                'class'  => 'ee-status-legend ee-status-legend-'.$status,
                 'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
                 'status' => $status,
             );
         }
 
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
+        $content = '<div class="ee-list-table-legend-container">'."\n";
+        $content .= '<h4 class="status-legend-title">'.esc_html__('Status Legend', 'event_espresso').'</h4>'."\n";
+        $content .= '<dl class="ee-list-table-legend">'."\n\t";
         foreach ($setup_array as $item => $details) {
             $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
+            $content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t";
+            $content .= '<span class="'.$details['class'].'"></span>'."\n\t\t";
+            $content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t";
+            $content .= '</dt>'."\n";
         }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
+        $content .= '</dl>'."\n";
+        $content .= '</div>'."\n";
         return $content;
     }
 
@@ -833,8 +833,8 @@ 
             );
         } else {
             $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             );
         }
 
@@ -846,7 +846,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         if ($current === 1) {
             $disable_first = ' disabled';
@@ -857,7 +857,7 @@ 
 
         $page_links[] = sprintf(
             "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
+            'first-page'.$disable_first,
             esc_attr__('Go to the first page', 'event_espresso'),
             esc_url(remove_query_arg($paged_arg_name, $url)),
             '&laquo;'
@@ -865,13 +865,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
+            'prev-page'.$disable_first,
             esc_attr__('Go to the previous page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
             '&lsaquo;'
         );
 
-        if (! $show_num_field) {
+        if ( ! $show_num_field) {
             $html_current_page = $current;
         } else {
             $html_current_page = sprintf(
@@ -886,7 +886,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
             $html_current_page,
             $html_total_pages,
@@ -896,7 +896,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
+            'next-page'.$disable_last,
             esc_attr__('Go to the next page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
             '&rsaquo;'
@@ -904,13 +904,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
+            'last-page'.$disable_last,
             esc_attr__('Go to the last page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
         // set page class
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
@@ -918,7 +918,7 @@ 
             $page_class = ' no-pages';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -930,7 +930,7 @@ 
     public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
     {
         $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (! $admin &&
+        if ( ! $admin &&
             ! apply_filters(
                 'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
                 EE_Registry::instance()->CFG->admin->show_reg_footer
@@ -955,7 +955,7 @@ 
         );
         $powered_by = apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso'
         );
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
@@ -980,7 +980,7 @@ 
 
 
 
-if (! function_exists('espresso_pagination')) {
+if ( ! function_exists('espresso_pagination')) {
     /**
      *    espresso_pagination
      *
@@ -1008,6 +1008,6 @@ 
                 'add_fragment' => '',
             )
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }
\ No newline at end of file

core/helpers/EEH_Template_Validator.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
     /**
      * For verifying that a variable is indeed an array, else throw an EE_Error
      * @param type $variable_to_test
-     * @param type $variable_name
+     * @param string $variable_name
      * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
      * @return void
      * @throws EE_Error
@@ -161,7 +161,7 @@ 
      * for verifying that a variable is one of the string optiosn supplied
      * @param mixed $variable_to_test
      * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
+     * @param string[] $string_options an array of acceptable values
      * @return void
      * @throws EE_Error
      */

Indentation +148 added lines, -148 removed lines

@@ -28,152 +28,152 @@
     
     
     
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
-            $error[]=__('Variable named %s is null.', 'event_espresso');
-            $error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-    
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[]=__('Template error.', 'event_espresso');
-            $error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[]=__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[]=__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-    
-    
-    
-    
-    
-    
-    
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0]=__('Malconfigured template.', 'event_espresso');
-            $msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
+			$error[]=__('Variable named %s is null.', 'event_espresso');
+			$error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+    
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[]=__('Template error.', 'event_espresso');
+			$error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[]=__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[]=__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+    
+    
+    
+    
+    
+    
+    
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0]=__('Malconfigured template.', 'event_espresso');
+			$msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -39,10 +39,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -65,12 +65,12 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
-            $error[]=__('Variable named %s is null.', 'event_espresso');
-            $error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+            $error[] = __('Variable named %s is null.', 'event_espresso');
+            $error[] = __("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
         }
     }
@@ -85,12 +85,12 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
-            $error[]=__('Template error.', 'event_espresso');
-            $error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
+        if ( ! $expression_to_test) {
+            $error[] = __('Template error.', 'event_espresso');
+            $error[] = __("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
         }
     }
@@ -109,16 +109,16 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[]=__("It should be of type %s", 'event_espresso');
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
+            $msg[] = __('Variable %s is not of the correct type.', 'event_espresso');
+            $msg[] = __("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
         }
     }
@@ -137,16 +137,16 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
+        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
-            $error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[]=__("Its value is, instead '%s'", 'event_espresso');
+        if ( ! is_array($variable_to_test)) {
+            $error[] = __('Variable %s should be an array, but it is not.', 'event_espresso');
+            $error[] = __("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
         }
     }
@@ -167,12 +167,12 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0]=__('Malconfigured template.', 'event_espresso');
-            $msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+        if ( ! in_array($variable_to_test, $string_options)) {
+            $msg[0] = __('Malconfigured template.', 'event_espresso');
+            $msg[1] = __("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
         }
     }