eventespresso / event-espresso-core

core/helpers/EEH_Venue_View.helper.php

Indentation +626 added lines, -626 removed lines

@@ -11,630 +11,630 @@
  */
 class EEH_Venue_View extends EEH_Base
 {
-    /**
-     * @access    private
-     * @var EE_Venue
-     */
-    private static $_venue = null;
-
-
-    /**
-     *    get_venue
-     *    attempts to retrieve an EE_Venue object any way it can
-     *
-     * @access    public
-     * @param int  $VNU_ID
-     * @param bool $look_in_event
-     * @param bool $privacy_check   Defaults to true.
-     *                              When false, means even if the venue is private we return it regardless of access.
-     * @param bool $password_check
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_venue($VNU_ID = 0, $look_in_event = true, $privacy_check = true, $password_check = true)
-    {
-        $VNU_ID = absint($VNU_ID);
-        // do we already have the Venue you are looking for?
-        if (EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
-            // If the Venue ID matches $VNU_ID, return the venue.
-            if (EEH_Venue_View::$_venue->ID() === $VNU_ID) {
-                return EEH_Venue_View::_get_venue($privacy_check);
-            }
-            // If the Venue ID does not match, try pulling a venue using $VNU_ID.
-            $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-            if ($venue instanceof EE_Venue) {
-                EEH_Venue_View::$_venue = $venue;
-                return EEH_Venue_View::_get_venue($privacy_check);
-            }
-        }
-        // international newspaper?
-        global $post;
-        if ($post instanceof WP_Post) {
-            switch ($post->post_type) {
-                // if this is being called from an EE_Venue post,
-                // and the EE_Venue post corresponds to the EE_Venue that is being asked for,
-                // then we can try to just grab the attached EE_Venue object
-                case EspressoPostType::VENUES:
-                    // the post already contains the related EE_Venue object AND one of the following is TRUE:
-                    // the requested Venue ID matches the post ID OR...
-                    // there was no specific Venue ID requested
-                    if (isset($post->EE_Venue) && ($VNU_ID == $post->ID || ! $VNU_ID)) {
-                        // use existing related EE_Venue object
-                        EEH_Venue_View::$_venue = $post->EE_Venue;
-                    } elseif ($VNU_ID) {
-                        // there WAS a specific Venue ID requested, but it's NOT the current post object
-                        EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-                    } else {
-                        // no specific Venue ID requested, so use post ID to generate EE_Venue object
-                        EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($post->ID);
-                    }
-                    break;
-
-                case EspressoPostType::EVENTS:
-                    if ($look_in_event) {
-                        // grab the events related venues
-                        $venues = EEH_Venue_View::get_event_venues();
-                        // make sure the result is an array
-                        $venues = is_array($venues) ? $venues : [$venues];
-                        // do we have an ID for a specific venue?
-                        if ($VNU_ID) {
-                            // loop thru the related venues
-                            foreach ($venues as $venue) {
-                                if ($venue instanceof EE_Venue) {
-                                    // until we find the venue we're looking for
-                                    if ($venue->ID() == $VNU_ID) {
-                                        EEH_Venue_View::$_venue = $venue;
-                                        break;
-                                    }
-                                }
-                            }
-                            // no venue ID ?
-                            // then the global post is an events post and this function was called with no argument
-                        } else {
-                            // just grab the first related event venue
-                            EEH_Venue_View::$_venue = reset($venues);
-                        }
-                    }
-                    break;
-            }
-        }
-        // now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
-        if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
-            // sigh... pull it from the db
-            EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        }
-        return EEH_Venue_View::_get_venue($privacy_check, $password_check);
-    }
-
-
-    /**
-     * return a single venue
-     *
-     * @param bool $privacy_check   Defaults to true.
-     *                              When false, means even if the venue is private we return it regardless of access.
-     * @param bool $password_check
-     * @return  EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_venue($privacy_check = true, $password_check = true)
-    {
-        // check for private venues.
-        if (
-            EEH_Venue_View::$_venue instanceof EE_Venue
-            && EEH_Venue_View::$_venue->status() == 'private'
-            && $privacy_check
-            && ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')
-        ) {
-            return null;
-        }
-        // check for password protected venues
-        if (
-            EEH_Venue_View::$_venue instanceof EE_Venue
-            && $password_check
-            && post_password_required(EEH_Venue_View::$_venue->ID())
-        ) {
-            return null;
-        }
-        return EEH_Venue_View::$_venue instanceof EE_Venue ? EEH_Venue_View::$_venue : null;
-    }
-
-
-    /**
-     *  get_event_venues
-     *
-     * @access     public
-     * @return     EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_venues()
-    {
-        global $post;
-        if ($post->post_type == EspressoPostType::EVENTS) {
-            if (isset($post->EE_Event) && $post->EE_Event instanceof EE_Event) {
-                return $post->EE_Event->venue();
-            }
-        }
-        return [];
-    }
-
-
-    /**
-     * Simply checks whether a venue for the given ID (or the internally derived venue is private).
-     *
-     * Note: This will return true if its private, null if the venue doesn't exist, and false, if the venue exists but
-     * is not private.  So it is important to do explicit boolean checks when using this conditional.
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     *
-     * @return bool|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_venue_private($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if (! $venue instanceof EE_Venue) {
-            return null;
-        }
-
-        return $venue->status() == 'private';
-    }
-
-
-    /**
-     * returns true or false if a venue is password protected or not
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_venue_password_protected($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
-        if (
-            $venue instanceof EE_Venue
-            && post_password_required($venue->ID())
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * If a venue is password protected, this will return the password form for gaining access
-     * returns an empty string otherwise
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function password_protected_venue_form($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
-        if (
-            $venue instanceof EE_Venue
-            && post_password_required($venue->ID())
-        ) {
-            return get_the_password_form($venue->ID());
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_description
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_description($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return $venue->get_pretty('VNU_desc');
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_excerpt
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_excerpt($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
-            $venue_link = ' ' . EEH_Venue_View::venue_details_link(
-                $venue->ID(),
-                esc_html__('more', 'event_espresso') . '…'
-            );
-            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_categories
-     *
-     * @access    public
-     * @param int  $VNU_ID
-     * @param bool $hide_uncategorized
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_categories($VNU_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = [];
-        $venue          = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // get category terms
-            if ($venue_categories = get_the_terms($venue->ID(), 'espresso_venue_categories')) {
-                // loop thru terms and create links
-                foreach ($venue_categories as $term) {
-                    $url = get_term_link($term, 'espresso_venue_categories');
-                    if (
-                        ! is_wp_error($url)
-                        && (($hide_uncategorized
-                             && strtolower($term->name) != esc_html__(
-                                 'uncategorized',
-                                 'event_espresso'
-                             ))
-                            || ! $hide_uncategorized)
-                    ) {
-                        $category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-    /**
-     *    venue_address
-     *
-     * @access    public
-     * @param string $type
-     * @param int    $VNU_ID
-     * @param bool   $use_schema
-     * @param bool   $add_wrapper
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_address($type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Address::format($venue, $type, $use_schema, $add_wrapper);
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_has_address
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return bool|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_has_address($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Address::format($venue, 'inline', false, false);
-        }
-        return false;
-    }
-
-
-    /**
-     *    venue_name
-     *
-     * @access    public
-     * @param string $link_to - options( details, website, none ) whether to turn Venue name into a clickable link to
-     *                        the Venue's details page or website
-     * @param int    $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_name($link_to = 'details', $VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $venue_name = apply_filters(
-                'FHEE__EEH_Venue__venue_name__append_private_venue_name',
-                EEH_Venue_View::is_venue_private()
-                    ? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
-                    : EEH_Venue_View::$_venue->name(),
-                EEH_Venue_View::$_venue
-            );
-            $venue_name = EEH_Schema::name($venue_name);
-
-            // if venue is trashed then ignore the "link to" setting because the venue is trashed.
-            if ($venue->get('status') == 'trash') {
-                $link_to = '';
-            }
-            switch ($link_to) {
-                case 'details':
-                    return EEH_Venue_View::venue_details_link($venue->ID(), $venue_name);
-
-                case 'website':
-                    return EEH_Venue_View::venue_website_link($venue->ID(), $venue_name);
-
-                default:
-                    return $venue_name;
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_details_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_details_link($VNU_ID = 0, $text = '')
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Schema::url(get_permalink($venue->ID()), $text);
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_website_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_website_link($VNU_ID = 0, $text = '')
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $url  = $venue->venue_url();
-            $text = ! empty($text) ? $text : $url;
-            return ! empty($url) ? EEH_Schema::url($url, $text, ['target' => '_blank']) : '';
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_phone
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_phone($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Schema::telephone($venue->phone());
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_gmap
-     *
-     * @access    public
-     * @param int         $VNU_ID
-     * @param bool|string $map_ID a unique identifier for this map
-     * @param array       $gmap   map options
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_gmap($VNU_ID = 0, $map_ID = false, $gmap = [])
-    {
-
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // check for global espresso_events post and use its ID if no map_ID is set
-            global $post;
-            $map_ID = empty($map_ID) && $post->post_type == EspressoPostType::EVENTS ? $post->ID : $map_ID;
-            // grab map settings
-            $map_cfg = EE_Registry::instance()->CFG->map_settings;
-            // are maps enabled ?
-            if ($map_cfg->use_google_maps && $venue->enable_for_gmap()) {
-                $details_page = is_single();
-                $options      = [];
-
-                $options['map_ID'] = $map_ID && $map_ID != $venue->ID()
-                    ? $map_ID . '-' . $venue->ID()
-                    : $venue->ID();
-
-                $options['location'] = EEH_Address::format($venue, 'inline', false, false);
-
-                $options['ee_map_width'] = $details_page
-                    ? $map_cfg->event_details_map_width
-                    : $map_cfg->event_list_map_width;
-
-                $options['ee_map_width'] = isset($gmap['ee_map_width']) && ! empty($gmap['ee_map_width'])
-                    ? $gmap['ee_map_width']
-                    : $options['ee_map_width'];
-
-                $options['ee_map_height'] = $details_page
-                    ? $map_cfg->event_details_map_height
-                    : $map_cfg->event_list_map_height;
-
-                $options['ee_map_height'] = isset($gmap['ee_map_height']) && ! empty($gmap['ee_map_height'])
-                    ? $gmap['ee_map_height']
-                    : $options['ee_map_height'];
-
-                $options['ee_map_zoom'] = $details_page
-                    ? $map_cfg->event_details_map_zoom
-                    : $map_cfg->event_list_map_zoom;
-
-                $options['ee_map_zoom'] = isset($gmap['ee_map_zoom']) && ! empty($gmap['ee_map_zoom'])
-                    ? $gmap['ee_map_zoom']
-                    : $options['ee_map_zoom'];
-
-                $options['ee_map_nav_display'] = $details_page
-                    ? $map_cfg->event_details_display_nav
-                    : $map_cfg->event_list_display_nav;
-
-                $options['ee_map_nav_display'] =
-                    isset($gmap['ee_map_nav_display']) && ! empty($gmap['ee_map_nav_display'])
-                        ? 'true'
-                        : $options['ee_map_nav_display'];
-
-                $options['ee_map_nav_size'] = $details_page
-                    ? $map_cfg->event_details_nav_size
-                    : $map_cfg->event_list_nav_size;
-
-                $options['ee_map_nav_size'] = isset($gmap['ee_map_nav_size']) && ! empty($gmap['ee_map_nav_size'])
-                    ? $gmap['ee_map_nav_size']
-                    : $options['ee_map_nav_size'];
-
-                $options['ee_map_type_control'] = $details_page
-                    ? $map_cfg->event_details_control_type
-                    : $map_cfg->event_list_control_type;
-
-                $options['ee_map_type_control'] =
-                    isset($gmap['ee_map_type_control']) && ! empty($gmap['ee_map_type_control'])
-                        ? $gmap['ee_map_type_control']
-                        : $options['ee_map_type_control'];
-
-                $options['ee_map_align'] = $details_page
-                    ? $map_cfg->event_details_map_align
-                    : $map_cfg->event_list_map_align;
-
-                $options['ee_map_align'] = isset($gmap['ee_map_align']) && ! empty($gmap['ee_map_align'])
-                    ? $gmap['ee_map_align']
-                    : $options['ee_map_align'];
-
-                $options['ee_static_url'] = isset($gmap['ee_static_url']) && ! empty($gmap['ee_static_url'])
-                    ? (bool) absint($gmap['ee_static_url'])
-                    : $venue->google_map_link();
-
-                return EEH_Maps::google_map($options);
-            }
-        }
-
-        return '';
-    }
-
-
-    /**
-     * Gets the HTML to display a static map of the venue
-     *
-     * @param EE_Venue $venue
-     * @param array    $attributes like EEH_Maps::google_map_link
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function espresso_google_static_map(EE_Venue $venue, $attributes = [])
-    {
-        $state      = $venue->state_obj();
-        $country    = $venue->country_obj();
-        $attributes = shortcode_atts(
-            [
-                'id'      => $venue->ID(),
-                'address' => $venue->get('VNU_address'),
-                'city'    => $venue->get('VNU_city'),
-                'state'   => $state instanceof EE_State ? $state->name() : '',
-                'zip'     => $venue->get('VNU_zip'),
-                'country' => $country instanceof EE_Country ? $country->name() : '',
-                'type'    => 'map',
-                'map_w'   => 200,
-                'map_h'   => 200,
-            ],
-            $attributes
-        );
-        return EEH_Maps::google_map_link($attributes);
-    }
-
-
-    /**
-     *    edit_venue_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function edit_venue_link(
-        $VNU_ID = 0,
-        $link = '',
-        $before = '<p class="edit-venue-lnk small-txt">',
-        $after = '</p>'
-    ) {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // can the user edit this post ?
-            if (current_user_can('edit_post', $venue->ID())) {
-                // set link text
-                $link = ! empty($link) ? $link : esc_html__('edit this venue', 'event_espresso');
-                // generate nonce
-                $nonce = wp_create_nonce('edit_nonce');
-                // generate url to venue editor for this venue
-                $url =
-                    add_query_arg(
-                        [
-                            'page'       => 'espresso_venues',
-                            'action'     => 'edit',
-                            'post'       => $venue->ID(),
-                            'edit_nonce' => $nonce,
-                        ],
-                        admin_url('admin.php')
-                    );
-                // get edit CPT text
-                $post_type_obj = get_post_type_object(EspressoPostType::VENUES);
-                // build final link html
-                $link =
-                    '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
-                        $post_type_obj->labels->edit_item
-                    ) . '">' . $link . '</a>';
-                // put it all together
-                return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
-            }
-        }
-        return '';
-    }
+	/**
+	 * @access    private
+	 * @var EE_Venue
+	 */
+	private static $_venue = null;
+
+
+	/**
+	 *    get_venue
+	 *    attempts to retrieve an EE_Venue object any way it can
+	 *
+	 * @access    public
+	 * @param int  $VNU_ID
+	 * @param bool $look_in_event
+	 * @param bool $privacy_check   Defaults to true.
+	 *                              When false, means even if the venue is private we return it regardless of access.
+	 * @param bool $password_check
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_venue($VNU_ID = 0, $look_in_event = true, $privacy_check = true, $password_check = true)
+	{
+		$VNU_ID = absint($VNU_ID);
+		// do we already have the Venue you are looking for?
+		if (EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+			// If the Venue ID matches $VNU_ID, return the venue.
+			if (EEH_Venue_View::$_venue->ID() === $VNU_ID) {
+				return EEH_Venue_View::_get_venue($privacy_check);
+			}
+			// If the Venue ID does not match, try pulling a venue using $VNU_ID.
+			$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+			if ($venue instanceof EE_Venue) {
+				EEH_Venue_View::$_venue = $venue;
+				return EEH_Venue_View::_get_venue($privacy_check);
+			}
+		}
+		// international newspaper?
+		global $post;
+		if ($post instanceof WP_Post) {
+			switch ($post->post_type) {
+				// if this is being called from an EE_Venue post,
+				// and the EE_Venue post corresponds to the EE_Venue that is being asked for,
+				// then we can try to just grab the attached EE_Venue object
+				case EspressoPostType::VENUES:
+					// the post already contains the related EE_Venue object AND one of the following is TRUE:
+					// the requested Venue ID matches the post ID OR...
+					// there was no specific Venue ID requested
+					if (isset($post->EE_Venue) && ($VNU_ID == $post->ID || ! $VNU_ID)) {
+						// use existing related EE_Venue object
+						EEH_Venue_View::$_venue = $post->EE_Venue;
+					} elseif ($VNU_ID) {
+						// there WAS a specific Venue ID requested, but it's NOT the current post object
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+					} else {
+						// no specific Venue ID requested, so use post ID to generate EE_Venue object
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($post->ID);
+					}
+					break;
+
+				case EspressoPostType::EVENTS:
+					if ($look_in_event) {
+						// grab the events related venues
+						$venues = EEH_Venue_View::get_event_venues();
+						// make sure the result is an array
+						$venues = is_array($venues) ? $venues : [$venues];
+						// do we have an ID for a specific venue?
+						if ($VNU_ID) {
+							// loop thru the related venues
+							foreach ($venues as $venue) {
+								if ($venue instanceof EE_Venue) {
+									// until we find the venue we're looking for
+									if ($venue->ID() == $VNU_ID) {
+										EEH_Venue_View::$_venue = $venue;
+										break;
+									}
+								}
+							}
+							// no venue ID ?
+							// then the global post is an events post and this function was called with no argument
+						} else {
+							// just grab the first related event venue
+							EEH_Venue_View::$_venue = reset($venues);
+						}
+					}
+					break;
+			}
+		}
+		// now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
+		if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+			// sigh... pull it from the db
+			EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		}
+		return EEH_Venue_View::_get_venue($privacy_check, $password_check);
+	}
+
+
+	/**
+	 * return a single venue
+	 *
+	 * @param bool $privacy_check   Defaults to true.
+	 *                              When false, means even if the venue is private we return it regardless of access.
+	 * @param bool $password_check
+	 * @return  EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_venue($privacy_check = true, $password_check = true)
+	{
+		// check for private venues.
+		if (
+			EEH_Venue_View::$_venue instanceof EE_Venue
+			&& EEH_Venue_View::$_venue->status() == 'private'
+			&& $privacy_check
+			&& ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')
+		) {
+			return null;
+		}
+		// check for password protected venues
+		if (
+			EEH_Venue_View::$_venue instanceof EE_Venue
+			&& $password_check
+			&& post_password_required(EEH_Venue_View::$_venue->ID())
+		) {
+			return null;
+		}
+		return EEH_Venue_View::$_venue instanceof EE_Venue ? EEH_Venue_View::$_venue : null;
+	}
+
+
+	/**
+	 *  get_event_venues
+	 *
+	 * @access     public
+	 * @return     EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_venues()
+	{
+		global $post;
+		if ($post->post_type == EspressoPostType::EVENTS) {
+			if (isset($post->EE_Event) && $post->EE_Event instanceof EE_Event) {
+				return $post->EE_Event->venue();
+			}
+		}
+		return [];
+	}
+
+
+	/**
+	 * Simply checks whether a venue for the given ID (or the internally derived venue is private).
+	 *
+	 * Note: This will return true if its private, null if the venue doesn't exist, and false, if the venue exists but
+	 * is not private.  So it is important to do explicit boolean checks when using this conditional.
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 *
+	 * @return bool|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_venue_private($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if (! $venue instanceof EE_Venue) {
+			return null;
+		}
+
+		return $venue->status() == 'private';
+	}
+
+
+	/**
+	 * returns true or false if a venue is password protected or not
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_venue_password_protected($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
+		if (
+			$venue instanceof EE_Venue
+			&& post_password_required($venue->ID())
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * If a venue is password protected, this will return the password form for gaining access
+	 * returns an empty string otherwise
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function password_protected_venue_form($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
+		if (
+			$venue instanceof EE_Venue
+			&& post_password_required($venue->ID())
+		) {
+			return get_the_password_form($venue->ID());
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_description
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_description($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return $venue->get_pretty('VNU_desc');
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_excerpt
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_excerpt($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
+			$venue_link = ' ' . EEH_Venue_View::venue_details_link(
+				$venue->ID(),
+				esc_html__('more', 'event_espresso') . '&hellip;'
+			);
+			return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_categories
+	 *
+	 * @access    public
+	 * @param int  $VNU_ID
+	 * @param bool $hide_uncategorized
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_categories($VNU_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = [];
+		$venue          = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// get category terms
+			if ($venue_categories = get_the_terms($venue->ID(), 'espresso_venue_categories')) {
+				// loop thru terms and create links
+				foreach ($venue_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if (
+						! is_wp_error($url)
+						&& (($hide_uncategorized
+							 && strtolower($term->name) != esc_html__(
+								 'uncategorized',
+								 'event_espresso'
+							 ))
+							|| ! $hide_uncategorized)
+					) {
+						$category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+	/**
+	 *    venue_address
+	 *
+	 * @access    public
+	 * @param string $type
+	 * @param int    $VNU_ID
+	 * @param bool   $use_schema
+	 * @param bool   $add_wrapper
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_address($type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, $type, $use_schema, $add_wrapper);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_has_address
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return bool|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_has_address($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, 'inline', false, false);
+		}
+		return false;
+	}
+
+
+	/**
+	 *    venue_name
+	 *
+	 * @access    public
+	 * @param string $link_to - options( details, website, none ) whether to turn Venue name into a clickable link to
+	 *                        the Venue's details page or website
+	 * @param int    $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_name($link_to = 'details', $VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$venue_name = apply_filters(
+				'FHEE__EEH_Venue__venue_name__append_private_venue_name',
+				EEH_Venue_View::is_venue_private()
+					? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
+					: EEH_Venue_View::$_venue->name(),
+				EEH_Venue_View::$_venue
+			);
+			$venue_name = EEH_Schema::name($venue_name);
+
+			// if venue is trashed then ignore the "link to" setting because the venue is trashed.
+			if ($venue->get('status') == 'trash') {
+				$link_to = '';
+			}
+			switch ($link_to) {
+				case 'details':
+					return EEH_Venue_View::venue_details_link($venue->ID(), $venue_name);
+
+				case 'website':
+					return EEH_Venue_View::venue_website_link($venue->ID(), $venue_name);
+
+				default:
+					return $venue_name;
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_details_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_details_link($VNU_ID = 0, $text = '')
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::url(get_permalink($venue->ID()), $text);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_website_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_website_link($VNU_ID = 0, $text = '')
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$url  = $venue->venue_url();
+			$text = ! empty($text) ? $text : $url;
+			return ! empty($url) ? EEH_Schema::url($url, $text, ['target' => '_blank']) : '';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_phone
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_phone($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::telephone($venue->phone());
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_gmap
+	 *
+	 * @access    public
+	 * @param int         $VNU_ID
+	 * @param bool|string $map_ID a unique identifier for this map
+	 * @param array       $gmap   map options
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_gmap($VNU_ID = 0, $map_ID = false, $gmap = [])
+	{
+
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// check for global espresso_events post and use its ID if no map_ID is set
+			global $post;
+			$map_ID = empty($map_ID) && $post->post_type == EspressoPostType::EVENTS ? $post->ID : $map_ID;
+			// grab map settings
+			$map_cfg = EE_Registry::instance()->CFG->map_settings;
+			// are maps enabled ?
+			if ($map_cfg->use_google_maps && $venue->enable_for_gmap()) {
+				$details_page = is_single();
+				$options      = [];
+
+				$options['map_ID'] = $map_ID && $map_ID != $venue->ID()
+					? $map_ID . '-' . $venue->ID()
+					: $venue->ID();
+
+				$options['location'] = EEH_Address::format($venue, 'inline', false, false);
+
+				$options['ee_map_width'] = $details_page
+					? $map_cfg->event_details_map_width
+					: $map_cfg->event_list_map_width;
+
+				$options['ee_map_width'] = isset($gmap['ee_map_width']) && ! empty($gmap['ee_map_width'])
+					? $gmap['ee_map_width']
+					: $options['ee_map_width'];
+
+				$options['ee_map_height'] = $details_page
+					? $map_cfg->event_details_map_height
+					: $map_cfg->event_list_map_height;
+
+				$options['ee_map_height'] = isset($gmap['ee_map_height']) && ! empty($gmap['ee_map_height'])
+					? $gmap['ee_map_height']
+					: $options['ee_map_height'];
+
+				$options['ee_map_zoom'] = $details_page
+					? $map_cfg->event_details_map_zoom
+					: $map_cfg->event_list_map_zoom;
+
+				$options['ee_map_zoom'] = isset($gmap['ee_map_zoom']) && ! empty($gmap['ee_map_zoom'])
+					? $gmap['ee_map_zoom']
+					: $options['ee_map_zoom'];
+
+				$options['ee_map_nav_display'] = $details_page
+					? $map_cfg->event_details_display_nav
+					: $map_cfg->event_list_display_nav;
+
+				$options['ee_map_nav_display'] =
+					isset($gmap['ee_map_nav_display']) && ! empty($gmap['ee_map_nav_display'])
+						? 'true'
+						: $options['ee_map_nav_display'];
+
+				$options['ee_map_nav_size'] = $details_page
+					? $map_cfg->event_details_nav_size
+					: $map_cfg->event_list_nav_size;
+
+				$options['ee_map_nav_size'] = isset($gmap['ee_map_nav_size']) && ! empty($gmap['ee_map_nav_size'])
+					? $gmap['ee_map_nav_size']
+					: $options['ee_map_nav_size'];
+
+				$options['ee_map_type_control'] = $details_page
+					? $map_cfg->event_details_control_type
+					: $map_cfg->event_list_control_type;
+
+				$options['ee_map_type_control'] =
+					isset($gmap['ee_map_type_control']) && ! empty($gmap['ee_map_type_control'])
+						? $gmap['ee_map_type_control']
+						: $options['ee_map_type_control'];
+
+				$options['ee_map_align'] = $details_page
+					? $map_cfg->event_details_map_align
+					: $map_cfg->event_list_map_align;
+
+				$options['ee_map_align'] = isset($gmap['ee_map_align']) && ! empty($gmap['ee_map_align'])
+					? $gmap['ee_map_align']
+					: $options['ee_map_align'];
+
+				$options['ee_static_url'] = isset($gmap['ee_static_url']) && ! empty($gmap['ee_static_url'])
+					? (bool) absint($gmap['ee_static_url'])
+					: $venue->google_map_link();
+
+				return EEH_Maps::google_map($options);
+			}
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * Gets the HTML to display a static map of the venue
+	 *
+	 * @param EE_Venue $venue
+	 * @param array    $attributes like EEH_Maps::google_map_link
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function espresso_google_static_map(EE_Venue $venue, $attributes = [])
+	{
+		$state      = $venue->state_obj();
+		$country    = $venue->country_obj();
+		$attributes = shortcode_atts(
+			[
+				'id'      => $venue->ID(),
+				'address' => $venue->get('VNU_address'),
+				'city'    => $venue->get('VNU_city'),
+				'state'   => $state instanceof EE_State ? $state->name() : '',
+				'zip'     => $venue->get('VNU_zip'),
+				'country' => $country instanceof EE_Country ? $country->name() : '',
+				'type'    => 'map',
+				'map_w'   => 200,
+				'map_h'   => 200,
+			],
+			$attributes
+		);
+		return EEH_Maps::google_map_link($attributes);
+	}
+
+
+	/**
+	 *    edit_venue_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function edit_venue_link(
+		$VNU_ID = 0,
+		$link = '',
+		$before = '<p class="edit-venue-lnk small-txt">',
+		$after = '</p>'
+	) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// can the user edit this post ?
+			if (current_user_can('edit_post', $venue->ID())) {
+				// set link text
+				$link = ! empty($link) ? $link : esc_html__('edit this venue', 'event_espresso');
+				// generate nonce
+				$nonce = wp_create_nonce('edit_nonce');
+				// generate url to venue editor for this venue
+				$url =
+					add_query_arg(
+						[
+							'page'       => 'espresso_venues',
+							'action'     => 'edit',
+							'post'       => $venue->ID(),
+							'edit_nonce' => $nonce,
+						],
+						admin_url('admin.php')
+					);
+				// get edit CPT text
+				$post_type_obj = get_post_type_object(EspressoPostType::VENUES);
+				// build final link html
+				$link =
+					'<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
+						$post_type_obj->labels->edit_item
+					) . '">' . $link . '</a>';
+				// put it all together
+				return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
+			}
+		}
+		return '';
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -100,7 +100,7 @@ 
             }
         }
         // now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
-        if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+        if ( ! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
             // sigh... pull it from the db
             EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
         }
@@ -176,7 +176,7 @@ 
     public static function is_venue_private($VNU_ID = false)
     {
         $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if (! $venue instanceof EE_Venue) {
+        if ( ! $venue instanceof EE_Venue) {
             return null;
         }
 
@@ -261,11 +261,11 @@ 
         $venue = EEH_Venue_View::get_venue($VNU_ID);
         if ($venue instanceof EE_Venue) {
             $excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
-            $venue_link = ' ' . EEH_Venue_View::venue_details_link(
+            $venue_link = ' '.EEH_Venue_View::venue_details_link(
                 $venue->ID(),
-                esc_html__('more', 'event_espresso') . '…'
+                esc_html__('more', 'event_espresso').'…'
             );
-            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
+            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '').$venue_link : '';
         }
         return '';
     }
@@ -300,7 +300,7 @@ 
                              ))
                             || ! $hide_uncategorized)
                     ) {
-                        $category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
+                        $category_links[] = '<a href="'.esc_url($url).'" rel="tag">'.$term->name.'</a> ';
                     }
                 }
             }
@@ -368,7 +368,7 @@ 
             $venue_name = apply_filters(
                 'FHEE__EEH_Venue__venue_name__append_private_venue_name',
                 EEH_Venue_View::is_venue_private()
-                    ? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
+                    ? EEH_Venue_View::$_venue->name()."&nbsp;".esc_html__('(Private)', 'event_espresso')
                     : EEH_Venue_View::$_venue->name(),
                 EEH_Venue_View::$_venue
             );
@@ -481,7 +481,7 @@ 
                 $options      = [];
 
                 $options['map_ID'] = $map_ID && $map_ID != $venue->ID()
-                    ? $map_ID . '-' . $venue->ID()
+                    ? $map_ID.'-'.$venue->ID()
                     : $venue->ID();
 
                 $options['location'] = EEH_Address::format($venue, 'inline', false, false);
@@ -628,11 +628,11 @@ 
                 $post_type_obj = get_post_type_object(EspressoPostType::VENUES);
                 // build final link html
                 $link =
-                    '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
+                    '<a class="post-edit-link" href="'.$url.'" title="'.esc_attr(
                         $post_type_obj->labels->edit_item
-                    ) . '">' . $link . '</a>';
+                    ).'">'.$link.'</a>';
                 // put it all together
-                return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
+                return $before.apply_filters('edit_post_link', $link, $venue->ID()).$after;
             }
         }
         return '';

core/helpers/EEH_Export.helper.php

Indentation +182 added lines, -182 removed lines

@@ -11,200 +11,200 @@
  */
 class EEH_Export
 {
-    /**
-     * Gets the 'normal' column named for fields
-     *
-     * @param EE_Model_Field_Base $field
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_column_name_for_field(EE_Model_Field_Base $field): string
-    {
-        $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
-        if (
-            apply_filters(
-                'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-                false,
-                $column_name,
-                $field
-            )
-        ) {
-            $column_name .= "["
-                . wp_specialchars_decode($field->get_name(), ENT_QUOTES)
-                . "]";
-        }
-        return $column_name;
-    }
+	/**
+	 * Gets the 'normal' column named for fields
+	 *
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_column_name_for_field(EE_Model_Field_Base $field): string
+	{
+		$column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
+		if (
+			apply_filters(
+				'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+				false,
+				$column_name,
+				$field
+			)
+		) {
+			$column_name .= "["
+				. wp_specialchars_decode($field->get_name(), ENT_QUOTES)
+				. "]";
+		}
+		return $column_name;
+	}
 
 
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param string $filepath
-     * @param array  $data                          2D array,first numerically-indexed,
-     *                                              and next-level-down preferably indexed by string
-     * @param bool   $write_column_headers          whether or not we should add the keys in the bottom-most array
-     *                                              as a row for headers in the CSV.
-     *                                              Eg, if $data looked like:
-     *                                              array(
-     *                                              0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
-     *                                              1=>array(...,...)
-     *                                              )
-     * @param bool   $headers_only                  if true then we won't print any data, just headers. defaults to
-     *                                              false
-     * @return boolean                      if we successfully wrote to the CSV or not. If there's no $data,
-     *                                              we consider that a success (because we wrote everything there
-     *                                              was...nothing)
-     * @throws EE_Error
-     */
-    public static function write_data_array_to_csv(
-        string $filepath,
-        array $data,
-        bool $write_column_headers = true,
-        bool $headers_only = false
-    ): bool {
-        // determine if $data is actually a 2d array
-        if ($data && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "top-level array must be numerically indexed. Does these look like numbers to you? %s",
-                            "event_espresso"
-                        ),
-                        implode(",", array_keys($data))
-                    )
-                );
-            }
-            $new_file_contents       = '';
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys              = array_keys($item_in_top_level_array);
-                $new_file_contents .= EEH_Export::get_csv_row($keys);
-                if ($headers_only) {
-                    return EEH_File::write_to_file(
-                        $filepath,
-                        EEH_File::get_file_contents($filepath) . $new_file_contents
-                    );
-                }
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $new_row           = EEH_Export::get_csv_row($data_row);
-                $new_file_contents .= $new_row ?: '';
-            }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
-        }
-        // no data TO write... so we can assume that's a success
-        return true;
-    }
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param string $filepath
+	 * @param array  $data                          2D array,first numerically-indexed,
+	 *                                              and next-level-down preferably indexed by string
+	 * @param bool   $write_column_headers          whether or not we should add the keys in the bottom-most array
+	 *                                              as a row for headers in the CSV.
+	 *                                              Eg, if $data looked like:
+	 *                                              array(
+	 *                                              0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
+	 *                                              1=>array(...,...)
+	 *                                              )
+	 * @param bool   $headers_only                  if true then we won't print any data, just headers. defaults to
+	 *                                              false
+	 * @return boolean                      if we successfully wrote to the CSV or not. If there's no $data,
+	 *                                              we consider that a success (because we wrote everything there
+	 *                                              was...nothing)
+	 * @throws EE_Error
+	 */
+	public static function write_data_array_to_csv(
+		string $filepath,
+		array $data,
+		bool $write_column_headers = true,
+		bool $headers_only = false
+	): bool {
+		// determine if $data is actually a 2d array
+		if ($data && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"top-level array must be numerically indexed. Does these look like numbers to you? %s",
+							"event_espresso"
+						),
+						implode(",", array_keys($data))
+					)
+				);
+			}
+			$new_file_contents       = '';
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys              = array_keys($item_in_top_level_array);
+				$new_file_contents .= EEH_Export::get_csv_row($keys);
+				if ($headers_only) {
+					return EEH_File::write_to_file(
+						$filepath,
+						EEH_File::get_file_contents($filepath) . $new_file_contents
+					);
+				}
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$new_row           = EEH_Export::get_csv_row($data_row);
+				$new_file_contents .= $new_row ?: '';
+			}
+			return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+		}
+		// no data TO write... so we can assume that's a success
+		return true;
+	}
 
 
-    /**
-     *
-     *  Writes a row to the csv file
-     *
-     * @param array  $row        - individual row of csv data
-     * @param string $delimiter  - csv delimiter
-     * @param string $enclosure  - csv enclosure
-     * @param bool   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     * @return string of text for teh csv file
-     */
-    public static function get_csv_row(
-        array $row,
-        string $delimiter = ',',
-        string $enclosure = '"',
-        bool $mysql_null = false
-    ): string {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+	/**
+	 *
+	 *  Writes a row to the csv file
+	 *
+	 * @param array  $row        - individual row of csv data
+	 * @param string $delimiter  - csv delimiter
+	 * @param string $enclosure  - csv enclosure
+	 * @param bool   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	 * @return string of text for teh csv file
+	 */
+	public static function get_csv_row(
+		array $row,
+		string $delimiter = ',',
+		string $enclosure = '"',
+		bool $mysql_null = false
+	): string {
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
 
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
 
-        $output = [];
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
+		$output = [];
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
 
-            $output[] = $field_value && preg_match("/(?:$delimiter_esc|$enclosure_esc|\s)/", $field_value)
-                ? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
-                : $field_value;
-        }
+			$output[] = $field_value && preg_match("/(?:$delimiter_esc|$enclosure_esc|\s)/", $field_value)
+				? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+				: $field_value;
+		}
 
