eventespresso / event-espresso-core

core/libraries/qtips/EE_Qtip_Config.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -238,7 +238,7 @@
      * return the _qtips property contents
      *
      * @access public
-     * @return EE_Qtip[]
+     * @return EE_Qtip
      */
     public function get_tips()
     {

Indentation +225 added lines, -225 removed lines

@@ -15,235 +15,235 @@ 
 abstract class EE_Qtip_Config extends EE_Base
 {
 
-    /**
-     * This will hold the qtips setup array (setup by children)
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_qtipsa;
+	/**
+	 * This will hold the qtips setup array (setup by children)
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_qtipsa;
 
 
-    /**
-     * This holds the constructed EE_Qtip objects
-     *
-     * @access protected
-     * @var EE_Qtip
-     */
-    protected $_qtips;
+	/**
+	 * This holds the constructed EE_Qtip objects
+	 *
+	 * @access protected
+	 * @var EE_Qtip
+	 */
+	protected $_qtips;
 
 
-    /**
-     * an array of default options for instantiated qtip js objects
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_default_options;
+	/**
+	 * an array of default options for instantiated qtip js objects
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_default_options;
 
 
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        $this->_qtipsa = $this->_qtips = array();
-        $this->_set_default_options();
-        $this->_set_tips_array();
-        $this->_construct_tips();
-    }
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		$this->_qtipsa = $this->_qtips = array();
+		$this->_set_default_options();
+		$this->_set_tips_array();
+		$this->_construct_tips();
+	}
 
 
-    /**
-     * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
-     *
-     * $qtipsa = array(
-     *        0 => array(
-     *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
-     *            'content' => 'html/text content for the qtip',
-     *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
-     *            target is for the qTip in the dom (i.e. if class then '.some-class').
-     *            'options' => array() //use this to override any of the default options for this specific qtip.
-     *        )
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tips_array();
+	/**
+	 * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
+	 *
+	 * $qtipsa = array(
+	 *        0 => array(
+	 *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
+	 *            'content' => 'html/text content for the qtip',
+	 *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
+	 *            target is for the qTip in the dom (i.e. if class then '.some-class').
+	 *            'options' => array() //use this to override any of the default options for this specific qtip.
+	 *        )
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tips_array();
 
 
-    /**
-     * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
-     * qtips defined in their config OR just leave it and have the parent default options apply.
-     *
-     * commented out options are there for reference so you know which can be defined by the child.
-     *
-     * Note: children do NOT have to define all these options.  Just define the ones to override.
-     *
-     * @link   http://qtip2.com/options
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_default_options()
-    {
-        $this->_default_options = array(
-            // 'id' => 'unique_id_referncing_qtip_instance',
-            'prerender'      => false,
-            // increases page load if true,
-            'suppress'       => true,
-            // whether default browser tooltips are suppressed.
-            'content'        => array(
-                'button' => false,
-                // what you want for the close button text/link.
-                'title'  => true,
-                // Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
-                'clone'  => true,
-                // Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
-            ),
-            'show_only_once' => false,
-            // this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
-            'position'       => array(
-                'my'        => 'top left',
-                // top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
-                'at'        => 'bottom right',
-                // same options as above.
-                'target'    => 'event',
-                // if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
-                'container' => false,
-                // what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
-                'viewport'  => true,
-                // @link http://qtip2.com/plugins#viewport
-                'adjust'    => array(
-                    'x'      => 0,
-                    // adjust position on x axis by 0 pixels.
-                    'y'      => 0,
-                    // adjust position on y axis by 0 pixels.
-                    'mouse'  => true,
-                    // when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
-                    'resize' => true,
-                    // adjust tooltip position when window is resized.
-                    'scroll' => true,
-                    // position of tooltip adjusted when window (or position.container) is scrolled.
-                    'method' => 'flipinvert',
-                    // @link http://qtip2.com/plugins#viewport
-                ),
-            ),
-            'show'           => array(
-                'event'  => 'mouseenter',
-                // what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
-                'target' => false,
-                // options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
-                'delay'  => 90,
-                // time in millisecons by which to delay showing of tooltip.
-                'solo'   => false,
-                // determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
-                'modal'  => array(
-                    'on'         => false, // does tooltip trigger modal?
-                    'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
-                    'escape'     => true, // hitting escape key hide the tooltip and cancel modal
-                    'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
-                ),
-            ),
-            'hide'           => array(
-                'event'    => 'mouseleave',
-                // similar as what you do for show.event.
-                'target'   => false,
-                // Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
-                'delay'    => 0,
-                // set time in milliseconds for delaying the hide of the tooltip
-                'inactive' => false,
-                // if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
-                'fixed'    => false,
-                // when set to true, the tooltip will not hide if moused over.
-                'leave'    => 'window',
-                // specify whether the tooltip will hide when leaving the window it's conained within.
-                'distance' => false,
-                // if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
-            ),
-            'style'          => array(
-                'classes' => 'qtip-tipsy',
-                // Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
-                'def'     => true,
-                // set to false and the default qtip class does not get applied
-                'widget'  => false,
-                // whether ui-widget classes of the themeroller UI styles are applied to tooltip.
-                'width'   => false,
-                // Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
-                'height'  => false,
-                // same as above except applies to height.
-                'tip'     => array(
-                    'corner' => true,
-                    // where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
-                    'mimic'  => false,
-                    // see documentation @link http://qtip2.com/plugins#tips
-                    'border' => true,
-                    // Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
-                    'width'  => 6,
-                    // width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
-                    'height' => 6,
-                    // works the same as tip.width
-                    'offset' => 0,
-                    // use to set the offset of the tip in relation to its corner position.
-                ),
-            ),
+	/**
+	 * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
+	 * qtips defined in their config OR just leave it and have the parent default options apply.
+	 *
+	 * commented out options are there for reference so you know which can be defined by the child.
+	 *
+	 * Note: children do NOT have to define all these options.  Just define the ones to override.
+	 *
+	 * @link   http://qtip2.com/options
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_default_options()
+	{
+		$this->_default_options = array(
+			// 'id' => 'unique_id_referncing_qtip_instance',
+			'prerender'      => false,
+			// increases page load if true,
+			'suppress'       => true,
+			// whether default browser tooltips are suppressed.
+			'content'        => array(
+				'button' => false,
+				// what you want for the close button text/link.
+				'title'  => true,
+				// Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
+				'clone'  => true,
+				// Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
+			),
+			'show_only_once' => false,
+			// this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
+			'position'       => array(
+				'my'        => 'top left',
+				// top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
+				'at'        => 'bottom right',
+				// same options as above.
+				'target'    => 'event',
+				// if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
+				'container' => false,
+				// what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
+				'viewport'  => true,
+				// @link http://qtip2.com/plugins#viewport
+				'adjust'    => array(
+					'x'      => 0,
+					// adjust position on x axis by 0 pixels.
+					'y'      => 0,
+					// adjust position on y axis by 0 pixels.
+					'mouse'  => true,
+					// when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
+					'resize' => true,
+					// adjust tooltip position when window is resized.
+					'scroll' => true,
+					// position of tooltip adjusted when window (or position.container) is scrolled.
+					'method' => 'flipinvert',
+					// @link http://qtip2.com/plugins#viewport
+				),
+			),
+			'show'           => array(
+				'event'  => 'mouseenter',
+				// what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
+				'target' => false,
+				// options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
+				'delay'  => 90,
+				// time in millisecons by which to delay showing of tooltip.
+				'solo'   => false,
+				// determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
+				'modal'  => array(
+					'on'         => false, // does tooltip trigger modal?
+					'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
+					'escape'     => true, // hitting escape key hide the tooltip and cancel modal
+					'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
+				),
+			),
+			'hide'           => array(
+				'event'    => 'mouseleave',
+				// similar as what you do for show.event.
+				'target'   => false,
+				// Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
+				'delay'    => 0,
+				// set time in milliseconds for delaying the hide of the tooltip
+				'inactive' => false,
+				// if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
+				'fixed'    => false,
+				// when set to true, the tooltip will not hide if moused over.
+				'leave'    => 'window',
+				// specify whether the tooltip will hide when leaving the window it's conained within.
+				'distance' => false,
+				// if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
+			),
+			'style'          => array(
+				'classes' => 'qtip-tipsy',
+				// Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
+				'def'     => true,
+				// set to false and the default qtip class does not get applied
+				'widget'  => false,
+				// whether ui-widget classes of the themeroller UI styles are applied to tooltip.
+				'width'   => false,
+				// Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
+				'height'  => false,
+				// same as above except applies to height.
+				'tip'     => array(
+					'corner' => true,
+					// where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
+					'mimic'  => false,
+					// see documentation @link http://qtip2.com/plugins#tips
+					'border' => true,
+					// Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
+					'width'  => 6,
+					// width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
+					'height' => 6,
+					// works the same as tip.width
+					'offset' => 0,
+					// use to set the offset of the tip in relation to its corner position.
+				),
+			),
 
-        );
-    }
+		);
+	}
 
 
-    /**
-     * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
-     * the $_qtips property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _construct_tips()
-    {
-        foreach ($this->_qtipsa as $qt) {
-            // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        var_export($qt, true)
-                    )
-                );
-            }
+	/**
+	 * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
+	 * the $_qtips property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _construct_tips()
+	{
+		foreach ($this->_qtipsa as $qt) {
+			// make sure we have what we need.
+			if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
+							'event_espresso'
+						),
+						get_class($this),
+						var_export($qt, true)
+					)
+				);
+			}
 
-            // make sure the options include defaults and just override via set config.
-            $options_override = isset($qt['options']) ? (array) $qt['options'] : array();
-            $options = array_merge($this->_default_options, $options_override);
-            $setup = array(
-                'content_id' => $qt['content_id'],
-                'options'    => $options,
-                'target'     => $qt['target'],
-                'content'    => $qt['content'],
-            );
-            $this->_qtips[] = new EE_Qtip($setup);
-        }
-    }
+			// make sure the options include defaults and just override via set config.
+			$options_override = isset($qt['options']) ? (array) $qt['options'] : array();
+			$options = array_merge($this->_default_options, $options_override);
+			$setup = array(
+				'content_id' => $qt['content_id'],
+				'options'    => $options,
+				'target'     => $qt['target'],
+				'content'    => $qt['content'],
+			);
+			$this->_qtips[] = new EE_Qtip($setup);
+		}
+	}
 
 
-    /**
-     * return the _qtips property contents
-     *
-     * @access public
-     * @return EE_Qtip[]
-     */
-    public function get_tips()
-    {
-        return $this->_qtips;
-    }
+	/**
+	 * return the _qtips property contents
+	 *
+	 * @access public
+	 * @return EE_Qtip[]
+	 */
+	public function get_tips()
+	{
+		return $this->_qtips;
+	}
 }
 
 // class names you can use for tooltip styles
@@ -295,17 +295,17 @@ 
  */
 class EE_Qtip extends EE_Base
 {
-    public $content_id;
-    public $options;
-    public $target;
-    public $content;
+	public $content_id;
+	public $options;
+	public $target;
+	public $content;
 
-    public function __construct($setup_array)
-    {
-        foreach ($setup_array as $prop => $value) {
-            if (EEH_Class_Tools::has_property($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-    }
+	public function __construct($setup_array)
+	{
+		foreach ($setup_array as $prop => $value) {
+			if (EEH_Class_Tools::has_property($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
     {
         foreach ($this->_qtipsa as $qt) {
             // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+            if ( ! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
                 throw new EE_Error(
                     sprintf(
                         __(

core/libraries/shortcodes/EE_Event_Shortcodes.lib.php

Doc Comments +1 added lines

@@ -283,6 +283,7 @@
      *
      * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
      *                            Otherwise we just return the url of the event.
+     * @param EE_Event $event
      * @return string
      */
     private function _get_event_link($event, $full_link = true)

Indentation +272 added lines, -272 removed lines

@@ -19,276 +19,276 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = __('Event Shortcodes', 'event_espresso');
-        $this->description = __('All shortcodes specific to event related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[EVENT_ID]'                              => __(
-                'Will be replaced by the event ID of an event',
-                'event_espresso'
-            ),
-            '[EVENT]'                                 => __('The name of the event', 'event_espresso'),
-            '[EVENT_NAME]'                            => __(
-                "This also can be used for the name of the event",
-                'event_espresso'
-            ),
-            '[EVENT_PHONE]'                           => __(
-                'The phone number for the event (usually an info number)',
-                'event_espresso'
-            ),
-            '[EVENT_DESCRIPTION]'                     => __('The description of the event', 'event_espresso'),
-            '[EVENT_EXCERPT]'                         => __(
-                'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
-                'event_espresso'
-            ),
-            '[EVENT_LINK]'                            => __('A link associated with the event', 'event_espresso'),
-            '[EVENT_URL]'                             => __(
-                'A link to the event set up on the host site.',
-                'event_espresso'
-            ),
-            '[VIRTUAL_URL]'                           => __(
-                'What was used for the "URL of Event" field in the Venue settings',
-                'event_espresso'
-            ),
-            '[VIRTUAL_PHONE]'                         => __(
-                'An alternate phone number for the event. Typically used as a "call-in" number',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE]'                           => __(
-                'This will parse to the Feature image for the event.',
-                'event_espresso'
-            ),
-            '[EVENT_IMAGE_*]'                         => sprintf(
-                __(
-                    'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
-                __(
-                    'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[EVENT_TOTAL_SPOTS_TAKEN]'               => __(
-                'This shortcode will parse to the output the total approved registrations for this event',
-                'event_espresso'
-            ),
-            '[EVENT_FACEBOOK_URL]'                    => __(
-                'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
-                'event_espresso'
-            ),
-            '[EVENT_TWITTER_URL]'                     => __(
-                'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
-                'event_espresso'
-            ),
-            '[EVENT_META_*]'                          => __(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __(
-                'This parses to the url for the registration list table filtered by registrations for this event.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
-        if (empty($this->_event)) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event() : null;
-        }
-
-
-        // If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[EVENT_ID]':
-                return $this->_event->ID();
-                break;
-
-            case '[EVENT]':
-            case '[EVENT_NAME]':
-                return $this->_event->get('EVT_name');
-                break;
-
-            case '[EVENT_PHONE]':
-                return $this->_event->get('EVT_phone');
-                break;
-
-            case '[EVENT_DESCRIPTION]':
-                return $this->_event->get('EVT_desc');
-                break;
-
-            case '[EVENT_EXCERPT]':
-                return $this->_event->get('EVT_short_desc');
-                break;
-
-            case '[EVENT_LINK]':
-                return $this->_get_event_link($this->_event);
-                break;
-
-            case '[EVENT_URL]':
-                return $this->_get_event_link($this->_event, false);
-                break;
-
-            case '[VIRTUAL_URL]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_url');
-
-            case '[VIRTUAL_PHONE]':
-                $venue = $this->_event->get_first_related('Venue');
-                if (empty($venue)) {
-                    return '';
-                }
-                return $venue->get('VNU_virtual_phone');
-                break;
-
-            case '[EVENT_IMAGE]':
-                $image = $this->_event->feature_image_url(array(600, 300));
-                // @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
-                return ! empty($image)
-                    ? '<img src="' . $image . '" alt="'
-                      . sprintf(
-                          esc_attr__('%s Feature Image', 'event_espresso'),
-                          $this->_event->get('EVT_name')
-                      ) . '" />'
-                    : '';
-                break;
-
-            case '[EVENT_FACEBOOK_URL]':
-                $facebook_url = $this->_event->get_post_meta('event_facebook', true);
-                return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
-                    : $facebook_url;
-                break;
-
-            case '[EVENT_TWITTER_URL]':
-                $twitter_url = $this->_event->get_post_meta('event_twitter', true);
-                return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
-                    : $twitter_url;
-                break;
-
-            case '[EVENT_AUTHOR_EMAIL]':
-                $author_id = $this->_event->get('EVT_wp_user');
-                $user_data = get_userdata((int) $author_id);
-                return $user_data->user_email;
-                break;
-
-            case '[EVENT_TOTAL_SPOTS_TAKEN]':
-                return EEM_Registration::instance()->count(
-                    array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
-                    'REG_ID',
-                    true
-                );
-                break;
-
-            case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
-                return EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'event_id' => $this->_event->ID(),
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'default',
-                    ),
-                    admin_url('admin.php'),
-                    true
-                );
-                break;
-        }
-
-        if (strpos($shortcode, '[EVENT_META_*') !== false) {
-            $shortcode = str_replace('[EVENT_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-            // pull the meta value from the event post
-            $event_meta = $this->_event->get_post_meta($shortcode, true);
-
-            return ! empty($event_meta) ? $this->_event->get_post_meta($shortcode, true) : '';
-        }
-
-        if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $method = empty($attrs['method']) ? 'current' : $attrs['method'];
-            $method = $method === 'current';
-            $available = $this->_event->total_available_spaces($method);
-            return $available === EE_INF ? '&infin;' : $available;
-        }
-
-        if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
-            $height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
-
-            // Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
-            if (! empty($attrs['size'])) {
-                $size = explode(',', $attrs['size']);
-                if (count($size) === 1) {
-                    $size = $size[0];
-                }
-            } else {
-                $size = 'thumbnail';
-            }
-
-            $image = $this->_event->feature_image_url($size);
-
-            return ! empty($image)
-                ? '<img src="' . $image . '" alt="'
-                  . sprintf(
-                      esc_attr__('%s Feature Image', 'event_espresso'),
-                      $this->_event->get('EVT_name')
-                  ) . '"' . $width . $height . '/>'
-                : '';
-        }
-
-        return '';
-    }
-
-
-    /**
-     * returns the link to the event
-     *
-     * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
-     *                            Otherwise we just return the url of the event.
-     * @return string
-     */
-    private function _get_event_link($event, $full_link = true)
-    {
-        $url = get_permalink($event->ID());
-
-        return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = __('Event Shortcodes', 'event_espresso');
+		$this->description = __('All shortcodes specific to event related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[EVENT_ID]'                              => __(
+				'Will be replaced by the event ID of an event',
+				'event_espresso'
+			),
+			'[EVENT]'                                 => __('The name of the event', 'event_espresso'),
+			'[EVENT_NAME]'                            => __(
+				"This also can be used for the name of the event",
+				'event_espresso'
+			),
+			'[EVENT_PHONE]'                           => __(
+				'The phone number for the event (usually an info number)',
+				'event_espresso'
+			),
+			'[EVENT_DESCRIPTION]'                     => __('The description of the event', 'event_espresso'),
+			'[EVENT_EXCERPT]'                         => __(
+				'This gets parsed to the value for the excerpt field in the event or blank if there is no excerpt.',
+				'event_espresso'
+			),
+			'[EVENT_LINK]'                            => __('A link associated with the event', 'event_espresso'),
+			'[EVENT_URL]'                             => __(
+				'A link to the event set up on the host site.',
+				'event_espresso'
+			),
+			'[VIRTUAL_URL]'                           => __(
+				'What was used for the "URL of Event" field in the Venue settings',
+				'event_espresso'
+			),
+			'[VIRTUAL_PHONE]'                         => __(
+				'An alternate phone number for the event. Typically used as a "call-in" number',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE]'                           => __(
+				'This will parse to the Feature image for the event.',
+				'event_espresso'
+			),
+			'[EVENT_IMAGE_*]'                         => sprintf(
+				__(
+					'This will parse to the Feature image for the event, %1$ssize%2$s can be set to determine the size of the image loaded by the shortcode. The %1$swidth%2$s and/or %1$sheight%2$s can also be set to determine the width and height of the image when output. By default the shortcode will load the %1$sthumbnail%2$s image size.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_AVAILABLE_SPACES_*]'        => sprintf(
+				__(
+					'This will parse to the total available spaces for an event. Calculating total spaces is approximate because it is dependent on the complexity of limits on your event.  There are two methods of calculation (which can be indicated by the %1$smethod%2$s param on the shortcode).  %1$scurrent%2$s which will do a more accurate calculation of total available spaces based on current sales, and %1$sfull%2$s which will be the maximum total available spaces that is on the event in optimal conditions. The shortcode will default to current.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[EVENT_TOTAL_SPOTS_TAKEN]'               => __(
+				'This shortcode will parse to the output the total approved registrations for this event',
+				'event_espresso'
+			),
+			'[EVENT_FACEBOOK_URL]'                    => __(
+				'This will return the Facebook URL for the event if you have it set via custom field in your event, otherwise it will use the Facebook URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_facebook</code> and the value as your facebook url.',
+				'event_espresso'
+			),
+			'[EVENT_TWITTER_URL]'                     => __(
+				'This will return the Twitter URL for the event if you have it set via custom field in your event, otherwise it will use the Twitter URL set in "Your Organization Settings". To set the facebook url in your event, add a custom field with the key as <code>event_twitter</code> and the value as your facebook url',
+				'event_espresso'
+			),
+			'[EVENT_META_*]'                          => __(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the event then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]' => __(
+				'This parses to the url for the registration list table filtered by registrations for this event.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the reg_obj instead.
+		if (empty($this->_event)) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event() : null;
+		}
+
+
+		// If there is no event objecdt by now then get out.
+		if (! $this->_event instanceof EE_Event) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[EVENT_ID]':
+				return $this->_event->ID();
+				break;
+
+			case '[EVENT]':
+			case '[EVENT_NAME]':
+				return $this->_event->get('EVT_name');
+				break;
+
+			case '[EVENT_PHONE]':
+				return $this->_event->get('EVT_phone');
+				break;
+
+			case '[EVENT_DESCRIPTION]':
+				return $this->_event->get('EVT_desc');
+				break;
+
+			case '[EVENT_EXCERPT]':
+				return $this->_event->get('EVT_short_desc');
+				break;
+
+			case '[EVENT_LINK]':
+				return $this->_get_event_link($this->_event);
+				break;
+
+			case '[EVENT_URL]':
+				return $this->_get_event_link($this->_event, false);
+				break;
+
+			case '[VIRTUAL_URL]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_url');
+
+			case '[VIRTUAL_PHONE]':
+				$venue = $this->_event->get_first_related('Venue');
+				if (empty($venue)) {
+					return '';
+				}
+				return $venue->get('VNU_virtual_phone');
+				break;
+
+			case '[EVENT_IMAGE]':
+				$image = $this->_event->feature_image_url(array(600, 300));
+				// @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
+				return ! empty($image)
+					? '<img src="' . $image . '" alt="'
+					  . sprintf(
+						  esc_attr__('%s Feature Image', 'event_espresso'),
+						  $this->_event->get('EVT_name')
+					  ) . '" />'
+					: '';
+				break;
+
+			case '[EVENT_FACEBOOK_URL]':
+				$facebook_url = $this->_event->get_post_meta('event_facebook', true);
+				return empty($facebook_url) ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
+					: $facebook_url;
+				break;
+
+			case '[EVENT_TWITTER_URL]':
+				$twitter_url = $this->_event->get_post_meta('event_twitter', true);
+				return empty($twitter_url) ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
+					: $twitter_url;
+				break;
+
+			case '[EVENT_AUTHOR_EMAIL]':
+				$author_id = $this->_event->get('EVT_wp_user');
+				$user_data = get_userdata((int) $author_id);
+				return $user_data->user_email;
+				break;
+
+			case '[EVENT_TOTAL_SPOTS_TAKEN]':
+				return EEM_Registration::instance()->count(
+					array(array('EVT_ID' => $this->_event->ID(), 'STS_ID' => EEM_Registration::status_id_approved)),
+					'REG_ID',
+					true
+				);
+				break;
+
+			case '[REGISTRATION_LIST_TABLE_FOR_EVENT_URL]':
+				return EEH_URL::add_query_args_and_nonce(
+					array(
+						'event_id' => $this->_event->ID(),
+						'page'     => 'espresso_registrations',
+						'action'   => 'default',
+					),
+					admin_url('admin.php'),
+					true
+				);
+				break;
+		}
+
+		if (strpos($shortcode, '[EVENT_META_*') !== false) {
+			$shortcode = str_replace('[EVENT_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+			// pull the meta value from the event post
+			$event_meta = $this->_event->get_post_meta($shortcode, true);
+
+			return ! empty($event_meta) ? $this->_event->get_post_meta($shortcode, true) : '';
+		}
+
+		if (strpos($shortcode, '[EVENT_TOTAL_AVAILABLE_SPACES_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$method = empty($attrs['method']) ? 'current' : $attrs['method'];
+			$method = $method === 'current';
+			$available = $this->_event->total_available_spaces($method);
+			return $available === EE_INF ? '&infin;' : $available;
+		}
+
+		if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
+			$height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
+
+			// Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
+			if (! empty($attrs['size'])) {
+				$size = explode(',', $attrs['size']);
+				if (count($size) === 1) {
+					$size = $size[0];
+				}
+			} else {
+				$size = 'thumbnail';
+			}
+
+			$image = $this->_event->feature_image_url($size);
+
+			return ! empty($image)
+				? '<img src="' . $image . '" alt="'
+				  . sprintf(
+					  esc_attr__('%s Feature Image', 'event_espresso'),
+					  $this->_event->get('EVT_name')
+				  ) . '"' . $width . $height . '/>'
+				: '';
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * returns the link to the event
+	 *
+	 * @param  boolean $full_link if TRUE (default) we return the html for the name of the event linked to the event.
+	 *                            Otherwise we just return the url of the event.
+	 * @return string
+	 */
+	private function _get_event_link($event, $full_link = true)
+	{
+		$url = get_permalink($event->ID());
+
+		return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -130,7 +130,7 @@ 
 
 
         // If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             return '';
         }
 
@@ -183,11 +183,11 @@ 
                 $image = $this->_event->feature_image_url(array(600, 300));
                 // @todo: eventually we should make this an attribute shortcode so that em can send along what size they want returned.
                 return ! empty($image)
-                    ? '<img src="' . $image . '" alt="'
+                    ? '<img src="'.$image.'" alt="'
                       . sprintf(
                           esc_attr__('%s Feature Image', 'event_espresso'),
                           $this->_event->get('EVT_name')
-                      ) . '" />'
+                      ).'" />'
                     : '';
                 break;
 
@@ -250,11 +250,11 @@ 
 
         if (strpos($shortcode, '[EVENT_IMAGE_*') !== false) {
             $attrs = $this->_get_shortcode_attrs($shortcode);
-            $width = empty($attrs['width']) ? '' : ' width="' . $attrs['width'] . '"';
-            $height = empty($attrs['height']) ? '' : ' height="' . $attrs['height'] . '"';
+            $width = empty($attrs['width']) ? '' : ' width="'.$attrs['width'].'"';
+            $height = empty($attrs['height']) ? '' : ' height="'.$attrs['height'].'"';
 
             // Size may be set to a string such as 'tumbnail' or "width, height" eg - '200,200'
-            if (! empty($attrs['size'])) {
+            if ( ! empty($attrs['size'])) {
                 $size = explode(',', $attrs['size']);
                 if (count($size) === 1) {
                     $size = $size[0];
@@ -266,11 +266,11 @@ 
             $image = $this->_event->feature_image_url($size);
 
             return ! empty($image)
-                ? '<img src="' . $image . '" alt="'
+                ? '<img src="'.$image.'" alt="'
                   . sprintf(
                       esc_attr__('%s Feature Image', 'event_espresso'),
                       $this->_event->get('EVT_name')
-                  ) . '"' . $width . $height . '/>'
+                  ).'"'.$width.$height.'/>'
                 : '';
         }
 
@@ -289,6 +289,6 @@ 
     {
         $url = get_permalink($event->ID());
 
-        return $full_link ? '<a href="' . $url . '">' . $event->get('EVT_name') . '</a>' : $url;
+        return $full_link ? '<a href="'.$url.'">'.$event->get('EVT_name').'</a>' : $url;
     }
 }

core/libraries/shortcodes/EE_Primary_Registration_List_Shortcodes.lib.php

Doc Comments +6 added lines

@@ -125,6 +125,9 @@ 
     }
 
 
+    /**
+     * @param EE_Registration $reg
+     */
     private function _get_tickets_from_event(EE_Event $event, $reg = null)
     {
         $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
@@ -203,6 +206,9 @@ 
     }
 
 
+    /**
+     * @param EE_Registration $reg
+     */
     private function _get_datetimes_from_event(EE_Event $event, $reg = null)
     {
         $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(

Indentation +201 added lines, -201 removed lines

@@ -19,205 +19,205 @@
 class EE_Primary_Registration_List_Shortcodes extends EE_Shortcodes
 {
 
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = __('Primary Registrant List Shortcodes', 'event_espresso');
-        $this->description = __(
-            'All shortcodes specific primary registrant recipients list type data.',
-            'event_espresso'
-        );
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_TICKET_LIST]' => __(
-                'Will output a list of tickets that the primary registration received.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]' => __(
-                'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_TICKET_LIST]':
-                return $this->_get_recipient_ticket_list(true);
-                break;
-
-            case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
-                return $this->_get_recipient_datetime_list(true);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_ticket_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-    }
-
-
-    private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array(
-                'ticket',
-                'event_list',
-                'attendee_list',
-                'datetime_list',
-                'registration_details',
-                'attendee',
-            );
-            $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-                ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
-            // let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
-            $template = str_replace('[EVENT_LIST]', '', $template);
-            // data will be tickets for this event for this recipient.
-            $tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $tktparsed = '';
-        foreach ($tkts as $ticket) {
-            $tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $data
-            );
-        }
-        return $tktparsed;
-    }
-
-
-    private function _get_tickets_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_tkts = array();
-            // return only tickets for the given attendee
-            foreach ($evt_tkts as $tkt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
-                ) {
-                    $adj_tkts[] = $tkt;
-                }
-            }
-            $evt_tkts = $adj_tkts;
-        }
-        return $evt_tkts;
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_datetime_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-
-        return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-    }
-
-
-    private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-                ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
-            $dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $dtt_parsed = '';
-        foreach ($dtts as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-        return $dtt_parsed;
-    }
-
-
-    private function _get_datetimes_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_dtts = array();
-            // return only dtts for the given attendee
-            foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
-                    $adj_dtts[] = $dtt;
-                }
-            }
-            $evt_dtts = $adj_dtts;
-        }
-        return $evt_dtts;
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = __('Primary Registrant List Shortcodes', 'event_espresso');
+		$this->description = __(
+			'All shortcodes specific primary registrant recipients list type data.',
+			'event_espresso'
+		);
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_TICKET_LIST]' => __(
+				'Will output a list of tickets that the primary registration received.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]' => __(
+				'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_TICKET_LIST]':
+				return $this->_get_recipient_ticket_list(true);
+				break;
+
+			case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
+				return $this->_get_recipient_datetime_list(true);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_ticket_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+	}
+
+
+	private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array(
+				'ticket',
+				'event_list',
+				'attendee_list',
+				'datetime_list',
+				'registration_details',
+				'attendee',
+			);
+			$template = $this->_data['template'];
+			$tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+				? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
+			// let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
+			$template = str_replace('[EVENT_LIST]', '', $template);
+			// data will be tickets for this event for this recipient.
+			$tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$tktparsed = '';
+		foreach ($tkts as $ticket) {
+			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$data
+			);
+		}
+		return $tktparsed;
+	}
+
+
+	private function _get_tickets_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['tkt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_tkts = array();
+			// return only tickets for the given attendee
+			foreach ($evt_tkts as $tkt) {
+				if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
+					&& $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+				) {
+					$adj_tkts[] = $tkt;
+				}
+			}
+			$evt_tkts = $adj_tkts;
+		}
+		return $evt_tkts;
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_datetime_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+
+		return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+	}
+
+
+	private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = $this->_data['template'];
+			$dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+				? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
+			$dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$dtt_parsed = '';
+		foreach ($dtts as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+		return $dtt_parsed;
+	}
+
+
+	private function _get_datetimes_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['dtt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_dtts = array();
+			// return only dtts for the given attendee
+			foreach ($evt_dtts as $dtt) {
+				if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+					$adj_dtts[] = $dtt;
+				}
+			}
+			$evt_dtts = $adj_dtts;
+		}
+		return $evt_dtts;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -83,7 +83,7 @@ 
     private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
@@ -97,7 +97,7 @@ 
                 'attendee',
             );
             $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+            $tkts = array($data->registrations[$registration->ID()]['tkt_obj']);
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
@@ -127,15 +127,15 @@ 
 
     private function _get_tickets_from_event(EE_Event $event, $reg = null)
     {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
+        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['tkt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_tkts = array();
             // return only tickets for the given attendee
             foreach ($evt_tkts as $tkt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+                if (isset($this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'])
+                    && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID()
                 ) {
                     $adj_tkts[] = $tkt;
                 }
@@ -171,14 +171,14 @@ 
     private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
         if ($this->_data['data'] instanceof EE_Messages_Addressee) {
             $valid_shortcodes = array('datetime', 'attendee');
             $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+            $dtts = $data->registrations[$registration->ID()]['dtt_objs'];
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('datetime', 'attendee');
@@ -205,14 +205,14 @@ 
 
     private function _get_datetimes_from_event(EE_Event $event, $reg = null)
     {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
+        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['dtt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_dtts = array();
             // return only dtts for the given attendee
             foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+                if (isset($this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()])) {
                     $adj_dtts[] = $dtt;
                 }
             }

core/services/notices/NoticeConverterInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -20,6 +20,7 @@ 
 
     /**
      * @param bool $throw_exceptions
+     * @return void
      */
     public function setThrowExceptions($throw_exceptions);
 
@@ -37,7 +38,7 @@ 
     public function process(NoticesContainerInterface $notices);
 
     /**
-     * @return void;
+     * @return void
      */
     public function clearNotices();
 }

Indentation +23 added lines, -23 removed lines

@@ -13,31 +13,31 @@
 interface NoticeConverterInterface
 {
 
-    /**
-     * @return NoticesContainerInterface
-     */
-    public function getNotices();
+	/**
+	 * @return NoticesContainerInterface
+	 */
+	public function getNotices();
 
-    /**
-     * @param bool $throw_exceptions
-     */
-    public function setThrowExceptions($throw_exceptions);
+	/**
+	 * @param bool $throw_exceptions
+	 */
+	public function setThrowExceptions($throw_exceptions);
 
-    /**
-     * @return bool
-     */
-    public function getThrowExceptions();
+	/**
+	 * @return bool
+	 */
+	public function getThrowExceptions();
 
-    /**
-     * Converts NoticesContainerInterface objects into other format
-     *
-     * @param NoticesContainerInterface $notices
-     * @return
-     */
-    public function process(NoticesContainerInterface $notices);
+	/**
+	 * Converts NoticesContainerInterface objects into other format
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @return
+	 */
+	public function process(NoticesContainerInterface $notices);
 
-    /**
-     * @return void;
-     */
-    public function clearNotices();
+	/**
+	 * @return void;
+	 */
+	public function clearNotices();
 }

modules/add_new_state/EED_Add_New_State.module.php

Doc Comments +2 added lines, -2 removed lines

@@ -231,7 +231,7 @@ 
      * display_add_new_state_micro_form
      *
      * @param EE_Form_Section_Proper $question_group_reg_form
-     * @return string
+     * @return EE_Form_Section_Proper
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -773,7 +773,7 @@ 
 
     /**
      * @param EE_State[] $state_options
-     * @return array
+     * @return EE_State[]
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Indentation +814 added lines, -814 removed lines

@@ -17,818 +17,818 @@
 {
 
 
-    /**
-     * @return EED_Module|EED_Add_New_State
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'),
-            1,
-            1
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'),
-            1,
-            1
-        );
-        add_filter(
-            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'),
-            10,
-            1
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'),
-            10,
-            5
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'),
-            10,
-            5
-        );
-        add_filter(
-            'FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'),
-            10,
-            1
-        );
-        add_filter(
-            'FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'),
-            1,
-            1
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'),
-            1,
-            1
-        );
-        add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_filter(
-            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-            array('EED_Add_New_State', 'update_country_settings'),
-            10,
-            3
-        );
-        add_action(
-            'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-            array('EED_Add_New_State', 'update_country_settings'),
-            10,
-            3
-        );
-        add_filter(
-            'FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'),
-            10,
-            1
-        );
-        add_filter(
-            'FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'),
-            10,
-            1
-        );
-        add_filter(
-            'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-            array('EED_Add_New_State', 'filter_checkout_request_params'),
-            10,
-            1
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'),
-            10,
-            5
-        );
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'),
-            10,
-            5
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define(
-            'ANS_TEMPLATES_PATH',
-            str_replace(
-                '\\',
-                DS,
-                plugin_dir_path(__FILE__)
-            ) . 'templates' . DS
-        );
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ans_no_country'] = esc_html__(
-            'In order to proceed, you need to select the Country that your State/Province belongs to.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_name'] = esc_html__(
-            'In order to proceed, you need to enter the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_abbreviation'] = esc_html__(
-            'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_save_success'] = esc_html__(
-            'The new state was successfully saved to the database.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
-            'An unknown error has occurred on the server while saving the new state to the database.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function wp_enqueue_scripts()
-    {
-        if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script(
-                'add_new_state',
-                ANS_ASSETS_URL . 'add_new_state.js',
-                array('espresso_core', 'single_page_checkout'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('add_new_state');
-        }
-    }
-
-
-
-    /**
-     * display_add_new_state_micro_form
-     *
-     * @param EE_Form_Section_Proper $question_group_reg_form
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
-    {
-        // only add the 'new_state_micro_form' when displaying reg forms,
-        // not during processing since we process the 'new_state_micro_form' in it's own AJAX request
-        $action = EE_Registry::instance()->REQ->get('action', '');
-        // is the "state" question in this form section?
-        $input = $question_group_reg_form->get_subsection('state');
-        if ($action === 'process_reg_step' || $action === 'update_reg_step') {
-            // ok then all we need to do is make sure the input's HTML name is consistent
-            // by forcing it to set it now, like it did while getting the form for display
-            if ($input instanceof EE_State_Select_Input) {
-                $input->html_name();
-            }
-            return $question_group_reg_form;
-        }
-        // we're only doing this for state select inputs
-        if ($input instanceof EE_State_Select_Input
-            && ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy
-        ) {
-            // grab any set values from the request
-            $country_name = str_replace('state', 'nsmf_new_state_country', $input->html_name());
-            $state_name = str_replace('state', 'nsmf_new_state_name', $input->html_name());
-            $abbrv_name = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
-            $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
-            $country_options = array();
-            $countries = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
-                foreach ($countries as $country) {
-                    if ($country instanceof EE_Country) {
-                        $country_options[ $country->ID() ] = $country->name();
-                    }
-                }
-            }
-            $new_state_micro_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'new_state_micro_form',
-                    'html_id'         => 'new_state_micro_form',
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'subsections'     => array(
-                        // add hidden input to indicate that a new state is being added
-                        'add_new_state'               => new EE_Hidden_Input(
-                            array(
-                                'html_name' => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_name()
-                                ),
-                                'html_id'   => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_id()
-                                ),
-                                'default'   => 0,
-                            )
-                        ),
-                        // add link for displaying hidden container
-                        'click_here_link'             => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('click here to add a new state/province', 'event_espresso'),
-                                    '',
-                                    'display-' . $input->html_id(),
-                                    'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                            )
-                        ),
-                        // add initial html for hidden container
-                        'add_new_state_micro_form'    => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div(
-                                    '',
-                                    $input->html_id() . '-dv',
-                                    'ee-form-add-new-state-dv',
-                                    'display: none;'
-                                ) .
-                                EEH_HTML::h6(
-                                    esc_html__(
-                                        'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::ul() .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'first select the Country that your State/Province belongs to',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'enter a two to six letter abbreviation for the name of your State/Province',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
-                                EEH_HTML::ulx()
-                            )
-                        ),
-                        // NEW STATE COUNTRY
-                        'new_state_country'           => new EE_Country_Select_Input(
-                            $country_options,
-                            array(
-                                'html_name'       => $country_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_country',
-                                    $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
-                                'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        // NEW STATE NAME
-                        'new_state_name'              => new EE_Text_Input(
-                            array(
-                                'html_name'       => $state_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_name',
-                                    $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
-                                'html_label_text' => esc_html__(
-                                    'New State/Province Name',
-                                    'event_espresso'
-                                ),
-                                'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
-                        // NEW STATE NAME
-                        'new_state_abbrv'             => new EE_Text_Input(
-                            array(
-                                'html_name'             => $abbrv_name,
-                                'html_id'               => str_replace(
-                                    'state',
-                                    'nsmf_new_state_abbrv',
-                                    $input->html_id()
-                                ),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
-                                'html_label_text'       => esc_html__(
-                                    'New State/Province Abbreviation',
-                                    'event_espresso'
-                                ) . ' *',
-                                'html_other_attributes' => 'size="24"',
-                                'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
-                                'required'              => false,
-                            )
-                        ),
-                        // "submit" button
-                        'add_new_state_submit_button' => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('ADD', 'event_espresso'),
-                                    '',
-                                    'submit-' . $new_state_submit_id,
-                                    'ee-form-add-new-state-submit button button-secondary',
-                                    '',
-                                    'data-target="' . $new_state_submit_id . '"'
-                                )
-                            )
-                        ),
-                        // extra info
-                        'add_new_state_extra'         => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
-                                EEH_HTML::br(2)
-                                .
-                                EEH_HTML::div('', '', 'small-text')
-                                .
-                                EEH_HTML::strong(
-                                    '* ' .
-                                    esc_html__(
-                                        'Don\'t know your State/Province Abbreviation?',
-                                        'event_espresso'
-                                    )
-                                )
-                                .
-                                EEH_HTML::br()
-                                .
-                                sprintf(
-                                    esc_html__(
-                                        'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
-                                        'event_espresso'
-                                    ),
-                                    EEH_HTML::link(
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        '',
-                                        '',
-                                        'ee-form-add-new-state-wiki-lnk',
-                                        '',
-                                        'target="_blank"'
-                                    )
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                                .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('cancel new State/Province', 'event_espresso'),
-                                    '',
-                                    'hide-' . $input->html_id(),
-                                    'ee-form-cancel-new-state-lnk smaller-text',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                            )
-                        ),
-                    ),
-                )
-            );
-            $question_group_reg_form->add_subsections(
-                array('new_state_micro_form' => $new_state_micro_form),
-                'state',
-                false
-            );
-        }
-        return $question_group_reg_form;
-    }
-
-
-    /**
-     * set_new_state_input_width
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_new_state()
-    {
-        $REQ = EE_Registry::instance()->load_core('Request_Handler');
-        if (absint($REQ->get('nsmf_add_new_state')) === 1) {
-            EE_Registry::instance()->load_model('State');
-            // grab country ISO code, new state name, and new state abbreviation
-            $state_country = $REQ->is_set('nsmf_new_state_country')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_country'))
-                : false;
-            $state_name = $REQ->is_set('nsmf_new_state_name')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_name'))
-                : false;
-            $state_abbr = $REQ->is_set('nsmf_new_state_abbrv')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
-                : false;
-            if ($state_country && $state_name && $state_abbr) {
-                $new_state = EED_Add_New_State::save_new_state_to_db(
-                    array(
-                        'CNT_ISO'    => strtoupper($state_country),
-                        'STA_abbrev' => strtoupper($state_abbr),
-                        'STA_name'   => ucwords($state_name),
-                        'STA_active' => false,
-                    )
-                );
-                if ($new_state instanceof EE_State) {
-                    // clean house
-                    EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
-                    // get any existing new states
-                    $new_states = EE_Registry::instance()->SSN->get_session_data(
-                        'nsmf_new_states'
-                    );
-                    $new_states[ $new_state->ID() ] = $new_state;
-                    EE_Registry::instance()->SSN->set_session_data(
-                        array('nsmf_new_states' => $new_states)
-                    );
-                    if (EE_Registry::instance()->REQ->ajax) {
-                        echo wp_json_encode(
-                            array(
-                                'success'      => true,
-                                'id'           => $new_state->ID(),
-                                'name'         => $new_state->name(),
-                                'abbrev'       => $new_state->abbrev(),
-                                'country_iso'  => $new_state->country_iso(),
-                                'country_name' => $new_state->country()->name(),
-                            )
-                        );
-                        exit();
-                    }
-                    return $new_state->ID();
-                }
-            } else {
-                $error = esc_html__(
-                    'A new State/Province could not be added because invalid or missing data was received.',
-                    'event_espresso'
-                );
-                if (EE_Registry::instance()->REQ->ajax) {
-                    echo wp_json_encode(array('error' => $error));
-                    exit();
-                }
-                EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * recursively drills down through request params to remove any that were added by this module
-     *
-     * @param array $request_params
-     * @return array
-     */
-    public static function filter_checkout_request_params($request_params)
-    {
-        foreach ($request_params as $form_section) {
-            if (is_array($form_section)) {
-                EED_Add_New_State::unset_new_state_request_params($form_section);
-                EED_Add_New_State::filter_checkout_request_params($form_section);
-            }
-        }
-        return $request_params;
-    }
-
-
-    /**
-     * @param array $request_params
-     * @return array
-     */
-    public static function unset_new_state_request_params($request_params)
-    {
-        unset(
-            $request_params['new_state_micro_form'],
-            $request_params['new_state_micro_add_new_state'],
-            $request_params['new_state_micro_new_state_country'],
-            $request_params['new_state_micro_new_state_name'],
-            $request_params['new_state_micro_new_state_abbrv']
-        );
-        return $request_params;
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function save_new_state_to_db($props_n_values = array())
-    {
-        $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
-            return array_pop($existing_state);
-        }
-        $new_state = EE_State::new_instance($props_n_values);
-        if ($new_state instanceof EE_State) {
-            $country_settings_url = add_query_arg(
-                array(
-                    'page'    => 'espresso_general_settings',
-                    'action'  => 'country_settings',
-                    'country' => $new_state->country_iso(),
-                ),
-                admin_url('admin.php')
-            );
-            // if not non-ajax admin
-            new PersistentAdminNotice(
-                'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
-                sprintf(
-                    esc_html__(
-                        'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
-                        'event_espresso'
-                    ),
-                    '<b>' . $new_state->name() . '</b>',
-                    '<b>' . $new_state->abbrev() . '</b>',
-                    '<b>' . $new_state->country()->name() . '</b>',
-                    '<a href="'
-                    . $country_settings_url
-                    . '">'
-                    . esc_html__(
-                        'Event Espresso - General Settings > Countries Tab',
-                        'event_espresso'
-                    )
-                    . '</a>',
-                    '<br />'
-                )
-            );
-            $new_state->save();
-            EEM_State::instance()->reset_cached_states();
-            return $new_state;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $CNT_ISO
-     * @param string $STA_ID
-     * @param array  $cols_n_values
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
-    {
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
-            : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
-            $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-            if ($state instanceof EE_State) {
-                $STA_abbrev = $state->abbrev();
-            }
-        }
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
-    }
-
-
-    /**
-     * @param EE_State[]                            $state_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_state_into_options(
-        $state_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type() === EEM_Question::QST_type_state
-        ) {
-            $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
-                $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-                if ($state instanceof EE_State) {
-                    $country = $state->country();
-                    if ($country instanceof EE_Country) {
-                        if (! isset($state_options[ $country->name() ])) {
-                            $state_options[ $country->name() ] = array();
-                        }
-                        if (! isset($state_options[ $country->name() ][ $STA_ID ])) {
-                            $state_options[ $country->name() ][ $STA_ID ] = $state->name();
-                        }
-                    }
-                }
-            }
-        }
-        return $state_options;
-    }
-
-
-    /**
-     * @param EE_Country[]                          $country_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_country_into_options(
-        $country_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type()
-               === EEM_Question::QST_type_country
-        ) {
-            $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
-                $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-                if ($country instanceof EE_Country) {
-                    if (! isset($country_options[ $CNT_ISO ])) {
-                        $country_options[ $CNT_ISO ] = $country->name();
-                    }
-                }
-            }
-        }
-        return $country_options;
-    }
-
-
-    /**
-     * @param EE_State[] $state_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function state_options($state_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if ($new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $state_options[ $new_state->country()->name() ][ $new_state->ID() ] = $new_state->name();
-            }
-        }
-        return $state_options;
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_new_states()
-    {
-        $new_states = array();
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            $new_states = EE_Registry::instance()->SSN->get_session_data(
-                'nsmf_new_states'
-            );
-        }
-        return is_array($new_states) ? $new_states : array();
-    }
-
-
-    /**
-     * @param EE_Country[] $country_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function country_options($country_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if ($new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $country_options[ $new_state->country()->ID() ] = $new_state->country()->name();
-            }
-        }
-        return $country_options;
-    }
+	/**
+	 * @return EED_Module|EED_Add_New_State
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'),
+			1,
+			1
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'),
+			1,
+			1
+		);
+		add_filter(
+			'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'),
+			10,
+			1
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'),
+			10,
+			5
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'),
+			10,
+			5
+		);
+		add_filter(
+			'FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'),
+			10,
+			1
+		);
+		add_filter(
+			'FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'),
+			1,
+			1
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'),
+			1,
+			1
+		);
+		add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_filter(
+			'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+			array('EED_Add_New_State', 'update_country_settings'),
+			10,
+			3
+		);
+		add_action(
+			'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+			array('EED_Add_New_State', 'update_country_settings'),
+			10,
+			3
+		);
+		add_filter(
+			'FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'),
+			10,
+			1
+		);
+		add_filter(
+			'FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'),
+			10,
+			1
+		);
+		add_filter(
+			'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+			array('EED_Add_New_State', 'filter_checkout_request_params'),
+			10,
+			1
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'),
+			10,
+			5
+		);
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'),
+			10,
+			5
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define(
+			'ANS_TEMPLATES_PATH',
+			str_replace(
+				'\\',
+				DS,
+				plugin_dir_path(__FILE__)
+			) . 'templates' . DS
+		);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ans_no_country'] = esc_html__(
+			'In order to proceed, you need to select the Country that your State/Province belongs to.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_name'] = esc_html__(
+			'In order to proceed, you need to enter the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_abbreviation'] = esc_html__(
+			'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_save_success'] = esc_html__(
+			'The new state was successfully saved to the database.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
+			'An unknown error has occurred on the server while saving the new state to the database.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts()
+	{
+		if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
+			wp_register_script(
+				'add_new_state',
+				ANS_ASSETS_URL . 'add_new_state.js',
+				array('espresso_core', 'single_page_checkout'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('add_new_state');
+		}
+	}
+
+
+
+	/**
+	 * display_add_new_state_micro_form
+	 *
+	 * @param EE_Form_Section_Proper $question_group_reg_form
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
+	{
+		// only add the 'new_state_micro_form' when displaying reg forms,
+		// not during processing since we process the 'new_state_micro_form' in it's own AJAX request
+		$action = EE_Registry::instance()->REQ->get('action', '');
+		// is the "state" question in this form section?
+		$input = $question_group_reg_form->get_subsection('state');
+		if ($action === 'process_reg_step' || $action === 'update_reg_step') {
+			// ok then all we need to do is make sure the input's HTML name is consistent
+			// by forcing it to set it now, like it did while getting the form for display
+			if ($input instanceof EE_State_Select_Input) {
+				$input->html_name();
+			}
+			return $question_group_reg_form;
+		}
+		// we're only doing this for state select inputs
+		if ($input instanceof EE_State_Select_Input
+			&& ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy
+		) {
+			// grab any set values from the request
+			$country_name = str_replace('state', 'nsmf_new_state_country', $input->html_name());
+			$state_name = str_replace('state', 'nsmf_new_state_name', $input->html_name());
+			$abbrv_name = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
+			$new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
+			$country_options = array();
+			$countries = EEM_Country::instance()->get_all_countries();
+			if (! empty($countries)) {
+				foreach ($countries as $country) {
+					if ($country instanceof EE_Country) {
+						$country_options[ $country->ID() ] = $country->name();
+					}
+				}
+			}
+			$new_state_micro_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'new_state_micro_form',
+					'html_id'         => 'new_state_micro_form',
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'subsections'     => array(
+						// add hidden input to indicate that a new state is being added
+						'add_new_state'               => new EE_Hidden_Input(
+							array(
+								'html_name' => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_name()
+								),
+								'html_id'   => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_id()
+								),
+								'default'   => 0,
+							)
+						),
+						// add link for displaying hidden container
+						'click_here_link'             => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
+								EEH_HTML::link(
+									'',
+									esc_html__('click here to add a new state/province', 'event_espresso'),
+									'',
+									'display-' . $input->html_id(),
+									'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+							)
+						),
+						// add initial html for hidden container
+						'add_new_state_micro_form'    => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
+								EEH_HTML::div(
+									'',
+									$input->html_id() . '-dv',
+									'ee-form-add-new-state-dv',
+									'display: none;'
+								) .
+								EEH_HTML::h6(
+									esc_html__(
+										'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::ul() .
+								EEH_HTML::li(
+									esc_html__(
+										'first select the Country that your State/Province belongs to',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(
+									esc_html__('enter the name of your State/Province', 'event_espresso')
+								) .
+								EEH_HTML::li(
+									esc_html__(
+										'enter a two to six letter abbreviation for the name of your State/Province',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+								EEH_HTML::ulx()
+							)
+						),
+						// NEW STATE COUNTRY
+						'new_state_country'           => new EE_Country_Select_Input(
+							$country_options,
+							array(
+								'html_name'       => $country_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_country',
+									$input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-country',
+								'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
+								'required'        => false,
+							)
+						),
+						// NEW STATE NAME
+						'new_state_name'              => new EE_Text_Input(
+							array(
+								'html_name'       => $state_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_name',
+									$input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-state',
+								'html_label_text' => esc_html__(
+									'New State/Province Name',
+									'event_espresso'
+								),
+								'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
+								'required'        => false,
+							)
+						),
+						'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
+						// NEW STATE NAME
+						'new_state_abbrv'             => new EE_Text_Input(
+							array(
+								'html_name'             => $abbrv_name,
+								'html_id'               => str_replace(
+									'state',
+									'nsmf_new_state_abbrv',
+									$input->html_id()
+								),
+								'html_class'            => $input->html_class() . ' new-state-abbrv',
+								'html_label_text'       => esc_html__(
+									'New State/Province Abbreviation',
+									'event_espresso'
+								) . ' *',
+								'html_other_attributes' => 'size="24"',
+								'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
+								'required'              => false,
+							)
+						),
+						// "submit" button
+						'add_new_state_submit_button' => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
+								EEH_HTML::nbsp(3) .
+								EEH_HTML::link(
+									'',
+									esc_html__('ADD', 'event_espresso'),
+									'',
+									'submit-' . $new_state_submit_id,
+									'ee-form-add-new-state-submit button button-secondary',
+									'',
+									'data-target="' . $new_state_submit_id . '"'
+								)
+							)
+						),
+						// extra info
+						'add_new_state_extra'         => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
+								EEH_HTML::br(2)
+								.
+								EEH_HTML::div('', '', 'small-text')
+								.
+								EEH_HTML::strong(
+									'* ' .
+									esc_html__(
+										'Don\'t know your State/Province Abbreviation?',
+										'event_espresso'
+									)
+								)
+								.
+								EEH_HTML::br()
+								.
+								sprintf(
+									esc_html__(
+										'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
+										'event_espresso'
+									),
+									EEH_HTML::link(
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'',
+										'',
+										'ee-form-add-new-state-wiki-lnk',
+										'',
+										'target="_blank"'
+									)
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+								.
+								EEH_HTML::link(
+									'',
+									esc_html__('cancel new State/Province', 'event_espresso'),
+									'',
+									'hide-' . $input->html_id(),
+									'ee-form-cancel-new-state-lnk smaller-text',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+							)
+						),
+					),
+				)
+			);
+			$question_group_reg_form->add_subsections(
+				array('new_state_micro_form' => $new_state_micro_form),
+				'state',
+				false
+			);
+		}
+		return $question_group_reg_form;
+	}
+
+
+	/**
+	 * set_new_state_input_width
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_new_state()
+	{
+		$REQ = EE_Registry::instance()->load_core('Request_Handler');
+		if (absint($REQ->get('nsmf_add_new_state')) === 1) {
+			EE_Registry::instance()->load_model('State');
+			// grab country ISO code, new state name, and new state abbreviation
+			$state_country = $REQ->is_set('nsmf_new_state_country')
+				? sanitize_text_field($REQ->get('nsmf_new_state_country'))
+				: false;
+			$state_name = $REQ->is_set('nsmf_new_state_name')
+				? sanitize_text_field($REQ->get('nsmf_new_state_name'))
+				: false;
+			$state_abbr = $REQ->is_set('nsmf_new_state_abbrv')
+				? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
+				: false;
+			if ($state_country && $state_name && $state_abbr) {
+				$new_state = EED_Add_New_State::save_new_state_to_db(
+					array(
+						'CNT_ISO'    => strtoupper($state_country),
+						'STA_abbrev' => strtoupper($state_abbr),
+						'STA_name'   => ucwords($state_name),
+						'STA_active' => false,
+					)
+				);
+				if ($new_state instanceof EE_State) {
+					// clean house
+					EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
+					// get any existing new states
+					$new_states = EE_Registry::instance()->SSN->get_session_data(
+						'nsmf_new_states'
+					);
+					$new_states[ $new_state->ID() ] = $new_state;
+					EE_Registry::instance()->SSN->set_session_data(
+						array('nsmf_new_states' => $new_states)
+					);
+					if (EE_Registry::instance()->REQ->ajax) {
+						echo wp_json_encode(
+							array(
+								'success'      => true,
+								'id'           => $new_state->ID(),
+								'name'         => $new_state->name(),
+								'abbrev'       => $new_state->abbrev(),
+								'country_iso'  => $new_state->country_iso(),
+								'country_name' => $new_state->country()->name(),
+							)
+						);
+						exit();
+					}
+					return $new_state->ID();
+				}
+			} else {
+				$error = esc_html__(
+					'A new State/Province could not be added because invalid or missing data was received.',
+					'event_espresso'
+				);
+				if (EE_Registry::instance()->REQ->ajax) {
+					echo wp_json_encode(array('error' => $error));
+					exit();
+				}
+				EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * recursively drills down through request params to remove any that were added by this module
+	 *
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function filter_checkout_request_params($request_params)
+	{
+		foreach ($request_params as $form_section) {
+			if (is_array($form_section)) {
+				EED_Add_New_State::unset_new_state_request_params($form_section);
+				EED_Add_New_State::filter_checkout_request_params($form_section);
+			}
+		}
+		return $request_params;
+	}
+
+
+	/**
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function unset_new_state_request_params($request_params)
+	{
+		unset(
+			$request_params['new_state_micro_form'],
+			$request_params['new_state_micro_add_new_state'],
+			$request_params['new_state_micro_new_state_country'],
+			$request_params['new_state_micro_new_state_name'],
+			$request_params['new_state_micro_new_state_abbrv']
+		);
+		return $request_params;
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function save_new_state_to_db($props_n_values = array())
+	{
+		$existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
+		if (! empty($existing_state)) {
+			return array_pop($existing_state);
+		}
+		$new_state = EE_State::new_instance($props_n_values);
+		if ($new_state instanceof EE_State) {
+			$country_settings_url = add_query_arg(
+				array(
+					'page'    => 'espresso_general_settings',
+					'action'  => 'country_settings',
+					'country' => $new_state->country_iso(),
+				),
+				admin_url('admin.php')
+			);
+			// if not non-ajax admin
+			new PersistentAdminNotice(
+				'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
+				sprintf(
+					esc_html__(
+						'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
+						'event_espresso'
+					),
+					'<b>' . $new_state->name() . '</b>',
+					'<b>' . $new_state->abbrev() . '</b>',
+					'<b>' . $new_state->country()->name() . '</b>',
+					'<a href="'
+					. $country_settings_url
+					. '">'
+					. esc_html__(
+						'Event Espresso - General Settings > Countries Tab',
+						'event_espresso'
+					)
+					. '</a>',
+					'<br />'
+				)
+			);
+			$new_state->save();
+			EEM_State::instance()->reset_cached_states();
+			return $new_state;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $CNT_ISO
+	 * @param string $STA_ID
+	 * @param array  $cols_n_values
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
+	{
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
+			: false;
+		if (! $STA_abbrev && ! empty($STA_ID)) {
+			$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+			if ($state instanceof EE_State) {
+				$STA_abbrev = $state->abbrev();
+			}
+		}
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
+	}
+
+
+	/**
+	 * @param EE_State[]                            $state_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_state_into_options(
+		$state_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type() === EEM_Question::QST_type_state
+		) {
+			$STA_ID = $answer->value();
+			if (! empty($STA_ID)) {
+				$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+				if ($state instanceof EE_State) {
+					$country = $state->country();
+					if ($country instanceof EE_Country) {
+						if (! isset($state_options[ $country->name() ])) {
+							$state_options[ $country->name() ] = array();
+						}
+						if (! isset($state_options[ $country->name() ][ $STA_ID ])) {
+							$state_options[ $country->name() ][ $STA_ID ] = $state->name();
+						}
+					}
+				}
+			}
+		}
+		return $state_options;
+	}
+
+
+	/**
+	 * @param EE_Country[]                          $country_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_country_into_options(
+		$country_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type()
+			   === EEM_Question::QST_type_country
+		) {
+			$CNT_ISO = $answer->value();
+			if (! empty($CNT_ISO)) {
+				$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+				if ($country instanceof EE_Country) {
+					if (! isset($country_options[ $CNT_ISO ])) {
+						$country_options[ $CNT_ISO ] = $country->name();
+					}
+				}
+			}
+		}
+		return $country_options;
+	}
+
+
+	/**
+	 * @param EE_State[] $state_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function state_options($state_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if ($new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$state_options[ $new_state->country()->name() ][ $new_state->ID() ] = $new_state->name();
+			}
+		}
+		return $state_options;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_new_states()
+	{
+		$new_states = array();
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			$new_states = EE_Registry::instance()->SSN->get_session_data(
+				'nsmf_new_states'
+			);
+		}
+		return is_array($new_states) ? $new_states : array();
+	}
+
+
+	/**
+	 * @param EE_Country[] $country_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function country_options($country_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if ($new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$country_options[ $new_state->country()->ID() ] = $new_state->country()->name();
+			}
+		}
+		return $country_options;
+	}
 }

Spacing +45 added lines, -45 removed lines

@@ -159,14 +159,14 @@ 
      */
     public static function set_definitions()
     {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
         define(
             'ANS_TEMPLATES_PATH',
             str_replace(
                 '\\',
                 DS,
                 plugin_dir_path(__FILE__)
-            ) . 'templates' . DS
+            ).'templates'.DS
         );
     }
 
@@ -216,7 +216,7 @@ 
         if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
             wp_register_script(
                 'add_new_state',
-                ANS_ASSETS_URL . 'add_new_state.js',
+                ANS_ASSETS_URL.'add_new_state.js',
                 array('espresso_core', 'single_page_checkout'),
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -263,10 +263,10 @@ 
             $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
             $country_options = array();
             $countries = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
+            if ( ! empty($countries)) {
                 foreach ($countries as $country) {
                     if ($country instanceof EE_Country) {
-                        $country_options[ $country->ID() ] = $country->name();
+                        $country_options[$country->ID()] = $country->name();
                     }
                 }
             }
@@ -300,10 +300,10 @@ 
                                     '',
                                     esc_html__('click here to add a new state/province', 'event_espresso'),
                                     '',
-                                    'display-' . $input->html_id(),
+                                    'display-'.$input->html_id(),
                                     'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                             )
                         ),
@@ -313,33 +313,33 @@ 
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
                                 EEH_HTML::div(
                                     '',
-                                    $input->html_id() . '-dv',
+                                    $input->html_id().'-dv',
                                     'ee-form-add-new-state-dv',
                                     'display: none;'
-                                ) .
+                                ).
                                 EEH_HTML::h6(
                                     esc_html__(
                                         'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::ul() .
+                                ).
+                                EEH_HTML::ul().
                                 EEH_HTML::li(
                                     esc_html__(
                                         'first select the Country that your State/Province belongs to',
                                         'event_espresso'
                                     )
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__(
                                         'enter a two to six letter abbreviation for the name of your State/Province',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+                                ).
+                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')).
                                 EEH_HTML::ulx()
                             )
                         ),
@@ -353,7 +353,7 @@ 
                                     'nsmf_new_state_country',
                                     $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
+                                'html_class'      => $input->html_class().' new-state-country',
                                 'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
                                 'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
                                 'required'        => false,
@@ -368,7 +368,7 @@ 
                                     'nsmf_new_state_name',
                                     $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
+                                'html_class'      => $input->html_class().' new-state-state',
                                 'html_label_text' => esc_html__(
                                     'New State/Province Name',
                                     'event_espresso'
@@ -387,11 +387,11 @@ 
                                     'nsmf_new_state_abbrv',
                                     $input->html_id()
                                 ),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
+                                'html_class'            => $input->html_class().' new-state-abbrv',
                                 'html_label_text'       => esc_html__(
                                     'New State/Province Abbreviation',
                                     'event_espresso'
-                                ) . ' *',
+                                ).' *',
                                 'html_other_attributes' => 'size="24"',
                                 'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
                                 'required'              => false,
@@ -401,15 +401,15 @@ 
                         'add_new_state_submit_button' => new EE_Form_Section_HTML(
                             apply_filters(
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
+                                EEH_HTML::nbsp(3).
                                 EEH_HTML::link(
                                     '',
                                     esc_html__('ADD', 'event_espresso'),
                                     '',
-                                    'submit-' . $new_state_submit_id,
+                                    'submit-'.$new_state_submit_id,
                                     'ee-form-add-new-state-submit button button-secondary',
                                     '',
-                                    'data-target="' . $new_state_submit_id . '"'
+                                    'data-target="'.$new_state_submit_id.'"'
                                 )
                             )
                         ),
@@ -422,7 +422,7 @@ 
                                 EEH_HTML::div('', '', 'small-text')
                                 .
                                 EEH_HTML::strong(
-                                    '* ' .
+                                    '* '.
                                     esc_html__(
                                         'Don\'t know your State/Province Abbreviation?',
                                         'event_espresso'
@@ -455,10 +455,10 @@ 
                                     '',
                                     esc_html__('cancel new State/Province', 'event_espresso'),
                                     '',
-                                    'hide-' . $input->html_id(),
+                                    'hide-'.$input->html_id(),
                                     'ee-form-cancel-new-state-lnk smaller-text',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                                 .
                                 EEH_HTML::divx()
@@ -523,7 +523,7 @@ 
                     $new_states = EE_Registry::instance()->SSN->get_session_data(
                         'nsmf_new_states'
                     );
-                    $new_states[ $new_state->ID() ] = $new_state;
+                    $new_states[$new_state->ID()] = $new_state;
                     EE_Registry::instance()->SSN->set_session_data(
                         array('nsmf_new_states' => $new_states)
                     );
@@ -604,7 +604,7 @@ 
     public static function save_new_state_to_db($props_n_values = array())
     {
         $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
+        if ( ! empty($existing_state)) {
             return array_pop($existing_state);
         }
         $new_state = EE_State::new_instance($props_n_values);
@@ -619,15 +619,15 @@ 
             );
             // if not non-ajax admin
             new PersistentAdminNotice(
-                'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
+                'new-state-added-'.$new_state->country_iso().'-'.$new_state->abbrev(),
                 sprintf(
                     esc_html__(
                         'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
                         'event_espresso'
                     ),
-                    '<b>' . $new_state->name() . '</b>',
-                    '<b>' . $new_state->abbrev() . '</b>',
-                    '<b>' . $new_state->country()->name() . '</b>',
+                    '<b>'.$new_state->name().'</b>',
+                    '<b>'.$new_state->abbrev().'</b>',
+                    '<b>'.$new_state->country()->name().'</b>',
                     '<a href="'
                     . $country_settings_url
                     . '">'
@@ -660,7 +660,7 @@ 
      */
     public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
     {
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
                 __FILE__,
@@ -670,13 +670,13 @@ 
         }
         $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
             : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
+        if ( ! $STA_abbrev && ! empty($STA_ID)) {
             $state = EEM_State::instance()->get_one_by_ID($STA_ID);
             if ($state instanceof EE_State) {
                 $STA_abbrev = $state->abbrev();
             }
         }
-        if (! $STA_abbrev) {
+        if ( ! $STA_abbrev) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
                 __FILE__,
@@ -688,7 +688,7 @@ 
         $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
             'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
         );
-        $persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
+        $persistent_admin_notice_manager->dismissNotice($CNT_ISO.'-'.$STA_abbrev, true, true);
     }
 
 
@@ -715,16 +715,16 @@ 
             && $question->type() === EEM_Question::QST_type_state
         ) {
             $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
+            if ( ! empty($STA_ID)) {
                 $state = EEM_State::instance()->get_one_by_ID($STA_ID);
                 if ($state instanceof EE_State) {
                     $country = $state->country();
                     if ($country instanceof EE_Country) {
-                        if (! isset($state_options[ $country->name() ])) {
-                            $state_options[ $country->name() ] = array();
+                        if ( ! isset($state_options[$country->name()])) {
+                            $state_options[$country->name()] = array();
                         }
-                        if (! isset($state_options[ $country->name() ][ $STA_ID ])) {
-                            $state_options[ $country->name() ][ $STA_ID ] = $state->name();
+                        if ( ! isset($state_options[$country->name()][$STA_ID])) {
+                            $state_options[$country->name()][$STA_ID] = $state->name();
                         }
                     }
                 }
@@ -758,11 +758,11 @@ 
                === EEM_Question::QST_type_country
         ) {
             $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
+            if ( ! empty($CNT_ISO)) {
                 $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
                 if ($country instanceof EE_Country) {
-                    if (! isset($country_options[ $CNT_ISO ])) {
-                        $country_options[ $CNT_ISO ] = $country->name();
+                    if ( ! isset($country_options[$CNT_ISO])) {
+                        $country_options[$CNT_ISO] = $country->name();
                     }
                 }
             }
@@ -786,7 +786,7 @@ 
             if ($new_state instanceof EE_State
                 && $new_state->country() instanceof EE_Country
             ) {
-                $state_options[ $new_state->country()->name() ][ $new_state->ID() ] = $new_state->name();
+                $state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
             }
         }
         return $state_options;
@@ -826,7 +826,7 @@ 
             if ($new_state instanceof EE_State
                 && $new_state->country() instanceof EE_Country
             ) {
-                $country_options[ $new_state->country()->ID() ] = $new_state->country()->name();
+                $country_options[$new_state->country()->ID()] = $new_state->country()->name();
             }
         }
         return $country_options;

modules/certificate/EED_Certificate.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
      *    the_content
      *
      * @access    public
-     * @return    void
+     * @return    string
      */
     public function the_content($content)
     {

Indentation +78 added lines, -78 removed lines

@@ -12,95 +12,95 @@
 {
 
 
-    /**
-     * @return EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
 
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
 
 
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
-    /**
-     *    certificate_launch
-     *
-     * @access    public
-     * @return    void
-     */
-    public function certificate_launch()
-    {
-        if (EE_Registry::instance()->REQ->is_set('id') && EE_Registry::instance()->REQ->is_set('r_id')) {
-            echo espresso_certificate_launch(
-                EE_Registry::instance()->REQ->get('id'),
-                EE_Registry::instance()->REQ->get('r_id')
-            );
-        }
-    }
+	/**
+	 *    certificate_launch
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function certificate_launch()
+	{
+		if (EE_Registry::instance()->REQ->is_set('id') && EE_Registry::instance()->REQ->is_set('r_id')) {
+			echo espresso_certificate_launch(
+				EE_Registry::instance()->REQ->get('id'),
+				EE_Registry::instance()->REQ->get('r_id')
+			);
+		}
+	}
 
 
-    /**
-     *    wp_loaded
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
+	/**
+	 *    wp_loaded
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
 
 
-    /**
-     *    wp
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
+	/**
+	 *    wp
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
 
 
-    /**
-     *    the_content
-     *
-     * @access    public
-     * @return    void
-     */
-    public function the_content($content)
-    {
-        $content .= $this->ouput;
-        return $content;
-    }
+	/**
+	 *    the_content
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function the_content($content)
+	{
+		$content .= $this->ouput;
+		return $content;
+	}
 }

modules/events_archive_filters/EED_Events_Archive_Filters.module.php

Doc Comments +14 added lines, -13 removed lines

@@ -247,6 +247,7 @@ 
      * @access    public
      * @param    mixed boolean|string    $join_terms pass TRUE or term string, doesn't really matter since this value
      *                                   doesn't really get used for anything yet
+     * @param string $join_terms
      * @return    string
      */
     public static function posts_join_sql_for_terms($join_terms = null)
@@ -422,7 +423,7 @@ 
      *    or else some of the table references below will result in MySQL errors
      *
      * @access    public
-     * @param    boolean $orderby_params
+     * @param    string[] $orderby_params
      * @return    string
      */
     public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
@@ -535,7 +536,7 @@ 
      *
      * @access    public
      * @param        string $content
-     * @return        void
+     * @return        string
      */
     public function event_details($content)
     {
@@ -552,7 +553,7 @@ 
      *
      * @access    public
      * @param        string $content
-     * @return        void
+     * @return        string
      */
     public function event_tickets($content)
     {
@@ -569,7 +570,7 @@ 
      *
      * @access    public
      * @param        string $content
-     * @return        void
+     * @return        string
      */
     public function event_datetimes($content)
     {
@@ -586,7 +587,7 @@ 
      *
      * @access    public
      * @param        string $content
-     * @return        void
+     * @return        string
      */
     public function event_venues($content)
     {
@@ -635,7 +636,7 @@ 
      *    excerpt_length
      *
      * @access    public
-     * @return    void
+     * @return    integer|null
      */
     public function excerpt_length($length)
     {
@@ -665,7 +666,7 @@ 
      *    excerpt_more
      *
      * @access    public
-     * @return    void
+     * @return    string
      */
     public function excerpt_more($more)
     {
@@ -866,7 +867,7 @@ 
      *    get_template_part
      *
      * @access    public
-     * @return    void
+     * @return    string|null
      */
     public static function get_template_part()
     {
@@ -910,7 +911,7 @@ 
      *    event_list_css
      *
      * @access    public
-     * @return    void
+     * @return    string
      */
     public static function event_list_css($extra_class = '')
     {
@@ -946,7 +947,7 @@ 
      *    display_description
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public static function display_description($value)
     {
@@ -961,7 +962,7 @@ 
      *    display_venue_details
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public static function display_venue_details()
     {
@@ -977,7 +978,7 @@ 
      *    display_address
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public static function display_address()
     {
@@ -993,7 +994,7 @@ 
      *    pagination
      *
      * @access    public
-     * @return    void
+     * @return    string
      */
     public static function pagination()
     {

Indentation +1021 added lines, -1021 removed lines

@@ -12,1025 +12,1025 @@
 {
 
 
-    /**
-     * @return EED_Events_Archive_Filters
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    Start Date
-     *
-     * @var    $_elf_month
-     * @access    protected
-     */
-    protected $_elf_month = null;
-
-
-    /**
-     *    Category
-     *
-     * @var    $_elf_category
-     * @access    protected
-     */
-    protected $_elf_category = null;
-
-
-    /**
-     *    whether to display expired events in the event list
-     *
-     * @var    $_show_expired
-     * @access    protected
-     */
-    protected $_show_expired = null;
-
-
-    /**
-     *    whether to display the event list as a grid or list
-     *
-     * @var    $_type
-     * @access    protected
-     */
-    protected static $_type = null;
-
-
-    /**
-     *    array of existing event list views
-     *
-     * @var    $_types
-     * @access    protected
-     */
-    protected static $_types = array('grid', 'text', 'dates');
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_definitions()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     *    event_list
-     *
-     * @access    public
-     * @return    void
-     */
-    public function event_list()
-    {
-        // load other required components
-        $this->_load_assests();
-    }
-
-
-    /**
-     *    _filter_query_parts
-     *
-     * @access    public
-     * @return    void
-     */
-    private function _filter_query_parts()
-    {
-        // build event list query
-        add_filter('posts_join', array($this, 'posts_join'), 1, 2);
-        add_filter('posts_where', array($this, 'posts_where'), 1, 2);
-        add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
-    }
-
-    /**
-     *    _type - the type of event list : grid, text, dates
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function set_type()
-    {
-        do_action('AHEE__EED_Events_Archive_Filters__before_set_type');
-        EED_Events_Archive_Filters::$_types = apply_filters(
-            'EED_Events_Archive_Filters__set_type__types',
-            EED_Events_Archive_Filters::$_types
-        );
-        $view = isset(EE_Registry::instance()->CFG->EED_Events_Archive_Filters['default_type']) ? EE_Registry::instance(
-        )->CFG->EED_Events_Archive_Filters['default_type'] : 'grid';
-        $elf_type = EE_Registry::instance()->REQ->is_set('elf_type') ? sanitize_text_field(
-            EE_Registry::instance()->REQ->get('elf_type')
-        ) : '';
-        $view = ! empty($elf_type) ? $elf_type : $view;
-        $view = apply_filters('EED_Events_Archive_Filters__set_type__type', $view);
-        if (! empty($view) && in_array($view, EED_Events_Archive_Filters::$_types)) {
-            self::$_type = $view;
-        }
-    }
-
-    /**
-     *    _show_expired
-     *
-     * @access    private
-     * @param    boolean $req_only if TRUE, then ignore defaults and only return $_POST value
-     * @return    boolean
-     */
-    private static function _show_expired($req_only = false)
-    {
-        // get default value for "display_expired_events" as set in the EE General Settings > Templates > Event Listings
-        $show_expired = ! $req_only && isset(
-            EE_Registry::instance()->CFG->EED_Events_Archive_Filters['display_expired_events']
-        ) ? EE_Registry::instance()->CFG->EED_Events_Archive_Filters['display_expired_events'] : false;
-        // override default expired option if set via filter
-        $show_expired = EE_Registry::instance()->REQ->is_set('elf_expired_chk') ? absint(
-            EE_Registry::instance()->REQ->get('elf_expired_chk')
-        ) : $show_expired;
-        return $show_expired ? true : false;
-    }
-
-    /**
-     *    _event_category_slug
-     *
-     * @access    private
-     * @return    string
-     */
-    private static function _event_category_slug()
-    {
-        return EE_Registry::instance()->REQ->is_set('elf_category_dd') ? sanitize_text_field(
-            EE_Registry::instance()->REQ->get('elf_category_dd')
-        ) : '';
-    }
-
-    /**
-     *    _display_month - what month should the event list display events for?
-     *
-     * @access    private
-     * @return    string
-     */
-    private static function _display_month()
-    {
-        return EE_Registry::instance()->REQ->is_set('elf_month_dd') ? sanitize_text_field(
-            EE_Registry::instance()->REQ->get('elf_month_dd')
-        ) : '';
-    }
-
-
-    /**
-     *    get_post_data
-     *
-     * @access    public
-     * @return    void
-     */
-    public function get_post_data()
-    {
-        $this->_elf_month = EED_Events_Archive_Filters::_display_month();
-        $this->_elf_category = EED_Events_Archive_Filters::_event_category_slug();
-        $this->_show_expired = EED_Events_Archive_Filters::_show_expired(true);
-    }
-
-
-    /**
-     *    posts_join
-     *
-     * @access    public
-     * @return    void
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        if (isset($wp_query->query) && isset($wp_query->query['post_type']) && $wp_query->query['post_type'] == 'espresso_events') {
-            // Category
-            $SQL .= EED_Events_Archive_Filters::posts_join_sql_for_terms(
-                EED_Events_Archive_Filters::_event_category_slug()
-            );
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_join_sql_for_terms
-     *
-     * @access    public
-     * @param    mixed boolean|string    $join_terms pass TRUE or term string, doesn't really matter since this value
-     *                                   doesn't really get used for anything yet
-     * @return    string
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        $SQL = '';
-        if (! empty($join_terms)) {
-            global $wpdb;
-            $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
-            $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
-            $SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_join_for_orderby
-     *    usage:  $SQL .= EED_Events_Archive_Filters::posts_join_for_orderby( $orderby_params );
-     *
-     * @access    public
-     * @param    array $orderby_params
-     * @return    string
-     */
-    public static function posts_join_for_orderby($orderby_params = array())
-    {
-        global $wpdb;
-        $SQL = '';
-        $orderby_params = is_array($orderby_params) ? $orderby_params : array($orderby_params);
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                case 'ticket_end':
-                    $SQL .= ' LEFT JOIN ' . EEM_Datetime_Ticket::instance()->table() . ' ON ('
-                            . EEM_Datetime::instance()->table() . '.DTT_ID = '
-                            . EEM_Datetime_Ticket::instance()->table() . '.DTT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table() . ' ON ('
-                            . EEM_Datetime_Ticket::instance()->table() . '.TKT_ID = '
-                            . EEM_Ticket::instance()->table() . '.TKT_ID )';
-                    break;
-
-                case 'venue_title':
-                case 'city':
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
-                            . EEM_Event_Venue::instance()->table() . '.EVT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Venue::instance()->table() . ' ON ('
-                            . EEM_Event_Venue::instance()->table() . '.VNU_ID = '
-                            . EEM_Venue::instance()->table() . '.VNU_ID )';
-                    break;
-
-                case 'state':
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
-                            . EEM_Event_Venue::instance()->table() . '.EVT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->second_table() . ' ON ('
-                            . EEM_Event_Venue::instance()->table() . '.VNU_ID = '
-                            . EEM_Event_Venue::instance()->second_table() . '.VNU_ID )';
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_where
-     *
-     * @access    public
-     * @return    void
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        if (isset($wp_query->query_vars) && isset($wp_query->query_vars['post_type']) && $wp_query->query_vars['post_type'] == 'espresso_events') {
-            // Show Expired ?
-            $SQL .= EED_Events_Archive_Filters::posts_where_sql_for_show_expired(
-                EED_Events_Archive_Filters::_show_expired()
-            );
-            // Category
-            // $elf_category = EED_Events_Archive_Filters::_event_category_slug();
-            $SQL .= EED_Events_Archive_Filters::posts_where_sql_for_event_category_slug(
-                EED_Events_Archive_Filters::_event_category_slug()
-            );
-            // Start Date
-            // $elf_month = EED_Events_Archive_Filters::_display_month();
-            $SQL .= EED_Events_Archive_Filters::posts_where_sql_for_event_list_month(
-                EED_Events_Archive_Filters::_display_month()
-            );
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_where_sql_for_show_expired
-     *
-     * @access    public
-     * @param    boolean $show_expired if TRUE, then displayed past events
-     * @return    string
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > "' . date('Y-m-d H:s:i') . '" '
-            : '';
-    }
-
-
-    /**
-     *    posts_where_sql_for_event_category_slug
-     *
-     * @access    public
-     * @param    boolean $event_category_slug
-     * @return    string
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        global $wpdb;
-        return ! empty($event_category_slug) ? ' AND ' . $wpdb->terms . '.slug = "' . $event_category_slug . '" ' : '';
-    }
-
-    /**
-     *    posts_where_sql_for_event_list_month
-     *
-     * @access    public
-     * @param    boolean $month
-     * @return    string
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        $SQL = '';
-        if (! empty($month)) {
-            // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start';
-            $SQL .= ' <= "' . date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '"';
-            // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end';
-            $SQL .= ' >= "' . date('Y-m-d 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '" ';
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_orderby
-     *
-     * @access    public
-     * @return    void
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if (isset($wp_query->query) && isset($wp_query->query['post_type']) && $wp_query->query['post_type'] == 'espresso_events') {
-            $SQL = EED_Events_Archive_Filters::posts_orderby_sql(array('start_date'));
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_orderby_sql
-     *
-     *    possible parameters:
-     *    ID
-     *    start_date
-     *    end_date
-     *    event_name
-     *    category_slug
-     *    ticket_start
-     *    ticket_end
-     *    venue_title
-     *    city
-     *    state
-     *
-     *    **IMPORTANT**
-     *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
-     *    or else some of the table references below will result in MySQL errors
-     *
-     * @access    public
-     * @param    boolean $orderby_params
-     * @return    string
-     */
-    public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
-    {
-        global $wpdb;
-        $SQL = '';
-        $cntr = 1;
-        $orderby_params = is_array($orderby_params) ? $orderby_params : array($orderby_params);
-        foreach ($orderby_params as $orderby) {
-            $glue = $cntr == 1 || $cntr == count($orderby_params) ? ' ' : ', ';
-            switch ($orderby) {
-                case 'id':
-                case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
-                    break;
-
-                case 'start_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_start ' . $sort;
-                    break;
-
-                case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
-                    break;
-
-                case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
-                    break;
-
-                case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
-                    break;
-
-                case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
-                    break;
-
-                case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
-                    break;
-
-                case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
-                    break;
-
-                case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
-                    break;
-
-                case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
-                    break;
-            }
-            $cntr++;
-        }
-        // echo '<h4>$SQL : ' . $SQL . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-        return $SQL;
-    }
-
-
-    /**
-     *    template_redirect
-     *
-     * @access    public
-     * @return    void
-     */
-    public function template_redirect()
-    {
-        // add event list filters
-        add_action('loop_start', array($this, 'event_list_template_filters'));
-        // and pagination
-        add_action('loop_start', array($this, 'event_list_pagination'));
-        add_action('loop_end', array($this, 'event_list_pagination'));
-        // if NOT a custom template
-        if (EE_Registry::instance()
-                       ->load_core('Front_Controller', array(), false, true)
-                       ->get_selected_template() != 'archive-espresso_events.php'
-        ) {
-            // don't know if theme uses the_excerpt
-            add_filter('the_excerpt', array($this, 'event_details'), 100);
-            add_filter('the_excerpt', array($this, 'event_tickets'), 110);
-            add_filter('the_excerpt', array($this, 'event_datetimes'), 120);
-            add_filter('the_excerpt', array($this, 'event_venues'), 130);
-            // or the_content
-            add_filter('the_content', array($this, 'event_details'), 100);
-            add_filter('the_content', array($this, 'event_tickets'), 110);
-            add_filter('the_content', array($this, 'event_datetimes'), 120);
-            add_filter('the_content', array($this, 'event_venues'), 130);
-        } else {
-            remove_all_filters('excerpt_length');
-            add_filter('excerpt_length', array($this, 'excerpt_length'), 10);
-            add_filter('excerpt_more', array($this, 'excerpt_more'), 10);
-        }
-    }
-
-
-    /**
-     *    event_list_pagination
-     *
-     * @access    public
-     * @return        void
-     */
-    public function event_list_pagination()
-    {
-        echo '<div class="ee-pagination-dv ee-clear-float">' . espresso_event_list_pagination() . '</div>';
-    }
-
-
-    /**
-     *    event_details
-     *
-     * @access    public
-     * @param        string $content
-     * @return        void
-     */
-    public function event_details($content)
-    {
-        return EEH_Template::display_template(
-            EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-details.php',
-            array('the_content' => $content),
-            true
-        );
-    }
-
-
-    /**
-     *    event_tickets
-     *
-     * @access    public
-     * @param        string $content
-     * @return        void
-     */
-    public function event_tickets($content)
-    {
-        return $content
-               . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-tickets.php',
-                   array(),
-                   true
-               );
-    }
-
-    /**
-     *    event_datetimes
-     *
-     * @access    public
-     * @param        string $content
-     * @return        void
-     */
-    public function event_datetimes($content)
-    {
-        return $content
-               . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-datetimes.php',
-                   array(),
-                   true
-               );
-    }
-
-    /**
-     *    event_venues
-     *
-     * @access    public
-     * @param        string $content
-     * @return        void
-     */
-    public function event_venues($content)
-    {
-        return $content
-               . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-venues.php',
-                   array(),
-                   true
-               );
-    }
-
-
-    /**
-     *    _initial_setup
-     *
-     * @access    public
-     * @return    void
-     */
-    private function _load_assests()
-    {
-        do_action('AHEE__EED_Events_Archive_Filters__before_load_assests');
-        wp_enqueue_style('espresso_default');
-        wp_enqueue_style('espresso_custom_css');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-        }
-        // add_filter( 'the_excerpt', array( $this, 'the_excerpt' ), 999 );
-    }
-
-
-    /**
-     *    _get_template
-     *
-     * @access    private
-     * @return    string
-     */
-    private function _get_template($which = 'part')
-    {
-        return EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
-    }
-
-
-    /**
-     *    excerpt_length
-     *
-     * @access    public
-     * @return    void
-     */
-    public function excerpt_length($length)
-    {
-
-        if (self::$_type == 'grid') {
-            return 36;
-        }
-
-        switch (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size) {
-            case 'tiny':
-                return 12;
-                break;
-            case 'small':
-                return 24;
-                break;
-            case 'large':
-                return 48;
-                break;
-            case 'medium':
-            default:
-                return 36;
-        }
-    }
-
-
-    /**
-     *    excerpt_more
-     *
-     * @access    public
-     * @return    void
-     */
-    public function excerpt_more($more)
-    {
-        return '&hellip;';
-    }
-
-
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (is_readable(
-                get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css'
-            )) {
-                wp_register_style(
-                    'archive-espresso_events',
-                    get_stylesheet_directory_uri() . EE_Config::get_current_theme(
-                    ) . DS . 'archive-espresso_events.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-                wp_register_style(
-                    'archive-espresso_events',
-                    EE_TEMPLATES_URL . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css',
-                    array('dashicons', 'espresso_default')
-                );
-            }
-            if (is_readable(
-                get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js'
-            )) {
-                wp_register_script(
-                    'archive-espresso_events',
-                    get_stylesheet_directory_uri() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js',
-                    array('jquery-masonry'),
-                    '1.0',
-                    true
-                );
-            } else {
-                wp_register_script(
-                    'archive-espresso_events',
-                    EVENTS_ARCHIVE_ASSETS_URL . 'archive-espresso_events.js',
-                    array('jquery-masonry'),
-                    '1.0',
-                    true
-                );
-            }
-            wp_enqueue_style('archive-espresso_events');
-            wp_enqueue_script('jquery-masonry');
-            wp_enqueue_script('archive-espresso_events');
-            add_action('wp_footer', array('EED_Events_Archive_Filters', 'localize_grid_event_lists'), 1);
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function localize_grid_event_lists()
-    {
-        wp_localize_script(
-            'archive-espresso_events',
-            'espresso_grid_event_lists',
-            EED_Events_Archive_Filters::$espresso_grid_event_lists
-        );
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function template_settings_form()
-    {
-        $EE = EE_Registry::instance();
-        $EE->CFG->template_settings->EED_Events_Archive_Filters = isset($EE->CFG->template_settings->EED_Events_Archive_Filters)
-            ? $EE->CFG->template_settings->EED_Events_Archive_Filters : new EE_Events_Archive_Config();
-        $EE->CFG->template_settings->EED_Events_Archive_Filters = apply_filters(
-            'FHEE__Event_List__template_settings_form__event_list_config',
-            $EE->CFG->template_settings->EED_Events_Archive_Filters
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $EE->CFG->template_settings->EED_Events_Archive_Filters
-        );
-    }
-
-
-    /**
-     *    set_default_settings
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function set_default_settings($CFG)
-    {
-        // EEH_Debug_Tools::printr( $CFG, '$CFG  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        $CFG->display_description = isset($CFG->display_description) && ! empty($CFG->display_description)
-            ? $CFG->display_description : 1;
-        $CFG->display_address = isset($CFG->display_address) && ! empty($CFG->display_address) ? $CFG->display_address
-            : true;
-        $CFG->display_venue_details = isset($CFG->display_venue_details) && ! empty($CFG->display_venue_details)
-            ? $CFG->display_venue_details : true;
-        $CFG->display_expired_events = isset($CFG->display_expired_events) && ! empty($CFG->display_expired_events)
-            ? $CFG->display_expired_events : false;
-        $CFG->default_type = isset($CFG->default_type) && ! empty($CFG->default_type) ? $CFG->default_type : 'grid';
-        $CFG->event_list_grid_size = isset($CFG->event_list_grid_size) && ! empty($CFG->event_list_grid_size)
-            ? $CFG->event_list_grid_size : 'medium';
-        $CFG->templates['full'] = isset($CFG->templates['full']) && ! empty($CFG->templates['full'])
-            ? $CFG->templates['full']
-            : EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
-        $CFG->templates['part'] = isset($CFG->templates['part']) && ! empty($CFG->templates['part'])
-            ? $CFG->templates['part']
-            : EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-grid-view.php';
-        return $CFG;
-    }
-
-
-    /**
-     *    filter_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public function filter_config($CFG)
-    {
-        return $CFG;
-    }
-
-
-    /**
-     *    filter_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        // $CFG->template_settings->EED_Events_Archive_Filters = new stdClass();
-        $CFG->EED_Events_Archive_Filters->display_description = isset($REQ['display_description_in_event_list'])
-            ? absint($REQ['display_description_in_event_list']) : 1;
-        $CFG->EED_Events_Archive_Filters->display_address = isset($REQ['display_address_in_event_list']) ? absint(
-            $REQ['display_address_in_event_list']
-        ) : true;
-        $CFG->EED_Events_Archive_Filters->display_venue_details = isset($REQ['display_venue_details_in_event_list'])
-            ? absint($REQ['display_venue_details_in_event_list']) : true;
-        $CFG->EED_Events_Archive_Filters->display_expired_events = isset($REQ['display_expired_events']) ? absint(
-            $REQ['display_expired_events']
-        ) : false;
-        $CFG->EED_Events_Archive_Filters->default_type = isset($REQ['default_type']) ? sanitize_text_field(
-            $REQ['default_type']
-        ) : 'grid';
-        $CFG->EED_Events_Archive_Filters->event_list_grid_size = isset($REQ['event_list_grid_size'])
-            ? sanitize_text_field($REQ['event_list_grid_size']) : 'medium';
-        $CFG->EED_Events_Archive_Filters->templates = array(
-            'full' => EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php',
-        );
-
-        switch ($CFG->EED_Events_Archive_Filters->default_type) {
-            case 'dates':
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-dates-view.php';
-                break;
-            case 'text':
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-text-view.php';
-                break;
-            default:
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-grid-view.php';
-        }
-
-        $CFG->EED_Events_Archive_Filters = isset($REQ['reset_event_list_settings'])
-                                           && absint($REQ['reset_event_list_settings']) == 1
-            ? new EE_Events_Archive_Config()
-            : $CFG->EED_Events_Archive_Filters;
-        return $CFG;
-    }
-
-
-    /**
-     *    get_template_part
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function get_template_part()
-    {
-        switch (self::$_type) {
-            case 'dates':
-                return 'archive-espresso_events-dates-view.php';
-                break;
-            case 'text':
-                return 'archive-espresso_events-text-view.php';
-                break;
-            default:
-                return 'archive-espresso_events-grid-view.php';
-        }
-    }
-
-
-    /**
-     *    event_list_template_filters
-     *
-     * @access    public
-     * @return    void
-     */
-    public function event_list_template_filters()
-    {
-        $args = array(
-            'form_url'         => get_post_type_archive_link('espresso_events'),
-            // add_query_arg( array( 'post_type' => 'espresso_events' ), home_url() ),
-            'elf_month'        => EED_Events_Archive_Filters::_display_month(),
-            'elf_category'     => EED_Events_Archive_Filters::_event_category_slug(),
-            'elf_show_expired' => EED_Events_Archive_Filters::_show_expired(),
-            'elf_type'         => self::$_type,
-        );
-        EEH_Template::display_template(
-            EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-filters.php',
-            $args
-        );
-    }
-
-
-    /**
-     *    event_list_css
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $EE = EE_Registry::instance();
-        $event_list_css = ! empty($extra_class) ? array($extra_class) : array();
-        $event_list_css[] = 'espresso-event-list-event';
-        if (self::$_type == 'grid') {
-            $event_list_grid_size = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size)
-                ? $EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size : 'medium';
-            $event_list_css[] = $event_list_grid_size . '-event-list-grid';
-        }
-        $event_list_css = apply_filters(
-            'EED_Events_Archive_Filters__event_list_css__event_list_css_array',
-            $event_list_css
-        );
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     *    event_categories
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     *    display_description
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function display_description($value)
-    {
-        $EE = EE_Registry::instance();
-        $display_description = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_description)
-            ? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_description : 1;
-        return $display_description === $value ? true : false;
-    }
-
-
-    /**
-     *    display_venue_details
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function display_venue_details()
-    {
-        $EE = EE_Registry::instance();
-        $display_venue_details = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_venue_details)
-            ? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_venue_details : true;
-        $venue_name = EEH_Venue_View::venue_name();
-        return $display_venue_details && ! empty($venue_name) ? true : false;
-    }
-
-
-    /**
-     *    display_address
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function display_address()
-    {
-        $EE = EE_Registry::instance();
-        $display_address = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_address)
-            ? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_address : false;
-        $venue_name = EEH_Venue_View::venue_name();
-        return $display_address && ! empty($venue_name) ? true : false;
-    }
-
-
-    /**
-     *    pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function pagination()
-    {
-        global $wp_query;
-        $big = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            array(
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            )
-        );
-        return ! empty($pagination) ? '<div class="ee-pagination-dv clear">' . $pagination . '</div>' : '';
-    }
-
-
-    /**
-     *    event_list_title
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'EED_Events_Archive_Filters__event_list_title__event_list_title',
-            __('Upcoming Events', 'event_espresso')
-        );
-    }
+	/**
+	 * @return EED_Events_Archive_Filters
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    Start Date
+	 *
+	 * @var    $_elf_month
+	 * @access    protected
+	 */
+	protected $_elf_month = null;
+
+
+	/**
+	 *    Category
+	 *
+	 * @var    $_elf_category
+	 * @access    protected
+	 */
+	protected $_elf_category = null;
+
+
+	/**
+	 *    whether to display expired events in the event list
+	 *
+	 * @var    $_show_expired
+	 * @access    protected
+	 */
+	protected $_show_expired = null;
+
+
+	/**
+	 *    whether to display the event list as a grid or list
+	 *
+	 * @var    $_type
+	 * @access    protected
+	 */
+	protected static $_type = null;
+
+
+	/**
+	 *    array of existing event list views
+	 *
+	 * @var    $_types
+	 * @access    protected
+	 */
+	protected static $_types = array('grid', 'text', 'dates');
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_definitions()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 *    event_list
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function event_list()
+	{
+		// load other required components
+		$this->_load_assests();
+	}
+
+
+	/**
+	 *    _filter_query_parts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	private function _filter_query_parts()
+	{
+		// build event list query
+		add_filter('posts_join', array($this, 'posts_join'), 1, 2);
+		add_filter('posts_where', array($this, 'posts_where'), 1, 2);
+		add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
+	}
+
+	/**
+	 *    _type - the type of event list : grid, text, dates
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function set_type()
+	{
+		do_action('AHEE__EED_Events_Archive_Filters__before_set_type');
+		EED_Events_Archive_Filters::$_types = apply_filters(
+			'EED_Events_Archive_Filters__set_type__types',
+			EED_Events_Archive_Filters::$_types
+		);
+		$view = isset(EE_Registry::instance()->CFG->EED_Events_Archive_Filters['default_type']) ? EE_Registry::instance(
+		)->CFG->EED_Events_Archive_Filters['default_type'] : 'grid';
+		$elf_type = EE_Registry::instance()->REQ->is_set('elf_type') ? sanitize_text_field(
+			EE_Registry::instance()->REQ->get('elf_type')
+		) : '';
+		$view = ! empty($elf_type) ? $elf_type : $view;
+		$view = apply_filters('EED_Events_Archive_Filters__set_type__type', $view);
+		if (! empty($view) && in_array($view, EED_Events_Archive_Filters::$_types)) {
+			self::$_type = $view;
+		}
+	}
+
+	/**
+	 *    _show_expired
+	 *
+	 * @access    private
+	 * @param    boolean $req_only if TRUE, then ignore defaults and only return $_POST value
+	 * @return    boolean
+	 */
+	private static function _show_expired($req_only = false)
+	{
+		// get default value for "display_expired_events" as set in the EE General Settings > Templates > Event Listings
+		$show_expired = ! $req_only && isset(
+			EE_Registry::instance()->CFG->EED_Events_Archive_Filters['display_expired_events']
+		) ? EE_Registry::instance()->CFG->EED_Events_Archive_Filters['display_expired_events'] : false;
+		// override default expired option if set via filter
+		$show_expired = EE_Registry::instance()->REQ->is_set('elf_expired_chk') ? absint(
+			EE_Registry::instance()->REQ->get('elf_expired_chk')
+		) : $show_expired;
+		return $show_expired ? true : false;
+	}
+
+	/**
+	 *    _event_category_slug
+	 *
+	 * @access    private
+	 * @return    string
+	 */
+	private static function _event_category_slug()
+	{
+		return EE_Registry::instance()->REQ->is_set('elf_category_dd') ? sanitize_text_field(
+			EE_Registry::instance()->REQ->get('elf_category_dd')
+		) : '';
+	}
+
+	/**
+	 *    _display_month - what month should the event list display events for?
+	 *
+	 * @access    private
+	 * @return    string
+	 */
+	private static function _display_month()
+	{
+		return EE_Registry::instance()->REQ->is_set('elf_month_dd') ? sanitize_text_field(
+			EE_Registry::instance()->REQ->get('elf_month_dd')
+		) : '';
+	}
+
+
+	/**
+	 *    get_post_data
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function get_post_data()
+	{
+		$this->_elf_month = EED_Events_Archive_Filters::_display_month();
+		$this->_elf_category = EED_Events_Archive_Filters::_event_category_slug();
+		$this->_show_expired = EED_Events_Archive_Filters::_show_expired(true);
+	}
+
+
+	/**
+	 *    posts_join
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		if (isset($wp_query->query) && isset($wp_query->query['post_type']) && $wp_query->query['post_type'] == 'espresso_events') {
+			// Category
+			$SQL .= EED_Events_Archive_Filters::posts_join_sql_for_terms(
+				EED_Events_Archive_Filters::_event_category_slug()
+			);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_join_sql_for_terms
+	 *
+	 * @access    public
+	 * @param    mixed boolean|string    $join_terms pass TRUE or term string, doesn't really matter since this value
+	 *                                   doesn't really get used for anything yet
+	 * @return    string
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		$SQL = '';
+		if (! empty($join_terms)) {
+			global $wpdb;
+			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
+			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
+			$SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_join_for_orderby
+	 *    usage:  $SQL .= EED_Events_Archive_Filters::posts_join_for_orderby( $orderby_params );
+	 *
+	 * @access    public
+	 * @param    array $orderby_params
+	 * @return    string
+	 */
+	public static function posts_join_for_orderby($orderby_params = array())
+	{
+		global $wpdb;
+		$SQL = '';
+		$orderby_params = is_array($orderby_params) ? $orderby_params : array($orderby_params);
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+				case 'ticket_end':
+					$SQL .= ' LEFT JOIN ' . EEM_Datetime_Ticket::instance()->table() . ' ON ('
+							. EEM_Datetime::instance()->table() . '.DTT_ID = '
+							. EEM_Datetime_Ticket::instance()->table() . '.DTT_ID )';
+					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table() . ' ON ('
+							. EEM_Datetime_Ticket::instance()->table() . '.TKT_ID = '
+							. EEM_Ticket::instance()->table() . '.TKT_ID )';
+					break;
+
+				case 'venue_title':
+				case 'city':
+					$SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
+							. EEM_Event_Venue::instance()->table() . '.EVT_ID )';
+					$SQL .= ' LEFT JOIN ' . EEM_Venue::instance()->table() . ' ON ('
+							. EEM_Event_Venue::instance()->table() . '.VNU_ID = '
+							. EEM_Venue::instance()->table() . '.VNU_ID )';
+					break;
+
+				case 'state':
+					$SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
+							. EEM_Event_Venue::instance()->table() . '.EVT_ID )';
+					$SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->second_table() . ' ON ('
+							. EEM_Event_Venue::instance()->table() . '.VNU_ID = '
+							. EEM_Event_Venue::instance()->second_table() . '.VNU_ID )';
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_where
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		if (isset($wp_query->query_vars) && isset($wp_query->query_vars['post_type']) && $wp_query->query_vars['post_type'] == 'espresso_events') {
+			// Show Expired ?
+			$SQL .= EED_Events_Archive_Filters::posts_where_sql_for_show_expired(
+				EED_Events_Archive_Filters::_show_expired()
+			);
+			// Category
+			// $elf_category = EED_Events_Archive_Filters::_event_category_slug();
+			$SQL .= EED_Events_Archive_Filters::posts_where_sql_for_event_category_slug(
+				EED_Events_Archive_Filters::_event_category_slug()
+			);
+			// Start Date
+			// $elf_month = EED_Events_Archive_Filters::_display_month();
+			$SQL .= EED_Events_Archive_Filters::posts_where_sql_for_event_list_month(
+				EED_Events_Archive_Filters::_display_month()
+			);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_where_sql_for_show_expired
+	 *
+	 * @access    public
+	 * @param    boolean $show_expired if TRUE, then displayed past events
+	 * @return    string
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		return ! $show_expired
+			? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > "' . date('Y-m-d H:s:i') . '" '
+			: '';
+	}
+
+
+	/**
+	 *    posts_where_sql_for_event_category_slug
+	 *
+	 * @access    public
+	 * @param    boolean $event_category_slug
+	 * @return    string
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		global $wpdb;
+		return ! empty($event_category_slug) ? ' AND ' . $wpdb->terms . '.slug = "' . $event_category_slug . '" ' : '';
+	}
+
+	/**
+	 *    posts_where_sql_for_event_list_month
+	 *
+	 * @access    public
+	 * @param    boolean $month
+	 * @return    string
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		$SQL = '';
+		if (! empty($month)) {
+			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
+			$SQL = ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start';
+			$SQL .= ' <= "' . date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '"';
+			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
+			$SQL .= ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end';
+			$SQL .= ' >= "' . date('Y-m-d 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '" ';
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_orderby
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if (isset($wp_query->query) && isset($wp_query->query['post_type']) && $wp_query->query['post_type'] == 'espresso_events') {
+			$SQL = EED_Events_Archive_Filters::posts_orderby_sql(array('start_date'));
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_orderby_sql
+	 *
+	 *    possible parameters:
+	 *    ID
+	 *    start_date
+	 *    end_date
+	 *    event_name
+	 *    category_slug
+	 *    ticket_start
+	 *    ticket_end
+	 *    venue_title
+	 *    city
+	 *    state
+	 *
+	 *    **IMPORTANT**
+	 *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
+	 *    or else some of the table references below will result in MySQL errors
+	 *
+	 * @access    public
+	 * @param    boolean $orderby_params
+	 * @return    string
+	 */
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
+	{
+		global $wpdb;
+		$SQL = '';
+		$cntr = 1;
+		$orderby_params = is_array($orderby_params) ? $orderby_params : array($orderby_params);
+		foreach ($orderby_params as $orderby) {
+			$glue = $cntr == 1 || $cntr == count($orderby_params) ? ' ' : ', ';
+			switch ($orderby) {
+				case 'id':
+				case 'ID':
+					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					break;
+
+				case 'start_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_start ' . $sort;
+					break;
+
+				case 'end_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					break;
+
+				case 'event_name':
+					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					break;
+
+				case 'category_slug':
+					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					break;
+
+				case 'ticket_start':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					break;
+
+				case 'ticket_end':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					break;
+
+				case 'venue_title':
+					$SQL .= $glue . 'venue_title ' . $sort;
+					break;
+
+				case 'city':
+					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					break;
+
+				case 'state':
+					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					break;
+			}
+			$cntr++;
+		}
+		// echo '<h4>$SQL : ' . $SQL . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+		return $SQL;
+	}
+
+
+	/**
+	 *    template_redirect
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function template_redirect()
+	{
+		// add event list filters
+		add_action('loop_start', array($this, 'event_list_template_filters'));
+		// and pagination
+		add_action('loop_start', array($this, 'event_list_pagination'));
+		add_action('loop_end', array($this, 'event_list_pagination'));
+		// if NOT a custom template
+		if (EE_Registry::instance()
+					   ->load_core('Front_Controller', array(), false, true)
+					   ->get_selected_template() != 'archive-espresso_events.php'
+		) {
+			// don't know if theme uses the_excerpt
+			add_filter('the_excerpt', array($this, 'event_details'), 100);
+			add_filter('the_excerpt', array($this, 'event_tickets'), 110);
+			add_filter('the_excerpt', array($this, 'event_datetimes'), 120);
+			add_filter('the_excerpt', array($this, 'event_venues'), 130);
+			// or the_content
+			add_filter('the_content', array($this, 'event_details'), 100);
+			add_filter('the_content', array($this, 'event_tickets'), 110);
+			add_filter('the_content', array($this, 'event_datetimes'), 120);
+			add_filter('the_content', array($this, 'event_venues'), 130);
+		} else {
+			remove_all_filters('excerpt_length');
+			add_filter('excerpt_length', array($this, 'excerpt_length'), 10);
+			add_filter('excerpt_more', array($this, 'excerpt_more'), 10);
+		}
+	}
+
+
+	/**
+	 *    event_list_pagination
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public function event_list_pagination()
+	{
+		echo '<div class="ee-pagination-dv ee-clear-float">' . espresso_event_list_pagination() . '</div>';
+	}
+
+
+	/**
+	 *    event_details
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        void
+	 */
+	public function event_details($content)
+	{
+		return EEH_Template::display_template(
+			EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-details.php',
+			array('the_content' => $content),
+			true
+		);
+	}
+
+
+	/**
+	 *    event_tickets
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        void
+	 */
+	public function event_tickets($content)
+	{
+		return $content
+			   . EEH_Template::display_template(
+				   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-tickets.php',
+				   array(),
+				   true
+			   );
+	}
+
+	/**
+	 *    event_datetimes
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        void
+	 */
+	public function event_datetimes($content)
+	{
+		return $content
+			   . EEH_Template::display_template(
+				   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-datetimes.php',
+				   array(),
+				   true
+			   );
+	}
+
+	/**
+	 *    event_venues
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        void
+	 */
+	public function event_venues($content)
+	{
+		return $content
+			   . EEH_Template::display_template(
+				   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-venues.php',
+				   array(),
+				   true
+			   );
+	}
+
+
+	/**
+	 *    _initial_setup
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	private function _load_assests()
+	{
+		do_action('AHEE__EED_Events_Archive_Filters__before_load_assests');
+		wp_enqueue_style('espresso_default');
+		wp_enqueue_style('espresso_custom_css');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+		}
+		// add_filter( 'the_excerpt', array( $this, 'the_excerpt' ), 999 );
+	}
+
+
+	/**
+	 *    _get_template
+	 *
+	 * @access    private
+	 * @return    string
+	 */
+	private function _get_template($which = 'part')
+	{
+		return EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
+	}
+
+
+	/**
+	 *    excerpt_length
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function excerpt_length($length)
+	{
+
+		if (self::$_type == 'grid') {
+			return 36;
+		}
+
+		switch (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size) {
+			case 'tiny':
+				return 12;
+				break;
+			case 'small':
+				return 24;
+				break;
+			case 'large':
+				return 48;
+				break;
+			case 'medium':
+			default:
+				return 36;
+		}
+	}
+
+
+	/**
+	 *    excerpt_more
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function excerpt_more($more)
+	{
+		return '&hellip;';
+	}
+
+
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (is_readable(
+				get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css'
+			)) {
+				wp_register_style(
+					'archive-espresso_events',
+					get_stylesheet_directory_uri() . EE_Config::get_current_theme(
+					) . DS . 'archive-espresso_events.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+				wp_register_style(
+					'archive-espresso_events',
+					EE_TEMPLATES_URL . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css',
+					array('dashicons', 'espresso_default')
+				);
+			}
+			if (is_readable(
+				get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js'
+			)) {
+				wp_register_script(
+					'archive-espresso_events',
+					get_stylesheet_directory_uri() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js',
+					array('jquery-masonry'),
+					'1.0',
+					true
+				);
+			} else {
+				wp_register_script(
+					'archive-espresso_events',
+					EVENTS_ARCHIVE_ASSETS_URL . 'archive-espresso_events.js',
+					array('jquery-masonry'),
+					'1.0',
+					true
+				);
+			}
+			wp_enqueue_style('archive-espresso_events');
+			wp_enqueue_script('jquery-masonry');
+			wp_enqueue_script('archive-espresso_events');
+			add_action('wp_footer', array('EED_Events_Archive_Filters', 'localize_grid_event_lists'), 1);
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function localize_grid_event_lists()
+	{
+		wp_localize_script(
+			'archive-espresso_events',
+			'espresso_grid_event_lists',
+			EED_Events_Archive_Filters::$espresso_grid_event_lists
+		);
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function template_settings_form()
+	{
+		$EE = EE_Registry::instance();
+		$EE->CFG->template_settings->EED_Events_Archive_Filters = isset($EE->CFG->template_settings->EED_Events_Archive_Filters)
+			? $EE->CFG->template_settings->EED_Events_Archive_Filters : new EE_Events_Archive_Config();
+		$EE->CFG->template_settings->EED_Events_Archive_Filters = apply_filters(
+			'FHEE__Event_List__template_settings_form__event_list_config',
+			$EE->CFG->template_settings->EED_Events_Archive_Filters
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$EE->CFG->template_settings->EED_Events_Archive_Filters
+		);
+	}
+
+
+	/**
+	 *    set_default_settings
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function set_default_settings($CFG)
+	{
+		// EEH_Debug_Tools::printr( $CFG, '$CFG  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		$CFG->display_description = isset($CFG->display_description) && ! empty($CFG->display_description)
+			? $CFG->display_description : 1;
+		$CFG->display_address = isset($CFG->display_address) && ! empty($CFG->display_address) ? $CFG->display_address
+			: true;
+		$CFG->display_venue_details = isset($CFG->display_venue_details) && ! empty($CFG->display_venue_details)
+			? $CFG->display_venue_details : true;
+		$CFG->display_expired_events = isset($CFG->display_expired_events) && ! empty($CFG->display_expired_events)
+			? $CFG->display_expired_events : false;
+		$CFG->default_type = isset($CFG->default_type) && ! empty($CFG->default_type) ? $CFG->default_type : 'grid';
+		$CFG->event_list_grid_size = isset($CFG->event_list_grid_size) && ! empty($CFG->event_list_grid_size)
+			? $CFG->event_list_grid_size : 'medium';
+		$CFG->templates['full'] = isset($CFG->templates['full']) && ! empty($CFG->templates['full'])
+			? $CFG->templates['full']
+			: EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
+		$CFG->templates['part'] = isset($CFG->templates['part']) && ! empty($CFG->templates['part'])
+			? $CFG->templates['part']
+			: EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-grid-view.php';
+		return $CFG;
+	}
+
+
+	/**
+	 *    filter_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function filter_config($CFG)
+	{
+		return $CFG;
+	}
+
+
+	/**
+	 *    filter_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		// $CFG->template_settings->EED_Events_Archive_Filters = new stdClass();
+		$CFG->EED_Events_Archive_Filters->display_description = isset($REQ['display_description_in_event_list'])
+			? absint($REQ['display_description_in_event_list']) : 1;
+		$CFG->EED_Events_Archive_Filters->display_address = isset($REQ['display_address_in_event_list']) ? absint(
+			$REQ['display_address_in_event_list']
+		) : true;
+		$CFG->EED_Events_Archive_Filters->display_venue_details = isset($REQ['display_venue_details_in_event_list'])
+			? absint($REQ['display_venue_details_in_event_list']) : true;
+		$CFG->EED_Events_Archive_Filters->display_expired_events = isset($REQ['display_expired_events']) ? absint(
+			$REQ['display_expired_events']
+		) : false;
+		$CFG->EED_Events_Archive_Filters->default_type = isset($REQ['default_type']) ? sanitize_text_field(
+			$REQ['default_type']
+		) : 'grid';
+		$CFG->EED_Events_Archive_Filters->event_list_grid_size = isset($REQ['event_list_grid_size'])
+			? sanitize_text_field($REQ['event_list_grid_size']) : 'medium';
+		$CFG->EED_Events_Archive_Filters->templates = array(
+			'full' => EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php',
+		);
+
+		switch ($CFG->EED_Events_Archive_Filters->default_type) {
+			case 'dates':
+				$CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
+																	  . DS . 'archive-espresso_events-dates-view.php';
+				break;
+			case 'text':
+				$CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
+																	  . DS . 'archive-espresso_events-text-view.php';
+				break;
+			default:
+				$CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
+																	  . DS . 'archive-espresso_events-grid-view.php';
+		}
+
+		$CFG->EED_Events_Archive_Filters = isset($REQ['reset_event_list_settings'])
+										   && absint($REQ['reset_event_list_settings']) == 1
+			? new EE_Events_Archive_Config()
+			: $CFG->EED_Events_Archive_Filters;
+		return $CFG;
+	}
+
+
+	/**
+	 *    get_template_part
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function get_template_part()
+	{
+		switch (self::$_type) {
+			case 'dates':
+				return 'archive-espresso_events-dates-view.php';
+				break;
+			case 'text':
+				return 'archive-espresso_events-text-view.php';
+				break;
+			default:
+				return 'archive-espresso_events-grid-view.php';
+		}
+	}
+
+
+	/**
+	 *    event_list_template_filters
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function event_list_template_filters()
+	{
+		$args = array(
+			'form_url'         => get_post_type_archive_link('espresso_events'),
+			// add_query_arg( array( 'post_type' => 'espresso_events' ), home_url() ),
+			'elf_month'        => EED_Events_Archive_Filters::_display_month(),
+			'elf_category'     => EED_Events_Archive_Filters::_event_category_slug(),
+			'elf_show_expired' => EED_Events_Archive_Filters::_show_expired(),
+			'elf_type'         => self::$_type,
+		);
+		EEH_Template::display_template(
+			EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-filters.php',
+			$args
+		);
+	}
+
+
+	/**
+	 *    event_list_css
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$EE = EE_Registry::instance();
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
+		$event_list_css[] = 'espresso-event-list-event';
+		if (self::$_type == 'grid') {
+			$event_list_grid_size = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size)
+				? $EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size : 'medium';
+			$event_list_css[] = $event_list_grid_size . '-event-list-grid';
+		}
+		$event_list_css = apply_filters(
+			'EED_Events_Archive_Filters__event_list_css__event_list_css_array',
+			$event_list_css
+		);
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 *    event_categories
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 *    display_description
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function display_description($value)
+	{
+		$EE = EE_Registry::instance();
+		$display_description = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_description)
+			? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_description : 1;
+		return $display_description === $value ? true : false;
+	}
+
+
+	/**
+	 *    display_venue_details
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function display_venue_details()
+	{
+		$EE = EE_Registry::instance();
+		$display_venue_details = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_venue_details)
+			? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_venue_details : true;
+		$venue_name = EEH_Venue_View::venue_name();
+		return $display_venue_details && ! empty($venue_name) ? true : false;
+	}
+
+
+	/**
+	 *    display_address
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function display_address()
+	{
+		$EE = EE_Registry::instance();
+		$display_address = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->display_address)
+			? $EE->CFG->template_settings->EED_Events_Archive_Filters->display_address : false;
+		$venue_name = EEH_Venue_View::venue_name();
+		return $display_address && ! empty($venue_name) ? true : false;
+	}
+
+
+	/**
+	 *    pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function pagination()
+	{
+		global $wp_query;
+		$big = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			array(
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			)
+		);
+		return ! empty($pagination) ? '<div class="ee-pagination-dv clear">' . $pagination . '</div>' : '';
+	}
+
+
+	/**
+	 *    event_list_title
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'EED_Events_Archive_Filters__event_list_title__event_list_title',
+			__('Upcoming Events', 'event_espresso')
+		);
+	}
 }

Spacing +61 added lines, -61 removed lines

@@ -157,7 +157,7 @@ 
         ) : '';
         $view = ! empty($elf_type) ? $elf_type : $view;
         $view = apply_filters('EED_Events_Archive_Filters__set_type__type', $view);
-        if (! empty($view) && in_array($view, EED_Events_Archive_Filters::$_types)) {
+        if ( ! empty($view) && in_array($view, EED_Events_Archive_Filters::$_types)) {
             self::$_type = $view;
         }
     }
@@ -252,7 +252,7 @@ 
     public static function posts_join_sql_for_terms($join_terms = null)
     {
         $SQL = '';
-        if (! empty($join_terms)) {
+        if ( ! empty($join_terms)) {
             global $wpdb;
             $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
             $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -279,29 +279,29 @@ 
             switch ($orderby) {
                 case 'ticket_start':
                 case 'ticket_end':
-                    $SQL .= ' LEFT JOIN ' . EEM_Datetime_Ticket::instance()->table() . ' ON ('
-                            . EEM_Datetime::instance()->table() . '.DTT_ID = '
-                            . EEM_Datetime_Ticket::instance()->table() . '.DTT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table() . ' ON ('
-                            . EEM_Datetime_Ticket::instance()->table() . '.TKT_ID = '
-                            . EEM_Ticket::instance()->table() . '.TKT_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Datetime_Ticket::instance()->table().' ON ('
+                            . EEM_Datetime::instance()->table().'.DTT_ID = '
+                            . EEM_Datetime_Ticket::instance()->table().'.DTT_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table().' ON ('
+                            . EEM_Datetime_Ticket::instance()->table().'.TKT_ID = '
+                            . EEM_Ticket::instance()->table().'.TKT_ID )';
                     break;
 
                 case 'venue_title':
                 case 'city':
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
-                            . EEM_Event_Venue::instance()->table() . '.EVT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Venue::instance()->table() . ' ON ('
-                            . EEM_Event_Venue::instance()->table() . '.VNU_ID = '
-                            . EEM_Venue::instance()->table() . '.VNU_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Event_Venue::instance()->table().' ON ('.$wpdb->posts.'.ID = '
+                            . EEM_Event_Venue::instance()->table().'.EVT_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Venue::instance()->table().' ON ('
+                            . EEM_Event_Venue::instance()->table().'.VNU_ID = '
+                            . EEM_Venue::instance()->table().'.VNU_ID )';
                     break;
 
                 case 'state':
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->table() . ' ON (' . $wpdb->posts . '.ID = '
-                            . EEM_Event_Venue::instance()->table() . '.EVT_ID )';
-                    $SQL .= ' LEFT JOIN ' . EEM_Event_Venue::instance()->second_table() . ' ON ('
-                            . EEM_Event_Venue::instance()->table() . '.VNU_ID = '
-                            . EEM_Event_Venue::instance()->second_table() . '.VNU_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Event_Venue::instance()->table().' ON ('.$wpdb->posts.'.ID = '
+                            . EEM_Event_Venue::instance()->table().'.EVT_ID )';
+                    $SQL .= ' LEFT JOIN '.EEM_Event_Venue::instance()->second_table().' ON ('
+                            . EEM_Event_Venue::instance()->table().'.VNU_ID = '
+                            . EEM_Event_Venue::instance()->second_table().'.VNU_ID )';
                     break;
             }
         }
@@ -347,7 +347,7 @@ 
     public static function posts_where_sql_for_show_expired($show_expired = false)
     {
         return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > "' . date('Y-m-d H:s:i') . '" '
+            ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > "'.date('Y-m-d H:s:i').'" '
             : '';
     }
 
@@ -362,7 +362,7 @@ 
     public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
     {
         global $wpdb;
-        return ! empty($event_category_slug) ? ' AND ' . $wpdb->terms . '.slug = "' . $event_category_slug . '" ' : '';
+        return ! empty($event_category_slug) ? ' AND '.$wpdb->terms.'.slug = "'.$event_category_slug.'" ' : '';
     }
 
     /**
@@ -375,13 +375,13 @@ 
     public static function posts_where_sql_for_event_list_month($month = null)
     {
         $SQL = '';
-        if (! empty($month)) {
+        if ( ! empty($month)) {
             // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start';
-            $SQL .= ' <= "' . date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '"';
+            $SQL = ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_start';
+            $SQL .= ' <= "'.date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)).'"';
             // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end';
-            $SQL .= ' >= "' . date('Y-m-d 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . '" ';
+            $SQL .= ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end';
+            $SQL .= ' >= "'.date('Y-m-d 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)).'" ';
         }
         return $SQL;
     }
@@ -436,43 +436,43 @@ 
             switch ($orderby) {
                 case 'id':
                 case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.ID '.$sort;
                     break;
 
                 case 'start_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_start ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_start '.$sort;
                     break;
 
                 case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
                     break;
 
                 case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
                     break;
 
                 case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+                    $SQL .= $glue.$wpdb->terms.'.slug '.$sort;
                     break;
 
                 case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
                     break;
 
                 case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
                     break;
 
                 case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
+                    $SQL .= $glue.'venue_title '.$sort;
                     break;
 
                 case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+                    $SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
                     break;
 
                 case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+                    $SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
                     break;
             }
             $cntr++;
@@ -526,7 +526,7 @@ 
      */
     public function event_list_pagination()
     {
-        echo '<div class="ee-pagination-dv ee-clear-float">' . espresso_event_list_pagination() . '</div>';
+        echo '<div class="ee-pagination-dv ee-clear-float">'.espresso_event_list_pagination().'</div>';
     }
 
 
@@ -540,7 +540,7 @@ 
     public function event_details($content)
     {
         return EEH_Template::display_template(
-            EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-details.php',
+            EE_TEMPLATES.EE_Config::get_current_theme().DS.'content-espresso_events-details.php',
             array('the_content' => $content),
             true
         );
@@ -558,7 +558,7 @@ 
     {
         return $content
                . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-tickets.php',
+                   EE_TEMPLATES.EE_Config::get_current_theme().DS.'content-espresso_events-tickets.php',
                    array(),
                    true
                );
@@ -575,7 +575,7 @@ 
     {
         return $content
                . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-datetimes.php',
+                   EE_TEMPLATES.EE_Config::get_current_theme().DS.'content-espresso_events-datetimes.php',
                    array(),
                    true
                );
@@ -592,7 +592,7 @@ 
     {
         return $content
                . EEH_Template::display_template(
-                   EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'content-espresso_events-venues.php',
+                   EE_TEMPLATES.EE_Config::get_current_theme().DS.'content-espresso_events-venues.php',
                    array(),
                    true
                );
@@ -627,7 +627,7 @@ 
      */
     private function _get_template($which = 'part')
     {
-        return EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
+        return EE_TEMPLATES.EE_Config::get_current_theme().DS.'archive-espresso_events.php';
     }
 
 
@@ -687,27 +687,27 @@ 
         if (apply_filters('FHEE_enable_default_espresso_css', false)) {
             // first check uploads folder
             if (is_readable(
-                get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css'
+                get_stylesheet_directory().EE_Config::get_current_theme().DS.'archive-espresso_events.css'
             )) {
                 wp_register_style(
                     'archive-espresso_events',
-                    get_stylesheet_directory_uri() . EE_Config::get_current_theme(
-                    ) . DS . 'archive-espresso_events.css',
+                    get_stylesheet_directory_uri().EE_Config::get_current_theme(
+                    ).DS.'archive-espresso_events.css',
                     array('dashicons', 'espresso_default')
                 );
             } else {
                 wp_register_style(
                     'archive-espresso_events',
-                    EE_TEMPLATES_URL . EE_Config::get_current_theme() . DS . 'archive-espresso_events.css',
+                    EE_TEMPLATES_URL.EE_Config::get_current_theme().DS.'archive-espresso_events.css',
                     array('dashicons', 'espresso_default')
                 );
             }
             if (is_readable(
-                get_stylesheet_directory() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js'
+                get_stylesheet_directory().EE_Config::get_current_theme().DS.'archive-espresso_events.js'
             )) {
                 wp_register_script(
                     'archive-espresso_events',
-                    get_stylesheet_directory_uri() . EE_Config::get_current_theme() . DS . 'archive-espresso_events.js',
+                    get_stylesheet_directory_uri().EE_Config::get_current_theme().DS.'archive-espresso_events.js',
                     array('jquery-masonry'),
                     '1.0',
                     true
@@ -715,7 +715,7 @@ 
             } else {
                 wp_register_script(
                     'archive-espresso_events',
-                    EVENTS_ARCHIVE_ASSETS_URL . 'archive-espresso_events.js',
+                    EVENTS_ARCHIVE_ASSETS_URL.'archive-espresso_events.js',
                     array('jquery-masonry'),
                     '1.0',
                     true
@@ -763,7 +763,7 @@ 
             $EE->CFG->template_settings->EED_Events_Archive_Filters
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $EE->CFG->template_settings->EED_Events_Archive_Filters
         );
     }
@@ -792,10 +792,10 @@ 
             ? $CFG->event_list_grid_size : 'medium';
         $CFG->templates['full'] = isset($CFG->templates['full']) && ! empty($CFG->templates['full'])
             ? $CFG->templates['full']
-            : EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php';
+            : EE_TEMPLATES.EE_Config::get_current_theme().DS.'archive-espresso_events.php';
         $CFG->templates['part'] = isset($CFG->templates['part']) && ! empty($CFG->templates['part'])
             ? $CFG->templates['part']
-            : EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-grid-view.php';
+            : EE_TEMPLATES.EE_Config::get_current_theme().DS.'archive-espresso_events-grid-view.php';
         return $CFG;
     }
 
@@ -837,21 +837,21 @@ 
         $CFG->EED_Events_Archive_Filters->event_list_grid_size = isset($REQ['event_list_grid_size'])
             ? sanitize_text_field($REQ['event_list_grid_size']) : 'medium';
         $CFG->EED_Events_Archive_Filters->templates = array(
-            'full' => EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events.php',
+            'full' => EE_TEMPLATES.EE_Config::get_current_theme().DS.'archive-espresso_events.php',
         );
 
         switch ($CFG->EED_Events_Archive_Filters->default_type) {
             case 'dates':
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-dates-view.php';
+                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES.EE_Config::get_current_theme()
+                                                                      . DS.'archive-espresso_events-dates-view.php';
                 break;
             case 'text':
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-text-view.php';
+                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES.EE_Config::get_current_theme()
+                                                                      . DS.'archive-espresso_events-text-view.php';
                 break;
             default:
-                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES . EE_Config::get_current_theme()
-                                                                      . DS . 'archive-espresso_events-grid-view.php';
+                $CFG->EED_Events_Archive_Filters->templates['part'] = EE_TEMPLATES.EE_Config::get_current_theme()
+                                                                      . DS.'archive-espresso_events-grid-view.php';
         }
 
         $CFG->EED_Events_Archive_Filters = isset($REQ['reset_event_list_settings'])
@@ -900,7 +900,7 @@ 
             'elf_type'         => self::$_type,
         );
         EEH_Template::display_template(
-            EE_TEMPLATES . EE_Config::get_current_theme() . DS . 'archive-espresso_events-filters.php',
+            EE_TEMPLATES.EE_Config::get_current_theme().DS.'archive-espresso_events-filters.php',
             $args
         );
     }
@@ -920,7 +920,7 @@ 
         if (self::$_type == 'grid') {
             $event_list_grid_size = isset($EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size)
                 ? $EE->CFG->template_settings->EED_Events_Archive_Filters->event_list_grid_size : 'medium';
-            $event_list_css[] = $event_list_grid_size . '-event-list-grid';
+            $event_list_css[] = $event_list_grid_size.'-event-list-grid';
         }
         $event_list_css = apply_filters(
             'EED_Events_Archive_Filters__event_list_css__event_list_css_array',
@@ -1016,7 +1016,7 @@ 
                 'add_fragment' => '',
             )
         );
-        return ! empty($pagination) ? '<div class="ee-pagination-dv clear">' . $pagination . '</div>' : '';
+        return ! empty($pagination) ? '<div class="ee-pagination-dv clear">'.$pagination.'</div>' : '';
     }
 
 

modules/feeds/EED_Feeds.module.php

Doc Comments +4 added lines, -4 removed lines

@@ -112,7 +112,7 @@ 
      *
      * @access    public
      * @param    string $SQL the JOIN clause for the comment feed query
-     * @return    void
+     * @return    string
      */
     public static function comment_feed_join($SQL)
     {
@@ -133,7 +133,7 @@ 
      *
      * @access    public
      * @param    string $SQL the WHERE clause for the comment feed query
-     * @return    void
+     * @return    string
      */
     public static function comment_feed_where($SQL)
     {
@@ -150,7 +150,7 @@ 
      *
      * @access    public
      * @param    string $content
-     * @return    void
+     * @return    string
      */
     public static function the_event_feed($content)
     {
@@ -191,7 +191,7 @@ 
      *
      * @access    public
      * @param    string $content
-     * @return    void
+     * @return    string
      */
     public static function the_venue_feed($content)
     {

Indentation +213 added lines, -213 removed lines

@@ -12,217 +12,217 @@
 {
 
 
-    /**
-     * @return EED_Feeds
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_action('parse_request', array('EED_Feeds', 'parse_request'), 10);
-        add_filter('default_feed', array('EED_Feeds', 'default_feed'), 10, 1);
-        add_filter('comment_feed_join', array('EED_Feeds', 'comment_feed_join'), 10, 2);
-        add_filter('comment_feed_where', array('EED_Feeds', 'comment_feed_where'), 10, 2);
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     *    default_feed
-     *
-     * @access    public
-     * @param    type    rss2, atom, rss, rdf, rssjs
-     * @return    string
-     */
-    public static function default_feed($type = 'rss2')
-    {
-        // rss2, atom, rss, rdf, rssjs
-        $type = 'rss2';
-        return $type;
-    }
-
-
-    /**
-     *    parse_request
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function parse_request()
-    {
-        if (EE_Registry::instance()->REQ->is_set('post_type')) {
-            // define path to templates
-            define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
-            // what kinda post_type are we dealing with ?
-            switch (EE_Registry::instance()->REQ->get('post_type')) {
-                case 'espresso_events':
-                    // for rss2, atom, rss, rdf
-                    add_filter('the_excerpt_rss', array('EED_Feeds', 'the_event_feed'), 10, 1);
-                    add_filter('the_content_feed', array('EED_Feeds', 'the_event_feed'), 10, 1);
-                    // for json ( also uses the above filter )
-                    add_filter('rssjs_feed_item', array('EED_Feeds', 'the_event_rssjs_feed'), 10, 1);
-                    break;
-                case 'espresso_venues':
-                    // for rss2, atom, rss, rdf
-                    add_filter('the_excerpt_rss', array('EED_Feeds', 'the_venue_feed'), 10, 1);
-                    add_filter('the_content_feed', array('EED_Feeds', 'the_venue_feed'), 10, 1);
-                    // for json ( also uses the above filter )
-                    add_filter('rssjs_feed_item', array('EED_Feeds', 'the_venue_rssjs_feed'), 10, 1);
-                    break;
-            }
-        }
-    }
-
-
-    /**
-     *    comment_feed_join - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
-     *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
-     *    so this little snippet of SQL taps into the comment feed query and removes comments for the
-     *    espresso_attendees post_type
-     *
-     * @access    public
-     * @param    string $SQL the JOIN clause for the comment feed query
-     * @return    void
-     */
-    public static function comment_feed_join($SQL)
-    {
-        global $wpdb;
-        // check for wp_posts table in JOIN clause
-        if (strpos($SQL, $wpdb->posts) !== false) {
-            add_filter('EED_Feeds__comment_feed_where__espresso_attendees', '__return_true');
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    comment_feed_where - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
-     *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
-     *    so this little snippet of SQL taps into the comment feed query and removes comments for the
-     *    espresso_attendees post_type
-     *
-     * @access    public
-     * @param    string $SQL the WHERE clause for the comment feed query
-     * @return    void
-     */
-    public static function comment_feed_where($SQL)
-    {
-        global $wp_query, $wpdb;
-        if ($wp_query->is_comment_feed && apply_filters('EED_Feeds__comment_feed_where__espresso_attendees', false)) {
-            $SQL .= " AND $wpdb->posts.post_type != 'espresso_attendees'";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    the_event_feed
-     *
-     * @access    public
-     * @param    string $content
-     * @return    void
-     */
-    public static function the_event_feed($content)
-    {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
-            global $post;
-            $template_args = array(
-                'EVT_ID'            => $post->ID,
-                'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
-            );
-            $content = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $content;
-    }
-
-
-    /**
-     *    the_event_rssjs_feed
-     *
-     * @access    public
-     * @param    object $item
-     * @return    void
-     */
-    public static function the_event_rssjs_feed($item)
-    {
-        if (is_feed() && isset($item->description)) {
-            $item->description = EED_Feeds::the_event_feed($item->description);
-        }
-        return $item;
-    }
-
-
-    /**
-     *    the_venue_feed
-     *
-     * @access    public
-     * @param    string $content
-     * @return    void
-     */
-    public static function the_venue_feed($content)
-    {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
-            global $post;
-            $template_args = array(
-                'VNU_ID'            => $post->ID,
-                'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
-            );
-            $content = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $content;
-    }
-
-
-    /**
-     *    the_venue_rssjs_feed
-     *
-     * @access    public
-     * @param    object $item
-     * @return    void
-     */
-    public static function the_venue_rssjs_feed($item)
-    {
-        if (is_feed() && isset($item->description)) {
-            $item->description = EED_Feeds::the_venue_feed($item->description);
-        }
-        return $item;
-    }
+	/**
+	 * @return EED_Feeds
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_action('parse_request', array('EED_Feeds', 'parse_request'), 10);
+		add_filter('default_feed', array('EED_Feeds', 'default_feed'), 10, 1);
+		add_filter('comment_feed_join', array('EED_Feeds', 'comment_feed_join'), 10, 2);
+		add_filter('comment_feed_where', array('EED_Feeds', 'comment_feed_where'), 10, 2);
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 *    default_feed
+	 *
+	 * @access    public
+	 * @param    type    rss2, atom, rss, rdf, rssjs
+	 * @return    string
+	 */
+	public static function default_feed($type = 'rss2')
+	{
+		// rss2, atom, rss, rdf, rssjs
+		$type = 'rss2';
+		return $type;
+	}
+
+
+	/**
+	 *    parse_request
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function parse_request()
+	{
+		if (EE_Registry::instance()->REQ->is_set('post_type')) {
+			// define path to templates
+			define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
+			// what kinda post_type are we dealing with ?
+			switch (EE_Registry::instance()->REQ->get('post_type')) {
+				case 'espresso_events':
+					// for rss2, atom, rss, rdf
+					add_filter('the_excerpt_rss', array('EED_Feeds', 'the_event_feed'), 10, 1);
+					add_filter('the_content_feed', array('EED_Feeds', 'the_event_feed'), 10, 1);
+					// for json ( also uses the above filter )
+					add_filter('rssjs_feed_item', array('EED_Feeds', 'the_event_rssjs_feed'), 10, 1);
+					break;
+				case 'espresso_venues':
+					// for rss2, atom, rss, rdf
+					add_filter('the_excerpt_rss', array('EED_Feeds', 'the_venue_feed'), 10, 1);
+					add_filter('the_content_feed', array('EED_Feeds', 'the_venue_feed'), 10, 1);
+					// for json ( also uses the above filter )
+					add_filter('rssjs_feed_item', array('EED_Feeds', 'the_venue_rssjs_feed'), 10, 1);
+					break;
+			}
+		}
+	}
+
+
+	/**
+	 *    comment_feed_join - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
+	 *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
+	 *    so this little snippet of SQL taps into the comment feed query and removes comments for the
+	 *    espresso_attendees post_type
+	 *
+	 * @access    public
+	 * @param    string $SQL the JOIN clause for the comment feed query
+	 * @return    void
+	 */
+	public static function comment_feed_join($SQL)
+	{
+		global $wpdb;
+		// check for wp_posts table in JOIN clause
+		if (strpos($SQL, $wpdb->posts) !== false) {
+			add_filter('EED_Feeds__comment_feed_where__espresso_attendees', '__return_true');
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    comment_feed_where - EVEN THOUGH... our espresso_attendees custom post type is set to NOT PUBLIC
+	 *    WordPress thought it would be a good idea to display the comments for them in the RSS feeds... we think NOT
+	 *    so this little snippet of SQL taps into the comment feed query and removes comments for the
+	 *    espresso_attendees post_type
+	 *
+	 * @access    public
+	 * @param    string $SQL the WHERE clause for the comment feed query
+	 * @return    void
+	 */
+	public static function comment_feed_where($SQL)
+	{
+		global $wp_query, $wpdb;
+		if ($wp_query->is_comment_feed && apply_filters('EED_Feeds__comment_feed_where__espresso_attendees', false)) {
+			$SQL .= " AND $wpdb->posts.post_type != 'espresso_attendees'";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    the_event_feed
+	 *
+	 * @access    public
+	 * @param    string $content
+	 * @return    void
+	 */
+	public static function the_event_feed($content)
+	{
+		if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
+			global $post;
+			$template_args = array(
+				'EVT_ID'            => $post->ID,
+				'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
+			);
+			$content = EEH_Template::display_template(
+				RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    the_event_rssjs_feed
+	 *
+	 * @access    public
+	 * @param    object $item
+	 * @return    void
+	 */
+	public static function the_event_rssjs_feed($item)
+	{
+		if (is_feed() && isset($item->description)) {
+			$item->description = EED_Feeds::the_event_feed($item->description);
+		}
+		return $item;
+	}
+
+
+	/**
+	 *    the_venue_feed
+	 *
+	 * @access    public
+	 * @param    string $content
+	 * @return    void
+	 */
+	public static function the_venue_feed($content)
+	{
+		if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
+			global $post;
+			$template_args = array(
+				'VNU_ID'            => $post->ID,
+				'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
+			);
+			$content = EEH_Template::display_template(
+				RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    the_venue_rssjs_feed
+	 *
+	 * @access    public
+	 * @param    object $item
+	 * @return    void
+	 */
+	public static function the_venue_rssjs_feed($item)
+	{
+		if (is_feed() && isset($item->description)) {
+			$item->description = EED_Feeds::the_venue_feed($item->description);
+		}
+		return $item;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -82,7 +82,7 @@ 
     {
         if (EE_Registry::instance()->REQ->is_set('post_type')) {
             // define path to templates
-            define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
+            define('RSS_FEEDS_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
             // what kinda post_type are we dealing with ?
             switch (EE_Registry::instance()->REQ->get('post_type')) {
                 case 'espresso_events':
@@ -154,14 +154,14 @@ 
      */
     public static function the_event_feed($content)
     {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php')) {
+        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH.'espresso_events_feed.template.php')) {
             global $post;
             $template_args = array(
                 'EVT_ID'            => $post->ID,
                 'event_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
             );
             $content = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_events_feed.template.php',
+                RSS_FEEDS_TEMPLATES_PATH.'espresso_events_feed.template.php',
                 $template_args,
                 true
             );
@@ -195,14 +195,14 @@ 
      */
     public static function the_venue_feed($content)
     {
-        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php')) {
+        if (is_feed() && is_readable(RSS_FEEDS_TEMPLATES_PATH.'espresso_venues_feed.template.php')) {
             global $post;
             $template_args = array(
                 'VNU_ID'            => $post->ID,
                 'venue_description' => get_option('rss_use_excerpt') ? $post->post_excerpt : $post->post_content,
             );
             $content = EEH_Template::display_template(
-                RSS_FEEDS_TEMPLATES_PATH . 'espresso_venues_feed.template.php',
+                RSS_FEEDS_TEMPLATES_PATH.'espresso_venues_feed.template.php',
                 $template_args,
                 true
             );

admin_pages/support/Support_Admin_Page_Init.core.php

Indentation +30 added lines, -30 removed lines

@@ -16,36 +16,36 @@
 {
 
 
-    public function __construct()
-    {
-        // define some help/support page related constants
-        define('EE_SUPPORT_PG_SLUG', 'espresso_support');
-        define('EE_SUPPORT_ADMIN_URL', admin_url('admin.php?page=' . EE_SUPPORT_PG_SLUG));
-        define('EE_SUPPORT_ADMIN_TEMPLATE_PATH', EE_ADMIN_PAGES . 'support/templates/');
-        define('EE_SUPPORT_ADMIN', EE_ADMIN_PAGES . 'support/');
-        define('EE_SUPPORT_ASSETS_URL', EE_ADMIN_PAGES_URL . 'support/assets/');
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		// define some help/support page related constants
+		define('EE_SUPPORT_PG_SLUG', 'espresso_support');
+		define('EE_SUPPORT_ADMIN_URL', admin_url('admin.php?page=' . EE_SUPPORT_PG_SLUG));
+		define('EE_SUPPORT_ADMIN_TEMPLATE_PATH', EE_ADMIN_PAGES . 'support/templates/');
+		define('EE_SUPPORT_ADMIN', EE_ADMIN_PAGES . 'support/');
+		define('EE_SUPPORT_ASSETS_URL', EE_ADMIN_PAGES_URL . 'support/assets/');
+		parent::__construct();
+	}
 
-    protected function _set_init_properties()
-    {
-        $this->label = __('Help & Support', 'event_espresso');
-    }
+	protected function _set_init_properties()
+	{
+		$this->label = __('Help & Support', 'event_espresso');
+	}
 
-    protected function _set_menu_map()
-    {
-        $this->_menu_map = new EE_Admin_Page_Sub_Menu(
-            array(
-                'menu_group'              => 'extras',
-                'menu_order'              => 30,
-                'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                'parent_slug'             => 'espresso_events',
-                'menu_slug'               => EE_SUPPORT_PG_SLUG,
-                'menu_label'              => __('Help & Support', 'event_espresso'),
-                'capability'              => 'ee_read_ee',
-                'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                'admin_init_page'         => $this,
-            )
-        );
-    }
+	protected function _set_menu_map()
+	{
+		$this->_menu_map = new EE_Admin_Page_Sub_Menu(
+			array(
+				'menu_group'              => 'extras',
+				'menu_order'              => 30,
+				'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+				'parent_slug'             => 'espresso_events',
+				'menu_slug'               => EE_SUPPORT_PG_SLUG,
+				'menu_label'              => __('Help & Support', 'event_espresso'),
+				'capability'              => 'ee_read_ee',
+				'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				'admin_init_page'         => $this,
+			)
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -20,10 +20,10 @@
     {
         // define some help/support page related constants
         define('EE_SUPPORT_PG_SLUG', 'espresso_support');
-        define('EE_SUPPORT_ADMIN_URL', admin_url('admin.php?page=' . EE_SUPPORT_PG_SLUG));
-        define('EE_SUPPORT_ADMIN_TEMPLATE_PATH', EE_ADMIN_PAGES . 'support/templates/');
-        define('EE_SUPPORT_ADMIN', EE_ADMIN_PAGES . 'support/');
-        define('EE_SUPPORT_ASSETS_URL', EE_ADMIN_PAGES_URL . 'support/assets/');
+        define('EE_SUPPORT_ADMIN_URL', admin_url('admin.php?page='.EE_SUPPORT_PG_SLUG));
+        define('EE_SUPPORT_ADMIN_TEMPLATE_PATH', EE_ADMIN_PAGES.'support/templates/');
+        define('EE_SUPPORT_ADMIN', EE_ADMIN_PAGES.'support/');
+        define('EE_SUPPORT_ASSETS_URL', EE_ADMIN_PAGES_URL.'support/assets/');
         parent::__construct();
     }