eventespresso / event-espresso-core

core/libraries/messages/messenger/EE_Email_messenger.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -456,7 +456,7 @@
      * be empty
      *
      * @since 4.3.1
-     * @return array
+     * @return string[]
      */
     private function _parse_from()
     {

Indentation +543 added lines, -543 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -28,548 +28,548 @@ 
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * The following are the properties that email requires for the message going out.
-     */
-    protected $_to;
-    protected $_from;
-    protected $_subject;
-    protected $_content;
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = __('This messenger delivers messages via email using the built-in <code>wp_mail</code> function included with WordPress',
-            'event_espresso');
-        $this->label               = array(
-            'singular' => __('email', 'event_espresso'),
-            'plural'   => __('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => __('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => __('To', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => __('From', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => __('Subject', 'event_espresso'),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => __('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool | WP_Error  true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
-            stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
-        $headers = array(
-            'MIME-Version: 1.0',
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) ? $parsed_from[1] : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
-
-        return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name,
-                    false, 'main', $this->_variation), true);
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                $body  = ltrim($CSS->convert(true),
-                    ">\n"); //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($body, "<?"); //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * The following are the properties that email requires for the message going out.
+	 */
+	protected $_to;
+	protected $_from;
+	protected $_subject;
+	protected $_content;
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = __('This messenger delivers messages via email using the built-in <code>wp_mail</code> function included with WordPress',
+			'event_espresso');
+		$this->label               = array(
+			'singular' => __('email', 'event_espresso'),
+			'plural'   => __('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => __('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => __('To', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => __('From', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => __('Subject', 'event_espresso'),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => __('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool | WP_Error  true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
+			stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					__('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
+		$headers = array(
+			'MIME-Version: 1.0',
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1]) ? $parsed_from[1] : get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		$from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
+
+		return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name,
+					false, 'main', $this->_variation), true);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				$body  = ltrim($CSS->convert(true),
+					">\n"); //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($body, "<?"); //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 
 
 }

Spacing +7 added lines, -7 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -387,7 +387,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     __('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
@@ -426,8 +426,8 @@ 
         $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
         $headers = array(
             'MIME-Version: 1.0',
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -527,7 +527,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -538,10 +538,10 @@ 
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
 
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name,
                     false, 'main', $this->_variation), true);
                 $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);

core/EE_Error.core.php

Indentation +1090 added lines, -1090 removed lines

@@ -5,8 +5,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -23,259 +23,259 @@ 
 {
 
 
-    /**
-     *    name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     *    has shutdown action been added ?
-     *
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/' :
-            case 'http://ee4decaf.eventespresso.com/' :
-            case 'http://ee4hf.eventespresso.com/' :
-            case 'http://ee4a.eventespresso.com/' :
-            case 'http://ee4ad.eventespresso.com/' :
-            case 'http://ee4b.eventespresso.com/' :
-            case 'http://ee4bd.eventespresso.com/' :
-            case 'http://ee4d.eventespresso.com/' :
-            case 'http://ee4dd.eventespresso.com/' :
-                $to = 'developers@eventespresso.com';
-                break;
-            default :
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[$x_time]['name'] = get_class($this);
-        self::$_all_exceptions[$x_time]['file'] = $this->getFile();
-        self::$_all_exceptions[$x_time]['line'] = $this->getLine();
-        self::$_all_exceptions[$x_time]['msg'] = $msg;
-        self::$_all_exceptions[$x_time]['code'] = $this->getCode();
-        self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
-        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        //add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-
-    /**
-     *    has_error
-     *
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[$type_to_check])
-                     && ! empty(self::$_espresso_notices[$type_to_check])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = (array)get_option('ee_notices', array());
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-
-    /**
-     *    display_errors
-     *
-     * @echo   string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	/**
+	 *    name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 *    has shutdown action been added ?
+	 *
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/' :
+			case 'http://ee4decaf.eventespresso.com/' :
+			case 'http://ee4hf.eventespresso.com/' :
+			case 'http://ee4a.eventespresso.com/' :
+			case 'http://ee4ad.eventespresso.com/' :
+			case 'http://ee4b.eventespresso.com/' :
+			case 'http://ee4bd.eventespresso.com/' :
+			case 'http://ee4d.eventespresso.com/' :
+			case 'http://ee4dd.eventespresso.com/' :
+				$to = 'developers@eventespresso.com';
+				break;
+			default :
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[$x_time]['name'] = get_class($this);
+		self::$_all_exceptions[$x_time]['file'] = $this->getFile();
+		self::$_all_exceptions[$x_time]['line'] = $this->getLine();
+		self::$_all_exceptions[$x_time]['msg'] = $msg;
+		self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+		self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
+		self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		//add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+
+	/**
+	 *    has_error
+	 *
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[$type_to_check])
+					 && ! empty(self::$_espresso_notices[$type_to_check])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = (array)get_option('ee_notices', array());
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+
+	/**
+	 *    display_errors
+	 *
+	 * @echo   string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -331,19 +331,19 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __('Sorry, but no trace information was available for this exception.',
-                    'event_espresso');
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __('Sorry, but no trace information was available for this exception.',
+					'event_espresso');
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -353,38 +353,38 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            $b = new ReflectionMethod($class, $function);
-                            $line = $b->getStartLine();
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							$b = new ReflectionMethod($class, $function);
+							$line = $b->getStartLine();
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -392,674 +392,674 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $type whether the message is for a success or error notification
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[$type][$notice_code] = $msg;
-            } else {
-                self::$_espresso_notices[$type][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return        void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-
-    /**
-     *    in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return        void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    reset_notices
-     *
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success'] = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     *    has_errors
-     *
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
-            'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
-        );
-    }
-
-
-
-    /**
-     *    compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
-     * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param        boolean $remove_empty      whether or not to unset empty messages
-     * @return        array
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success_messages = '';
-        $attention_messages = '';
-        $error_messages = '';
-        $print_scripts = false;
-        // either save notices to the db
-        if ($save_to_transient) {
-            update_option('ee_notices', self::$_espresso_notices);
-            return array();
-        }
-        // grab any notices that have been previously saved
-        if ($notices = get_option('ee_notices', false)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
-                                                      && ! empty(self::$_espresso_notices[$type])
-                        ? self::$_espresso_notices[$type] : array();
-                    // merge stored notices with any newly created ones
-                    self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            update_option('ee_notices', false);
-        }
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
-            $print_scripts = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
-            $print_scripts = true;
-        }
-        if ($format_output) {
-            $notices = '<div id="espresso-notices">';
-            $close = is_admin() ? ''
-                : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
-            if ($success_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-success';
-                $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-                //showMessage( $success_messages );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $success_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($attention_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-attention';
-                $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $attention_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            if ($error_messages !== '') {
-                $css_id = is_admin() ? 'message' : 'espresso-notices-error';
-                $css_class = is_admin() ? 'error' : 'error fade-away';
-                //showMessage( $error_messages, TRUE );
-                $notices .= '<div id="'
-                            . $css_id
-                            . '" class="espresso-notices '
-                            . $css_class
-                            . '" style="display:none;"><p>'
-                            . $error_messages
-                            . '</p>'
-                            . $close
-                            . '</div>';
-            }
-            $notices .= '</div>';
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[$type]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     *    add_persistent_admin_notice
-     *
-     * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param        string $pan_message  the message to be stored persistently until dismissed
-     * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
-     * @return        void
-     */
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            //maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option('ee_pers_admin_notices', array(), '', 'no');
-            }
-            $pan_name = sanitize_key($pan_name);
-            if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
-                $persistent_admin_notices[$pan_name] = $pan_message;
-                update_option('ee_pers_admin_notices', $persistent_admin_notices);
-            }
-        }
-    }
-
-
-
-    /**
-     *    dismiss_persistent_admin_notice
-     *
-     * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool          $purge
-     * @param bool          $return_immediately
-     * @return        void
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
-    {
-        $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
-            ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
-        if (! empty($pan_name)) {
-            $persistent_admin_notices = get_option('ee_pers_admin_notices', array());
-            // check if notice we wish to dismiss is actually in the $persistent_admin_notices array
-            if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
-                // completely delete nag notice, or just NULL message so that it can NOT be added again ?
-                if ($purge) {
-                    unset($persistent_admin_notices[$pan_name]);
-                } else {
-                    $persistent_admin_notices[$pan_name] = null;
-                }
-                if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
-                    EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
-                        'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        if ($return_immediately) {
-            return;
-        }
-        if (EE_Registry::instance()->REQ->ajax) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        $return_url = EE_Registry::instance()->REQ->is_set('return_url')
-            ? EE_Registry::instance()->REQ->get('return_url') : '';
-        wp_safe_redirect(urldecode($return_url));
-    }
-
-
-
-    /**
-     * display_persistent_admin_notices
-     *
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     * @return string
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        if (! empty($pan_name) && ! empty($pan_message)) {
-            $args = array(
-                'nag_notice'    => $pan_name,
-                'return_url'    => urlencode($return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => esc_html__(
-                    'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                    'event_espresso'
-                ),
-            );
-            EE_Registry::$i18n_js_strings = array_merge(
-                EE_Registry::$i18n_js_strings,
-                array('ee_dismiss' => $args)
-            );
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $type whether the message is for a success or error notification
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null)
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[$type][$notice_code] = $msg;
+			} else {
+				self::$_espresso_notices[$type][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+
+	/**
+	 *    in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    reset_notices
+	 *
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success'] = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 *    has_errors
+	 *
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
+			'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
+		);
+	}
+
+
+
+	/**
+	 *    compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param        boolean $format_output     whether or not to format the messages for display in the WP admin
+	 * @param        boolean $save_to_transient whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param        boolean $remove_empty      whether or not to unset empty messages
+	 * @return        array
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success_messages = '';
+		$attention_messages = '';
+		$error_messages = '';
+		$print_scripts = false;
+		// either save notices to the db
+		if ($save_to_transient) {
+			update_option('ee_notices', self::$_espresso_notices);
+			return array();
+		}
+		// grab any notices that have been previously saved
+		if ($notices = get_option('ee_notices', false)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+													  && ! empty(self::$_espresso_notices[$type])
+						? self::$_espresso_notices[$type] : array();
+					// merge stored notices with any newly created ones
+					self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			update_option('ee_notices', false);
+		}
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />');
+			$print_scripts = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />');
+			$print_scripts = true;
+		}
+		if ($format_output) {
+			$notices = '<div id="espresso-notices">';
+			$close = is_admin() ? ''
+				: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>';
+			if ($success_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-success';
+				$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+				//showMessage( $success_messages );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $success_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($attention_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-attention';
+				$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $attention_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			if ($error_messages !== '') {
+				$css_id = is_admin() ? 'message' : 'espresso-notices-error';
+				$css_class = is_admin() ? 'error' : 'error fade-away';
+				//showMessage( $error_messages, TRUE );
+				$notices .= '<div id="'
+							. $css_id
+							. '" class="espresso-notices '
+							. $css_class
+							. '" style="display:none;"><p>'
+							. $error_messages
+							. '</p>'
+							. $close
+							. '</div>';
+			}
+			$notices .= '</div>';
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[$type]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 *    add_persistent_admin_notice
+	 *
+	 * @param        string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param        string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool          $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return        void
+	 */
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			//maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option('ee_pers_admin_notices', array(), '', 'no');
+			}
+			$pan_name = sanitize_key($pan_name);
+			if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
+				$persistent_admin_notices[$pan_name] = $pan_message;
+				update_option('ee_pers_admin_notices', $persistent_admin_notices);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    dismiss_persistent_admin_notice
+	 *
+	 * @param        string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool          $purge
+	 * @param bool          $return_immediately
+	 * @return        void
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false)
+	{
+		$pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice')
+			? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
+		if (! empty($pan_name)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
+			// check if notice we wish to dismiss is actually in the $persistent_admin_notices array
+			if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
+				// completely delete nag notice, or just NULL message so that it can NOT be added again ?
+				if ($purge) {
+					unset($persistent_admin_notices[$pan_name]);
+				} else {
+					$persistent_admin_notices[$pan_name] = null;
+				}
+				if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) {
+					EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.',
+						'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		if ($return_immediately) {
+			return;
+		}
+		if (EE_Registry::instance()->REQ->ajax) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false))));
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		$return_url = EE_Registry::instance()->REQ->is_set('return_url')
+			? EE_Registry::instance()->REQ->get('return_url') : '';
+		wp_safe_redirect(urldecode($return_url));
+	}
+
+
+
+	/**
+	 * display_persistent_admin_notices
+	 *
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 * @return string
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		if (! empty($pan_name) && ! empty($pan_message)) {
+			$args = array(
+				'nag_notice'    => $pan_name,
+				'return_url'    => urlencode($return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => esc_html__(
+					'An unknown error has occurred on the server while attempting to dismiss this notice.',
+					'event_espresso'
+				),
+			);
+			EE_Registry::$i18n_js_strings = array_merge(
+				EE_Registry::$i18n_js_strings,
+				array('ee_dismiss' => $args)
+			);
+			return '
 			<div id="'
-                   . $pan_name
-                   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
+				   . $pan_name
+				   . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
 				<p>'
-                   . $pan_message
-                   . '</p>
+				   . $pan_message
+				   . '</p>
 				<a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="'
-                   . $pan_name
-                   . '">
+				   . $pan_name
+				   . '">
 					<span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'
-                   . __('Dismiss', 'event_espresso')
-                   . '
+				   . __('Dismiss', 'event_espresso')
+				   . '
 				</a>
 				<div style="clear:both;"></div>
 			</div>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @param string $return_url
-     * @return string
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        $notices = '';
-        // check for persistent admin notices
-        //filter the list though so plugins can notify the admin in a different way if they want
-        $persistent_admin_notices = apply_filters(
-            'FHEE__EE_Error__get_persistent_admin_notices',
-            get_option('ee_pers_admin_notices', false),
-            'ee_pers_admin_notices',
-            $return_url
-        );
-        if ($persistent_admin_notices) {
-            // load scripts
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                array('jquery'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_register_script(
-                'ee_error_js',
-                EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-                array('espresso_core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ee_error_js');
-            // and display notices
-            foreach ($persistent_admin_notices as $pan_name => $pan_message) {
-                $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
-            }
-        }
-        return $notices;
-    }
-
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-            }
-        } else {
-            return '
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @param string $return_url
+	 * @return string
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		$notices = '';
+		// check for persistent admin notices
+		//filter the list though so plugins can notify the admin in a different way if they want
+		$persistent_admin_notices = apply_filters(
+			'FHEE__EE_Error__get_persistent_admin_notices',
+			get_option('ee_pers_admin_notices', false),
+			'ee_pers_admin_notices',
+			$return_url
+		);
+		if ($persistent_admin_notices) {
+			// load scripts
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				array('jquery'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_register_script(
+				'ee_error_js',
+				EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+				array('espresso_core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ee_error_js');
+			// and display notices
+			foreach ($persistent_admin_notices as $pan_name => $pan_message) {
+				$notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
+			}
+		}
+		return $notices;
+	}
+
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1069,143 +1069,143 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    enqueue_error_scripts
-     *
-     * @return        void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-
-    /**
-     *    create error code from filepath, function name,
-     *    and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-
-    /**
-     *    write exception details to log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            EEH_File::ensure_file_exists_and_is_writable(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-            );
-            EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
-            if (! $clear) {
-                //get existing log file and append new log info
-                $exception_log = EEH_File::get_file_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
-                ) . $exception_log;
-            }
-            EEH_File::write_to_file(
-                EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
-                $exception_log
-            );
-        } catch (EE_Error $e) {
-            EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
-                'event_espresso'), $e->getMessage()));
-            return;
-        }
-    }
-
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    enqueue_error_scripts
+	 *
+	 * @return        void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+
+	/**
+	 *    create error code from filepath, function name,
+	 *    and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+
+	/**
+	 *    write exception details to log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			EEH_File::ensure_file_exists_and_is_writable(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+			);
+			EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
+			if (! $clear) {
+				//get existing log file and append new log info
+				$exception_log = EEH_File::get_file_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file
+				) . $exception_log;
+			}
+			EEH_File::write_to_file(
+				EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file,
+				$exception_log
+			);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
+				'event_espresso'), $e->getMessage()));
+			return;
+		}
+	}
+
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
 
 
 
@@ -1221,27 +1221,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 }
 
 

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.44.rc.028');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.44.rc.028');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

core/helpers/EEH_Event_View.helper.php

Indentation +97 added lines, -97 removed lines

@@ -32,51 +32,51 @@ 
 
 
 
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
-    public static function get_event($EVT_ID = 0)
-    {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        //reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
-            EEH_Event_View::$_event = $post;
-            return EEH_Event_View::$_event;
-        }
-        //if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-        //then let's just use that cached event on the $post object.
-        if (
-            $post instanceof WP_Post
-            && $post->post_type === 'espresso_events'
-            && isset($post->EE_Event)
-            && (
-                $EVT_ID === 0
-                || $EVT_ID === $post->ID
-            )
-        ) {
-            EEH_Event_View::$_event = $post->EE_Event;
-            return EEH_Event_View::$_event;
-        }
-        //If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-            EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        return EEH_Event_View::$_event;
-    }
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
+	public static function get_event($EVT_ID = 0)
+	{
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		//reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+		if (! $EVT_ID && $post instanceof EE_Event) {
+			EEH_Event_View::$_event = $post;
+			return EEH_Event_View::$_event;
+		}
+		//if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+		//then let's just use that cached event on the $post object.
+		if (
+			$post instanceof WP_Post
+			&& $post->post_type === 'espresso_events'
+			&& isset($post->EE_Event)
+			&& (
+				$EVT_ID === 0
+				|| $EVT_ID === $post->ID
+			)
+		) {
+			EEH_Event_View::$_event = $post->EE_Event;
+			return EEH_Event_View::$_event;
+		}
+		//If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+		if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+			EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		return EEH_Event_View::$_event;
+	}
 
 
 
@@ -152,58 +152,58 @@ 
 	 * @return    string
 	 */
 	public static function event_content_or_excerpt( $num_words = NULL, $more = NULL ) {
-        global $post;
+		global $post;
 		ob_start();
 		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
 			// admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
+			// for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
 		} else if (( is_archive() && espresso_display_excerpt_in_event_list() ) ) {
-            if ( has_excerpt( $post->ID )) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if ( ! empty( $num_words )) {
-                    if ( empty( $more )) {
-                        $more_link_text = __( '(more…)' );
-                        $more = ' <a href="' . get_permalink() . '"';
-                        $more .= ' class="more-link"';
-                        $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
-                        $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
-                    }
-                    $content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
-
-                    $content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
-                } else {
-                    $content =  get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : array();
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content = wp_kses( $content, $allowedtags );
-                $content = strip_shortcodes( $content );
-                echo apply_filters( 'the_content', $content );
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters( 'the_content', '' );
+			if ( has_excerpt( $post->ID )) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if ( ! empty( $num_words )) {
+					if ( empty( $more )) {
+						$more_link_text = __( '(more&hellip;)' );
+						$more = ' <a href="' . get_permalink() . '"';
+						$more .= ' class="more-link"';
+						$more .= \EED_Events_Archive::link_target();
+						$more .= '>' . $more_link_text . '</a>';
+						$more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+					}
+					$content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
+
+					$content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
+				} else {
+					$content =  get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: array();
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content = wp_kses( $content, $allowedtags );
+				$content = strip_shortcodes( $content );
+				echo apply_filters( 'the_content', $content );
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters( 'the_content', '' );
 		}
 		return ob_get_clean();
 	}
@@ -250,11 +250,11 @@ 
 					$url = get_term_link( $term, 'espresso_venue_categories' );
 					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
 						$category_links[] = '<a href="' . esc_url( $url )
-                                            . '" rel="tag"'
-                                            . \EED_Events_Archive::link_target()
-                                            .'>'
-                                            . $term->name
-                                            . '</a>';
+											. '" rel="tag"'
+											. \EED_Events_Archive::link_target()
+											.'>'
+											. $term->name
+											. '</a>';
 					}
 				}
 			}