-        return implode($delimiter, $output) . PHP_EOL;
-    }
+		return implode($delimiter, $output) . PHP_EOL;
+	}
 
 
-    /**
-     * Shortcut for preparing a database result for display
-     *
-     * @param EEM_Base         $model
-     * @param string           $field_name
-     * @param int|float|string $raw_db_value
-     * @param boolean|string $pretty_schema   true to display pretty,
-     *                                        a string to use a specific "Schema",
-     *                                        or false to NOT display pretty
-     * @return string
-     * @throws EE_Error
-     */
-    public static function prepare_value_from_db_for_display(
-        EEM_Base $model,
-        string $field_name,
-        $raw_db_value,
-        $pretty_schema = true
-    ): string {
-        $field_obj          = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(
-                EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)),
-                $pretty_schema
-            );
-            $field_obj->set_time_format(
-                EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)),
-                $pretty_schema
-            );
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        }
-        if (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        }
-        return $field_obj->prepare_for_get($value_on_model_obj);
-    }
+	/**
+	 * Shortcut for preparing a database result for display
+	 *
+	 * @param EEM_Base         $model
+	 * @param string           $field_name
+	 * @param int|float|string $raw_db_value
+	 * @param boolean|string $pretty_schema   true to display pretty,
+	 *                                        a string to use a specific "Schema",
+	 *                                        or false to NOT display pretty
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function prepare_value_from_db_for_display(
+		EEM_Base $model,
+		string $field_name,
+		$raw_db_value,
+		$pretty_schema = true
+	): string {
+		$field_obj          = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(
+				EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)),
+				$pretty_schema
+			);
+			$field_obj->set_time_format(
+				EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)),
+				$pretty_schema
+			);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		}
+		if (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		}
+		return $field_obj->prepare_for_get($value_on_model_obj);
+	}
 
 
-    /**
-     * Gets the date format to use in exports. filterable
-     *
-     * @param string|null $current_format
-     * @return string
-     */
-    public static function get_date_format_for_export(?string $current_format = null): string
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
+	/**
+	 * Gets the date format to use in exports. filterable
+	 *
+	 * @param string|null $current_format
+	 * @return string
+	 */
+	public static function get_date_format_for_export(?string $current_format = null): string
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
 
 
-    /**
-     * Gets the time format we want to use in exports. Filterable
-     *
-     * @param string|null $current_format
-     * @return string
-     */
-    public static function get_time_format_for_export(?string $current_format = null): string
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	/**
+	 * Gets the time format we want to use in exports. Filterable
+	 *
+	 * @param string|null $current_format
+	 * @return string
+	 */
+	public static function get_time_format_for_export(?string $current_format = null): string
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -82,21 +82,21 @@ 
             // now, is the last item in the top-level array of $data an associative or numeric array?
             if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
                 // its associative, so we want to output its keys as column headers
