eventespresso / event-espresso-core

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +57 added lines, -57 removed lines

@@ -21,63 +21,63 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return MINUTE_IN_SECONDS * 5;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return MINUTE_IN_SECONDS * 5;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();    }
 }
 // End of file EspressoTicketSelector.php
 // Location: EventEspresso\core\domain\entities\shortcodes/EspressoTicketSelector.php
\ No newline at end of file

core/domain/entities/shortcodes/EspressoEventAttendees.php

Indentation +239 added lines, -239 removed lines

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

core/services/shortcodes/ShortcodeInterface.php

Indentation +38 added lines, -38 removed lines

@@ -8,44 +8,44 @@
 interface ShortcodeInterface
 {
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag();
-
-    /**
-     * the length of time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration();
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * !!! IMPORTANT !!!
-     * After performing any logic within this method required for initialization
-     *         $this->shortcodeHasBeenInitialized();
-     * should be called to ensure that the shortcode is setup correctly.
-     *
-     * @return void
-     */
-    public function initializeShortcode();
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array());
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag();
+
+	/**
+	 * the length of time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration();
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * !!! IMPORTANT !!!
+	 * After performing any logic within this method required for initialization
+	 *         $this->shortcodeHasBeenInitialized();
+	 * should be called to ensure that the shortcode is setup correctly.
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode();
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array());
 
 }
 // End of file ShortcodeInterface.php

core/services/shortcodes/EspressoShortcode.php

Indentation +213 added lines, -213 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -81,7 +81,7 @@ 
             }
         }
         return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
+            $this->sanitizeAttributes((array) $attributes)
         );
     }
 
@@ -109,8 +109,8 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
+            function() use ($shortcode, $attributes) {
+                if ($shortcode->initialized === false) {
                     $shortcode->initializeShortcode();
                 }
                 return $shortcode->processShortcode($attributes);

espresso.php

Indentation +219 added lines, -219 removed lines

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

core/domain/services/admin/AdminToolBar.php

Indentation +799 added lines, -799 removed lines

@@ -22,804 +22,804 @@
 class AdminToolBar
 {
 
-    /**
-     * @var WP_Admin_Bar $admin_bar
-     */
-    private $admin_bar;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var string $events_admin_url
-     */
-    private $events_admin_url;
-
-    /**
-     * @var string $menu_class
-     */
-    private $menu_class = 'espresso_menu_item_class';
-
-    /**
-     * @var string $reg_admin_url
-     */
-    private $reg_admin_url;
-
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
-        $this->enqueueAssets();
-    }
-
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if its an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (
-            defined('DOING_AJAX')
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->admin_bar = $admin_bar;
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        //because they're only defined in each of their respective constructors
-        //and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all of the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            array(
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                    . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                    . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => array(
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if (
-        $this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_edit_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-new'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array('action' => 'create_new'),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            //Current post
-            global $post;
-            if (
-                $this->capabilities->current_user_can(
-                    'ee_edit_event',
-                    'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID
-                )
-            ) {
-                $this->admin_bar->add_menu(
-                    array(
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post' => $post->ID
-                            ),
-                            $this->events_admin_url
-                        ),
-                        'meta'   => array(
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ),
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-view'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-all'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'today'
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'month'
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'     => 'default',
-                            'status'     => 'today',
-                            'reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', //EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_ee',
-                'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => array(
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
+	/**
+	 * @var WP_Admin_Bar $admin_bar
+	 */
+	private $admin_bar;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var string $events_admin_url
+	 */
+	private $events_admin_url;
+
+	/**
+	 * @var string $menu_class
+	 */
+	private $menu_class = 'espresso_menu_item_class';
+
+	/**
+	 * @var string $reg_admin_url
+	 */
+	private $reg_admin_url;
+
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
+		$this->enqueueAssets();
+	}
+
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if its an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (
+			defined('DOING_AJAX')
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->admin_bar = $admin_bar;
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		//because they're only defined in each of their respective constructors
+		//and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all of the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			array(
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+					. esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+					. '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => array(
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if (
+		$this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_edit_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-new'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array('action' => 'create_new'),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			//Current post
+			global $post;
+			if (
+				$this->capabilities->current_user_can(
+					'ee_edit_event',
+					'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID
+				)
+			) {
+				$this->admin_bar->add_menu(
+					array(
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post' => $post->ID
+							),
+							$this->events_admin_url
+						),
+						'meta'   => array(
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						),
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-view'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-all'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'today'
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'month'
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'     => 'default',
+							'status'     => 'today',
+							'reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', //EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_ee',
+				'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => array(
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
 
 }

core/EE_System.core.php

Indentation +1027 added lines, -1027 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\services\shortcodes\ShortcodesManager;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,1032 +18,1032 @@ 
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @type  EE_Registry $Registry
-     * @access    protected
-     */
-    protected $registry;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Registry $Registry
-     * @return \EE_System
-     */
-    public static function instance(EE_Registry $Registry = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($Registry);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     *    sets hooks for running rest of system
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     *    starting EE Addons from any other point may lead to problems
-     *
-     * @access private
-     * @param  \EE_Registry $Registry
-     */
-    private function __construct(EE_Registry $Registry)
-    {
-        $this->registry = $Registry;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
-            3);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
-        // you wanna get going? I wanna get going... let's get going!
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        //load and setup EE_Capabilities
-        $this->registry->load_core('Capabilities');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if ( ! function_exists('json_basic_auth_handler')
-             && ! function_exists('json_basic_auth_error')
-             && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
-            )
-             && ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            //detect teh request type for that addon
-            $addon->detect_activation_or_upgrade();
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // load M-Mode class
-        $this->registry->load_core('Maintenance_Mode');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    protected function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required'));
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param null $espresso_db_update
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
-     *           from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if ( ! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if ( ! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            $addon->initialize_db_if_no_migrations_required();
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if ( ! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add == null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
-                'ee_espresso_activation', espresso_version());
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    protected function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if ( ! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
-                            ? '1970-01-01 00:00:00' : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->registry->load_core('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $this->registry->load_core('Config');
-        $this->registry->load_core('Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($this->registry->CFG->admin->use_full_logging) {
-            $this->registry->load_core('Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models);
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        try {
-            // load, register, and add shortcodes the new way
-            new ShortcodesManager(
-            // and the old way, but we'll put it under control of the new system
-                EE_Config::getLegacyShortcodesManager()
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hookpoint
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
-        if ( ! empty($class_names)) {
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso');
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso');
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->registry->load_core('PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if ( ! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->registry->load_core('Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->registry->load_core('Front_Controller');
-        } else if ( ! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            EE_Registry::instance()->load_core('Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
-        }
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->registry->load_core('Session');
-        $this->registry->create('EventEspresso\core\services\assets\Registry');
-        wp_enqueue_script('espresso_core');
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function addEspressoToolbar()
-    {
-        $this->registry->create(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if ( ! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if ( ! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if ( ! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @type  EE_Registry $Registry
+	 * @access    protected
+	 */
+	protected $registry;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Registry $Registry
+	 * @return \EE_System
+	 */
+	public static function instance(EE_Registry $Registry = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($Registry);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *    sets hooks for running rest of system
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 *    starting EE Addons from any other point may lead to problems
+	 *
+	 * @access private
+	 * @param  \EE_Registry $Registry
+	 */
+	private function __construct(EE_Registry $Registry)
+	{
+		$this->registry = $Registry;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
+			3);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		//load and setup EE_Capabilities
+		$this->registry->load_core('Capabilities');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if ( ! function_exists('json_basic_auth_handler')
+			 && ! function_exists('json_basic_auth_error')
+			 && ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
+			)
+			 && ! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			//detect teh request type for that addon
+			$addon->detect_activation_or_upgrade();
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// load M-Mode class
+		$this->registry->load_core('Maintenance_Mode');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	protected function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required'));
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param null $espresso_db_update
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
+	 *           from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if ( ! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if ( ! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			$addon->initialize_db_if_no_migrations_required();
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if ( ! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add == null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
+				'ee_espresso_activation', espresso_version());
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	protected function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if ( ! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
+							? '1970-01-01 00:00:00' : $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->registry->load_core('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$this->registry->load_core('Config');
+		$this->registry->load_core('Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($this->registry->CFG->admin->use_full_logging) {
+			$this->registry->load_core('Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		try {
+			// load, register, and add shortcodes the new way
+			new ShortcodesManager(
+			// and the old way, but we'll put it under control of the new system
+				EE_Config::getLegacyShortcodesManager()
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hookpoint
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
+		if ( ! empty($class_names)) {
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso');
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso');
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->registry->load_core('PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if ( ! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->registry->load_core('Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->registry->load_core('Front_Controller');
+		} else if ( ! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			EE_Registry::instance()->load_core('Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// load_espresso_template_tags
+		if (is_readable(EE_PUBLIC . 'template_tags.php')) {
+			require_once(EE_PUBLIC . 'template_tags.php');
+		}
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->registry->load_core('Session');
+		$this->registry->create('EventEspresso\core\services\assets\Registry');
+		wp_enqueue_script('espresso_core');
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->registry->create(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if ( ! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if ( ! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if ( ! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 
 
 

Spacing +9 added lines, -9 removed lines

@@ -184,7 +184,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
         //load and setup EE_Capabilities
         $this->registry->load_core('Capabilities');
         //caps need to be initialized on every request so that capability maps are set.
@@ -207,7 +207,7 @@ 
                 && $_GET['activate'] === 'true'
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -689,7 +689,7 @@ 
     private function _parse_model_names()
     {
         //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -717,8 +717,8 @@ 
      */
     private function _maybe_brew_regular()
     {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -768,8 +768,8 @@ 
                 'event_espresso');
             $msg .= '<ul>';
             foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
+                $msg .= '<li><b>Event Espresso - '.str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+                        $class_name).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
@@ -918,8 +918,8 @@ 
     {
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
+        if (is_readable(EE_PUBLIC.'template_tags.php')) {
+            require_once(EE_PUBLIC.'template_tags.php');
         }
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
         $this->registry->load_core('Session');