Spacing +115 added lines, -115 removed lines

@@ -53,7 +53,7 @@ 
         }
         //reset property so that the new event is cached.
         EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
+        if ( ! $EVT_ID && $post instanceof EE_Event) {
             EEH_Event_View::$_event = $post;
             return EEH_Event_View::$_event;
         }
@@ -72,7 +72,7 @@ 
             return EEH_Event_View::$_event;
         }
         //If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+        if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
             EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
         }
         return EEH_Event_View::$_event;
@@ -87,8 +87,8 @@ 
 	 * @param    int $EVT_ID
 	 * @return    boolean
 	 */
-	public static function display_ticket_selector( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function display_ticket_selector($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		return $event instanceof EE_Event ? $event->display_ticket_selector() : FALSE;
 	}
 
@@ -101,9 +101,9 @@ 
 	 * @param    int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_status( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		return $event instanceof EE_Event ? $event->pretty_active_status( FALSE ) : '';
+	public static function event_status($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status(FALSE) : '';
 	}
 
 
@@ -115,8 +115,8 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	string
 	 */
-	public static function event_active_status( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_active_status($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		return $event instanceof EE_Event ? $event->pretty_active_status() : 'inactive';
 	}
 
@@ -129,13 +129,13 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	string
 	 */
-	public static function event_has_content_or_excerpt( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_has_content_or_excerpt($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		$has_content_or_excerpt = FALSE;
-		if ( $event instanceof EE_Event ) {
-			$has_content_or_excerpt = $event->description() != '' || $event->short_description( NULL, NULL, TRUE ) != '' ? TRUE : FALSE;
+		if ($event instanceof EE_Event) {
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(NULL, NULL, TRUE) != '' ? TRUE : FALSE;
 		}
-		if ( is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
+		if (is_archive() && ! (espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list())) {
 			$has_content_or_excerpt = FALSE;
 		}
 		return $has_content_or_excerpt;
@@ -151,15 +151,15 @@ 
 	 * @param null $more
 	 * @return    string
 	 */
-	public static function event_content_or_excerpt( $num_words = NULL, $more = NULL ) {
+	public static function event_content_or_excerpt($num_words = NULL, $more = NULL) {
         global $post;
 		ob_start();
-		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
+		if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
 			// admin has chosen "full description"
             // for the "Event Espresso - Events > Templates > Display Description" option
 			the_content();
-		} else if (( is_archive() && espresso_display_excerpt_in_event_list() ) ) {
-            if ( has_excerpt( $post->ID )) {
+		} else if ((is_archive() && espresso_display_excerpt_in_event_list())) {
+            if (has_excerpt($post->ID)) {
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
                 // AND an excerpt actually exists
@@ -168,20 +168,20 @@ 
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
                 // but NO excerpt actually exists, so we need to create one
-                if ( ! empty( $num_words )) {
-                    if ( empty( $more )) {
-                        $more_link_text = __( '(more…)' );
-                        $more = ' <a href="' . get_permalink() . '"';
+                if ( ! empty($num_words)) {
+                    if (empty($more)) {
+                        $more_link_text = __('(more&hellip;)');
+                        $more = ' <a href="'.get_permalink().'"';
                         $more .= ' class="more-link"';
                         $more .= \EED_Events_Archive::link_target();
-                        $more .= '>' . $more_link_text . '</a>';
-                        $more = apply_filters( 'the_content_more_link', $more, $more_link_text );
+                        $more .= '>'.$more_link_text.'</a>';
+                        $more = apply_filters('the_content_more_link', $more, $more_link_text);
                     }
-                    $content = str_replace( 'NOMORELINK', '', get_the_content( 'NOMORELINK' ));
+                    $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
 
-                    $content =  wp_trim_words( $content, $num_words, ' ' ) . $more;
+                    $content = wp_trim_words($content, $num_words, ' ').$more;
                 } else {
-                    $content =  get_the_content();
+                    $content = get_the_content();
                 }
                 global $allowedtags;
                 // make sure links are allowed
@@ -195,15 +195,15 @@ 
                 // but get previous value so we can reset it
                 $prev_value = $allowedtags['a']['target'];
                 $allowedtags['a']['target'] = true;
-                $content = wp_kses( $content, $allowedtags );
-                $content = strip_shortcodes( $content );
-                echo apply_filters( 'the_content', $content );
+                $content = wp_kses($content, $allowedtags);
+                $content = strip_shortcodes($content);
+                echo apply_filters('the_content', $content);
                 $allowedtags['a']['target'] = $prev_value;
             }
         } else {
             // admin has chosen "none"
             // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters( 'the_content', '' );
+            echo apply_filters('the_content', '');
 		}
 		return ob_get_clean();
 	}
@@ -217,13 +217,13 @@ 
 	 * @param    int $EVT_ID
 	 *  @return 	EE_Ticket[]
 	 */
-	public static function event_tickets_available( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
+	public static function event_tickets_available($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
 		$tickets_available_for_purchase = array();
-		if( $event instanceof EE_Event ) {
-			$datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, FALSE );
-			foreach( $datetimes as $datetime ) {
-				$tickets_available_for_purchase = array_merge( $tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase() );
+		if ($event instanceof EE_Event) {
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, FALSE);
+			foreach ($datetimes as $datetime) {
+				$tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
 			}
 		}
 		return $tickets_available_for_purchase;
@@ -239,17 +239,17 @@ 
 	 * @param 	  bool   $hide_uncategorized
 	 * @return    string
 	 */
-	public static function event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE ) {
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = TRUE) {
 		$category_links = array();
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			$event_categories = get_the_terms( $event->ID(), 'espresso_event_categories' );
-			if ( $event_categories ) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
+			if ($event_categories) {
 				// loop thru terms and create links
-				foreach ( $event_categories as $term ) {
-					$url = get_term_link( $term, 'espresso_venue_categories' );
-					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
-						$category_links[] = '<a href="' . esc_url( $url )
+				foreach ($event_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if ( ! is_wp_error($url) && (($hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized)) {
+						$category_links[] = '<a href="'.esc_url($url)
                                             . '" rel="tag"'
                                             . \EED_Events_Archive::link_target()
                                             .'>'
@@ -259,7 +259,7 @@ 
 				}
 			}
 		}
-		return implode( ', ', $category_links );
+		return implode(', ', $category_links);
 	}
 
 
@@ -273,10 +273,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_primary_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime( 'DTT_EVT_start', $format ) :  '';
+	public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
 	}
 
 
@@ -290,10 +290,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_event_end_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_last_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime( 'DTT_EVT_end', $format ) : '';
+	public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
 	}
 
 
@@ -307,10 +307,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_earliest_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_earliest_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime( 'DTT_EVT_start', $format ) : '';
+	public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
 	}
 
 
@@ -324,10 +324,10 @@ 
 	 * @param int    $EVT_ID
 	 * @return    string
 	 */
-	public static function the_latest_event_date( $dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_latest_date_obj( $EVT_ID );
-		$format = ! empty( $dt_frmt ) && ! empty( $tm_frmt ) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
-		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime( 'DTT_EVT_end', $format ) : '';
+	public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt.' '.$tm_frmt : $dt_frmt.$tm_frmt;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
 	}
 
 
@@ -339,13 +339,13 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_date_as_calendar_page( $EVT_ID = 0 ) {
-		$datetime = EEH_Event_View::get_primary_date_obj( $EVT_ID );
-		if ( $datetime instanceof EE_Datetime ) {
+	public static function event_date_as_calendar_page($EVT_ID = 0) {
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		if ($datetime instanceof EE_Datetime) {
 	?>
 		<div class="event-date-calendar-page-dv">
-			<div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime( 'DTT_EVT_start', 'M' );?></div>
-			<div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date( 'd' );?></div>
+			<div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M'); ?></div>
+			<div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d'); ?></div>
 		</div>
 	<?php
 		}
@@ -360,17 +360,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_primary_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_primary_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_order' => 'ASC' )
+					'order_by' => array('DTT_order' => 'ASC')
 				)
 			);
-			return reset( $datetimes );
+			return reset($datetimes);
 		} else {
 			 return FALSE;
 		}
@@ -385,17 +385,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_last_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_last_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_order' => 'DESC' )
+					'order_by' => array('DTT_order' => 'DESC')
 				)
 			);
-			return end( $datetimes );
+			return end($datetimes);
 		} else {
 			return FALSE;
 		}
@@ -410,17 +410,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_earliest_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_earliest_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+					'order_by' => array('DTT_EVT_start' => 'ASC')
 				)
 			);
-			return reset( $datetimes );
+			return reset($datetimes);
 		} else {
 			 return FALSE;
 		}
@@ -435,17 +435,17 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function get_latest_date_obj( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function get_latest_date_obj($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			$datetimes = $event->get_many_related(
 				'Datetime',
 				array(
 					'limit' => 1,
-					'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+					'order_by' => array('DTT_EVT_start' => 'DESC')
 				)
 			);
-			return end( $datetimes );
+			return end($datetimes);
 		} else {
 			return FALSE;
 		}
@@ -463,17 +463,17 @@ 
 	 * @param null $limit
 	 * @return EE_Datetime[]
 	 */
-	public static function get_all_date_obj( $EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = NULL ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if($include_expired === null){
-			if($event instanceof EE_Event && $event->is_expired()){
+	public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = NULL) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($include_expired === null) {
+			if ($event instanceof EE_Event && $event->is_expired()) {
 				$include_expired = true;
-			}else{
+			} else {
 				$include_expired = false;
 			}
 		}
 
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
 		} else {
 			 return array();
@@ -489,11 +489,11 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_link_url( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			$url = $event->external_url() !== NULL && $event->external_url() !== '' ? $event->external_url() : get_permalink( $event->ID() );
-			return preg_match( "~^(?:f|ht)tps?://~i", $url ) ? $url : 'http://' . $url;
+	public static function event_link_url($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$url = $event->external_url() !== NULL && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
+			return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://'.$url;
 		}
 		return NULL;
 	}
@@ -507,10 +507,10 @@ 
 	 * @param int $EVT_ID
 	 * @return    string
 	 */
-	public static function event_phone( $EVT_ID = 0 ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
-			return EEH_Schema::telephone( $event->phone() );
+	public static function event_phone($EVT_ID = 0) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			return EEH_Schema::telephone($event->phone());
 		}
 		return NULL;
 	}
@@ -527,26 +527,26 @@ 
 	 * @param string $after
 	 * @return    string
 	 */
-	public static function edit_event_link( $EVT_ID = 0, $link = '', $before = '', $after = '' ) {
-		$event = EEH_Event_View::get_event( $EVT_ID );
-		if ( $event instanceof EE_Event ) {
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '') {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
 			// can the user edit this post ?
-			if ( current_user_can( 'edit_post', $event->ID() )) {
+			if (current_user_can('edit_post', $event->ID())) {
 				// set link text
-				$link_text = ! empty( $link ) ? $link : __('edit this event');
+				$link_text = ! empty($link) ? $link : __('edit this event');
 				// generate nonce
-				$nonce = wp_create_nonce( 'edit_nonce' );
+				$nonce = wp_create_nonce('edit_nonce');
 				// generate url to event editor for this event
-				$url = add_query_arg( array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url() );
+				$url = add_query_arg(array('page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce), admin_url());
 				// get edit CPT text
-				$post_type_obj = get_post_type_object( 'espresso_events' );
+				$post_type_obj = get_post_type_object('espresso_events');
 				// build final link html
-				$link = '<a class="post-edit-link" href="' . $url . '" ';
-				$link .= ' title="' . esc_attr( $post_type_obj->labels->edit_item ) . '"';
+				$link = '<a class="post-edit-link" href="'.$url.'" ';
+				$link .= ' title="'.esc_attr($post_type_obj->labels->edit_item).'"';
 				$link .= \EED_Events_Archive::link_target();
-				$link .='>' . $link_text . '</a>';
+				$link .= '>'.$link_text.'</a>';
 				// put it all together
-				return $before . apply_filters( 'edit_post_link', $link, $event->ID() ) . $after;
+				return $before.apply_filters('edit_post_link', $link, $event->ID()).$after;
 			}
 		}
 		return '';

core/services/shortcodes/EspressoShortcode.php

Indentation +217 added lines, -217 removed lines

@@ -23,223 +23,223 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof EE_Event) {
-            return $event->ID();
-        }
-        global $post;
-        if ($post instanceof EE_Event) {
-            return $post->ID();
-        }
-        if ($post instanceof WP_Post) {
-            return $post->ID;
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof EE_Event) {
+			return $event->ID();
+		}
+		global $post;
+		if ($post instanceof EE_Event) {
+			return $post->ID();
+		}
+		if ($post instanceof WP_Post) {
+			return $post->ID;
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 
 
 

core/domain/entities/shortcodes/EspressoEventAttendees.php

Indentation +239 added lines, -239 removed lines

@@ -28,245 +28,245 @@
 class EspressoEventAttendees extends EspressoShortcode
 {
 
-    private $query_params = array(
-        0 => array()
-    );
-
-    private $template_args = array(
-        'contacts'      => array(),
-        'event'         => null,
-        'datetime'      => null,
-        'ticket'        => null,
-    );
-
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENT_ATTENDEES';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
-     *  [ESPRESSO_EVENT_ATTENDEES] - defaults to attendees for earliest active event, or earliest upcoming event.
-     *  [ESPRESSO_EVENT_ATTENDEES event_id=123] - attendees for specific event.
-     *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245] - attendees for a specific datetime.
-     *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123] - attendees for a specific ticket.
-     *  [ESPRESSO_EVENT_ATTENDEES status=all] - specific registration status (use status id) or all for all attendees
-     *                                          regardless of status.  Note default is to only return approved attendees
-     *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true] - default is to not return gravatar.  Otherwise if this is set
-     *                                                  then return gravatar for email address given.
-     *  Note: because of the relationship between event_id, ticket_id, and datetime_id.
-     * If more than one of those params is included then preference is given to the following:
-     *  - event_id is used whenever its present and any others are ignored.
-     *  - if no event_id then datetime is used whenever its present and any others are ignored.
-     *  - otherwise ticket_id is used if present.
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array)$attributes);
-        // add attributes to template args
-        $this->template_args['show_gravatar'] = $attributes['show_gravatar'];
-        // add required objects: event, datetime, and ticket
-        $this->template_args['event'] = $this->getEventAndQueryParams($attributes);
-        $this->template_args['datetime'] = $this->getDatetimeAndQueryParams($attributes);
-        $this->template_args['ticket'] = $this->getTicketAndQueryParams($attributes);
-
-        // if any of the above objects is invalid or missing,
-        // then there was an invalid parameter or the shortcode was used incorrectly
-        // so when WP_DEBUG is set and true, we'll show a message,
-        // otherwise we'll just return an empty string.
-         if (
-            ! $this->template_args['event'] instanceof EE_Event
-            || empty($this->query_params[0])
-            || ($attributes['datetime_id'] && ! $this->template_args['datetime'] instanceof EE_Datetime)
-            || ($attributes['ticket_id'] && ! $this->template_args['ticket'] instanceof EE_Ticket)
-        ) {
-            if (WP_DEBUG) {
-                return '<div class="important-notice ee-attention">'
-                       . esc_html__('The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
-                        'event_espresso')
-                       . '</div>';
-            } else {
-                return '';
-            }
-        }
-        $this->setAdditionalQueryParams($attributes);
-        //get contacts!
-        $this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
-        //all set let's load up the template and return.
-        return EEH_Template::locate_template('loop-espresso_event_attendees.php', $this->template_args, true, true);
-    }
-
-
-
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array) apply_filters(
-                'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
-                array(
-                    'event_id'      => null,
-                    'datetime_id'   => null,
-                    'ticket_id'     => null,
-                    'status'        => EEM_Registration::status_id_approved,
-                    'show_gravatar' => false
-                )
-            ),
-            $attributes
-        );
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
-    private function getEventAndQueryParams(array $attributes){
-        if ( ! empty($attributes['event_id'])) {
-            $event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
-            if ($event instanceof EE_Event) {
-                $this->query_params[0]['Registration.EVT_ID'] = $attributes['event_id'];
-                return $event;
-            }
-        }
-        //seems like is_espresso_event_single() isn't working as expected. So using alternate method.
-        if ( is_espresso_event()) {
-            $event = EEH_Event_View::get_event();
-            if ($event instanceof EE_Event) {
-                $this->query_params[0]['Registration.EVT_ID'] = $event->ID();
-                return $event;
-            }
-        }
-        // one last shot...
-        // try getting the earliest active event
-        $events = EEM_Event::instance()->get_active_events(array(
-            'limit'    => 1,
-            'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
-        ));
-        //  if none then get the next upcoming
-        $events = empty($events)
-            ? EEM_Event::instance()->get_upcoming_events(array(
-                'limit'    => 1,
-                'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
-            ))
-            : $events;
-        $event = reset($events);
-        if ($event instanceof EE_Event) {
-            $this->query_params[0]['Registration.EVT_ID'] = $event->ID();
-            return $event;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return EE_Datetime|null
-     */
-    private function getDatetimeAndQueryParams(array $attributes)
-    {
-        if ( ! empty($attributes['datetime_id'])) {
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
-            if ($datetime instanceof EE_Datetime) {
-                $this->query_params[0]['Registration.Ticket.Datetime.DTT_ID'] = $attributes['datetime_id'];
-                $this->query_params['default_where_conditions'] = 'this_model_only';
-                if ( ! $this->template_args['event'] instanceof EE_Event) {
-                    $this->template_args['event'] = $datetime->event();
-                }
-                return $datetime;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return \EE_Base_Class|null
-     * @throws \EE_Error
-     */
-    private function getTicketAndQueryParams(array $attributes)
-    {
-        if ( ! empty($attributes['ticket_id']) && empty($attributes['event_id']) && empty($attributes['datetime_id'])) {
-            $ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
-            if ($ticket instanceof EE_Ticket) {
-                $this->query_params[0]['Registration.TKT_ID'] = $attributes['ticket_id'];
-                if ( ! $this->template_args['event'] instanceof EE_Event) {
-                    $this->template_args['event'] = $ticket->first_datetime() instanceof EE_Datetime
-                        ? $ticket->first_datetime()->event()
-                        : null;
-                }
-                return $ticket;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     */
-    private function setAdditionalQueryParams(array $attributes)
-    {
-        $reg_status_array = EEM_Registration::reg_status_array();
-        if ($attributes['status'] !== 'all' && isset($reg_status_array[$attributes['status']])) {
-            $this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
-        }
-        $this->query_params['group_by'] = array('ATT_ID');
-        $this->query_params['order_by'] = (array) apply_filters(
-            'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
-            array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
-        );
-    }
+	private $query_params = array(
+		0 => array()
+	);
+
+	private $template_args = array(
+		'contacts'      => array(),
+		'event'         => null,
+		'datetime'      => null,
+		'ticket'        => null,
+	);
+
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENT_ATTENDEES';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
+	 *  [ESPRESSO_EVENT_ATTENDEES] - defaults to attendees for earliest active event, or earliest upcoming event.
+	 *  [ESPRESSO_EVENT_ATTENDEES event_id=123] - attendees for specific event.
+	 *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245] - attendees for a specific datetime.
+	 *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123] - attendees for a specific ticket.
+	 *  [ESPRESSO_EVENT_ATTENDEES status=all] - specific registration status (use status id) or all for all attendees
+	 *                                          regardless of status.  Note default is to only return approved attendees
+	 *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true] - default is to not return gravatar.  Otherwise if this is set
+	 *                                                  then return gravatar for email address given.
+	 *  Note: because of the relationship between event_id, ticket_id, and datetime_id.
+	 * If more than one of those params is included then preference is given to the following:
+	 *  - event_id is used whenever its present and any others are ignored.
+	 *  - if no event_id then datetime is used whenever its present and any others are ignored.
+	 *  - otherwise ticket_id is used if present.
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes((array)$attributes);
+		// add attributes to template args
+		$this->template_args['show_gravatar'] = $attributes['show_gravatar'];
+		// add required objects: event, datetime, and ticket
+		$this->template_args['event'] = $this->getEventAndQueryParams($attributes);
+		$this->template_args['datetime'] = $this->getDatetimeAndQueryParams($attributes);
+		$this->template_args['ticket'] = $this->getTicketAndQueryParams($attributes);
+
+		// if any of the above objects is invalid or missing,
+		// then there was an invalid parameter or the shortcode was used incorrectly
+		// so when WP_DEBUG is set and true, we'll show a message,
+		// otherwise we'll just return an empty string.
+		 if (
+			! $this->template_args['event'] instanceof EE_Event
+			|| empty($this->query_params[0])
+			|| ($attributes['datetime_id'] && ! $this->template_args['datetime'] instanceof EE_Datetime)
+			|| ($attributes['ticket_id'] && ! $this->template_args['ticket'] instanceof EE_Ticket)
+		) {
+			if (WP_DEBUG) {
+				return '<div class="important-notice ee-attention">'
+					   . esc_html__('The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
+						'event_espresso')
+					   . '</div>';
+			} else {
+				return '';
+			}
+		}
+		$this->setAdditionalQueryParams($attributes);
+		//get contacts!
+		$this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
+		//all set let's load up the template and return.
+		return EEH_Template::locate_template('loop-espresso_event_attendees.php', $this->template_args, true, true);
+	}
+
+
+
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array) apply_filters(
+				'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
+				array(
+					'event_id'      => null,
+					'datetime_id'   => null,
+					'ticket_id'     => null,
+					'status'        => EEM_Registration::status_id_approved,
+					'show_gravatar' => false
+				)
+			),
+			$attributes
+		);
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
+	private function getEventAndQueryParams(array $attributes){
+		if ( ! empty($attributes['event_id'])) {
+			$event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
+			if ($event instanceof EE_Event) {
+				$this->query_params[0]['Registration.EVT_ID'] = $attributes['event_id'];
+				return $event;
+			}
+		}
+		//seems like is_espresso_event_single() isn't working as expected. So using alternate method.
+		if ( is_espresso_event()) {
+			$event = EEH_Event_View::get_event();
+			if ($event instanceof EE_Event) {
+				$this->query_params[0]['Registration.EVT_ID'] = $event->ID();
+				return $event;
+			}
+		}
+		// one last shot...
+		// try getting the earliest active event
+		$events = EEM_Event::instance()->get_active_events(array(
+			'limit'    => 1,
+			'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+		));
+		//  if none then get the next upcoming
+		$events = empty($events)
+			? EEM_Event::instance()->get_upcoming_events(array(
+				'limit'    => 1,
+				'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+			))
+			: $events;
+		$event = reset($events);
+		if ($event instanceof EE_Event) {
+			$this->query_params[0]['Registration.EVT_ID'] = $event->ID();
+			return $event;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return EE_Datetime|null
+	 */
+	private function getDatetimeAndQueryParams(array $attributes)
+	{
+		if ( ! empty($attributes['datetime_id'])) {
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
+			if ($datetime instanceof EE_Datetime) {
+				$this->query_params[0]['Registration.Ticket.Datetime.DTT_ID'] = $attributes['datetime_id'];
+				$this->query_params['default_where_conditions'] = 'this_model_only';
+				if ( ! $this->template_args['event'] instanceof EE_Event) {
+					$this->template_args['event'] = $datetime->event();
+				}
+				return $datetime;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return \EE_Base_Class|null
+	 * @throws \EE_Error
+	 */
+	private function getTicketAndQueryParams(array $attributes)
+	{
+		if ( ! empty($attributes['ticket_id']) && empty($attributes['event_id']) && empty($attributes['datetime_id'])) {
+			$ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
+			if ($ticket instanceof EE_Ticket) {
+				$this->query_params[0]['Registration.TKT_ID'] = $attributes['ticket_id'];
+				if ( ! $this->template_args['event'] instanceof EE_Event) {
+					$this->template_args['event'] = $ticket->first_datetime() instanceof EE_Datetime
+						? $ticket->first_datetime()->event()
+						: null;
+				}
+				return $ticket;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 */
+	private function setAdditionalQueryParams(array $attributes)
+	{
+		$reg_status_array = EEM_Registration::reg_status_array();
+		if ($attributes['status'] !== 'all' && isset($reg_status_array[$attributes['status']])) {
+			$this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
+		}
+		$this->query_params['group_by'] = array('ATT_ID');
+		$this->query_params['order_by'] = (array) apply_filters(
+			'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
+			array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
+		);
+	}
 
 
 

Spacing +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
     public function processShortcode($attributes = array())
     {
         // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array)$attributes);
+        $attributes = $this->getAttributes((array) $attributes);
         // add attributes to template args
         $this->template_args['show_gravatar'] = $attributes['show_gravatar'];
         // add required objects: event, datetime, and ticket
@@ -167,7 +167,7 @@ 
      * @return EE_Event|null
      * @throws \EE_Error
      */
-    private function getEventAndQueryParams(array $attributes){
+    private function getEventAndQueryParams(array $attributes) {
         if ( ! empty($attributes['event_id'])) {
             $event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
             if ($event instanceof EE_Event) {
@@ -176,7 +176,7 @@ 
             }
         }
         //seems like is_espresso_event_single() isn't working as expected. So using alternate method.
-        if ( is_espresso_event()) {
+        if (is_espresso_event()) {
             $event = EEH_Event_View::get_event();
             if ($event instanceof EE_Event) {
                 $this->query_params[0]['Registration.EVT_ID'] = $event->ID();

public/template_tags.php

Indentation +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	function espresso_ticket_selector( $event = NULL ) {
 		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
 			espresso_load_ticket_selector();
-            \EED_Ticket_Selector::set_definitions();
+			\EED_Ticket_Selector::set_definitions();
 			echo EED_Ticket_Selector::display_ticket_selector( $event );
 		}
 	}

Spacing +276 added lines, -276 removed lines

@@ -14,12 +14,12 @@ 
  * @param int | \EE_Event $event
  * @return bool
  */
-function is_espresso_event( $event = NULL ) {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+function is_espresso_event($event = NULL) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		// extract EE_Event object from passed param regardless of what it is (within reason of course)
-		$event = EEH_Event_View::get_event( $event );
+		$event = EEH_Event_View::get_event($event);
 		// do we have a valid event ?
-		return $event instanceof EE_Event  ? TRUE : FALSE;
+		return $event instanceof EE_Event ? TRUE : FALSE;
 	}
 	return FALSE;
 }
@@ -31,7 +31,7 @@ 
  * @return bool
  */
 function is_espresso_event_single() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		// return conditionals set by CPTs
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_single : FALSE;
@@ -46,7 +46,7 @@ 
  * @return bool
  */
 function is_espresso_event_archive() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_archive : FALSE;
 	}
@@ -60,7 +60,7 @@ 
  * @return bool
  */
 function is_espresso_event_taxonomy() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_taxonomy : FALSE;
 	}
@@ -74,10 +74,10 @@ 
  * @param int | \EE_Venue $venue
  * @return bool
  */
-function is_espresso_venue( $venue = NULL ) {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+function is_espresso_venue($venue = NULL) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		// extract EE_Venue object from passed param regardless of what it is (within reason of course)
-		$venue = EEH_Venue_View::get_venue( $venue, FALSE );
+		$venue = EEH_Venue_View::get_venue($venue, FALSE);
 		// do we have a valid event ?
 		return $venue instanceof EE_Venue ? TRUE : FALSE;
 	}
@@ -91,7 +91,7 @@ 
  * @return bool
  */
 function is_espresso_venue_single() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_single : FALSE;
 	}
@@ -105,7 +105,7 @@ 
  * @return bool
  */
 function is_espresso_venue_archive() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_archive : FALSE;
 	}
@@ -119,7 +119,7 @@ 
  * @return bool
  */
 function is_espresso_venue_taxonomy() {
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
 		global $wp_query;
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_taxonomy : FALSE;
 	}
@@ -133,12 +133,12 @@ 
  * @param $conditional_tag
  * @return bool
  */
-function can_use_espresso_conditionals( $conditional_tag ) {
-	if ( ! did_action( 'AHEE__EE_System__initialize' )) {
+function can_use_espresso_conditionals($conditional_tag) {
+	if ( ! did_action('AHEE__EE_System__initialize')) {
 		EE_Error::doing_it_wrong(
 			__FUNCTION__,
 			sprintf(
-				__( 'The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.','event_espresso'),
+				__('The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.', 'event_espresso'),
 				$conditional_tag
 			),
 			'4.4.0'
@@ -153,13 +153,13 @@ 
 
 /*************************** Event Queries ***************************/
 
-if ( ! function_exists( 'espresso_get_events' )) {
+if ( ! function_exists('espresso_get_events')) {
 	/**
 	 * 	espresso_get_events
 	 * @param array $params
 	 * @return array
 	 */
-	function espresso_get_events( $params = array() ) {
+	function espresso_get_events($params = array()) {
 		//set default params
 		$default_espresso_events_params = array(
 			'limit' => 10,
@@ -170,18 +170,18 @@ 
 			'sort' => 'ASC'
 		);
 		// allow the defaults to be filtered
-		$default_espresso_events_params = apply_filters( 'espresso_get_events__default_espresso_events_params', $default_espresso_events_params );
+		$default_espresso_events_params = apply_filters('espresso_get_events__default_espresso_events_params', $default_espresso_events_params);
 		// grab params and merge with defaults, then extract
-		$params = array_merge( $default_espresso_events_params, $params );
+		$params = array_merge($default_espresso_events_params, $params);
 		// run the query
-		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery( $params );
+		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery($params);
 		// assign results to a variable so we can return it
 		$events = $events_query->have_posts() ? $events_query->posts : array();
 		// but first reset the query and postdata
 		wp_reset_query();
 		wp_reset_postdata();
 		EED_Events_Archive::remove_all_events_archive_filters();
-		unset( $events_query );
+		unset($events_query);
 		return $events;
 	}
 }
@@ -195,33 +195,33 @@ 
  * espresso_load_ticket_selector
  */
 function espresso_load_ticket_selector() {
-	EE_Registry::instance()->load_file( EE_MODULES . 'ticket_selector', 'EED_Ticket_Selector', 'module' );
+	EE_Registry::instance()->load_file(EE_MODULES.'ticket_selector', 'EED_Ticket_Selector', 'module');
 }
 
-if ( ! function_exists( 'espresso_ticket_selector' )) {
+if ( ! function_exists('espresso_ticket_selector')) {
 	/**
 	 * espresso_ticket_selector
 	 * @param null $event
 	 */
-	function espresso_ticket_selector( $event = NULL ) {
-		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
+	function espresso_ticket_selector($event = NULL) {
+		if ( ! apply_filters('FHEE_disable_espresso_ticket_selector', FALSE)) {
 			espresso_load_ticket_selector();
             \EED_Ticket_Selector::set_definitions();
-			echo EED_Ticket_Selector::display_ticket_selector( $event );
+			echo EED_Ticket_Selector::display_ticket_selector($event);
 		}
 	}
 }
 
 
-	if ( ! function_exists( 'espresso_view_details_btn' )) {
+	if ( ! function_exists('espresso_view_details_btn')) {
 	/**
 	 * espresso_view_details_btn
 	 * @param null $event
 	 */
-	function espresso_view_details_btn( $event = NULL ) {
-		if (  ! apply_filters( 'FHEE_disable_espresso_view_details_btn', FALSE ) ) {
+	function espresso_view_details_btn($event = NULL) {
+		if ( ! apply_filters('FHEE_disable_espresso_view_details_btn', FALSE)) {
 			espresso_load_ticket_selector();
-			echo EED_Ticket_Selector::display_ticket_selector( $event, TRUE );
+			echo EED_Ticket_Selector::display_ticket_selector($event, TRUE);
 		}
 	}
 }
@@ -231,7 +231,7 @@ 
 
 /*************************** EEH_Event_View ***************************/
 
-if ( ! function_exists( 'espresso_load_event_list_assets' )) {
+if ( ! function_exists('espresso_load_event_list_assets')) {
 	/**
 	 * espresso_load_event_list_assets
 	 * ensures that event list styles and scripts are loaded
@@ -240,13 +240,13 @@ 
 	 */
 	function espresso_load_event_list_assets() {
 		$event_list = EED_Events_Archive::instance();
-		add_action( 'AHEE__EE_System__initialize_last', array( $event_list, 'load_event_list_assets' ), 10 );
-		add_filter( 'FHEE_enable_default_espresso_css', '__return_true' );
+		add_action('AHEE__EE_System__initialize_last', array($event_list, 'load_event_list_assets'), 10);
+		add_filter('FHEE_enable_default_espresso_css', '__return_true');
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_reg_button' )) {
+if ( ! function_exists('espresso_event_reg_button')) {
 	/**
 	 * espresso_event_reg_button
 	 * returns the "Register Now" button if event is active,
@@ -258,9 +258,9 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_reg_button( $btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE ) {
-		$event_status = EEH_Event_View::event_active_status( $EVT_ID );
-		switch ( $event_status ) {
+	function espresso_event_reg_button($btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE) {
+		$event_status = EEH_Event_View::event_active_status($EVT_ID);
+		switch ($event_status) {
 			case EE_Datetime::sold_out :
 				$btn_text = __('Sold Out', 'event_espresso');
 				$class = 'ee-pink';
@@ -276,10 +276,10 @@ 
 			case EE_Datetime::upcoming :
 			case EE_Datetime::active :
 			default :
-				$btn_text =! empty( $btn_text_if_active ) ? $btn_text_if_active : __( 'Register Now', 'event_espresso' );
+				$btn_text = ! empty($btn_text_if_active) ? $btn_text_if_active : __('Register Now', 'event_espresso');
 				$class = 'ee-green';
 		}
-		if ( $event_status < 1 && ! empty( $btn_text_if_inactive )) {
+		if ($event_status < 1 && ! empty($btn_text_if_inactive)) {
 			$btn_text = $btn_text_if_inactive;
 			$class = 'ee-grey';
 		}
@@ -293,7 +293,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_display_ticket_selector' )) {
+if ( ! function_exists('espresso_display_ticket_selector')) {
 	/**
 	 * espresso_display_ticket_selector
 	 * whether or not to display the Ticket Selector for an event
@@ -301,14 +301,14 @@ 
 	 * @param bool $EVT_ID
 	 * @return boolean
 	 */
-	function espresso_display_ticket_selector( $EVT_ID = FALSE ) {
-		return EEH_Event_View::display_ticket_selector( $EVT_ID );
+	function espresso_display_ticket_selector($EVT_ID = FALSE) {
+		return EEH_Event_View::display_ticket_selector($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_status_banner' )) {
+if ( ! function_exists('espresso_event_status_banner')) {
 	/**
 	 * espresso_event_status
 	 * returns a banner showing the event status if it is sold out, expired, or inactive
@@ -316,13 +316,13 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_status_banner( $EVT_ID = FALSE ) {
-		return EEH_Event_View::event_status( $EVT_ID );
+	function espresso_event_status_banner($EVT_ID = FALSE) {
+		return EEH_Event_View::event_status($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_status' )) {
+if ( ! function_exists('espresso_event_status')) {
 	/**
 	 * espresso_event_status
 	 * returns the event status if it is sold out, expired, or inactive
@@ -331,17 +331,17 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_status( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_active_status( $EVT_ID );
+	function espresso_event_status($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_active_status($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::event_active_status( $EVT_ID );
+		return EEH_Event_View::event_active_status($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_categories' )) {
+if ( ! function_exists('espresso_event_categories')) {
 	/**
 	 * espresso_event_categories
 	 * returns the terms associated with an event
@@ -351,17 +351,17 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
+	function espresso_event_categories($EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
 			return '';
 		}
-		return EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
+		return EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_tickets_available' )) {
+if ( ! function_exists('espresso_event_tickets_available')) {
 	/**
 	 * espresso_event_tickets_available
 	 * returns the ticket types available for purchase for an event
@@ -371,26 +371,26 @@ 
 	 * @param bool $format
 	 * @return string
 	 */
-	function espresso_event_tickets_available( $EVT_ID = 0, $echo = TRUE, $format = TRUE ) {
-		$tickets = EEH_Event_View::event_tickets_available( $EVT_ID );
-		if ( is_array( $tickets ) && ! empty( $tickets )) {
+	function espresso_event_tickets_available($EVT_ID = 0, $echo = TRUE, $format = TRUE) {
+		$tickets = EEH_Event_View::event_tickets_available($EVT_ID);
+		if (is_array($tickets) && ! empty($tickets)) {
 			// if formatting then $html will be a string, else it will be an array of ticket objects
-			$html = $format ? '<ul id="ee-event-tickets-ul-' . $EVT_ID . '" class="ee-event-tickets-ul">' : array();
-			foreach ( $tickets as $ticket ) {
-				if ( $ticket instanceof EE_Ticket ) {
-					if ( $format ) {
-						$html .= '<li id="ee-event-tickets-li-' . $ticket->ID() . '" class="ee-event-tickets-li">';
-						$html .= $ticket->name() . ' ' . EEH_Template::format_currency( $ticket->get_ticket_total_with_taxes() );
+			$html = $format ? '<ul id="ee-event-tickets-ul-'.$EVT_ID.'" class="ee-event-tickets-ul">' : array();
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
+					if ($format) {
+						$html .= '<li id="ee-event-tickets-li-'.$ticket->ID().'" class="ee-event-tickets-li">';
+						$html .= $ticket->name().' '.EEH_Template::format_currency($ticket->get_ticket_total_with_taxes());
 						$html .= '</li>';
 					} else {
 						$html[] = $ticket;
 					}
 				}
 			}
-			if ( $format ) {
+			if ($format) {
 				$html .= '</ul>';
 			}
-			if ( $echo && ! $format ) {
+			if ($echo && ! $format) {
 				echo $html;
 				return '';
 			}
@@ -400,7 +400,7 @@ 
 	}
 }
 
-if ( ! function_exists( 'espresso_event_date_obj' )) {
+if ( ! function_exists('espresso_event_date_obj')) {
 	/**
 	 * espresso_event_date_obj
 	 * returns the primary date object for an event
@@ -408,13 +408,13 @@ 
 	 * @param bool $EVT_ID
 	 * @return object
 	 */
-	function espresso_event_date_obj( $EVT_ID = FALSE ) {
-		return EEH_Event_View::get_primary_date_obj( $EVT_ID );
+	function espresso_event_date_obj($EVT_ID = FALSE) {
+		return EEH_Event_View::get_primary_date_obj($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_event_date' )) {
+if ( ! function_exists('espresso_event_date')) {
 	/**
 	 * espresso_event_date
 	 * returns the primary date for an event
@@ -425,22 +425,22 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_date__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_event_date__time_format', $time_format );
-		if($echo){
-			echo EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
+	function espresso_event_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_event_date__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_event_date__time_format', $time_format);
+		if ($echo) {
+			echo EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
+		return EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
 
 	}
 }
 
 
-if ( ! function_exists( 'espresso_list_of_event_dates' )) {
+if ( ! function_exists('espresso_list_of_event_dates')) {
 	/**
 	 * espresso_list_of_event_dates
 	 * returns a unordered list of dates for an event
@@ -455,40 +455,40 @@ 
 	 * @param null   $limit
 	 * @return string
 	 */
-	function espresso_list_of_event_dates( $EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_list_of_event_dates__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_list_of_event_dates__time_format', $time_format );
-		$datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, $show_expired, FALSE, $limit );
-		if ( ! $format ) {
-			return apply_filters( 'FHEE__espresso_list_of_event_dates__datetimes', $datetimes );
+	function espresso_list_of_event_dates($EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_list_of_event_dates__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_list_of_event_dates__time_format', $time_format);
+		$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, $show_expired, FALSE, $limit);
+		if ( ! $format) {
+			return apply_filters('FHEE__espresso_list_of_event_dates__datetimes', $datetimes);
 		}
 		//d( $datetimes );
-		if ( is_array( $datetimes ) && ! empty( $datetimes )) {
+		if (is_array($datetimes) && ! empty($datetimes)) {
 			global $post;
-			$html = $format ? '<ul id="ee-event-datetimes-ul-' . $post->ID . '" class="ee-event-datetimes-ul ee-clearfix">' : '';
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$html .= '<li id="ee-event-datetimes-li-' . $datetime->ID();
-					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-' . $datetime->get_active_status() . '">';
+			$html = $format ? '<ul id="ee-event-datetimes-ul-'.$post->ID.'" class="ee-event-datetimes-ul ee-clearfix">' : '';
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$html .= '<li id="ee-event-datetimes-li-'.$datetime->ID();
+					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-'.$datetime->get_active_status().'">';
 					$datetime_name = $datetime->name();
-					$html .= ! empty( $datetime_name ) ? '<strong>' . $datetime_name . '</strong>' : '';
-					$html .= ! empty( $datetime_name )  && $add_breaks ? '<br />' : '';
-					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">' . $datetime->date_range( $date_format ) . '</span><br/>';
-					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">' . $datetime->time_range( $time_format ) . '</span>';
+					$html .= ! empty($datetime_name) ? '<strong>'.$datetime_name.'</strong>' : '';
+					$html .= ! empty($datetime_name) && $add_breaks ? '<br />' : '';
+					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">'.$datetime->date_range($date_format).'</span><br/>';
+					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">'.$datetime->time_range($time_format).'</span>';
 					$datetime_description = $datetime->description();
-					$html .= ! empty( $datetime_description )  && $add_breaks ? '<br />' : '';
-					$html .= ! empty( $datetime_description ) ? ' - ' . $datetime_description : '';
-					$html = apply_filters( 'FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime );
+					$html .= ! empty($datetime_description) && $add_breaks ? '<br />' : '';
+					$html .= ! empty($datetime_description) ? ' - '.$datetime_description : '';
+					$html = apply_filters('FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime);
 					$html .= '</li>';
 				}
 			}
 			$html .= $format ? '</ul>' : '';
 		} else {
-			$html = $format ?  '<p><span class="dashicons dashicons-marker pink-text"></span>' . __( 'There are no upcoming dates for this event.', 'event_espresso' ) . '</p><br/>' : '';
+			$html = $format ? '<p><span class="dashicons dashicons-marker pink-text"></span>'.__('There are no upcoming dates for this event.', 'event_espresso').'</p><br/>' : '';
 		}
-		if ( $echo ) {
+		if ($echo) {
 			echo $html;
 			return '';
 		}
@@ -497,7 +497,7 @@ 
 }
 
 
-if ( ! function_exists( 'espresso_event_end_date' )) {
+if ( ! function_exists('espresso_event_end_date')) {
 	/**
 	 * espresso_event_end_date
 	 * returns the last date for an event
@@ -508,20 +508,20 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_event_end_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_end_date__date_format', $date_format );
-		$time_format = apply_filters( 'FHEE__espresso_event_end_date__time_format', $time_format );
-		if($echo){
-			echo EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
+	function espresso_event_end_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+		$date_format = apply_filters('FHEE__espresso_event_end_date__date_format', $date_format);
+		$time_format = apply_filters('FHEE__espresso_event_end_date__time_format', $time_format);
+		if ($echo) {
+			echo EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
+		return EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
 	}
 }
 
-if ( ! function_exists( 'espresso_event_date_range' )) {
+if ( ! function_exists('espresso_event_date_range')) {
 	/**
 	 * espresso_event_date_range
 	 * returns the first and last chronologically ordered dates for an event (if different)
@@ -534,31 +534,31 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_event_date_range( $date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
+	function espresso_event_date_range($date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
 		// set and filter date and time formats when a range is returned
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
-		$date_format = apply_filters( 'FHEE__espresso_event_date_range__date_format', $date_format );
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
+		$date_format = apply_filters('FHEE__espresso_event_date_range__date_format', $date_format);
 		// get the start and end date with NO time portion
-		$the_event_date = EEH_Event_View::the_earliest_event_date( $date_format, '', $EVT_ID );
-		$the_event_end_date = EEH_Event_View::the_latest_event_date( $date_format, '', $EVT_ID );
+		$the_event_date = EEH_Event_View::the_earliest_event_date($date_format, '', $EVT_ID);
+		$the_event_end_date = EEH_Event_View::the_latest_event_date($date_format, '', $EVT_ID);
 		// now we can determine if date range spans more than one day
-		if ( $the_event_date != $the_event_end_date ) {
-			$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
-			$time_format = apply_filters( 'FHEE__espresso_event_date_range__time_format', $time_format );
+		if ($the_event_date != $the_event_end_date) {
+			$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
+			$time_format = apply_filters('FHEE__espresso_event_date_range__time_format', $time_format);
 			$html = sprintf(
-				__( '%1$s - %2$s', 'event_espresso' ),
-				EEH_Event_View::the_earliest_event_date( $date_format, $time_format, $EVT_ID ),
-				EEH_Event_View::the_latest_event_date( $date_format, $time_format, $EVT_ID )
+				__('%1$s - %2$s', 'event_espresso'),
+				EEH_Event_View::the_earliest_event_date($date_format, $time_format, $EVT_ID),
+				EEH_Event_View::the_latest_event_date($date_format, $time_format, $EVT_ID)
 			);
 		} else {
 			// set and filter date and time formats when only a single datetime is returned
-			$single_date_format = ! empty( $single_date_format ) ? $single_date_format : get_option( 'date_format' );
-			$single_time_format = ! empty( $single_time_format ) ? $single_time_format : get_option( 'time_format' );
-			$single_date_format = apply_filters( 'FHEE__espresso_event_date_range__single_date_format', $single_date_format );
-			$single_time_format = apply_filters( 'FHEE__espresso_event_date_range__single_time_format', $single_time_format );
-			$html = EEH_Event_View::the_earliest_event_date( $single_date_format, $single_time_format, $EVT_ID );
+			$single_date_format = ! empty($single_date_format) ? $single_date_format : get_option('date_format');
+			$single_time_format = ! empty($single_time_format) ? $single_time_format : get_option('time_format');
+			$single_date_format = apply_filters('FHEE__espresso_event_date_range__single_date_format', $single_date_format);
+			$single_time_format = apply_filters('FHEE__espresso_event_date_range__single_time_format', $single_time_format);
+			$html = EEH_Event_View::the_earliest_event_date($single_date_format, $single_time_format, $EVT_ID);
 		}
-		if ( $echo ) {
+		if ($echo) {
 			echo $html;
 			return '';
 		}
@@ -567,7 +567,7 @@ 
 }
 
 
-if ( ! function_exists( 'espresso_event_date_as_calendar_page' )) {
+if ( ! function_exists('espresso_event_date_as_calendar_page')) {
 	/**
 	 * espresso_event_date_as_calendar_page
 	 * returns the primary date for an event, stylized to appear as the page of a calendar
@@ -575,15 +575,15 @@ 
 	 * @param bool $EVT_ID
 	 * @return string
 	 */
-	function espresso_event_date_as_calendar_page( $EVT_ID = FALSE ) {
-		EEH_Event_View::event_date_as_calendar_page( $EVT_ID );
+	function espresso_event_date_as_calendar_page($EVT_ID = FALSE) {
+		EEH_Event_View::event_date_as_calendar_page($EVT_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_event_link_url' )) {
+if ( ! function_exists('espresso_event_link_url')) {
 	/**
 	 * espresso_event_link_url
 	 *
@@ -591,18 +591,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_link_url( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_link_url( $EVT_ID );
+	function espresso_event_link_url($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_link_url($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::event_link_url( $EVT_ID );
+		return EEH_Event_View::event_link_url($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_has_content_or_excerpt' )) {
+if ( ! function_exists('espresso_event_has_content_or_excerpt')) {
 	/**
 	 *    espresso_event_has_content_or_excerpt
 	 *
@@ -610,15 +610,15 @@ 
 	 * @param bool $EVT_ID
 	 * @return    boolean
 	 */
-	function espresso_event_has_content_or_excerpt( $EVT_ID = FALSE ) {
-		return EEH_Event_View::event_has_content_or_excerpt( $EVT_ID );
+	function espresso_event_has_content_or_excerpt($EVT_ID = FALSE) {
+		return EEH_Event_View::event_has_content_or_excerpt($EVT_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_event_content_or_excerpt' )) {
+if ( ! function_exists('espresso_event_content_or_excerpt')) {
 	/**
 	 * espresso_event_content_or_excerpt
 	 *
@@ -627,18 +627,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_content_or_excerpt( $num_words = 55, $more = NULL, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_content_or_excerpt( $num_words, $more );
+	function espresso_event_content_or_excerpt($num_words = 55, $more = NULL, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_content_or_excerpt($num_words, $more);
 			return '';
 		}
-		return EEH_Event_View::event_content_or_excerpt( $num_words, $more );
+		return EEH_Event_View::event_content_or_excerpt($num_words, $more);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_event_phone' )) {
+if ( ! function_exists('espresso_event_phone')) {
 	/**
 	 * espresso_event_phone
 	 *
@@ -646,18 +646,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_event_phone( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::event_phone( $EVT_ID );
+	function espresso_event_phone($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::event_phone($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::event_phone( $EVT_ID );
+		return EEH_Event_View::event_phone($EVT_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_edit_event_link' )) {
+if ( ! function_exists('espresso_edit_event_link')) {
 	/**
 	 * espresso_edit_event_link
 	 * returns a link to edit an event
@@ -666,39 +666,39 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_edit_event_link( $EVT_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Event_View::edit_event_link( $EVT_ID );
+	function espresso_edit_event_link($EVT_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Event_View::edit_event_link($EVT_ID);
 			return '';
 		}
-		return EEH_Event_View::edit_event_link( $EVT_ID );
+		return EEH_Event_View::edit_event_link($EVT_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_organization_name' )) {
+if ( ! function_exists('espresso_organization_name')) {
 	/**
 	 * espresso_organization_name
 	 * @param bool $echo
 	 * @return string
 	 */
 	function espresso_organization_name($echo = TRUE) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('name');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('name');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_address' )) {
+if ( ! function_exists('espresso_organization_address')) {
 	/**
 	 * espresso_organization_address
 	 * @param string $type
 	 * @return string
 	 */
-	function espresso_organization_address( $type = 'inline' ) {
-		if ( EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config ) {
+	function espresso_organization_address($type = 'inline') {
+		if (EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config) {
 			$address = new EventEspresso\core\domain\entities\GenericAddress(
 				EE_Registry::instance()->CFG->organization->address_1,
 				EE_Registry::instance()->CFG->organization->address_2,
@@ -707,129 +707,129 @@ 
 				EE_Registry::instance()->CFG->organization->zip,
 				EE_Registry::instance()->CFG->organization->CNT_ISO
 			);
-			return EEH_Address::format( $address, $type );
+			return EEH_Address::format($address, $type);
 		}
 		return '';
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_email' )) {
+if ( ! function_exists('espresso_organization_email')) {
 	/**
 	 * espresso_organization_email
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_email( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
+	function espresso_organization_email($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('email');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('email');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_logo_url' )) {
+if ( ! function_exists('espresso_organization_logo_url')) {
 	/**
 	 * espresso_organization_logo_url
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_logo_url( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
+	function espresso_organization_logo_url($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_facebook' )) {
+if ( ! function_exists('espresso_organization_facebook')) {
 	/**
 	 * espresso_organization_facebook
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_facebook( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
+	function espresso_organization_facebook($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('facebook');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('facebook');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_twitter' )) {
+if ( ! function_exists('espresso_organization_twitter')) {
 	/**
 	 * espresso_organization_twitter
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_twitter( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
+	function espresso_organization_twitter($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('twitter');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('twitter');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_linkedin' )) {
+if ( ! function_exists('espresso_organization_linkedin')) {
 	/**
 	 * espresso_organization_linkedin
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_linkedin( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
+	function espresso_organization_linkedin($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_pinterest' )) {
+if ( ! function_exists('espresso_organization_pinterest')) {
 	/**
 	 * espresso_organization_pinterest
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_pinterest( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
+	function espresso_organization_pinterest($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_google' )) {
+if ( ! function_exists('espresso_organization_google')) {
 	/**
 	 * espresso_organization_google
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_google( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
+	function espresso_organization_google($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('google');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('google');
 	}
 }
 
-if ( ! function_exists( 'espresso_organization_instagram' )) {
+if ( ! function_exists('espresso_organization_instagram')) {
 	/**
 	 * espresso_organization_instagram
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_organization_instagram( $echo = TRUE ) {
-		if($echo){
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
+	function espresso_organization_instagram($echo = TRUE) {
+		if ($echo) {
+			echo EE_Registry::instance()->CFG->organization->get_pretty('instagram');
 			return '';
 		}
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
+		return EE_Registry::instance()->CFG->organization->get_pretty('instagram');
 	}
 }
 
@@ -839,7 +839,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_event_venues' )) {
+if ( ! function_exists('espresso_event_venues')) {
 	/**
 	 * espresso_event_venues
 	 *
@@ -853,7 +853,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_venue_id' )) {
+if ( ! function_exists('espresso_venue_id')) {
 	/**
 	 *    espresso_venue_name
 	 *
@@ -861,15 +861,15 @@ 
 	 * @param     int $EVT_ID
 	 * @return    string
 	 */
-	function espresso_venue_id( $EVT_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $EVT_ID );
+	function espresso_venue_id($EVT_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($EVT_ID);
 		return $venue instanceof EE_Venue ? $venue->ID() : 0;
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_is_venue_private' ) ) {
+if ( ! function_exists('espresso_is_venue_private')) {
 	/**
 	 * Return whether a venue is private or not.
 	 * @see EEH_Venue_View::get_venue() for more info on expected return results.
@@ -878,45 +878,45 @@ 
 	 *
 	 * @return bool | null
 	 */
-	function espresso_is_venue_private( $VNU_ID = 0 ) {
-		return EEH_Venue_View::is_venue_private( $VNU_ID );
+	function espresso_is_venue_private($VNU_ID = 0) {
+		return EEH_Venue_View::is_venue_private($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_is_password_protected' ) ) {
+if ( ! function_exists('espresso_venue_is_password_protected')) {
 	/**
 	 * returns true or false if a venue is password protected or not
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 * @return string
 	 */
-	function espresso_venue_is_password_protected( $VNU_ID = 0 ) {
-		EE_Registry::instance()->load_helper( 'Venue_View' );
-		return EEH_Venue_View::is_venue_password_protected( $VNU_ID );
+	function espresso_venue_is_password_protected($VNU_ID = 0) {
+		EE_Registry::instance()->load_helper('Venue_View');
+		return EEH_Venue_View::is_venue_password_protected($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_password_protected_venue_form' ) ) {
+if ( ! function_exists('espresso_password_protected_venue_form')) {
 	/**
 	 * Returns a password form if venue is password protected.
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 * @return string
 	 */
-	function espresso_password_protected_venue_form( $VNU_ID = 0 ) {
-		EE_Registry::instance()->load_helper( 'Venue_View' );
-		return EEH_Venue_View::password_protected_venue_form( $VNU_ID );
+	function espresso_password_protected_venue_form($VNU_ID = 0) {
+		EE_Registry::instance()->load_helper('Venue_View');
+		return EEH_Venue_View::password_protected_venue_form($VNU_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_venue_name' )) {
+if ( ! function_exists('espresso_venue_name')) {
 	/**
 	 *    espresso_venue_name
 	 *
@@ -926,19 +926,19 @@ 
 	 * @param bool   $echo
 	 * @return    string
 	 */
-	function espresso_venue_name( $VNU_ID = 0, $link_to = 'details', $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::venue_name( $link_to, $VNU_ID );
+	function espresso_venue_name($VNU_ID = 0, $link_to = 'details', $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_name($link_to, $VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_name( $link_to, $VNU_ID );
+		return EEH_Venue_View::venue_name($link_to, $VNU_ID);
 	}
 }
 
 
 
 
-if ( ! function_exists( 'espresso_venue_link' )) {
+if ( ! function_exists('espresso_venue_link')) {
 	/**
 	 * 	espresso_venue_link
 	 *
@@ -947,14 +947,14 @@ 
 	 *  @param 	string 	$text
 	 *  @return 	string
 	 */
-	function espresso_venue_link( $VNU_ID = 0, $text = '' ) {
-		return EEH_Venue_View::venue_details_link( $VNU_ID, $text );
+	function espresso_venue_link($VNU_ID = 0, $text = '') {
+		return EEH_Venue_View::venue_details_link($VNU_ID, $text);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_description' )) {
+if ( ! function_exists('espresso_venue_description')) {
 	/**
 	 *    espresso_venue_description
 	 *
@@ -963,17 +963,17 @@ 
 	 * @param bool $echo
 	 * @return    string
 	 */
-	function espresso_venue_description( $VNU_ID = FALSE, $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::venue_description( $VNU_ID );
+	function espresso_venue_description($VNU_ID = FALSE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_description($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_description( $VNU_ID );
+		return EEH_Venue_View::venue_description($VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_excerpt' )) {
+if ( ! function_exists('espresso_venue_excerpt')) {
 	/**
 	 *    espresso_venue_excerpt
 	 *
@@ -982,18 +982,18 @@ 
 	 * @param bool $echo
 	 * @return    string
 	 */
-	function espresso_venue_excerpt( $VNU_ID = 0,  $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_excerpt( $VNU_ID );
+	function espresso_venue_excerpt($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_excerpt($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_excerpt( $VNU_ID );
+		return EEH_Venue_View::venue_excerpt($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_categories' )) {
+if ( ! function_exists('espresso_venue_categories')) {
 	/**
 	 * espresso_venue_categories
 	 * returns the terms associated with a venue
@@ -1003,17 +1003,17 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_categories( $VNU_ID = 0, $hide_uncategorized = TRUE,  $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
+	function espresso_venue_categories($VNU_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
 			return '';
 		}
-		return EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
+		return EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_address' )) {
+if ( ! function_exists('espresso_venue_address')) {
 	/**
 	 * espresso_venue_address
 	 * returns a formatted block of html  for displaying a venue's address
@@ -1023,17 +1023,17 @@ 
 	 * @param bool   $echo
 	 * @return string
 	 */
-	function espresso_venue_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID );
+	function espresso_venue_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_address($type, $VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_address( $type, $VNU_ID );
+		return EEH_Venue_View::venue_address($type, $VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_raw_address' )) {
+if ( ! function_exists('espresso_venue_raw_address')) {
 	/**
 	 * espresso_venue_address
 	 * returns an UN-formatted string containing a venue's address
@@ -1043,17 +1043,17 @@ 
 	 * @param bool     $echo
 	 * @return string
 	 */
-	function espresso_venue_raw_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
+	function espresso_venue_raw_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
 			return '';
 		}
-		return EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
+		return EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_has_address' )) {
+if ( ! function_exists('espresso_venue_has_address')) {
 	/**
 	 * espresso_venue_has_address
 	 * returns TRUE or FALSE if a Venue has address information
@@ -1061,13 +1061,13 @@ 
 	 * @param int $VNU_ID
 	 * @return bool
 	 */
-	function espresso_venue_has_address( $VNU_ID = 0 ) {
-		return EEH_Venue_View::venue_has_address( $VNU_ID );
+	function espresso_venue_has_address($VNU_ID = 0) {
+		return EEH_Venue_View::venue_has_address($VNU_ID);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_gmap' )) {
+if ( ! function_exists('espresso_venue_gmap')) {
 	/**
 	 * espresso_venue_gmap
 	 * returns a google map for the venue address
@@ -1078,17 +1078,17 @@ 
 	 * @param bool     $echo
 	 * @return string
 	 */
-	function espresso_venue_gmap( $VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE  ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
+	function espresso_venue_gmap($VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
 			return '';
 		}
-		return EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
+		return EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
 	}
 }
 
 
-if ( ! function_exists( 'espresso_venue_phone' )) {
+if ( ! function_exists('espresso_venue_phone')) {
 	/**
 	 * espresso_venue_phone
 	 *
@@ -1096,18 +1096,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_phone( $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_phone( $VNU_ID );
+	function espresso_venue_phone($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_phone($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_phone( $VNU_ID );
+		return EEH_Venue_View::venue_phone($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_venue_website' )) {
+if ( ! function_exists('espresso_venue_website')) {
 	/**
 	 * espresso_venue_website
 	 *
@@ -1115,18 +1115,18 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_venue_website( $VNU_ID = 0, $echo = TRUE ) {
-		if ( $echo ) {
-			echo EEH_Venue_View::venue_website_link( $VNU_ID );
+	function espresso_venue_website($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::venue_website_link($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::venue_website_link( $VNU_ID );
+		return EEH_Venue_View::venue_website_link($VNU_ID);
 	}
 }
 
 
 
-if ( ! function_exists( 'espresso_edit_venue_link' )) {
+if ( ! function_exists('espresso_edit_venue_link')) {
 	/**
 	 * espresso_edit_venue_link
 	 *
@@ -1134,12 +1134,12 @@ 
 	 * @param bool $echo
 	 * @return string
 	 */
-	function espresso_edit_venue_link( $VNU_ID = 0, $echo = TRUE ) {
-		if($echo){
-			echo EEH_Venue_View::edit_venue_link( $VNU_ID );
+	function espresso_edit_venue_link($VNU_ID = 0, $echo = TRUE) {
+		if ($echo) {
+			echo EEH_Venue_View::edit_venue_link($VNU_ID);
 			return '';
 		}
-		return EEH_Venue_View::edit_venue_link( $VNU_ID );
+		return EEH_Venue_View::edit_venue_link($VNU_ID);
 	}
 }
 

modules/ticket_selector/EED_Ticket_Selector.module.php

Indentation +266 added lines, -266 removed lines

@@ -22,15 +22,15 @@ 
  */
 class EED_Ticket_Selector extends  EED_Module {
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
-     */
-    private static $ticket_selector;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
+	 */
+	private static $ticket_selector;
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
-     */
-    private static $iframe_embed_button;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
+	 */
+	private static $iframe_embed_button;
 
 
 
@@ -61,13 +61,13 @@ 
 		// routing
 		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
 		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
-        EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
+		EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
+		add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
 		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
-        EED_Ticket_Selector::loadIframeAssets();
-    }
+		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
+		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
+		EED_Ticket_Selector::loadIframeAssets();
+	}
 
 
 
@@ -86,16 +86,16 @@ 
 			10
 		);
 
-        /**
-         * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
-         * registrations work.
-         */
+		/**
+		 * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
+		 * registrations work.
+		 */
 		add_action(
-		    'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
-            array('EED_Ticket_Selector', 'set_definitions'),
-            10
-        );
-    }
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
+			array('EED_Ticket_Selector', 'set_definitions'),
+			10
+		);
+	}
 
 
 
@@ -106,34 +106,34 @@ 
 	 *  @return 	void
 	 */
 	public static function set_definitions() {
-	    // don't do this twice
-	    if(defined('TICKET_SELECTOR_ASSETS_URL')) {
-	        return;
-        }
+		// don't do this twice
+		if(defined('TICKET_SELECTOR_ASSETS_URL')) {
+			return;
+		}
 		define( 'TICKET_SELECTOR_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
 		define(
-		    'TICKET_SELECTOR_TEMPLATES_PATH',
-            str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS
-        );
+			'TICKET_SELECTOR_TEMPLATES_PATH',
+			str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS
+		);
 		//if config is not set, initialize
 		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
-            \EED_Ticket_Selector::instance()->set_config();
-            \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
+			\EED_Ticket_Selector::instance()->set_config();
+			\EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
 	}
 
 
 
 	/**
-     * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
-     */
-    public static function ticketSelector()
-    {
-        if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
-        }
-        return EED_Ticket_Selector::$ticket_selector;
-    }
+	 * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
+	 */
+	public static function ticketSelector()
+	{
+		if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
+		}
+		return EED_Ticket_Selector::$ticket_selector;
+	}
 
 
 	/**
@@ -186,15 +186,15 @@ 
 
 
 
-    /**
-     *    creates buttons for selecting number of attendees for an event
-     *
-     * @access    public
-     * @param    WP_Post|int $event
-     * @param    bool        $view_details
-     * @return    string
-     * @throws \EE_Error
-     */
+	/**
+	 *    creates buttons for selecting number of attendees for an event
+	 *
+	 * @access    public
+	 * @param    WP_Post|int $event
+	 * @param    bool        $view_details
+	 * @return    string
+	 * @throws \EE_Error
+	 */
 	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
 		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
 	}
@@ -215,244 +215,244 @@ 
 
 
 
-    /**
-     * cancel_ticket_selections
-     *
-     * @access        public
-     * @return        string
-     */
-    public static function cancel_ticket_selections()
-    {
-        $form = new ProcessTicketSelector();
-        return $form->cancelTicketSelections();
-    }
+	/**
+	 * cancel_ticket_selections
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public static function cancel_ticket_selections()
+	{
+		$form = new ProcessTicketSelector();
+		return $form->cancelTicketSelections();
+	}
 
 
 
 	/**
-	* @return void
-	*/
+	 * @return void
+	 */
 	public static function translate_js_strings() {
-        EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
-            'please select a datetime', 'event_espresso'
-        );
-    }
+		EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
+			'please select a datetime', 'event_espresso'
+		);
+	}
 
 
 
 	/**
-	* 	load js
-	*
-	* 	@access 		public
-	* 	@return 		void
-	*/
+	 * 	load js
+	 *
+	 * 	@access 		public
+	 * 	@return 		void
+	 */
 	public static function load_tckt_slctr_assets() {
 		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
-            // add some style
-            wp_register_style(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('ticket_selector');
-            // make it dance
-            wp_register_script(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
-                array('espresso_core'),
-                EVENT_ESPRESSO_VERSION,
-                TRUE
-            );
+			// add some style
+			wp_register_style(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('ticket_selector');
+			// make it dance
+			wp_register_script(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
+				array('espresso_core'),
+				EVENT_ESPRESSO_VERSION,
+				TRUE
+			);
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
-            \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-        }
+			require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+			\EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function loadIframeAssets()
+	{
+		// for event lists
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+		// for ticket selectors
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+	}
+
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_css
+	 * @return array
+	 */
+	public static function iframeCss(array $iframe_css)
+	{
+		$iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+		return $iframe_css;
 	}
 
 
 
-    /**
-     * @return void
-     */
-    public static function loadIframeAssets()
-    {
-        // for event lists
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-        // for ticket selectors
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_css
-     * @return array
-     */
-    public static function iframeCss(array $iframe_css)
-    {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
-        return $iframe_css;
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_js
-     * @return array
-     */
-    public static function iframeJs(array $iframe_js)
-    {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
-        return $iframe_js;
-    }
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_js
+	 * @return array
+	 */
+	public static function iframeJs(array $iframe_js)
+	{
+		$iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+		return $iframe_js;
+	}
 
 
 	/****************************** DEPRECATED ******************************/
 
 
 
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_view_details_btn()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_ticket_selector_submit()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param string $permalink_string
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        if (
-        	\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-        	&& \EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param int    $ID
-     * @param string $external_url
-     * @return string
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function ticket_selector_form_close()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formClose();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.13
-     * @return string
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function clear_tkt_slctr()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     */
-    public static function load_tckt_slctr_assets_admin()
-    {
-        // todo add doing_it_wrong() notice during next major version
-	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
-	    ) {
-		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->embedButtonAssets();
-        }
-    }
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_view_details_btn()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_ticket_selector_submit()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return string
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function ticket_selector_form_close()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formClose();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.13
+	 * @return string
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function clear_tkt_slctr()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 */
+	public static function load_tckt_slctr_assets_admin()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->embedButtonAssets();
+		}
+	}
 
 
 }

Spacing +30 added lines, -30 removed lines

@@ -3,8 +3,8 @@ 
 use EventEspresso\modules\ticket_selector\TicketSelectorIframe;
 use EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,15 +38,15 @@ 
 	 * @return EED_Ticket_Selector
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
 
-	protected function set_config(){
-		$this->set_config_section( 'template_settings' );
-		$this->set_config_class( 'EE_Ticket_Selector_Config' );
-		$this->set_config_name( 'EED_Ticket_Selector' );
+	protected function set_config() {
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
 	}
 
 
@@ -59,13 +59,13 @@ 
 	 */
 	public static function set_hooks() {
 		// routing
-		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
-		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
+		EE_Config::register_route('iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector');
+		EE_Config::register_route('process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections');
         EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
-		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
+        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
+        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
+        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
         EED_Ticket_Selector::loadIframeAssets();
     }
 
@@ -82,7 +82,7 @@ 
 		// to load assets for "espresso_events" page on the "edit" route (action)
 		add_action(
 			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
-			array( 'EED_Ticket_Selector', 'ticket_selector_iframe_embed_button' ),
+			array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
 			10
 		);
 
@@ -107,16 +107,16 @@ 
 	 */
 	public static function set_definitions() {
 	    // don't do this twice
-	    if(defined('TICKET_SELECTOR_ASSETS_URL')) {
+	    if (defined('TICKET_SELECTOR_ASSETS_URL')) {
 	        return;
         }
-		define( 'TICKET_SELECTOR_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
 		define(
 		    'TICKET_SELECTOR_TEMPLATES_PATH',
-            str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS
+            str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS
         );
 		//if config is not set, initialize
-		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
+		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
             \EED_Ticket_Selector::instance()->set_config();
             \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
@@ -143,7 +143,7 @@ 
 	 * 	@param	WP $WP
 	 * 	@return void
 	 */
-	public function run( $WP ) {}
+	public function run($WP) {}
 
 
 
@@ -151,7 +151,7 @@ 
 	 * @return \EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton
 	 */
 	public static function getIframeEmbedButton() {
-		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton ) {
+		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
 			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
 		}
 		return self::$iframe_embed_button;
@@ -195,8 +195,8 @@ 
      * @return    string
      * @throws \EE_Error
      */
-	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
-		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
+	public static function display_ticket_selector($event = NULL, $view_details = FALSE) {
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
 	}
 
 
@@ -247,11 +247,11 @@ 
 	* 	@return 		void
 	*/
 	public static function load_tckt_slctr_assets() {
-		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE)) {
             // add some style
             wp_register_style(
                 'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -259,13 +259,13 @@ 
             // make it dance
             wp_register_script(
                 'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js',
                 array('espresso_core'),
                 EVENT_ESPRESSO_VERSION,
                 TRUE
             );
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+            require_once(EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
             \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
         }
 	}
@@ -307,7 +307,7 @@ 
      */
     public static function iframeCss(array $iframe_css)
     {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css';
         return $iframe_css;
     }
 
@@ -321,7 +321,7 @@ 
      */
     public static function iframeJs(array $iframe_js)
     {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js';
         return $iframe_js;
     }
 
@@ -446,8 +446,8 @@ 
     {
         // todo add doing_it_wrong() notice during next major version
 	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		    \EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+		    && \EE_Registry::instance()->REQ->get('action') === 'edit'
 	    ) {
 		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
             $iframe_embed_button->embedButtonAssets();

modules/ticket_selector/DisplayTicketSelector.php

Indentation +676 added lines, -676 removed lines

@@ -17,7 +17,7 @@ 
 use WP_Post;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -34,684 +34,684 @@ 
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     *@var string $date_format
-     */
-    private $date_format;
-
-    /**
-     *@var string $time_format
-     */
-    private $time_format;
-
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     */
-    public function __construct()
-    {
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe( $iframe = true )
-    {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function setEvent( $event = null )
-    {
-        if ( $event === null ) {
-            global $post;
-            $event = $post;
-        }
-        if ( $event instanceof EE_Event ) {
-            $this->event = $event;
-        } else if ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
-                $this->event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso'
-                );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool         $view_details
-     * @return string
-     * @throws EE_Error
-     */
-    public function display( $event = null, $view_details = false )
-    {
-        // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
-        // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        if (EED_Events_Archive::is_iframe()){
-            $this->setIframe();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url();
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = ! is_admin()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string       $_event_active_status
-     * @param bool         $view_details
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return ! is_admin()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 *@var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 *@var string $time_format
+	 */
+	private $time_format;
+
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 */
+	public function __construct()
+	{
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe( $iframe = true )
+	{
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function setEvent( $event = null )
+	{
+		if ( $event === null ) {
+			global $post;
+			$event = $post;
+		}
+		if ( $event instanceof EE_Event ) {
+			$this->event = $event;
+		} else if ( $event instanceof WP_Post ) {
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+				$this->event = $event->EE_Event;
+			} else if ( $event->post_type === 'espresso_events' ) {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
+			$dev_msg = $user_msg . __(
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso'
+				);
+			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool         $view_details
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display( $event = null, $view_details = false )
+	{
+		// reset filter for displaying submit button
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+		// poke and prod incoming event till it tells us what it is
+		if ( ! $this->setEvent( $event ) ) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
+		if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		if ( $template_args[ 'event_is_expired' ] ) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		if (EED_Events_Archive::is_iframe()){
+			$this->setIframe();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url();
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets,$template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = ! is_admin()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string       $_event_active_status
+	 * @param bool         $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return ! is_admin()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws EE_Error
-     */
-    protected function getTickets()
-    {
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if (
-            ! (
-                EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-                && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
-            )
-        ) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array  $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        //display notice to admin that registration is external
-        return is_admin()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen( $ID = 0, $external_url = '' )
-    {
-        // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                EED_Events_Archive::is_iframe()
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
-        return $html;
-    }
-
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ( ! is_admin()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } else if ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
-                } else if (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } else if (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if ( ! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = $this->event->external_url();
-        $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayViewDetailsButton( $DWMTS = false )
-    {
-        if ( ! $this->event->get_permalink() ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            EED_Events_Archive::is_iframe()
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .='>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	protected function getTickets()
+	{
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if (
+			! (
+				EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+				&& EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
+			)
+		) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array  $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		//display notice to admin that registration is external
+		return is_admin()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen( $ID = 0, $external_url = '' )
+	{
+		// if redirecting, we don't need any anything else
+		if ( $external_url ) {
+			$html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				EED_Events_Archive::is_iframe()
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = EEH_URL::get_query_string( $external_url );
+			foreach ( (array)$query_args as $query_arg => $value ) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url( $ID );
+		if ( ! $checkout_url ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+		return $html;
+	}
+
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ( ! is_admin()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} else if ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .=  $this->ticketSelectorEndDiv();
+				} else if (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} else if (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if ( ! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = $this->event->external_url();
+		$html = EEH_HTML::div(
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayViewDetailsButton( $DWMTS = false )
+	{
+		if ( ! $this->event->get_permalink() ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			EED_Events_Archive::is_iframe()
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .='>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}