-                $keys              = array_keys($item_in_top_level_array);
+                $keys = array_keys($item_in_top_level_array);
                 $new_file_contents .= EEH_Export::get_csv_row($keys);
                 if ($headers_only) {
                     return EEH_File::write_to_file(
                         $filepath,
-                        EEH_File::get_file_contents($filepath) . $new_file_contents
+                        EEH_File::get_file_contents($filepath).$new_file_contents
                     );
                 }
             }
             // start writing data
             foreach ($data as $data_row) {
-                $new_row           = EEH_Export::get_csv_row($data_row);
+                $new_row = EEH_Export::get_csv_row($data_row);
                 $new_file_contents .= $new_row ?: '';
             }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents);
         }
         // no data TO write... so we can assume that's a success
         return true;
@@ -137,11 +137,11 @@ 
             }
 
             $output[] = $field_value && preg_match("/(?:$delimiter_esc|$enclosure_esc|\s)/", $field_value)
-                ? ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+                ? ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure)
                 : $field_value;
         }
 
-        return implode($delimiter, $output) . PHP_EOL;
+        return implode($delimiter, $output).PHP_EOL;
     }
 
 

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +606 added lines, -606 removed lines

@@ -42,610 +42,610 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
-        $DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(
-                esc_html__('You do not have permission to view registrations', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename()
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
-        } else {
-            $query_params = [
-                [ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
-                'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
-                'force_join' => ['Transaction', 'Ticket', 'Attendee'],
-                'caps'       => EEM_Base::caps_read_admin,
-            ];
-            if ($event_id) {
-                $query_params[0]['EVT_ID'] = $event_id;
-            } else {
-                $query_params['force_join'][] = 'Event';
-            }
-        }
-        // unless the query params already include a status,
-        // we want to exclude registrations from failed or abandoned transactions
-        if (! isset($query_params[0]['Transaction.STS_ID'])) {
-            $query_params[0]['OR'] = [
-                // don't include registrations from failed or abandoned transactions...
-                'Transaction.STS_ID' => [
-                    'NOT IN',
-                    [
-                        EEM_Transaction::failed_status_code,
-                        EEM_Transaction::abandoned_status_code,
-                    ],
-                ],
-                // unless the registration is approved,
-                // in which case include it regardless of transaction status
-                'STS_ID' => EEM_Registration::status_id_approved,
-            ];
-        }
-
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
-        }
-
-        $return_url_args = [];
-        parse_str(
-            parse_url(
-                $job_parameters->request_datum('return_url', ''),
-                PHP_URL_QUERY
-            ),
-            $return_url_args
-        );
-
-        if (
-            isset($return_url_args['orderby'], $return_url_args['order'])
-            && $return_url_args['orderby'] === 'ATT_lname'
-        ) {
-            $query_params['order_by'] = [
-                'Attendee.ATT_lname' => $return_url_args['order'],
-                'Attendee.ATT_fname' => $return_url_args['order'],
-                'REG_ID' => $return_url_args['order']
-            ];
-        }
-
-        $query_params = apply_filters(
-            'FHEE__EE_Export__report_registration_for_event',
-            $query_params,
-            $event_id
-        );
-
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size($this->count_units_to_process($query_params));
-        // we need to set the header columns
-        // but to do that we need to process one row so that we can extract ALL of the column headers
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $question_labels,
-            $query_params,
-            $DTT_ID
-        );
-        // but we don't want to write any actual data yet...
-        // so let's blank out all the values for that first row
-        array_walk(
-            $csv_data_for_row[0],
-            function (&$value) {
-                $value = null;
-            }
-        );
-
-        EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
-        $this->updateTextHeader(
-            esc_html__('Registrations report started successfully...', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
-
-
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename(): string
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
-            sprintf(
-                'event-espresso-registrations-%s.csv',
-                str_replace([':', ' '], '-', current_time('mysql'))
-            )
-        );
-    }
-
-
-    /**
-     * Gets the questions which are to be used for this report,
-     * so they can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_labels(array $registration_query_params): array
-    {
-        $where                 = $registration_query_params[0] ?? null;
-        $question_query_params = [];
-        if ($where !== null) {
-            $question_query_params = [
-                $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
-            ];
-        }
-        // Make sure it's not a system question
-        $question_query_params[0]['OR*not-system-questions'] = [
-            'QST_system'      => '',
-            'QST_system*null' => ['IS_NULL']
-        ];
-        if (
-            apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
-                false,
-                $registration_query_params
-            )
-        ) {
-            $question_query_params[0]['Answer.ANS_ID'] = ['IS_NOT_NULL'];
-        }
-        $question_query_params['order_by'] = [
-            'Question_Group_Question.QGQ_order' => 'ASC',
-            'QST_order' => 'ASC',
-            'QST_admin_label' => 'ASC'
-        ];
-        $question_query_params['group_by'] = ['QST_ID'];
-        return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
-
-
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
-    {
-        $question_where_params = [];
-        foreach ($reg_where_params as $key => $val) {
-            if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] =
-                    $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                (int) $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params'),
-                (int) $job_parameters->request_datum('DTT_ID', '0')
-            );
-            EEH_Export::write_data_array_to_csv(
-                $job_parameters->extra_datum('filepath'),
-                $csv_data,
-                false
-            );
-            $units_processed = count($csv_data);
-            if ($units_processed) {
-                $job_parameters->mark_processed($units_processed);
-                $this->updateText(
-                    sprintf(
-                        esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
-                        $units_processed
-                    )
-                );
-            }
-        }
-        $extra_response_data = ['file_url' => ''];
-        if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-            $this->displayJobFinalResults($job_parameters);
-        } else {
-            $job_parameters->set_status(JobParameters::status_continue);
-        }
-        return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
-    }
-
-
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int      $offset
-     * @param int      $limit
-     * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array    $query_params    for using where querying the model
-     * @param int      $DTT_ID
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_csv_data_for(
-        ?int $event_id,
-        int $offset,
-        int $limit,
-        array $question_labels,
-        array $query_params,
-        int $DTT_ID = 0
-    ): array {
-        $reg_fields_to_include = [
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        ];
-        $att_fields_to_include = [
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        ];
-
-        // get models
-        $event_model   = EEM_Event::instance();
-        $date_model    = EEM_Datetime::instance();
-        $ticket_model  = EEM_Ticket::instance();
-        $txn_model     = EEM_Transaction::instance();
-        $reg_model     = EEM_Registration::instance();
-        $pay_model     = EEM_Payment::instance();
-        $status_model  = EEM_Status::instance();
-
-        $registrations_csv_ready_array = [];
-        $query_params['limit']         = [$offset, $limit];
-        $registration_rows             = $reg_model->get_all_wpdb_results($query_params);
-
-        foreach ($registration_rows as $reg_row) {
-            if (! is_array($reg_row)) {
-                continue;
-            }
-            $reg_csv_array = [];
-            // registration ID
-            $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
-                EEH_Export::prepare_value_from_db_for_display(
-                    $reg_model,
-                    'REG_ID',
-                    $reg_row[ $reg_id_field->get_qualified_column() ]
-                );
-            // ALL registrations, or is list filtered to just one?
-            if (! $event_id) {
-                // ALL registrations, so get each event's name and ID
-                $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
-                    /* translators: 1: event name, 2: event ID */
-                    esc_html__('%1$s (%2$s)', 'event_espresso'),
-                    EEH_Export::prepare_value_from_db_for_display(
-                        $event_model,
-                        'EVT_name',
-                        $reg_row['Event_CPT.post_title']
-                    ),
-                    $reg_row['Event_CPT.ID']
-                );
-            }
-            // add attendee columns
-            $reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
-            // add registration columns
-            $reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
-            // get pretty status
-            $stati = $status_model->localized_status(
-                [
-                    $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                    $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                ],
-                false,
-                'sentence'
-            );
-            $is_primary_reg = $reg_row['Registration.REG_count'] == '1';
-
-            $reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
-                $stati[ $reg_row['Registration.STS_ID'] ];
-            // get pretty transaction status
-            $reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
-                $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_total',
-                    $reg_row['TransactionTable.TXN_total'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_paid',
-                    $reg_row['TransactionTable.TXN_paid'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $payment_methods                                                                  = [];
-            $gateway_txn_ids_etc                                                              = [];
-            $payment_times                                                                    = [];
-            if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                $payments_info = $pay_model->get_all_wpdb_results(
-                    [
-                        [
-                            'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                            'STS_ID' => EEM_Payment::status_id_approved,
-                        ],
-                        'force_join' => ['Payment_Method'],
-                    ],
-                    ARRAY_A,
-                    'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                );
-                [$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
-                    $payments_info
-                );
-            }
-
-            $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_times
-            );
-
-            $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_methods
-            );
-
-            $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                ',',
-                $gateway_txn_ids_etc
-            );
-
-            $ticket_name      = esc_html__('Unknown', 'event_espresso');
-            $datetime_strings = [esc_html__('Unknown', 'event_espresso')];
-            if ($reg_row['Ticket.TKT_ID']) {
-                $ticket_name       = EEH_Export::prepare_value_from_db_for_display(
-                    $ticket_model,
-                    'TKT_name',
-                    $reg_row['Ticket.TKT_name']
-                );
-                $datetime_strings = [];
-                $datetimes        = $date_model->get_all_wpdb_results(
-                    [
-                        ['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    $datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
-                        $date_model,
-                        'DTT_EVT_start',
-                        $datetime['Datetime.DTT_EVT_start']
-                    );
-                }
-            }
-
-            $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-
-
-            $reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
-                ', ',
-                $datetime_strings
-            );
-
-            // add answer columns
-            $reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
-            // Include check-in data
-            if ($event_id && $DTT_ID) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin',
-                        [
-                            [
-                                'DTT_ID' => $DTT_ID
-                            ]
-                        ]
-                    );
-                $datetime     = $date_model->get_one_by_ID($DTT_ID);
-                $checkin_rows = EEM_Checkin::instance()->get_all(
-                    [
-                        [
-                            'REG_ID' => $reg_row['Registration.REG_ID'],
-                            'DTT_ID' => $datetime->get('DTT_ID'),
-                        ],
-                    ]
-                );
-                $checkins     = [];
-                foreach ($checkin_rows as $checkin_row) {
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    if ($checkin_value) {
-                        $checkins[] = $checkin_value;
-                    }
-                }
-                $datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
-                $reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
-            } elseif ($event_id) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin'
-                    );
-
-                $datetimes = $date_model->get_all(
-                    [
-                        [
-                            'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
-                        ],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    if (! $datetime instanceof EE_Datetime) {
-                        continue;
-                    }
-
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_row = EEM_Checkin::instance()->get_one(
-                        [
-                            [
-                                'REG_ID' => $reg_row['Registration.REG_ID'],
-                                'DTT_ID' => $datetime->get('DTT_ID'),
-                            ],
-                            'limit'    => 1,
-                            'order_by' => [
-                                'CHK_ID' => 'DESC'
-                            ]
-                        ]
-                    );
-
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    $datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
-
-                    $reg_csv_array[ $datetime_name ] = $checkin_value;
-                }
-            }
-            /**
-             * Filter to change the contents of each row of the registrations report CSV file.
-             * This can be used to add or remote columns from the CSV file, or change their values.
-             * Note when using: all rows in the CSV should have the same columns.
-             *
-             * @param array $reg_csv_array keys are the column names, values are their cell values
-             * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
-             */
-            $registrations_csv_ready_array[] = apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-                $reg_csv_array,
-                $reg_row
-            );
-        }
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array               = [];
-            $model_and_fields_to_include = [
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            ];
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field                                                          =
-                        $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
-
-
-    /**
-     * Counts total unit to process
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_units_to_process(array $query_params): int
-    {
-        return EEM_Registration::instance()->count(
-            array_diff_key(
-                $query_params,
-                array_flip(
-                    ['limit']
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
-
-        $this->_file_helper->delete(
-            EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        $this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
+		$DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
+		if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(
+				esc_html__('You do not have permission to view registrations', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename()
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
+		} else {
+			$query_params = [
+				[ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
+				'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
+				'force_join' => ['Transaction', 'Ticket', 'Attendee'],
+				'caps'       => EEM_Base::caps_read_admin,
+			];
+			if ($event_id) {
+				$query_params[0]['EVT_ID'] = $event_id;
+			} else {
+				$query_params['force_join'][] = 'Event';
+			}
+		}
+		// unless the query params already include a status,
+		// we want to exclude registrations from failed or abandoned transactions
+		if (! isset($query_params[0]['Transaction.STS_ID'])) {
+			$query_params[0]['OR'] = [
+				// don't include registrations from failed or abandoned transactions...
+				'Transaction.STS_ID' => [
+					'NOT IN',
+					[
+						EEM_Transaction::failed_status_code,
+						EEM_Transaction::abandoned_status_code,
+					],
+				],
+				// unless the registration is approved,
+				// in which case include it regardless of transaction status
+				'STS_ID' => EEM_Registration::status_id_approved,
+			];
+		}
+
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
+		}
+
+		$return_url_args = [];
+		parse_str(
+			parse_url(
+				$job_parameters->request_datum('return_url', ''),
+				PHP_URL_QUERY
+			),
+			$return_url_args
+		);
+
+		if (
+			isset($return_url_args['orderby'], $return_url_args['order'])
+			&& $return_url_args['orderby'] === 'ATT_lname'
+		) {
+			$query_params['order_by'] = [
+				'Attendee.ATT_lname' => $return_url_args['order'],
+				'Attendee.ATT_fname' => $return_url_args['order'],
+				'REG_ID' => $return_url_args['order']
+			];
+		}
+
+		$query_params = apply_filters(
+			'FHEE__EE_Export__report_registration_for_event',
+			$query_params,
+			$event_id
+		);
+
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size($this->count_units_to_process($query_params));
+		// we need to set the header columns
+		// but to do that we need to process one row so that we can extract ALL of the column headers
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$question_labels,
+			$query_params,
+			$DTT_ID
+		);
+		// but we don't want to write any actual data yet...
+		// so let's blank out all the values for that first row
+		array_walk(
+			$csv_data_for_row[0],
+			function (&$value) {
+				$value = null;
+			}
+		);
+
+		EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
+		$this->updateTextHeader(
+			esc_html__('Registrations report started successfully...', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
+
+
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename(): string
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
+			sprintf(
+				'event-espresso-registrations-%s.csv',
+				str_replace([':', ' '], '-', current_time('mysql'))
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the questions which are to be used for this report,
+	 * so they can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_labels(array $registration_query_params): array
+	{
+		$where                 = $registration_query_params[0] ?? null;
+		$question_query_params = [];
+		if ($where !== null) {
+			$question_query_params = [
+				$this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
+			];
+		}
+		// Make sure it's not a system question
+		$question_query_params[0]['OR*not-system-questions'] = [
+			'QST_system'      => '',
+			'QST_system*null' => ['IS_NULL']
+		];
+		if (
+			apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
+				false,
+				$registration_query_params
+			)
+		) {
+			$question_query_params[0]['Answer.ANS_ID'] = ['IS_NOT_NULL'];
+		}
+		$question_query_params['order_by'] = [
+			'Question_Group_Question.QGQ_order' => 'ASC',
+			'QST_order' => 'ASC',
+			'QST_admin_label' => 'ASC'
+		];
+		$question_query_params['group_by'] = ['QST_ID'];
+		return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
+
+
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
+	{
+		$question_where_params = [];
+		foreach ($reg_where_params as $key => $val) {
+			if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] =
+					$this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				(int) $job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params'),
+				(int) $job_parameters->request_datum('DTT_ID', '0')
+			);
+			EEH_Export::write_data_array_to_csv(
+				$job_parameters->extra_datum('filepath'),
+				$csv_data,
+				false
+			);
+			$units_processed = count($csv_data);
+			if ($units_processed) {
+				$job_parameters->mark_processed($units_processed);
+				$this->updateText(
+					sprintf(
+						esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+						$units_processed
+					)
+				);
+			}
+		}
+		$extra_response_data = ['file_url' => ''];
+		if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+			$this->displayJobFinalResults($job_parameters);
+		} else {
+			$job_parameters->set_status(JobParameters::status_continue);
+		}
+		return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
+	}
+
+
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int      $offset
+	 * @param int      $limit
+	 * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array    $query_params    for using where querying the model
+	 * @param int      $DTT_ID
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_csv_data_for(
+		?int $event_id,
+		int $offset,
+		int $limit,
+		array $question_labels,
+		array $query_params,
+		int $DTT_ID = 0
+	): array {
+		$reg_fields_to_include = [
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		];
+		$att_fields_to_include = [
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		];
+
+		// get models
+		$event_model   = EEM_Event::instance();
+		$date_model    = EEM_Datetime::instance();
+		$ticket_model  = EEM_Ticket::instance();
+		$txn_model     = EEM_Transaction::instance();
+		$reg_model     = EEM_Registration::instance();
+		$pay_model     = EEM_Payment::instance();
+		$status_model  = EEM_Status::instance();
+
+		$registrations_csv_ready_array = [];
+		$query_params['limit']         = [$offset, $limit];
+		$registration_rows             = $reg_model->get_all_wpdb_results($query_params);
+
+		foreach ($registration_rows as $reg_row) {
+			if (! is_array($reg_row)) {
+				continue;
+			}
+			$reg_csv_array = [];
+			// registration ID
+			$reg_id_field = $reg_model->field_settings_for('REG_ID');
+			$reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
+				EEH_Export::prepare_value_from_db_for_display(
+					$reg_model,
+					'REG_ID',
+					$reg_row[ $reg_id_field->get_qualified_column() ]
+				);
+			// ALL registrations, or is list filtered to just one?
+			if (! $event_id) {
+				// ALL registrations, so get each event's name and ID
+				$reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+					/* translators: 1: event name, 2: event ID */
+					esc_html__('%1$s (%2$s)', 'event_espresso'),
+					EEH_Export::prepare_value_from_db_for_display(
+						$event_model,
+						'EVT_name',
+						$reg_row['Event_CPT.post_title']
+					),
+					$reg_row['Event_CPT.ID']
+				);
+			}
+			// add attendee columns
+			$reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
+			// add registration columns
+			$reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
+			// get pretty status
+			$stati = $status_model->localized_status(
+				[
+					$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+				],
+				false,
+				'sentence'
+			);
+			$is_primary_reg = $reg_row['Registration.REG_count'] == '1';
+
+			$reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
+				$stati[ $reg_row['Registration.STS_ID'] ];
+			// get pretty transaction status
+			$reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
+				$stati[ $reg_row['TransactionTable.STS_ID'] ];
+			$reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_total',
+					$reg_row['TransactionTable.TXN_total'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_paid',
+					$reg_row['TransactionTable.TXN_paid'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$payment_methods                                                                  = [];
+			$gateway_txn_ids_etc                                                              = [];
+			$payment_times                                                                    = [];
+			if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+				$payments_info = $pay_model->get_all_wpdb_results(
+					[
+						[
+							'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+							'STS_ID' => EEM_Payment::status_id_approved,
+						],
+						'force_join' => ['Payment_Method'],
+					],
+					ARRAY_A,
+					'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+				);
+				[$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
+					$payments_info
+				);
+			}
+
+			$reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_times
+			);
+
+			$reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_methods
+			);
+
+			$reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+				',',
+				$gateway_txn_ids_etc
+			);
+
+			$ticket_name      = esc_html__('Unknown', 'event_espresso');
+			$datetime_strings = [esc_html__('Unknown', 'event_espresso')];
+			if ($reg_row['Ticket.TKT_ID']) {
+				$ticket_name       = EEH_Export::prepare_value_from_db_for_display(
+					$ticket_model,
+					'TKT_name',
+					$reg_row['Ticket.TKT_name']
+				);
+				$datetime_strings = [];
+				$datetimes        = $date_model->get_all_wpdb_results(
+					[
+						['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					$datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
+						$date_model,
+						'DTT_EVT_start',
+						$datetime['Datetime.DTT_EVT_start']
+					);
+				}
+			}
+
+			$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+
+
+			$reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
+				', ',
+				$datetime_strings
+			);
+
+			// add answer columns
+			$reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
+			// Include check-in data
+			if ($event_id && $DTT_ID) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin',
+						[
+							[
+								'DTT_ID' => $DTT_ID
+							]
+						]
+					);
+				$datetime     = $date_model->get_one_by_ID($DTT_ID);
+				$checkin_rows = EEM_Checkin::instance()->get_all(
+					[
+						[
+							'REG_ID' => $reg_row['Registration.REG_ID'],
+							'DTT_ID' => $datetime->get('DTT_ID'),
+						],
+					]
+				);
+				$checkins     = [];
+				foreach ($checkin_rows as $checkin_row) {
+					/** @var EE_Checkin $checkin_row */
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					if ($checkin_value) {
+						$checkins[] = $checkin_value;
+					}
+				}
+				$datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
+				$reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
+			} elseif ($event_id) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin'
+					);
+
+				$datetimes = $date_model->get_all(
+					[
+						[
+							'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
+						],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					if (! $datetime instanceof EE_Datetime) {
+						continue;
+					}
+
+					/** @var EE_Checkin $checkin_row */
+					$checkin_row = EEM_Checkin::instance()->get_one(
+						[
+							[
+								'REG_ID' => $reg_row['Registration.REG_ID'],
+								'DTT_ID' => $datetime->get('DTT_ID'),
+							],
+							'limit'    => 1,
+							'order_by' => [
+								'CHK_ID' => 'DESC'
+							]
+						]
+					);
+
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					$datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
+
+					$reg_csv_array[ $datetime_name ] = $checkin_value;
+				}
+			}
+			/**
+			 * Filter to change the contents of each row of the registrations report CSV file.
+			 * This can be used to add or remote columns from the CSV file, or change their values.
+			 * Note when using: all rows in the CSV should have the same columns.
+			 *
+			 * @param array $reg_csv_array keys are the column names, values are their cell values
+			 * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
+			 */
+			$registrations_csv_ready_array[] = apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+				$reg_csv_array,
+				$reg_row
+			);
+		}
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array               = [];
+			$model_and_fields_to_include = [
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			];
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field                                                          =
+						$model->field_settings_for($field_name);
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
+
+
+	/**
+	 * Counts total unit to process
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_units_to_process(array $query_params): int
+	{
+		return EEM_Registration::instance()->count(
+			array_diff_key(
+				$query_params,
+				array_flip(
+					['limit']
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
+
+		$this->_file_helper->delete(
+			EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		$this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }

Spacing +32 added lines, -32 removed lines

@@ -59,7 +59,7 @@ 
     {
         $event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
         $DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
             throw new BatchRequestException(
                 esc_html__('You do not have permission to view registrations', 'event_espresso')
             );
@@ -74,7 +74,7 @@ 
             $query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
         } else {
             $query_params = [
-                [ 'Ticket.TKT_deleted' => ['IN', [true, false]] ],
+                ['Ticket.TKT_deleted' => ['IN', [true, false]]],
                 'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
                 'force_join' => ['Transaction', 'Ticket', 'Attendee'],
                 'caps'       => EEM_Base::caps_read_admin,
@@ -87,7 +87,7 @@ 
         }
         // unless the query params already include a status,
         // we want to exclude registrations from failed or abandoned transactions
-        if (! isset($query_params[0]['Transaction.STS_ID'])) {
+        if ( ! isset($query_params[0]['Transaction.STS_ID'])) {
             $query_params[0]['OR'] = [
                 // don't include registrations from failed or abandoned transactions...
                 'Transaction.STS_ID' => [
@@ -103,7 +103,7 @@ 
             ];
         }
 
-        if (! isset($query_params['force_join'])) {
+        if ( ! isset($query_params['force_join'])) {
             $query_params['force_join'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
         }
 
@@ -151,7 +151,7 @@ 
         // so let's blank out all the values for that first row
         array_walk(
             $csv_data_for_row[0],
-            function (&$value) {
+            function(&$value) {
                 $value = null;
             }
         );
@@ -236,11 +236,11 @@ 
         $question_where_params = [];
         foreach ($reg_where_params as $key => $val) {
             if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] =
+                $question_where_params[$key] =
                     $this->_change_registration_where_params_to_question_where_params($val);
             } else {
                 // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+                $question_where_params['Question_Group.Event.Registration.'.$key] = $val;
             }
         }
         return $question_where_params;
@@ -352,22 +352,22 @@ 
         $registration_rows             = $reg_model->get_all_wpdb_results($query_params);
 
         foreach ($registration_rows as $reg_row) {
-            if (! is_array($reg_row)) {
+            if ( ! is_array($reg_row)) {
                 continue;
             }
             $reg_csv_array = [];
             // registration ID
             $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
+            $reg_csv_array[EEH_Export::get_column_name_for_field($reg_id_field)] =
                 EEH_Export::prepare_value_from_db_for_display(
                     $reg_model,
                     'REG_ID',
-                    $reg_row[ $reg_id_field->get_qualified_column() ]
+                    $reg_row[$reg_id_field->get_qualified_column()]
                 );
             // ALL registrations, or is list filtered to just one?
-            if (! $event_id) {
+            if ( ! $event_id) {
                 // ALL registrations, so get each event's name and ID
-                $reg_csv_array[ esc_html__('Event', 'event_espresso') ] = sprintf(
+                $reg_csv_array[esc_html__('Event', 'event_espresso')] = sprintf(
                     /* translators: 1: event name, 2: event ID */
                     esc_html__('%1$s (%2$s)', 'event_espresso'),
                     EEH_Export::prepare_value_from_db_for_display(
@@ -393,12 +393,12 @@ 
             );
             $is_primary_reg = $reg_row['Registration.REG_count'] == '1';
 
-            $reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
-                $stati[ $reg_row['Registration.STS_ID'] ];
+            $reg_csv_array[esc_html__('Registration Status', 'event_espresso')] =
+                $stati[$reg_row['Registration.STS_ID']];
             // get pretty transaction status
-            $reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
-                $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+            $reg_csv_array[esc_html__('Transaction Status', 'event_espresso')]     =
+                $stati[$reg_row['TransactionTable.STS_ID']];
+            $reg_csv_array[esc_html__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
                 ? EEH_Export::prepare_value_from_db_for_display(
                     $txn_model,
                     'TXN_total',
@@ -407,7 +407,7 @@ 
                 )
                 : '0.00';
 
-            $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
+            $reg_csv_array[esc_html__('Amount Paid', 'event_espresso')] = $is_primary_reg
                 ? EEH_Export::prepare_value_from_db_for_display(
                     $txn_model,
                     'TXN_paid',
@@ -436,17 +436,17 @@ 
                 );
             }
 
-            $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Payment Date(s)', 'event_espresso')] = implode(
                 ',',
                 $payment_times
             );
 
-            $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Payment Method(s)', 'event_espresso')] = implode(
                 ',',
                 $payment_methods
             );
 
-            $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                 ',',
                 $gateway_txn_ids_etc
             );
@@ -454,7 +454,7 @@ 
             $ticket_name      = esc_html__('Unknown', 'event_espresso');
             $datetime_strings = [esc_html__('Unknown', 'event_espresso')];
             if ($reg_row['Ticket.TKT_ID']) {
-                $ticket_name       = EEH_Export::prepare_value_from_db_for_display(
+                $ticket_name = EEH_Export::prepare_value_from_db_for_display(
                     $ticket_model,
                     'TKT_name',
                     $reg_row['Ticket.TKT_name']
@@ -476,10 +476,10 @@ 
                 }
             }
 
-            $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+            $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
 
 
-            $reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
+            $reg_csv_array[esc_html__('Ticket Datetimes', 'event_espresso')] = implode(
                 ', ',
                 $datetime_strings
             );
@@ -489,7 +489,7 @@ 
             // Include check-in data
             if ($event_id && $DTT_ID) {
                 // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
+                $reg_csv_array[esc_html__('Datetime Check-ins #', 'event_espresso')] =
                     $reg_model->count_related(
                         $reg_row['Registration.REG_ID'],
                         'Checkin',
@@ -508,7 +508,7 @@ 
                         ],
                     ]
                 );
-                $checkins     = [];
+                $checkins = [];
                 foreach ($checkin_rows as $checkin_row) {
                     /** @var EE_Checkin $checkin_row */
                     $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
@@ -517,10 +517,10 @@ 
                     }
                 }
                 $datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
-                $reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
+                $reg_csv_array[$datetime_name] = implode(' --- ', $checkins);
             } elseif ($event_id) {
                 // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
+                $reg_csv_array[esc_html__('Event Check-ins #', 'event_espresso')] =
                     $reg_model->count_related(
                         $reg_row['Registration.REG_ID'],
                         'Checkin'
@@ -536,7 +536,7 @@ 
                     ]
                 );
                 foreach ($datetimes as $datetime) {
-                    if (! $datetime instanceof EE_Datetime) {
+                    if ( ! $datetime instanceof EE_Datetime) {
                         continue;
                     }
 
@@ -557,7 +557,7 @@ 
                     $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
                     $datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
 
-                    $reg_csv_array[ $datetime_name ] = $checkin_value;
+                    $reg_csv_array[$datetime_name] = $checkin_value;
                 }
             }
             /**
@@ -586,7 +586,7 @@ 
                 foreach ($field_list as $field_name) {
                     $field                                                          =
                         $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = null;
                 }
             }
             $registrations_csv_ready_array[] = $reg_csv_array;
@@ -641,7 +641,7 @@ 
                         'event_espresso'
                     ),
                     '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
+                    '<a href="'.$job_parameters->request_datum('return_url').'">',
                     '</a>'
                 )
             )

core/libraries/form_sections/strategies/layout/EE_Form_Section_Layout_Base.strategy.php

Indentation +273 added lines, -273 removed lines

@@ -11,175 +11,175 @@ 
  */
 abstract class EE_Form_Section_Layout_Base
 {
-    /**
-     * Form section to lay out
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_form_section;
-
-
-
-    /**
-     *  __construct
-     */
-    public function __construct()
-    {
-    }
-
-
-
-    /**
-     * The form section on which this strategy is to perform
-     *
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        $this->_form_section = $form;
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     */
-    public function form_section()
-    {
-        return $this->_form_section;
-    }
-
-
-
-    /**
-     * Also has teh side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string HTML for displaying
-     * @throws EE_Error
-     */
-    public function layout_form()
-    {
-        $html = '';
-        // layout_form_begin
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
-            $this->layout_form_begin(),
-            $this->_form_section
-        );
-        // layout_form_loop
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
-            $this->layout_form_loop(),
-            $this->_form_section
-        );
-        // layout_form_end
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
-            $this->layout_form_end(),
-            $this->_form_section
-        );
-        return $this->add_form_section_hooks_and_filters($html);
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function layout_form_loop()
-    {
-        $html = '';
-        foreach ($this->_form_section->subsections() as $name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_input($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            } elseif ($subsection instanceof EE_Form_Section_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_subsection($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_begin();
-
-
-
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_end();
-
-
-
-    /**
-     * Should be used internally by layout_form() to lay out each input (eg, if this layout
-     * is putting each input in a row of its own, this should probably be called by a
-     *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
-     * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
-     * customize the form's layout, but would like to make use of it for laying out
-     * 'easy-to-layout' inputs
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string html
-     */
-    abstract public function layout_input($input);
-
-
-
-    /**
-     * Similar to layout_input(), should be used internally by layout_form() within a
-     * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed
-     * that the proper subsection will lay out its container, label, etc on its own.
-     *
-     * @param EE_Form_Section_Base $subsection
-     * @return string html
-     */
-    abstract public function layout_subsection($subsection);
-
-
-    /**
-     * Gets the HTML for the label tag and its contents for the input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_label($input)
-    {
-        $label_text = $input->html_label_text();
-        if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-            return '';
-        }
-        $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
-            : $input->html_label_class();
-        $label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
-        return '
+	/**
+	 * Form section to lay out
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_form_section;
+
+
+
+	/**
+	 *  __construct
+	 */
+	public function __construct()
+	{
+	}
+
+
+
+	/**
+	 * The form section on which this strategy is to perform
+	 *
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		$this->_form_section = $form;
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 */
+	public function form_section()
+	{
+		return $this->_form_section;
+	}
+
+
+
+	/**
+	 * Also has teh side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string HTML for displaying
+	 * @throws EE_Error
+	 */
+	public function layout_form()
+	{
+		$html = '';
+		// layout_form_begin
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+			$this->layout_form_begin(),
+			$this->_form_section
+		);
+		// layout_form_loop
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+			$this->layout_form_loop(),
+			$this->_form_section
+		);
+		// layout_form_end
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+			$this->layout_form_end(),
+			$this->_form_section
+		);
+		return $this->add_form_section_hooks_and_filters($html);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function layout_form_loop()
+	{
+		$html = '';
+		foreach ($this->_form_section->subsections() as $name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_input($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			} elseif ($subsection instanceof EE_Form_Section_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_subsection($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_begin();
+
+
+
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_end();
+
+
+
+	/**
+	 * Should be used internally by layout_form() to lay out each input (eg, if this layout
+	 * is putting each input in a row of its own, this should probably be called by a
+	 *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
+	 * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
+	 * customize the form's layout, but would like to make use of it for laying out
+	 * 'easy-to-layout' inputs
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string html
+	 */
+	abstract public function layout_input($input);
+
+
+
+	/**
+	 * Similar to layout_input(), should be used internally by layout_form() within a
+	 * loop to lay out each proper subsection. Unlike layout_input(), however, it is assumed
+	 * that the proper subsection will lay out its container, label, etc on its own.
+	 *
+	 * @param EE_Form_Section_Base $subsection
+	 * @return string html
+	 */
+	abstract public function layout_subsection($subsection);
+
+
+	/**
+	 * Gets the HTML for the label tag and its contents for the input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_label($input)
+	{
+		$label_text = $input->html_label_text();
+		if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+			return '';
+		}
+		$class = $input->required()
+			? 'ee-required-label ' . $input->html_label_class()
+			: $input->html_label_class();
+		$label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
+		return '
         <label id="' . $input->html_label_id() . '"
                class="' . $class . '"
                style="' . $input->html_label_style() . '"
@@ -187,108 +187,108 @@ 
         >
             ' . $label_text . '
         </label>';
-    }
-
-
-
-    /**
-     * Gets the HTML for all the form's form-wide errors (ie, errors which
-     * are not for specific inputs. E.g., if two inputs somehow disagree,
-     * those errors would probably be on the form section, not one of its inputs)
-     * @return string
-     */
-    public function display_form_wide_errors()
-    {
-        $html = '';
-        if ($this->_form_section->get_validation_errors()) {
-            $html .= "<div class='ee-form-wide-errors'>";
-            // get all the errors on THIS form section (errors which aren't
-            // for specific inputs, but instead for the entire form section)
-            foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
-            }
-            $html .= '</div>';
-        }
-        return apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
-            $html,
-            $this
-        );
-    }
-
-
-    /**
-     * returns the HTML for the server-side validation errors for the specified input
-     * Note that if JS is enabled, it should remove these and instead
-     * populate the form's errors in the jquery validate fashion
-     * using the localized data provided to the JS
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_errors($input)
-    {
-        if ($input->get_validation_errors()) {
-            return "<label  id='"
-                   . $input->html_id()
-                   . "-error' class='error' for='{$input->html_name()}'>"
-                   . $input->get_validation_error_string()
-                   . '</label>';
-        }
-        return '';
-    }
-
-
-    /**
-     * Displays the help span for the specified input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_help_text($input)
-    {
-        $help_text  = $input->html_help_text();
-        if ($help_text !== '' && $help_text !== null) {
-            $tag = is_admin() ? 'p' : 'span';
-            return '<'
-                   . $tag
-                   . ' id="'
-                   . $input->html_id()
-                   . '-help" class="'
-                   . $input->html_help_class()
-                   . '" style="'
-                   . $input->html_help_style()
-                   . '">'
-                   . $help_text
-                   . '</'
-                   . $tag
-                   . '>';
-        }
-        return '';
-    }
-
-
-    /**
-     * Does an action and hook onto the end of teh form
-     *
-     * @param string $html
-     * @return string
-     * @throws EE_Error
-     */
-    public function add_form_section_hooks_and_filters($html)
-    {
-        // replace dashes and spaces with underscores
-        $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
-            $html,
-            $this->_form_section
-        );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
-        return $html;
-    }
+	}
+
+
+
+	/**
+	 * Gets the HTML for all the form's form-wide errors (ie, errors which
+	 * are not for specific inputs. E.g., if two inputs somehow disagree,
+	 * those errors would probably be on the form section, not one of its inputs)
+	 * @return string
+	 */
+	public function display_form_wide_errors()
+	{
+		$html = '';
+		if ($this->_form_section->get_validation_errors()) {
+			$html .= "<div class='ee-form-wide-errors'>";
+			// get all the errors on THIS form section (errors which aren't
+			// for specific inputs, but instead for the entire form section)
+			foreach ($this->_form_section->get_validation_errors() as $error) {
+				$html .= $error->getMessage() . '<br>';
+			}
+			$html .= '</div>';
+		}
+		return apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
+			$html,
+			$this
+		);
+	}
+
+
+	/**
+	 * returns the HTML for the server-side validation errors for the specified input
+	 * Note that if JS is enabled, it should remove these and instead
+	 * populate the form's errors in the jquery validate fashion
+	 * using the localized data provided to the JS
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_errors($input)
+	{
+		if ($input->get_validation_errors()) {
+			return "<label  id='"
+				   . $input->html_id()
+				   . "-error' class='error' for='{$input->html_name()}'>"
+				   . $input->get_validation_error_string()
+				   . '</label>';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Displays the help span for the specified input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_help_text($input)
+	{
+		$help_text  = $input->html_help_text();
+		if ($help_text !== '' && $help_text !== null) {
+			$tag = is_admin() ? 'p' : 'span';
+			return '<'
+				   . $tag
+				   . ' id="'
+				   . $input->html_id()
+				   . '-help" class="'
+				   . $input->html_help_class()
+				   . '" style="'
+				   . $input->html_help_style()
+				   . '">'
+				   . $help_text
+				   . '</'
+				   . $tag
+				   . '>';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Does an action and hook onto the end of teh form
+	 *
+	 * @param string $html
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function add_form_section_hooks_and_filters($html)
+	{
+		// replace dashes and spaces with underscores
+		$hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
+		do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+		$html = (string) apply_filters(
+			'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+			$html,
+			$this->_form_section
+		);
+		$html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
+		$html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+		return $html;
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -66,19 +66,19 @@ 
         $html = '';
         // layout_form_begin
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(),
             $this->layout_form_begin(),
             $this->_form_section
         );
         // layout_form_loop
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(),
             $this->layout_form_loop(),
             $this->_form_section
         );
         // layout_form_end
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(),
             $this->layout_form_end(),
             $this->_form_section
         );
@@ -98,7 +98,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_input($subsection),
                     $this->_form_section,
                     $subsection
@@ -106,7 +106,7 @@ 
             } elseif ($subsection instanceof EE_Form_Section_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_subsection($subsection),
                     $this->_form_section,
                     $subsection
@@ -172,20 +172,20 @@ 
     public function display_label($input)
     {
         $label_text = $input->html_label_text();
-        if (! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+        if ( ! $label_text || $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
             return '';
         }
         $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
+            ? 'ee-required-label '.$input->html_label_class()
             : $input->html_label_class();
         $label_text .= $input->required() ? '<span class="ee-asterisk">*</span>' : '';
         return '
-        <label id="' . $input->html_label_id() . '"
-               class="' . $class . '"
-               style="' . $input->html_label_style() . '"
-               for="' . $input->html_id() . '"
+        <label id="' . $input->html_label_id().'"
+               class="' . $class.'"
+               style="' . $input->html_label_style().'"
+               for="' . $input->html_id().'"
         >
-            ' . $label_text . '
+            ' . $label_text.'
         </label>';
     }
 
@@ -205,7 +205,7 @@ 
             // get all the errors on THIS form section (errors which aren't
             // for specific inputs, but instead for the entire form section)
             foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
+                $html .= $error->getMessage().'<br>';
             }
             $html .= '</div>';
         }
@@ -249,7 +249,7 @@ 
      */
     public function display_help_text($input)
     {
-        $help_text  = $input->html_help_text();
+        $help_text = $input->html_help_text();
         if ($help_text !== '' && $help_text !== null) {
             $tag = is_admin() ? 'p' : 'span';
             return '<'
@@ -281,14 +281,14 @@ 
     {
         // replace dashes and spaces with underscores
         $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+        do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section);
         $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+            'AFEE__Form_Section_Layout__'.$hook_name.'__html',
             $html,
             $this->_form_section
         );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+        $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->';
+        $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->';
         return $html;
     }
 }

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

Indentation +1223 added lines, -1223 removed lines

@@ -14,1227 +14,1227 @@
  */
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
 {
-    /**
-     * the input's name attribute
-     *
-     * @var string
-     */
-    protected $_html_name;
-
-    /**
-     * id for the html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_id;
-
-    /**
-     * class for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_class;
-
-    /**
-     * style for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_style;
-
-    /**
-     * text to be placed in the html label
-     *
-     * @var string
-     */
-    protected $_html_label_text;
-
-    /**
-     * the full html label. If used, all other html_label_* properties are invalid
-     *
-     * @var string
-     */
-    protected $_html_label;
-
-    /**
-     * HTML to use for help text (normally placed below form input), in a span which normally
-     * has a class of 'description'
-     *
-     * @var string
-     */
-    protected $_html_help_text;
-
-    /**
-     * CSS classes for displaying the help span
-     *
-     * @var string
-     */
-    protected $_html_help_class = 'description';
-
-    /**
-     * CSS to put in the style attribute on the help span
-     *
-     * @var string
-     */
-    protected $_html_help_style;
-
-    /**
-     * Stores whether or not this input's response is required.
-     * Because certain styling elements may also want to know that this
-     * input is required etc.
-     *
-     * @var boolean
-     */
-    protected $_required;
-
-    /**
-     * css class added to required inputs
-     *
-     * @var string
-     */
-    protected $_required_css_class = 'ee-required';
-
-    /**
-     * css styles applied to button type inputs
-     *
-     * @var string
-     */
-    protected $_button_css_attributes;
-
-    /**
-     * The raw post data submitted for this
-     * Generally unsafe for usage in client code
-     *
-     * @var mixed string or array
-     */
-    protected $_raw_value;
-
-    /**
-     * Value normalized according to the input's normalization strategy.
-     * The normalization strategy dictates whether this is a string, int, float,
-     * boolean, or array of any of those.
-     *
-     * @var mixed
-     */
-    protected $_normalized_value;
-
-
-    /**
-     * Normalized default value either initially set on the input, or provided by calling
-     * set_default().
-     *
-     * @var mixed
-     */
-    protected $_default;
-
-    /**
-     * Strategy used for displaying this field.
-     * Child classes must use _get_display_strategy to access it.
-     *
-     * @var EE_Display_Strategy_Base
-     */
-    private $_display_strategy;
-
-    /**
-     * Gets all the validation strategies used on this field
-     *
-     * @var EE_Validation_Strategy_Base[]
-     */
-    private $_validation_strategies = [];
-
-    /**
-     * The normalization strategy for this field
-     *
-     * @var EE_Normalization_Strategy_Base
-     */
-    private $_normalization_strategy;
-
-    /**
-     * Strategy for removing sensitive data after we're done with the form input
-     *
-     * @var EE_Sensitive_Data_Removal_Base
-     */
-    protected $_sensitive_data_removal_strategy;
-
-    /**
-     * Whether this input has been disabled or not.
-     * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
-     * (Client-side code that wants to dynamically disable it must also add this hidden input).
-     * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
-     * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
-     * input is again ignored.
-     *
-     * @var boolean
-     */
-    protected $disabled = false;
-
-
-    protected bool $_no_label = false; // if true, then no hrml label will be displayed for this input
-
-
-    /**
-     * @param array                         $input_args       {
-     * @type string                         $html_name        the html name for the input
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
-     * @type string                         $html_label_class the class attribute to give to the html label tag
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
-     * @type string                         $html_label_text  the text to put in the label tag
-     * @type string                         $html_label       the full html label. If used,
-     *                                                        all other html_label_* args are invalid
-     * @type string                         $html_help_text   text to put in help element
-     * @type string                         $html_help_style  style attribute to give to teh help element
-     * @type string                         $html_help_class  class attribute to give to the help element
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
-     *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
-     *                                                        '1' or '0')
-     * @type EE_Display_Strategy_Base       $display          strategy
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
-     * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
-     *                                                        validation strategies, and sets the normalization
-     *                                                        strategy to the Null normalization. This is good when you
-     *                                                        want the input to be totally ignored server-side (like
-     *                                                        when using React.js form inputs)
-     *                                                        }
-     */
-    public function __construct($input_args = [])
-    {
-        $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
-        // the following properties must be cast as arrays
-        if (isset($input_args['validation_strategies'])) {
-            foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
-                }
-            }
-            unset($input_args['validation_strategies']);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_validation_strategies = [];
-        }
-        // loop thru incoming options
-        foreach ($input_args as $key => $value) {
-            if ($key === 'disabled') {
-                $this->disable($value);
-                continue;
-            }
-            // add underscore to $key to match property names
-            $_key = '_' . $key;
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-            }
-        }
-        // ensure that "required" is set correctly
-        $this->set_required(
-            $this->_required,
-            $input_args['required_validation_error_message'] ?? null
-        );
-        // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
-        $this->_display_strategy->_construct_finalize($this);
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            $validation_strategy->_construct_finalize($this);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_normalization_strategy = new EE_Null_Normalization();
-        }
-        if (! $this->_normalization_strategy) {
-            $this->_normalization_strategy = new EE_Text_Normalization();
-        }
-        $this->_normalization_strategy->_construct_finalize($this);
-        // at least we can use the normalization strategy to populate the default
-        if (isset($input_args['default'])) {
-            $this->set_default($input_args['default']);
-            unset($input_args['default']);
-        }
-        if (! $this->_sensitive_data_removal_strategy) {
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
-        }
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
-        parent::__construct($input_args);
-    }
-
-
-    /**
-     * Sets the html_name to its default value, if none was specified in teh constructor.
-     * Calculation involves using the name and the parent's html_name
-     *
-     * @throws EE_Error
-     */
-    protected function _set_default_html_name_if_empty()
-    {
-        if (! $this->_html_name) {
-            $this->_html_name = $this->name();
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
-            }
-        }
-    }
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
-        }
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-    /**
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
-     *
-     * @return EE_Display_Strategy_Base
-     * @throws EE_Error
-     */
-    protected function _get_display_strategy()
-    {
-        $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
-                        "event_espresso"
-                    ),
-                    $this->html_name(),
-                    $this->html_id()
-                )
-            );
-        } else {
-            return $this->_display_strategy;
-        }
-    }
-
-
-    /**
-     * Sets the display strategy.
-     *
-     * @param EE_Display_Strategy_Base $strategy
-     */
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
-    {
-        $this->_display_strategy = $strategy;
-    }
-
-
-    /**
-     * Sets the sanitization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $strategy
-     */
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
-    {
-        $this->_normalization_strategy = $strategy;
-    }
-
-
-    /**
-     * Gets sensitive_data_removal_strategy
-     *
-     * @return EE_Sensitive_Data_Removal_Base
-     */
-    public function get_sensitive_data_removal_strategy()
-    {
-        return $this->_sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Sets sensitive_data_removal_strategy
-     *
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return void
-     */
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
-    {
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Gets the display strategy for this input
-     *
-     * @return EE_Display_Strategy_Base
-     */
-    public function get_display_strategy()
-    {
-        return $this->_display_strategy;
-    }
-
-
-    /**
-     * Overwrites the display strategy
-     *
-     * @param EE_Display_Strategy_Base $display_strategy
-     */
-    public function set_display_strategy($display_strategy)
-    {
-        $this->_display_strategy = $display_strategy;
-        $this->_display_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Gets the normalization strategy set on this input
-     *
-     * @return EE_Normalization_Strategy_Base
-     */
-    public function get_normalization_strategy()
-    {
-        return $this->_normalization_strategy;
-    }
-
-
-    /**
-     * Overwrites the normalization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
-     */
-    public function set_normalization_strategy($normalization_strategy)
-    {
-        $this->_normalization_strategy = $normalization_strategy;
-        $this->_normalization_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Returns all teh validation strategies which apply to this field, numerically indexed
-     *
-     * @return EE_Validation_Strategy_Base[]
-     */
-    public function get_validation_strategies()
-    {
-        return $this->_validation_strategies;
-    }
-
-
-    /**
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $validation_strategy->_construct_finalize($this);
-        $this->_validation_strategies[] = $validation_strategy;
-    }
-
-
-    /**
-     * Adds a new validation strategy onto the form input
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $this->_add_validation_strategy($validation_strategy);
-    }
-
-
-    /**
-     * The classname of the validation strategy to remove
-     *
-     * @param string $validation_strategy_classname
-     */
-    public function remove_validation_strategy($validation_strategy_classname)
-    {
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (
-                $validation_strategy instanceof $validation_strategy_classname
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
-            ) {
-                unset($this->_validation_strategies[ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
-     *
-     * @param array $validation_strategy_classnames
-     * @return bool
-     */
-    public function has_validation_strategy($validation_strategy_classnames)
-    {
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
-            ? $validation_strategy_classnames
-            : [$validation_strategy_classnames];
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (in_array($key, $validation_strategy_classnames)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the HTML
-     *
-     * @return string
-     */
-    public function get_html()
-    {
-        return $this->_parent_section->get_html_for_input($this);
-    }
-
-
-    /**
-     * Gets the HTML for the input itself (no label or errors) according to the
-     * input's display strategy
-     * Makes sure the JS and CSS are enqueued for it
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_input()
-    {
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml(
-                $this->_get_display_strategy()->display(),
-                $this
-            )
-            : $this->_get_display_strategy()->display();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_other_attributes()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        return $this->other_html_attributes();
-    }
-
-
-    /**
-     * @param string $html_other_attributes
-     */
-    public function set_html_other_attributes($html_other_attributes)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::set_other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        $this->set_other_html_attributes($html_other_attributes);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_label()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the errors section for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_errors()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the help text for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_help()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
-    }
-
-
-    /**
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
-     * and returns whether or not the form input's submitted value is value
-     *
-     * @return boolean
-     */
-    protected function _validate()
-    {
-        if ($this->isDisabled()) {
-            return true;
-        }
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                try {
-                    $validation_strategy->validate($this->normalized_value());
-                } catch (EE_Validation_Error $e) {
-                    $this->add_validation_error($e);
-                }
-            }
-        }
-        if ($this->get_validation_errors()) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-    /**
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value !== null
-            ? stripslashes(html_entity_decode(trim((string) $value)))
-            : null;
-    }
-
-
-    /**
-     * Picks out the form value that relates to this form input,
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
-     * Returns whether or not any validation errors occurred
-     *
-     * @param array $req_data
-     * @return boolean whether or not there was an error
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        // any existing validation errors don't apply so clear them
-        $this->_validation_errors = [];
-        // if the input is disabled, ignore whatever input was sent in
-        if ($this->isDisabled()) {
-            $this->_set_raw_value(null);
-            $this->_set_normalized_value($this->get_default());
-            return false;
-        }
-        try {
-            $raw_input = $this->find_form_data_for_this_section($req_data);
-            // super simple sanitization for now
-            if (is_array($raw_input)) {
-                $raw_value = [];
-                foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
-                }
-                $this->_set_raw_value($raw_value);
-            } else {
-                $this->_set_raw_value($this->_sanitize($raw_input));
-            }
-            // we want to mostly leave the input alone in case we need to re-display it to the user
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
-            return false;
-        } catch (EE_Validation_Error $e) {
-            $this->add_validation_error($e);
-            return true;
-        }
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name()
-    {
-        $this->_set_default_html_name_if_empty();
-        return $this->_html_name ?? '';
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_label_id()
-    {
-        return ! empty($this->_html_label_id)
-            ? $this->_html_label_id
-            : $this->html_id() . '-lbl';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_class()
-    {
-        return $this->_html_label_class ?? '';
-    }
-
-
-    /**
-     * @param string $html_class
-     */
-    public function add_html_label_class(string $html_class)
-    {
-        $this->_html_label_class .= ' ' . trim($html_class);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_style()
-    {
-        return $this->_html_label_style ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_text()
-    {
-        return $this->_html_label_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_text()
-    {
-        return $this->_html_help_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_class()
-    {
-        return $this->_html_help_class ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_style()
-    {
-        return $this->_html_style ?? '';
-    }
-
-
-    /**
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
-     * Please note that almost all client code should instead use the normalized_value;
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
-     * mostly by escaping quotes)
-     * Note, we do not store the exact original value sent in the user's request because
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
-     * in which case, we would have stored the malicious content to our database.
-     *
-     * @return mixed
-     */
-    public function raw_value()
-    {
-        return $this->_raw_value;
-    }
-
-
-    /**
-     * Returns a string safe to usage in form inputs when displaying, because
-     * it escapes all html entities
-     *
-     * @return string
-     */
-    public function raw_value_in_form(): string
-    {
-        return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
-    }
-
-
-    /**
-     * returns the value after it's been sanitized, and then converted into it's proper type
-     * in PHP. Eg, a string, an int, an array,
-     *
-     * @return mixed
-     */
-    public function normalized_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * Returns the normalized value is a presentable way. By default this is just
-     * the normalized value by itself, but it can be overridden for when that's not
-     * the best thing to display
-     *
-     * @return mixed
-     */
-    public function pretty_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * if this field had the name 'password_again', it should return
-     * <br><code>password_again: {
-     * equalTo: "#password"
-     * }</code>
-     *
-     * @return array
-     */
-    public function get_jquery_validation_rules(): array
-    {
-        $jquery_validation_js    = [];
-        $jquery_validation_rules = [];
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $jquery_validation_rules = array_replace_recursive(
-                $jquery_validation_rules,
-                $validation_strategy->get_jquery_validation_rule_array()
-            );
-        }
-        if (! empty($jquery_validation_rules)) {
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
-            }
-        }
-        return $jquery_validation_js;
-    }
-
-
-    /**
-     * Sets the input's default value for use in displaying in the form. Note: value should be
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
-     *
-     * @param mixed $value
-     * @return void
-     */
-    public function set_default($value)
-    {
-        $this->_default = $value;
-        $this->_set_normalized_value($value);
-        $this->_set_raw_value($value);
-    }
-
-
-    /**
-     * Sets the normalized value on this input
-     *
-     * @param mixed $value
-     */
-    protected function _set_normalized_value($value)
-    {
-        $this->_normalized_value = $value;
-    }
-
-
-    /**
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
-     *
-     * @param mixed $value
-     */
-    protected function _set_raw_value($value)
-    {
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
-    }
-
-
-    /**
-     * Sets the HTML label text after it has already been defined
-     *
-     * @param string $label
-     * @return void
-     */
-    public function set_html_label_text($label)
-    {
-        $this->_html_label_text = $label;
-    }
-
-
-    /**
-     * Sets whether or not this field is required, and adjusts the validation strategy.
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
-     * please add it as a validation strategy using add_validation_strategy as normal
-     *
-     * @param boolean $required boolean
-     * @param null    $required_text
-     */
-    public function set_required($required = true, $required_text = null)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
-        // whether $required is a string or a boolean, we want to add a required validation strategy
-        if ($required) {
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
-        } else {
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
-        }
-        $this->_required = $required;
-    }
-
-
-    /**
-     * Returns whether or not this field is required
-     *
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->_required;
-    }
-
-
-    /**
-     * @param string $required_css_class
-     */
-    public function set_required_css_class($required_css_class)
-    {
-        $this->_required_css_class = $required_css_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function required_css_class()
-    {
-        return $this->_required_css_class;
-    }
-
-
-    /**
-     * @param bool $add_required
-     * @return string
-     */
-    public function html_class($add_required = false)
-    {
-        return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
-            : $this->_html_class;
-    }
-
-
-    /**
-     * Sets the help text, in case
-     *
-     * @param string $text
-     */
-    public function set_html_help_text($text)
-    {
-        $this->_html_help_text = $text;
-    }
-
-
-    /**
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
-     * input. If there is any kind of sensitive data removal on this input, we clear
-     * out the raw value completely
-     *
-     * @return void
-     */
-    public function clean_sensitive_data()
-    {
-        // if we do ANY kind of sensitive data removal on this, then just clear out the raw value
-        // if we need more logic than this we'll make a strategy for it
-        if (
-            $this->_sensitive_data_removal_strategy
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
-        ) {
-            $this->_set_raw_value(null);
-        }
-        // and clean the normalized value according to the appropriate strategy
-        $this->_set_normalized_value(
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
-                $this->_normalized_value
-            )
-        );
-    }
-
-
-    /**
-     * @param bool   $primary
-     * @param string $button_size
-     * @param string $other_attributes
-     */
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
-    {
-        $button_css_attributes = 'button';
-        $button_css_attributes .= $primary === true
-            ? ' button--primary'
-            : ' button--secondary';
-        switch ($button_size) {
-            case 'xs':
-            case 'extra-small':
-                $button_css_attributes .= ' button-xs';
-                break;
-            case 'sm':
-            case 'small':
-                $button_css_attributes .= ' button-sm';
-                break;
-            case 'lg':
-            case 'large':
-                $button_css_attributes .= ' button-lg';
-                break;
-            case 'block':
-                $button_css_attributes .= ' button-block';
-                break;
-            case 'md':
-            case 'medium':
-            default:
-                $button_css_attributes .= '';
-        }
-        $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
-            : $button_css_attributes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function button_css_attributes()
-    {
-        if (empty($this->_button_css_attributes)) {
-            $this->set_button_css_attributes();
-        }
-        return $this->_button_css_attributes;
-    }
-
-
-    /**
-     * find_form_data_for_this_section
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
-     * then it's value should be in request at request['my_form']['subform']['form_input_1'].
-     * (If that doesn't exist, we also check for this subsection's name
-     * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
-     * This function finds its value in the form.
-     *
-     * @param array $req_data
-     * @return mixed whatever the raw value of this form section is in the request data
-     * @throws EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        $name_parts = $this->getInputNameParts();
-        // now get the value for the input
-        $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
-        // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
-        }
-        return $value;
-    }
-
-
-    /**
-     * If this input's name is something like "foo[bar][baz]"
-     * returns an array like `array('foo','bar',baz')`
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getInputNameParts()
-    {
-        // break up the html name by "[]"
-        if (strpos($this->html_name(), '[') !== false) {
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
-        } else {
-            $before_any_brackets = $this->html_name();
-        }
-        // grab all of the segments
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
-        if (isset($matches[1]) && is_array($matches[1])) {
-            $name_parts = $matches[1];
-            array_unshift($name_parts, $before_any_brackets);
-        } else {
-            $name_parts = [$before_any_brackets];
-        }
-        return $name_parts;
-    }
-
-
-    /**
-     * @param array $html_name_parts
-     * @param array $req_data
-     * @return array | NULL
-     */
-    public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
-    {
-        $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
-            if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
-            } else {
-                return $this->findRequestForSectionUsingNameParts(
-                    $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
-                );
-            }
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Checks if this form input's data is in the request data
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            /** @var RequestInterface $request */
-            $request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $req_data = $request->postParams();
-        }
-        $checked_value = $this->find_form_data_for_this_section($req_data);
-        if ($checked_value !== null) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parent to add js data from validation and display strategies
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = [])
-    {
-        return $this->get_other_js_data_from_strategies($form_other_js_data);
-    }
-
-
-    /**
-     * Gets other JS data for localization from this input's strategies, like
-     * the validation strategies and the display strategy
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data_from_strategies($form_other_js_data = [])
-    {
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // ask our display strategy and validation strategies if they have js to enqueue
-        $this->enqueue_js_from_strategies();
-    }
-
-
-    /**
-     * Tells strategies when its ok to enqueue their js and css
-     *
-     * @return void
-     */
-    public function enqueue_js_from_strategies()
-    {
-        $this->get_display_strategy()->enqueue_js();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $validation_strategy->enqueue_js();
-        }
-    }
-
-
-    /**
-     * Gets the default value set on the input (not the current value, which may have been
-     * changed because of a form submission). If no default was set, this us null.
-     *
-     * @return mixed
-     */
-    public function get_default()
-    {
-        return $this->_default;
-    }
-
-
-    /**
-     * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
-     * and server-side if any input was received it will be ignored
-     */
-    public function disable($disable = true)
-    {
-        $disabled_attribute = ' disabled="disabled"';
-        $this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
-        if ($this->disabled) {
-            if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
-                $this->_other_html_attributes .= $disabled_attribute;
-            }
-            $this->_set_normalized_value($this->get_default());
-        } else {
-            $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
-        }
-    }
-
-
-    /**
-     * Returns whether this input is currently disabled.
-     *
-     * @return bool
-     */
-    public function isDisabled()
-    {
-        return $this->disabled;
-    }
+	/**
+	 * the input's name attribute
+	 *
+	 * @var string
+	 */
+	protected $_html_name;
+
+	/**
+	 * id for the html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_id;
+
+	/**
+	 * class for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_class;
+
+	/**
+	 * style for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_style;
+
+	/**
+	 * text to be placed in the html label
+	 *
+	 * @var string
+	 */
+	protected $_html_label_text;
+
+	/**
+	 * the full html label. If used, all other html_label_* properties are invalid
+	 *
+	 * @var string
+	 */
+	protected $_html_label;
+
+	/**
+	 * HTML to use for help text (normally placed below form input), in a span which normally
+	 * has a class of 'description'
+	 *
+	 * @var string
+	 */
+	protected $_html_help_text;
+
+	/**
+	 * CSS classes for displaying the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_class = 'description';
+
+	/**
+	 * CSS to put in the style attribute on the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_style;
+
+	/**
+	 * Stores whether or not this input's response is required.
+	 * Because certain styling elements may also want to know that this
+	 * input is required etc.
+	 *
+	 * @var boolean
+	 */
+	protected $_required;
+
+	/**
+	 * css class added to required inputs
+	 *
+	 * @var string
+	 */
+	protected $_required_css_class = 'ee-required';
+
+	/**
+	 * css styles applied to button type inputs
+	 *
+	 * @var string
+	 */
+	protected $_button_css_attributes;
+
+	/**
+	 * The raw post data submitted for this
+	 * Generally unsafe for usage in client code
+	 *
+	 * @var mixed string or array
+	 */
+	protected $_raw_value;
+
+	/**
+	 * Value normalized according to the input's normalization strategy.
+	 * The normalization strategy dictates whether this is a string, int, float,
+	 * boolean, or array of any of those.
+	 *
+	 * @var mixed
+	 */
+	protected $_normalized_value;
+
+
+	/**
+	 * Normalized default value either initially set on the input, or provided by calling
+	 * set_default().
+	 *
+	 * @var mixed
+	 */
+	protected $_default;
+
+	/**
+	 * Strategy used for displaying this field.
+	 * Child classes must use _get_display_strategy to access it.
+	 *
+	 * @var EE_Display_Strategy_Base
+	 */
+	private $_display_strategy;
+
+	/**
+	 * Gets all the validation strategies used on this field
+	 *
+	 * @var EE_Validation_Strategy_Base[]
+	 */
+	private $_validation_strategies = [];
+
+	/**
+	 * The normalization strategy for this field
+	 *
+	 * @var EE_Normalization_Strategy_Base
+	 */
+	private $_normalization_strategy;
+
+	/**
+	 * Strategy for removing sensitive data after we're done with the form input
+	 *
+	 * @var EE_Sensitive_Data_Removal_Base
+	 */
+	protected $_sensitive_data_removal_strategy;
+
+	/**
+	 * Whether this input has been disabled or not.
+	 * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
+	 * (Client-side code that wants to dynamically disable it must also add this hidden input).
+	 * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
+	 * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
+	 * input is again ignored.
+	 *
+	 * @var boolean
+	 */
+	protected $disabled = false;
+
+
+	protected bool $_no_label = false; // if true, then no hrml label will be displayed for this input
+
+
+	/**
+	 * @param array                         $input_args       {
+	 * @type string                         $html_name        the html name for the input
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
+	 * @type string                         $html_label_text  the text to put in the label tag
+	 * @type string                         $html_label       the full html label. If used,
+	 *                                                        all other html_label_* args are invalid
+	 * @type string                         $html_help_text   text to put in help element
+	 * @type string                         $html_help_style  style attribute to give to teh help element
+	 * @type string                         $html_help_class  class attribute to give to the help element
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
+	 *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
+	 *                                                        '1' or '0')
+	 * @type EE_Display_Strategy_Base       $display          strategy
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
+	 * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
+	 *                                                        validation strategies, and sets the normalization
+	 *                                                        strategy to the Null normalization. This is good when you
+	 *                                                        want the input to be totally ignored server-side (like
+	 *                                                        when using React.js form inputs)
+	 *                                                        }
+	 */
+	public function __construct($input_args = [])
+	{
+		$input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
+		// the following properties must be cast as arrays
+		if (isset($input_args['validation_strategies'])) {
+			foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
+					$this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+				}
+			}
+			unset($input_args['validation_strategies']);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_validation_strategies = [];
+		}
+		// loop thru incoming options
+		foreach ($input_args as $key => $value) {
+			if ($key === 'disabled') {
+				$this->disable($value);
+				continue;
+			}
+			// add underscore to $key to match property names
+			$_key = '_' . $key;
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+			}
+		}
+		// ensure that "required" is set correctly
+		$this->set_required(
+			$this->_required,
+			$input_args['required_validation_error_message'] ?? null
+		);
+		// $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
+		$this->_display_strategy->_construct_finalize($this);
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			$validation_strategy->_construct_finalize($this);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_normalization_strategy = new EE_Null_Normalization();
+		}
+		if (! $this->_normalization_strategy) {
+			$this->_normalization_strategy = new EE_Text_Normalization();
+		}
+		$this->_normalization_strategy->_construct_finalize($this);
+		// at least we can use the normalization strategy to populate the default
+		if (isset($input_args['default'])) {
+			$this->set_default($input_args['default']);
+			unset($input_args['default']);
+		}
+		if (! $this->_sensitive_data_removal_strategy) {
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
+		}
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
+		parent::__construct($input_args);
+	}
+
+
+	/**
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
+	 * Calculation involves using the name and the parent's html_name
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _set_default_html_name_if_empty()
+	{
+		if (! $this->_html_name) {
+			$this->_html_name = $this->name();
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+			}
+		}
+	}
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
+		}
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+	/**
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
+	 *
+	 * @return EE_Display_Strategy_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_display_strategy()
+	{
+		$this->ensure_construct_finalized_called();
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
+						"event_espresso"
+					),
+					$this->html_name(),
+					$this->html_id()
+				)
+			);
+		} else {
+			return $this->_display_strategy;
+		}
+	}
+
+
+	/**
+	 * Sets the display strategy.
+	 *
+	 * @param EE_Display_Strategy_Base $strategy
+	 */
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
+	{
+		$this->_display_strategy = $strategy;
+	}
+
+
+	/**
+	 * Sets the sanitization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $strategy
+	 */
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
+	{
+		$this->_normalization_strategy = $strategy;
+	}
+
+
+	/**
+	 * Gets sensitive_data_removal_strategy
+	 *
+	 * @return EE_Sensitive_Data_Removal_Base
+	 */
+	public function get_sensitive_data_removal_strategy()
+	{
+		return $this->_sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Sets sensitive_data_removal_strategy
+	 *
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
+	 * @return void
+	 */
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
+	{
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Gets the display strategy for this input
+	 *
+	 * @return EE_Display_Strategy_Base
+	 */
+	public function get_display_strategy()
+	{
+		return $this->_display_strategy;
+	}
+
+
+	/**
+	 * Overwrites the display strategy
+	 *
+	 * @param EE_Display_Strategy_Base $display_strategy
+	 */
+	public function set_display_strategy($display_strategy)
+	{
+		$this->_display_strategy = $display_strategy;
+		$this->_display_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Gets the normalization strategy set on this input
+	 *
+	 * @return EE_Normalization_Strategy_Base
+	 */
+	public function get_normalization_strategy()
+	{
+		return $this->_normalization_strategy;
+	}
+
+
+	/**
+	 * Overwrites the normalization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
+	 */
+	public function set_normalization_strategy($normalization_strategy)
+	{
+		$this->_normalization_strategy = $normalization_strategy;
+		$this->_normalization_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
+	 *
+	 * @return EE_Validation_Strategy_Base[]
+	 */
+	public function get_validation_strategies()
+	{
+		return $this->_validation_strategies;
+	}
+
+
+	/**
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$validation_strategy->_construct_finalize($this);
+		$this->_validation_strategies[] = $validation_strategy;
+	}
+
+
+	/**
+	 * Adds a new validation strategy onto the form input
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$this->_add_validation_strategy($validation_strategy);
+	}
+
+
+	/**
+	 * The classname of the validation strategy to remove
+	 *
+	 * @param string $validation_strategy_classname
+	 */
+	public function remove_validation_strategy($validation_strategy_classname)
+	{
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (
+				$validation_strategy instanceof $validation_strategy_classname
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
+			) {
+				unset($this->_validation_strategies[ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
+	 *
+	 * @param array $validation_strategy_classnames
+	 * @return bool
+	 */
+	public function has_validation_strategy($validation_strategy_classnames)
+	{
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
+			? $validation_strategy_classnames
+			: [$validation_strategy_classnames];
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (in_array($key, $validation_strategy_classnames)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the HTML
+	 *
+	 * @return string
+	 */
+	public function get_html()
+	{
+		return $this->_parent_section->get_html_for_input($this);
+	}
+
+
+	/**
+	 * Gets the HTML for the input itself (no label or errors) according to the
+	 * input's display strategy
+	 * Makes sure the JS and CSS are enqueued for it
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_input()
+	{
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml(
+				$this->_get_display_strategy()->display(),
+				$this
+			)
+			: $this->_get_display_strategy()->display();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_other_attributes()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		return $this->other_html_attributes();
+	}
+
+
+	/**
+	 * @param string $html_other_attributes
+	 */
+	public function set_html_other_attributes($html_other_attributes)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::set_other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		$this->set_other_html_attributes($html_other_attributes);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_label()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the errors section for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_errors()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the help text for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_help()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
+	}
+
+
+	/**
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
+	 * and returns whether or not the form input's submitted value is value
+	 *
+	 * @return boolean
+	 */
+	protected function _validate()
+	{
+		if ($this->isDisabled()) {
+			return true;
+		}
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+				try {
+					$validation_strategy->validate($this->normalized_value());
+				} catch (EE_Validation_Error $e) {
+					$this->add_validation_error($e);
+				}
+			}
+		}
+		if ($this->get_validation_errors()) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+	/**
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value !== null
+			? stripslashes(html_entity_decode(trim((string) $value)))
+			: null;
+	}
+
+
+	/**
+	 * Picks out the form value that relates to this form input,
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
+	 * Returns whether or not any validation errors occurred
+	 *
+	 * @param array $req_data
+	 * @return boolean whether or not there was an error
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		// any existing validation errors don't apply so clear them
+		$this->_validation_errors = [];
+		// if the input is disabled, ignore whatever input was sent in
+		if ($this->isDisabled()) {
+			$this->_set_raw_value(null);
+			$this->_set_normalized_value($this->get_default());
+			return false;
+		}
+		try {
+			$raw_input = $this->find_form_data_for_this_section($req_data);
+			// super simple sanitization for now
+			if (is_array($raw_input)) {
+				$raw_value = [];
+				foreach ($raw_input as $key => $value) {
+					$raw_value[ $key ] = $this->_sanitize($value);
+				}
+				$this->_set_raw_value($raw_value);
+			} else {
+				$this->_set_raw_value($this->_sanitize($raw_input));
+			}
+			// we want to mostly leave the input alone in case we need to re-display it to the user
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
+			return false;
+		} catch (EE_Validation_Error $e) {
+			$this->add_validation_error($e);
+			return true;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name()
+	{
+		$this->_set_default_html_name_if_empty();
+		return $this->_html_name ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_label_id()
+	{
+		return ! empty($this->_html_label_id)
+			? $this->_html_label_id
+			: $this->html_id() . '-lbl';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_class()
+	{
+		return $this->_html_label_class ?? '';
+	}
+
+
+	/**
+	 * @param string $html_class
+	 */
+	public function add_html_label_class(string $html_class)
+	{
+		$this->_html_label_class .= ' ' . trim($html_class);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_style()
+	{
+		return $this->_html_label_style ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_text()
+	{
+		return $this->_html_label_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_text()
+	{
+		return $this->_html_help_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_class()
+	{
+		return $this->_html_help_class ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_style()
+	{
+		return $this->_html_style ?? '';
+	}
+
+
+	/**
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
+	 * Please note that almost all client code should instead use the normalized_value;
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
+	 * mostly by escaping quotes)
+	 * Note, we do not store the exact original value sent in the user's request because
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
+	 * in which case, we would have stored the malicious content to our database.
+	 *
+	 * @return mixed
+	 */
+	public function raw_value()
+	{
+		return $this->_raw_value;
+	}
+
+
+	/**
+	 * Returns a string safe to usage in form inputs when displaying, because
+	 * it escapes all html entities
+	 *
+	 * @return string
+	 */
+	public function raw_value_in_form(): string
+	{
+		return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
+	}
+
+
+	/**
+	 * returns the value after it's been sanitized, and then converted into it's proper type
+	 * in PHP. Eg, a string, an int, an array,
+	 *
+	 * @return mixed
+	 */
+	public function normalized_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * Returns the normalized value is a presentable way. By default this is just
+	 * the normalized value by itself, but it can be overridden for when that's not
+	 * the best thing to display
+	 *
+	 * @return mixed
+	 */
+	public function pretty_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * if this field had the name 'password_again', it should return
+	 * <br><code>password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 *
+	 * @return array
+	 */
+	public function get_jquery_validation_rules(): array
+	{
+		$jquery_validation_js    = [];
+		$jquery_validation_rules = [];
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$jquery_validation_rules = array_replace_recursive(
+				$jquery_validation_rules,
+				$validation_strategy->get_jquery_validation_rule_array()
+			);
+		}
+		if (! empty($jquery_validation_rules)) {
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
+				$jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+			}
+		}
+		return $jquery_validation_js;
+	}
+
+
+	/**
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
+	 *
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set_default($value)
+	{
+		$this->_default = $value;
+		$this->_set_normalized_value($value);
+		$this->_set_raw_value($value);
+	}
+
+
+	/**
+	 * Sets the normalized value on this input
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_normalized_value($value)
+	{
+		$this->_normalized_value = $value;
+	}
+
+
+	/**
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_raw_value($value)
+	{
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
+	}
+
+
+	/**
+	 * Sets the HTML label text after it has already been defined
+	 *
+	 * @param string $label
+	 * @return void
+	 */
+	public function set_html_label_text($label)
+	{
+		$this->_html_label_text = $label;
+	}
+
+
+	/**
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
+	 * please add it as a validation strategy using add_validation_strategy as normal
+	 *
+	 * @param boolean $required boolean
+	 * @param null    $required_text
+	 */
+	public function set_required($required = true, $required_text = null)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
+		// whether $required is a string or a boolean, we want to add a required validation strategy
+		if ($required) {
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
+		} else {
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
+		}
+		$this->_required = $required;
+	}
+
+
+	/**
+	 * Returns whether or not this field is required
+	 *
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->_required;
+	}
+
+
+	/**
+	 * @param string $required_css_class
+	 */
+	public function set_required_css_class($required_css_class)
+	{
+		$this->_required_css_class = $required_css_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function required_css_class()
+	{
+		return $this->_required_css_class;
+	}
+
+
+	/**
+	 * @param bool $add_required
+	 * @return string
+	 */
+	public function html_class($add_required = false)
+	{
+		return $add_required && $this->required()
+			? $this->required_css_class() . ' ' . $this->_html_class
+			: $this->_html_class;
+	}
+
+
+	/**
+	 * Sets the help text, in case
+	 *
+	 * @param string $text
+	 */
+	public function set_html_help_text($text)
+	{
+		$this->_html_help_text = $text;
+	}
+
+
+	/**
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
+	 * input. If there is any kind of sensitive data removal on this input, we clear
+	 * out the raw value completely
+	 *
+	 * @return void
+	 */
+	public function clean_sensitive_data()
+	{
+		// if we do ANY kind of sensitive data removal on this, then just clear out the raw value
+		// if we need more logic than this we'll make a strategy for it
+		if (
+			$this->_sensitive_data_removal_strategy
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
+		) {
+			$this->_set_raw_value(null);
+		}
+		// and clean the normalized value according to the appropriate strategy
+		$this->_set_normalized_value(
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
+				$this->_normalized_value
+			)
+		);
+	}
+
+
+	/**
+	 * @param bool   $primary
+	 * @param string $button_size
+	 * @param string $other_attributes
+	 */
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
+	{
+		$button_css_attributes = 'button';
+		$button_css_attributes .= $primary === true
+			? ' button--primary'
+			: ' button--secondary';
+		switch ($button_size) {
+			case 'xs':
+			case 'extra-small':
+				$button_css_attributes .= ' button-xs';
+				break;
+			case 'sm':
+			case 'small':
+				$button_css_attributes .= ' button-sm';
+				break;
+			case 'lg':
+			case 'large':
+				$button_css_attributes .= ' button-lg';
+				break;
+			case 'block':
+				$button_css_attributes .= ' button-block';
+				break;
+			case 'md':
+			case 'medium':
+			default:
+				$button_css_attributes .= '';
+		}
+		$this->_button_css_attributes .= ! empty($other_attributes)
+			? $button_css_attributes . ' ' . $other_attributes
+			: $button_css_attributes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function button_css_attributes()
+	{
+		if (empty($this->_button_css_attributes)) {
+			$this->set_button_css_attributes();
+		}
+		return $this->_button_css_attributes;
+	}
+
+
+	/**
+	 * find_form_data_for_this_section
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
+	 * then it's value should be in request at request['my_form']['subform']['form_input_1'].
+	 * (If that doesn't exist, we also check for this subsection's name
+	 * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
+	 * This function finds its value in the form.
+	 *
+	 * @param array $req_data
+	 * @return mixed whatever the raw value of this form section is in the request data
+	 * @throws EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		$name_parts = $this->getInputNameParts();
+		// now get the value for the input
+		$value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
+		// check if this thing's name is at the TOP level of the request data
+		if ($value === null && isset($req_data[ $this->name() ])) {
+			$value = $req_data[ $this->name() ];
+		}
+		return $value;
+	}
+
+
+	/**
+	 * If this input's name is something like "foo[bar][baz]"
+	 * returns an array like `array('foo','bar',baz')`
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getInputNameParts()
+	{
+		// break up the html name by "[]"
+		if (strpos($this->html_name(), '[') !== false) {
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
+		} else {
+			$before_any_brackets = $this->html_name();
+		}
+		// grab all of the segments
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
+		if (isset($matches[1]) && is_array($matches[1])) {
+			$name_parts = $matches[1];
+			array_unshift($name_parts, $before_any_brackets);
+		} else {
+			$name_parts = [$before_any_brackets];
+		}
+		return $name_parts;
+	}
+
+
+	/**
+	 * @param array $html_name_parts
+	 * @param array $req_data
+	 * @return array | NULL
+	 */
+	public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
+	{
+		$first_part_to_consider = array_shift($html_name_parts);
+		if (isset($req_data[ $first_part_to_consider ])) {
+			if (empty($html_name_parts)) {
+				return $req_data[ $first_part_to_consider ];
+			} else {
+				return $this->findRequestForSectionUsingNameParts(
+					$html_name_parts,
+					$req_data[ $first_part_to_consider ]
+				);
+			}
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Checks if this form input's data is in the request data
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			/** @var RequestInterface $request */
+			$request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$req_data = $request->postParams();
+		}
+		$checked_value = $this->find_form_data_for_this_section($req_data);
+		if ($checked_value !== null) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parent to add js data from validation and display strategies
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = [])
+	{
+		return $this->get_other_js_data_from_strategies($form_other_js_data);
+	}
+
+
+	/**
+	 * Gets other JS data for localization from this input's strategies, like
+	 * the validation strategies and the display strategy
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data_from_strategies($form_other_js_data = [])
+	{
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// ask our display strategy and validation strategies if they have js to enqueue
+		$this->enqueue_js_from_strategies();
+	}
+
+
+	/**
+	 * Tells strategies when its ok to enqueue their js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js_from_strategies()
+	{
+		$this->get_display_strategy()->enqueue_js();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$validation_strategy->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * Gets the default value set on the input (not the current value, which may have been
+	 * changed because of a form submission). If no default was set, this us null.
+	 *
+	 * @return mixed
+	 */
+	public function get_default()
+	{
+		return $this->_default;
+	}
+
+
+	/**
+	 * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
+	 * and server-side if any input was received it will be ignored
+	 */
+	public function disable($disable = true)
+	{
+		$disabled_attribute = ' disabled="disabled"';
+		$this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
+		if ($this->disabled) {
+			if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
+				$this->_other_html_attributes .= $disabled_attribute;
+			}
+			$this->_set_normalized_value($this->get_default());
+		} else {
+			$this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
+		}
+	}
+
+
+	/**
+	 * Returns whether this input is currently disabled.
+	 *
+	 * @return bool
+	 */
+	public function isDisabled()
+	{
+		return $this->disabled;
+	}
 }

core/libraries/iframe_display/IframeEmbedButton.php

Indentation +250 added lines, -250 removed lines

@@ -17,281 +17,281 @@
  */
 abstract class IframeEmbedButton
 {
-    /**
-     * @var string $iframe_name
-     */
-    private $iframe_name;
+	/**
+	 * @var string $iframe_name
+	 */
+	private $iframe_name;
 
-    /**
-     * @var string $route_name
-     */
-    private $route_name;
+	/**
+	 * @var string $route_name
+	 */
+	private $route_name;
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var boolean $append_filterable_content
-     */
-    private $append_filterable_content;
+	/**
+	 * @var boolean $append_filterable_content
+	 */
+	private $append_filterable_content;
 
 
-    /**
-     * IframeEmbedButton constructor.
-     *
-     * @param string $iframe_name i18n name for the iframe. This will be used in HTML
-     * @param string $route_name  the name of the registered route
-     * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
-     *                            will most likely be "event" since that's the only usage atm
-     */
-    public function __construct($iframe_name, $route_name, $slug = 'event')
-    {
-        $this->iframe_name = $iframe_name;
-        $this->route_name = $route_name;
-        $this->slug = $slug;
-    }
+	/**
+	 * IframeEmbedButton constructor.
+	 *
+	 * @param string $iframe_name i18n name for the iframe. This will be used in HTML
+	 * @param string $route_name  the name of the registered route
+	 * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
+	 *                            will most likely be "event" since that's the only usage atm
+	 */
+	public function __construct($iframe_name, $route_name, $slug = 'event')
+	{
+		$this->iframe_name = $iframe_name;
+		$this->route_name = $route_name;
+		$this->slug = $slug;
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButtonFilter()
-    {
-        add_filter(
-            'get_sample_permalink_html',
-            array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
-            15,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButtonFilter()
+	{
+		add_filter(
+			'get_sample_permalink_html',
+			array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
+			15,
+			2
+		);
+	}
 
-    /**
-     * Adds assets of iframe embed code button.
-     */
-    public function addEventEditorIframeEmbedButtonAssets()
-    {
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	/**
+	 * Adds assets of iframe embed code button.
+	 */
+	public function addEventEditorIframeEmbedButtonAssets()
+	{
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * @param $permalink_string
-     * @param $id
-     * @return string
-     */
-    public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
-    {
-        return $this->eventEditorIframeEmbedButton(
-            $permalink_string,
-            $id
-        );
-    }
+	/**
+	 * @param $permalink_string
+	 * @param $id
+	 * @return string
+	 */
+	public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
+	{
+		return $this->eventEditorIframeEmbedButton(
+			$permalink_string,
+			$id
+		);
+	}
 
 
-    /**
-     * iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string
-     * @param int    $id
-     * @return string
-     */
-    public function eventEditorIframeEmbedButton(
-        $permalink_string,
-        $id
-    ) {
-        // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
-            $post = get_post($id);
-            // if NOT event then let's get out.
-            if ($post->post_type !== EspressoPostType::EVENTS) {
-                return $permalink_string;
-            }
-            $permalink_string .= $this->embedButtonHtml([$this->slug => $id]);
-        }
-        return $permalink_string;
-    }
+	/**
+	 * iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @return string
+	 */
+	public function eventEditorIframeEmbedButton(
+		$permalink_string,
+		$id
+	) {
+		// make sure this is ONLY when editing and the event id has been set.
+		if (! empty($id)) {
+			$post = get_post($id);
+			// if NOT event then let's get out.
+			if ($post->post_type !== EspressoPostType::EVENTS) {
+				return $permalink_string;
+			}
+			$permalink_string .= $this->embedButtonHtml([$this->slug => $id]);
+		}
+		return $permalink_string;
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
-     *
-     * @param string $action name of the WP do_action() to hook into
-     */
-    public function addActionIframeEmbedButton($action)
-    {
-        // add button for iframe code to event editor.
-        add_action(
-            $action,
-            array($this, 'addActionIframeEmbedButtonCallback'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
+	 *
+	 * @param string $action name of the WP do_action() to hook into
+	 */
+	public function addActionIframeEmbedButton($action)
+	{
+		// add button for iframe code to event editor.
+		add_action(
+			$action,
+			array($this, 'addActionIframeEmbedButtonCallback'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function addActionIframeEmbedButtonCallback()
-    {
-        echo wp_kses($this->embedButtonHtml(), AllowedTags::getWithFullTags());
-    }
+	/**
+	 * @return void
+	 */
+	public function addActionIframeEmbedButtonCallback()
+	{
+		echo wp_kses($this->embedButtonHtml(), AllowedTags::getWithFullTags());
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
-     *
-     * @param string $filter     name of the WP apply_filters() to hook into
-     * @param bool   $append     if true, will add iframe embed button to end of content,
-     *                           else if false, will add to the beginning of the content
-     */
-    public function addFilterIframeEmbedButton($filter, $append = true)
-    {
-        $this->append_filterable_content = $append;
-        // add button for iframe code to event editor.
-        add_filter(
-            $filter,
-            array($this, 'addFilterIframeEmbedButtonCallback'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
+	 *
+	 * @param string $filter     name of the WP apply_filters() to hook into
+	 * @param bool   $append     if true, will add iframe embed button to end of content,
+	 *                           else if false, will add to the beginning of the content
+	 */
+	public function addFilterIframeEmbedButton($filter, $append = true)
+	{
+		$this->append_filterable_content = $append;
+		// add button for iframe code to event editor.
+		add_filter(
+			$filter,
+			array($this, 'addFilterIframeEmbedButtonCallback'),
+			10
+		);
+	}
 
 
-    /**
-     * @param array|string $filterable_content
-     * @return array|string
-     */
-    public function addFilterIframeEmbedButtonCallback($filterable_content)
-    {
-        $embedButtonHtml = $this->embedButtonHtml();
-        if (is_array($filterable_content)) {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content + array($this->route_name => $embedButtonHtml)
-                : array($this->route_name => $embedButtonHtml) + $filterable_content;
-        } else {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
-        }
-        return $filterable_content;
-    }
+	/**
+	 * @param array|string $filterable_content
+	 * @return array|string
+	 */
+	public function addFilterIframeEmbedButtonCallback($filterable_content)
+	{
+		$embedButtonHtml = $this->embedButtonHtml();
+		if (is_array($filterable_content)) {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content + array($this->route_name => $embedButtonHtml)
+				: array($this->route_name => $embedButtonHtml) + $filterable_content;
+		} else {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content . $embedButtonHtml
+				: $embedButtonHtml . $filterable_content;
+		}
+		return $filterable_content;
+	}
 
 
-    /**
-     * iframe_embed_html
-     *
-     * @param array  $query_args
-     * @param string $button_class
-     * @return string
-     */
-    public function embedButtonHtml($query_args = array(), $button_class = '')
-    {
-        // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array) $query_args + array($this->route_name => 'iframe');
-        $query_args = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
-            $query_args
-        );
-        // add this route to our localized vars
-        $iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
-        EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
-        $route_name = esc_attr($this->route_name);
-        $iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
+	/**
+	 * iframe_embed_html
+	 *
+	 * @param array  $query_args
+	 * @param string $button_class
+	 * @return string
+	 */
+	public function embedButtonHtml($query_args = array(), $button_class = '')
+	{
+		// incoming args will replace the defaults listed here in the second array (union preserves first array)
+		$query_args = (array) $query_args + array($this->route_name => 'iframe');
+		$query_args = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
+			$query_args
+		);
+		// add this route to our localized vars
+		$iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
+		$iframe_module_routes[ $this->route_name ] = $this->route_name;
+		EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
+		$route_name = esc_attr($this->route_name);
+		$iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
 
-        return EEH_HTML::div(
-            EEH_HTML::link(
-                '#',
-                sprintf(
-                    esc_html__('%1$s Embed %2$s iFrame', 'event_espresso'),
-                    '<span class="dashicons dashicons-embed-post"></span>',
-                    $this->iframe_name
-                ),
-                sprintf(
-                    esc_html__(
-                        'click here to generate code for embedding %1$s iframe into another site.',
-                        'event_espresso'
-                    ),
-                    EEH_Inflector::add_indefinite_article($this->iframe_name)
-                ),
-                $route_name . '-iframe-embed-trigger-js',
-                'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
-                '',
-                ' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
-            ),
-            '',
-            'ee-admin-button-row ee-admin-button-row--align-start'
-        )
-        . EEH_HTML::div(
-            EEH_HTML::div(
-                '<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
-                '',
-                '',
-                'width:100%; height: 500px;'
-            ),
-            $route_name . '-iframe-js',
-            'iframe-embed-wrapper-js',
-            'display:none;'
-        );
-    }
+		return EEH_HTML::div(
+			EEH_HTML::link(
+				'#',
+				sprintf(
+					esc_html__('%1$s Embed %2$s iFrame', 'event_espresso'),
+					'<span class="dashicons dashicons-embed-post"></span>',
+					$this->iframe_name
+				),
+				sprintf(
+					esc_html__(
+						'click here to generate code for embedding %1$s iframe into another site.',
+						'event_espresso'
+					),
+					EEH_Inflector::add_indefinite_article($this->iframe_name)
+				),
+				$route_name . '-iframe-embed-trigger-js',
+				'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
+				'',
+				' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
+			),
+			'',
+			'ee-admin-button-row ee-admin-button-row--align-start'
+		)
+		. EEH_HTML::div(
+			EEH_HTML::div(
+				'<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
+				'',
+				'',
+				'width:100%; height: 500px;'
+			),
+			$route_name . '-iframe-js',
+			'iframe-embed-wrapper-js',
+			'display:none;'
+		);
+	}
 
 
-    /**
-     * enqueue iframe button js
-     */
-    public function embedButtonAssets()
-    {
-        EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
-            'copy and paste the following into any other site\'s content to display this event:',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
-            'click anywhere outside of this window to close it.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('iframe_embed_button');
-    }
+	/**
+	 * enqueue iframe button js
+	 */
+	public function embedButtonAssets()
+	{
+		EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
+			'copy and paste the following into any other site\'s content to display this event:',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
+			'click anywhere outside of this window to close it.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'iframe_embed_button',
+			plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('iframe_embed_button');
+	}
 
 
-    /**
-     * generates embed button sections for admin pages
-     *
-     * @param array $embed_buttons
-     * @return string
-     */
-    public function addIframeEmbedButtonsSection(array $embed_buttons)
-    {
-        $embed_buttons = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
-            $embed_buttons
-        );
-        if (empty($embed_buttons)) {
-            return '';
-        }
-        // add button for iframe code to event editor.
-        $html = EEH_HTML::div('', '', 'ee-admin-section ee-iframe-embed-buttons');
-        $html .= EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
-        $html .= EEH_HTML::p(
-            esc_html__(
-                'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
-                'event_espresso'
-            )
-        );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
-        $html .= EEH_HTML::divx();
-        return $html;
-    }
+	/**
+	 * generates embed button sections for admin pages
+	 *
+	 * @param array $embed_buttons
+	 * @return string
+	 */
+	public function addIframeEmbedButtonsSection(array $embed_buttons)
+	{
+		$embed_buttons = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
+			$embed_buttons
+		);
+		if (empty($embed_buttons)) {
+			return '';
+		}
+		// add button for iframe code to event editor.
+		$html = EEH_HTML::div('', '', 'ee-admin-section ee-iframe-embed-buttons');
+		$html .= EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
+		$html .= EEH_HTML::p(
+			esc_html__(
+				'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
+				'event_espresso'
+			)
+		);
+		$html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+		$html .= EEH_HTML::divx();
+		return $html;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -106,7 +106,7 @@ 
         $id
     ) {
         // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             // if NOT event then let's get out.
             if ($post->post_type !== EspressoPostType::EVENTS) {
@@ -176,8 +176,8 @@ 
                 : array($this->route_name => $embedButtonHtml) + $filterable_content;
         } else {
             $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
+                ? $filterable_content.$embedButtonHtml
+                : $embedButtonHtml.$filterable_content;
         }
         return $filterable_content;
     }
@@ -200,7 +200,7 @@ 
         );
         // add this route to our localized vars
         $iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
+        $iframe_module_routes[$this->route_name] = $this->route_name;
         EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
         $route_name = esc_attr($this->route_name);
         $iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
@@ -220,22 +220,22 @@ 
                     ),
                     EEH_Inflector::add_indefinite_article($this->iframe_name)
                 ),
-                $route_name . '-iframe-embed-trigger-js',
-                'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
+                $route_name.'-iframe-embed-trigger-js',
+                'iframe-embed-trigger-js button button--small button--secondary '.esc_attr($button_class),
                 '',
-                ' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
+                ' data-iframe_embed_button="#'.$route_name.'-iframe-js" tabindex="-1"'
             ),
             '',
             'ee-admin-button-row ee-admin-button-row--align-start'
         )
         . EEH_HTML::div(
             EEH_HTML::div(
-                '<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
+                '<iframe src="'.$iframe_url.'" width="100%" height="100%"></iframe>',
                 '',
                 '',
                 'width:100%; height: 500px;'
             ),
-            $route_name . '-iframe-js',
+            $route_name.'-iframe-js',
             'iframe-embed-wrapper-js',
             'display:none;'
         );
@@ -257,7 +257,7 @@ 
         );
         wp_register_script(
             'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+            plugin_dir_url(__FILE__).'iframe-embed-button.js',
             array('ee-dialog'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -290,7 +290,7 @@ 
                 'event_espresso'
             )
         );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+        $html .= ' &nbsp; '.implode(' &nbsp; ', $embed_buttons).' ';
         $html .= EEH_HTML::divx();
         return $html;
     }