eventespresso / event-espresso-core

core/services/notifications/PersistentAdminNoticeManager.php

Indentation +338 added lines, -338 removed lines

@@ -30,344 +30,344 @@
 class PersistentAdminNoticeManager
 {
 
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    /**
-     * @var Collection|PersistentAdminNotice[] $notice_collection
-     */
-    private $notice_collection;
-
-    /**
-     * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
-     * persistent admin notice was displayed, and ultimately dismissed from.
-     *
-     * @type string $return_url
-     */
-    private $return_url;
-
-    /**
-     * @type CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @type EE_Request $request
-     */
-    private $request;
-
-
-
-    /**
-     * CapChecker constructor
-     *
-     * @param string              $return_url  where to  redirect to after dismissing notices
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param EE_Request          $request
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, EE_Request $request)
-    {
-        $this->setReturnUrl($return_url);
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request              = $request;
-        // setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
-        // and we want to retrieve and generate any nag notices at the last possible moment
-        add_action('admin_notices', array($this, 'displayNotices'), 9);
-        add_action('network_admin_notices', array($this, 'displayNotices'), 9);
-        add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
-        add_action('shutdown', array($this, 'saveNotices'));
-    }
-
-
-
-    /**
-     * @param string $return_url
-     * @throws InvalidDataTypeException
-     */
-    private function setReturnUrl($return_url)
-    {
-        if (! is_string($return_url)) {
-            throw new InvalidDataTypeException('$return_url', $return_url, 'string');
-        }
-        $this->return_url = $return_url;
-    }
-
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    protected function getPersistentAdminNoticeCollection()
-    {
-        if (! $this->notice_collection instanceof Collection) {
-            $this->notice_collection = new Collection(
-                'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            );
-            $this->retrieveStoredNotices();
-            $this->registerNotices();
-        }
-        return $this->notice_collection;
-    }
-
-
-
-    /**
-     * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
-     *
-     * @return void
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        // \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
-        if (! empty($persistent_admin_notices)) {
-            foreach ($persistent_admin_notices as $name => $details) {
-                if (is_array($details)) {
-                    if (
-                    ! isset(
-                        $details['message'],
-                        $details['capability'],
-                        $details['cap_context'],
-                        $details['dismissed']
-                    )
-                    ) {
-                        throw new DomainException(
-                            sprintf(
-                                esc_html__(
-                                    'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
-                                    'event_espresso'
-                                ),
-                                $name
-                            )
-                        );
-                    }
-                    // new format for nag notices
-                    $this->notice_collection->add(
-                        new PersistentAdminNotice(
-                            $name,
-                            $details['message'],
-                            false,
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        ),
-                        $name
-                    );
-                } else {
-                    try {
-                        // old nag notices, that we want to convert to the new format
-                        $this->notice_collection->add(
-                            new PersistentAdminNotice(
-                                $name,
-                                (string)$details,
-                                false,
-                                '',
-                                '',
-                                empty($details)
-                            ),
-                            $name
-                        );
-                    } catch (Exception $e) {
-                        EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-                // each notice will self register when the action hook in registerNotices is triggered
-            }
-        }
-    }
-
-
-
-    /**
-     * exposes the Persistent Admin Notice Collection via an action
-     * so that PersistentAdminNotice objects can be added and/or removed
-     * without compromising the actual collection like a filter would
-     */
-    protected function registerNotices()
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            $this->notice_collection
-        );
-    }
-
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            // and display notices
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                // don't display notices that have already been dismissed
-                if ($persistent_admin_notice->getDismissed()) {
-                    continue;
-                }
-                try {
-                    $this->capabilities_checker->processCapCheck(
-                        $persistent_admin_notice->getCapCheck()
-                    );
-                } catch (InsufficientPermissionsException $e) {
-                    // user does not have required cap, so skip to next notice
-                    // and just eat the exception - nom nom nom nom
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-            }
-            $this->enqueueAssets();
-        }
-    }
-
-
-
-    /**
-     * does what it's named
-     *
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_error_js',
-            'ee_dismiss',
-            array(
-                'return_url'    => urlencode($this->return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => esc_html__(
-                    'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                    'event_espresso'
-                ),
-            )
-        );
-        wp_enqueue_script('ee_error_js');
-    }
-
-
-
-    /**
-     * displayPersistentAdminNoticeHtml
-     *
-     * @param  PersistentAdminNotice $persistent_admin_notice
-     */
-    protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
-    {
-        // used in template
-        $persistent_admin_notice_name    = $persistent_admin_notice->getName();
-        $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
-    }
-
-
-
-    /**
-     * dismissNotice
-     *
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge    if true, then delete it from the db
-     * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
-     * @return void
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $return = false)
-    {
-        $pan_name                = $this->request->get('ee_nag_notice', $pan_name);
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
-            /** @var PersistentAdminNotice $persistent_admin_notice */
-            $persistent_admin_notice = $this->notice_collection->get($pan_name);
-            $persistent_admin_notice->setDismissed(true);
-            $persistent_admin_notice->setPurge($purge);
-            $this->saveNotices();
-        }
-        if ($return) {
-            return;
-        }
-        if ($this->request->ajax) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(
-                array(
-                    'errors' => implode('<br />', EE_Error::get_notices(false)),
-                )
-            );
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect(
-            urldecode(
-                $this->request->get('return_url', '')
-            )
-        );
-    }
-
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     */
-    public function saveNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-            //maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
-            }
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // are we deleting this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[$persistent_admin_notice->getName()]);
-                } else {
-                    /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[$persistent_admin_notice->getName()] = array(
-                        'message'     => $persistent_admin_notice->getMessage(),
-                        'capability'  => $persistent_admin_notice->getCapability(),
-                        'cap_context' => $persistent_admin_notice->getCapContext(),
-                        'dismissed'   => $persistent_admin_notice->getDismissed(),
-                    );
-                }
-            }
-            update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
-        }
-    }
+	const WP_OPTION_KEY = 'ee_pers_admin_notices';
+
+	/**
+	 * @var Collection|PersistentAdminNotice[] $notice_collection
+	 */
+	private $notice_collection;
+
+	/**
+	 * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
+	 * persistent admin notice was displayed, and ultimately dismissed from.
+	 *
+	 * @type string $return_url
+	 */
+	private $return_url;
+
+	/**
+	 * @type CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @type EE_Request $request
+	 */
+	private $request;
+
+
+
+	/**
+	 * CapChecker constructor
+	 *
+	 * @param string              $return_url  where to  redirect to after dismissing notices
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param EE_Request          $request
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, EE_Request $request)
+	{
+		$this->setReturnUrl($return_url);
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request              = $request;
+		// setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
+		// and we want to retrieve and generate any nag notices at the last possible moment
+		add_action('admin_notices', array($this, 'displayNotices'), 9);
+		add_action('network_admin_notices', array($this, 'displayNotices'), 9);
+		add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
+		add_action('shutdown', array($this, 'saveNotices'));
+	}
+
+
+
+	/**
+	 * @param string $return_url
+	 * @throws InvalidDataTypeException
+	 */
+	private function setReturnUrl($return_url)
+	{
+		if (! is_string($return_url)) {
+			throw new InvalidDataTypeException('$return_url', $return_url, 'string');
+		}
+		$this->return_url = $return_url;
+	}
+
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	protected function getPersistentAdminNoticeCollection()
+	{
+		if (! $this->notice_collection instanceof Collection) {
+			$this->notice_collection = new Collection(
+				'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			);
+			$this->retrieveStoredNotices();
+			$this->registerNotices();
+		}
+		return $this->notice_collection;
+	}
+
+
+
+	/**
+	 * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
+	 *
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		// \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
+		if (! empty($persistent_admin_notices)) {
+			foreach ($persistent_admin_notices as $name => $details) {
+				if (is_array($details)) {
+					if (
+					! isset(
+						$details['message'],
+						$details['capability'],
+						$details['cap_context'],
+						$details['dismissed']
+					)
+					) {
+						throw new DomainException(
+							sprintf(
+								esc_html__(
+									'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
+									'event_espresso'
+								),
+								$name
+							)
+						);
+					}
+					// new format for nag notices
+					$this->notice_collection->add(
+						new PersistentAdminNotice(
+							$name,
+							$details['message'],
+							false,
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						),
+						$name
+					);
+				} else {
+					try {
+						// old nag notices, that we want to convert to the new format
+						$this->notice_collection->add(
+							new PersistentAdminNotice(
+								$name,
+								(string)$details,
+								false,
+								'',
+								'',
+								empty($details)
+							),
+							$name
+						);
+					} catch (Exception $e) {
+						EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+				// each notice will self register when the action hook in registerNotices is triggered
+			}
+		}
+	}
+
+
+
+	/**
+	 * exposes the Persistent Admin Notice Collection via an action
+	 * so that PersistentAdminNotice objects can be added and/or removed
+	 * without compromising the actual collection like a filter would
+	 */
+	protected function registerNotices()
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			$this->notice_collection
+		);
+	}
+
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			// and display notices
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				// don't display notices that have already been dismissed
+				if ($persistent_admin_notice->getDismissed()) {
+					continue;
+				}
+				try {
+					$this->capabilities_checker->processCapCheck(
+						$persistent_admin_notice->getCapCheck()
+					);
+				} catch (InsufficientPermissionsException $e) {
+					// user does not have required cap, so skip to next notice
+					// and just eat the exception - nom nom nom nom
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+			}
+			$this->enqueueAssets();
+		}
+	}
+
+
+
+	/**
+	 * does what it's named
+	 *
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_error_js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_error_js',
+			'ee_dismiss',
+			array(
+				'return_url'    => urlencode($this->return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => esc_html__(
+					'An unknown error has occurred on the server while attempting to dismiss this notice.',
+					'event_espresso'
+				),
+			)
+		);
+		wp_enqueue_script('ee_error_js');
+	}
+
+
+
+	/**
+	 * displayPersistentAdminNoticeHtml
+	 *
+	 * @param  PersistentAdminNotice $persistent_admin_notice
+	 */
+	protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
+	{
+		// used in template
+		$persistent_admin_notice_name    = $persistent_admin_notice->getName();
+		$persistent_admin_notice_message = $persistent_admin_notice->getMessage();
+		require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
+	}
+
+
+
+	/**
+	 * dismissNotice
+	 *
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge    if true, then delete it from the db
+	 * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $return = false)
+	{
+		$pan_name                = $this->request->get('ee_nag_notice', $pan_name);
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+			/** @var PersistentAdminNotice $persistent_admin_notice */
+			$persistent_admin_notice = $this->notice_collection->get($pan_name);
+			$persistent_admin_notice->setDismissed(true);
+			$persistent_admin_notice->setPurge($purge);
+			$this->saveNotices();
+		}
+		if ($return) {
+			return;
+		}
+		if ($this->request->ajax) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(
+				array(
+					'errors' => implode('<br />', EE_Error::get_notices(false)),
+				)
+			);
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect(
+			urldecode(
+				$this->request->get('return_url', '')
+			)
+		);
+	}
+
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 */
+	public function saveNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+			//maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
+			}
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// are we deleting this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					unset($persistent_admin_notices[$persistent_admin_notice->getName()]);
+				} else {
+					/** @var PersistentAdminNotice $persistent_admin_notice */
+					$persistent_admin_notices[$persistent_admin_notice->getName()] = array(
+						'message'     => $persistent_admin_notice->getMessage(),
+						'capability'  => $persistent_admin_notice->getCapability(),
+						'cap_context' => $persistent_admin_notice->getCapContext(),
+						'dismissed'   => $persistent_admin_notice->getDismissed(),
+					);
+				}
+			}
+			update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
+		}
+	}
 
 
 

Spacing +8 added lines, -8 removed lines

@@ -86,7 +86,7 @@ 
      */
     private function setReturnUrl($return_url)
     {
-        if (! is_string($return_url)) {
+        if ( ! is_string($return_url)) {
             throw new InvalidDataTypeException('$return_url', $return_url, 'string');
         }
         $this->return_url = $return_url;
@@ -103,7 +103,7 @@ 
      */
     protected function getPersistentAdminNoticeCollection()
     {
-        if (! $this->notice_collection instanceof Collection) {
+        if ( ! $this->notice_collection instanceof Collection) {
             $this->notice_collection = new Collection(
                 'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
             );
@@ -127,7 +127,7 @@ 
     {
         $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
         // \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
-        if (! empty($persistent_admin_notices)) {
+        if ( ! empty($persistent_admin_notices)) {
             foreach ($persistent_admin_notices as $name => $details) {
                 if (is_array($details)) {
                     if (
@@ -166,7 +166,7 @@ 
                         $this->notice_collection->add(
                             new PersistentAdminNotice(
                                 $name,
-                                (string)$details,
+                                (string) $details,
                                 false,
                                 '',
                                 '',
@@ -244,14 +244,14 @@ 
     {
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
             array('espresso_core'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -283,7 +283,7 @@ 
         // used in template
         $persistent_admin_notice_name    = $persistent_admin_notice->getName();
         $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
+        require EE_TEMPLATES.DS.'notifications'.DS.'persistent_admin_notice.template.php';
     }
 
 
@@ -304,7 +304,7 @@ 
     {
         $pan_name                = $this->request->get('ee_nag_notice', $pan_name);
         $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+        if ( ! empty($pan_name) && $this->notice_collection->has($pan_name)) {
             /** @var PersistentAdminNotice $persistent_admin_notice */
             $persistent_admin_notice = $this->notice_collection->get($pan_name);
             $persistent_admin_notice->setDismissed(true);

core/domain/entities/notifications/PersistentAdminNotice.php

Indentation +321 added lines, -321 removed lines

@@ -26,330 +26,330 @@
 class PersistentAdminNotice implements RequiresCapCheckInterface
 {
 
-    /**
-     * @var string $name
-     */
-    protected $name = '';
-
-    /**
-     * @var string $message
-     */
-    protected $message = '';
-
-    /**
-     * @var boolean $force_update
-     */
-    protected $force_update = false;
-
-    /**
-     * @var string $capability
-     */
-    protected $capability = 'manage_options';
-
-    /**
-     * @var string $cap_context
-     */
-    protected $cap_context = 'view persistent admin notice';
-
-    /**
-     * @var boolean $dismissed
-     */
-    protected $dismissed = false;
-
-    /**
-     * @var CapCheckInterface $cap_check
-     */
-    protected $cap_check;
-
-    /**
-     * if true, then this notice will be deleted from the database
-     *
-     * @var boolean $purge
-     */
-    protected $purge = false;
-
-    /**
-     * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
-     * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
-     *
-     * @var boolean $registered
-     */
-    private $registered = false;
-
-
-
-    /**
-     * PersistentAdminNotice constructor
-     *
-     * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
-     * @param string $message      [required] the message to be stored persistently until dismissed
-     * @param bool   $force_update enforce the reappearance of a persistent message
-     * @param string $capability   user capability required to view this notice
-     * @param string $cap_context  description for why the cap check is being performed
-     * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $name,
-        $message,
-        $force_update = false,
-        $capability = 'manage_options',
-        $cap_context = 'view persistent admin notice',
-        $dismissed = false
-    ) {
-        $this->setName($name);
-        $this->setMessage($message);
-        $this->setForceUpdate($force_update);
-        $this->setCapability($capability);
-        $this->setCapContext($cap_context);
-        $this->setDismissed($dismissed);
-        add_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            array($this, 'registerPersistentAdminNotice')
-        );
-        add_action('admin_footer', array($this, 'confirmRegistered'));
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-
-
-    /**
-     * @param string $name
-     * @throws InvalidDataTypeException
-     */
-    private function setName($name)
-    {
-        if (! is_string($name)) {
-            throw new InvalidDataTypeException('$name', $name, 'string');
-        }
-        $this->name = sanitize_key($name);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getMessage()
-    {
-        return $this->message;
-    }
-
-
-
-    /**
-     * @param string $message
-     * @throws InvalidDataTypeException
-     */
-    private function setMessage($message)
-    {
-        if (! is_string($message)) {
-            throw new InvalidDataTypeException('$message', $message, 'string');
-        }
-        global $allowedtags;
-        $allowedtags['br'] = array();
-        $this->message     = wp_kses($message, $allowedtags);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function getForceUpdate()
-    {
-        return $this->force_update;
-    }
-
-
-
-    /**
-     * @param bool $force_update
-     */
-    private function setForceUpdate($force_update)
-    {
-        $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getCapability()
-    {
-        return $this->capability;
-    }
-
-
-
-    /**
-     * @param string $capability
-     * @throws InvalidDataTypeException
-     */
-    private function setCapability($capability)
-    {
-        if (! is_string($capability)) {
-            throw new InvalidDataTypeException('$capability', $capability, 'string');
-        }
-        $this->capability = $capability;
-    }
+	/**
+	 * @var string $name
+	 */
+	protected $name = '';
+
+	/**
+	 * @var string $message
+	 */
+	protected $message = '';
+
+	/**
+	 * @var boolean $force_update
+	 */
+	protected $force_update = false;
+
+	/**
+	 * @var string $capability
+	 */
+	protected $capability = 'manage_options';
+
+	/**
+	 * @var string $cap_context
+	 */
+	protected $cap_context = 'view persistent admin notice';
+
+	/**
+	 * @var boolean $dismissed
+	 */
+	protected $dismissed = false;
+
+	/**
+	 * @var CapCheckInterface $cap_check
+	 */
+	protected $cap_check;
+
+	/**
+	 * if true, then this notice will be deleted from the database
+	 *
+	 * @var boolean $purge
+	 */
+	protected $purge = false;
+
+	/**
+	 * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
+	 * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
+	 *
+	 * @var boolean $registered
+	 */
+	private $registered = false;
+
+
+
+	/**
+	 * PersistentAdminNotice constructor
+	 *
+	 * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $message      [required] the message to be stored persistently until dismissed
+	 * @param bool   $force_update enforce the reappearance of a persistent message
+	 * @param string $capability   user capability required to view this notice
+	 * @param string $cap_context  description for why the cap check is being performed
+	 * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$name,
+		$message,
+		$force_update = false,
+		$capability = 'manage_options',
+		$cap_context = 'view persistent admin notice',
+		$dismissed = false
+	) {
+		$this->setName($name);
+		$this->setMessage($message);
+		$this->setForceUpdate($force_update);
+		$this->setCapability($capability);
+		$this->setCapContext($cap_context);
+		$this->setDismissed($dismissed);
+		add_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			array($this, 'registerPersistentAdminNotice')
+		);
+		add_action('admin_footer', array($this, 'confirmRegistered'));
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+
+
+	/**
+	 * @param string $name
+	 * @throws InvalidDataTypeException
+	 */
+	private function setName($name)
+	{
+		if (! is_string($name)) {
+			throw new InvalidDataTypeException('$name', $name, 'string');
+		}
+		$this->name = sanitize_key($name);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getMessage()
+	{
+		return $this->message;
+	}
+
+
+
+	/**
+	 * @param string $message
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMessage($message)
+	{
+		if (! is_string($message)) {
+			throw new InvalidDataTypeException('$message', $message, 'string');
+		}
+		global $allowedtags;
+		$allowedtags['br'] = array();
+		$this->message     = wp_kses($message, $allowedtags);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function getForceUpdate()
+	{
+		return $this->force_update;
+	}
+
+
+
+	/**
+	 * @param bool $force_update
+	 */
+	private function setForceUpdate($force_update)
+	{
+		$this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getCapability()
+	{
+		return $this->capability;
+	}
+
+
+
+	/**
+	 * @param string $capability
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapability($capability)
+	{
+		if (! is_string($capability)) {
+			throw new InvalidDataTypeException('$capability', $capability, 'string');
+		}
+		$this->capability = $capability;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function getCapContext()
-    {
-        return $this->cap_context;
-    }
-
-
-
-    /**
-     * @param string $cap_context
-     * @throws InvalidDataTypeException
-     */
-    private function setCapContext($cap_context)
-    {
-        if (! is_string($cap_context)) {
-            throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
-        }
-        $this->cap_context = $cap_context;
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function getDismissed()
-    {
-        return $this->dismissed;
-    }
-
-
-
-    /**
-     * @param bool $dismissed
-     */
-    public function setDismissed($dismissed)
-    {
-        $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if (! $this->cap_check instanceof CapCheckInterface) {
-            $this->setCapCheck(
-                new CapCheck(
-                    $this->capability,
-                    $this->cap_context
-                )
-            );
-        }
-        return $this->cap_check;
-    }
-
-
-
-    /**
-     * @param CapCheckInterface $cap_check
-     */
-    private function setCapCheck(CapCheckInterface $cap_check)
-    {
-        $this->cap_check = $cap_check;
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function getPurge()
-    {
-        return $this->purge;
-    }
-
-
-
-    /**
-     * @param bool $purge
-     */
-    public function setPurge($purge)
-    {
-        $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * given a valid PersistentAdminNotice Collection,
-     * this notice will be added if it is not already found in the collection (using its name as the identifier)
-     * if an existing notice is found that has already been dismissed,
-     * but we are overriding with a forced update, then we will toggle its dismissed state,
-     * so that the notice is displayed again
-     *
-     * @param Collection $persistent_admin_notice_collection
-     * @throws InvalidEntityException
-     */
-    public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
-    {
-        if ($this->registered) {
-            return;
-        }
-        // first check if this notice has already been added to the collection
-        if ($persistent_admin_notice_collection->has($this->name)) {
-            /** @var PersistentAdminNotice $existing */
-            $existing = $persistent_admin_notice_collection->get($this->name);
-            // we don't need to add it again (we can't actually)
-            // but if it has already been dismissed, and we are overriding with a forced update
-            if ($existing->getDismissed() && $this->getForceUpdate()) {
-                // then toggle the notice's dismissed state to true
-                // so that it gets displayed again
-                $existing->setDismissed(false);
-            }
-        } else {
-            $persistent_admin_notice_collection->add($this, $this->name);
-        }
-        $this->registered = true;
-    }
-
-
-
-    /**
-     * @throws DomainException
-     */
-    public function confirmRegistered()
-    {
-        if (! $this->registered && WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
-                        'event_espresso'
-                    ),
-                    $this->name
-                )
-            );
-        }
-    }
+	/**
+	 * @return string
+	 */
+	public function getCapContext()
+	{
+		return $this->cap_context;
+	}
+
+
+
+	/**
+	 * @param string $cap_context
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapContext($cap_context)
+	{
+		if (! is_string($cap_context)) {
+			throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
+		}
+		$this->cap_context = $cap_context;
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function getDismissed()
+	{
+		return $this->dismissed;
+	}
+
+
+
+	/**
+	 * @param bool $dismissed
+	 */
+	public function setDismissed($dismissed)
+	{
+		$this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if (! $this->cap_check instanceof CapCheckInterface) {
+			$this->setCapCheck(
+				new CapCheck(
+					$this->capability,
+					$this->cap_context
+				)
+			);
+		}
+		return $this->cap_check;
+	}
+
+
+
+	/**
+	 * @param CapCheckInterface $cap_check
+	 */
+	private function setCapCheck(CapCheckInterface $cap_check)
+	{
+		$this->cap_check = $cap_check;
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function getPurge()
+	{
+		return $this->purge;
+	}
+
+
+
+	/**
+	 * @param bool $purge
+	 */
+	public function setPurge($purge)
+	{
+		$this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * given a valid PersistentAdminNotice Collection,
+	 * this notice will be added if it is not already found in the collection (using its name as the identifier)
+	 * if an existing notice is found that has already been dismissed,
+	 * but we are overriding with a forced update, then we will toggle its dismissed state,
+	 * so that the notice is displayed again
+	 *
+	 * @param Collection $persistent_admin_notice_collection
+	 * @throws InvalidEntityException
+	 */
+	public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
+	{
+		if ($this->registered) {
+			return;
+		}
+		// first check if this notice has already been added to the collection
+		if ($persistent_admin_notice_collection->has($this->name)) {
+			/** @var PersistentAdminNotice $existing */
+			$existing = $persistent_admin_notice_collection->get($this->name);
+			// we don't need to add it again (we can't actually)
+			// but if it has already been dismissed, and we are overriding with a forced update
+			if ($existing->getDismissed() && $this->getForceUpdate()) {
+				// then toggle the notice's dismissed state to true
+				// so that it gets displayed again
+				$existing->setDismissed(false);
+			}
+		} else {
+			$persistent_admin_notice_collection->add($this, $this->name);
+		}
+		$this->registered = true;
+	}
+
+
+
+	/**
+	 * @throws DomainException
+	 */
+	public function confirmRegistered()
+	{
+		if (! $this->registered && WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
+						'event_espresso'
+					),
+					$this->name
+				)
+			);
+		}
+	}
 
 
 }

Spacing +6 added lines, -6 removed lines

@@ -128,7 +128,7 @@ 
      */
     private function setName($name)
     {
-        if (! is_string($name)) {
+        if ( ! is_string($name)) {
             throw new InvalidDataTypeException('$name', $name, 'string');
         }
         $this->name = sanitize_key($name);
@@ -152,7 +152,7 @@ 
      */
     private function setMessage($message)
     {
-        if (! is_string($message)) {
+        if ( ! is_string($message)) {
             throw new InvalidDataTypeException('$message', $message, 'string');
         }
         global $allowedtags;
@@ -198,7 +198,7 @@ 
      */
     private function setCapability($capability)
     {
-        if (! is_string($capability)) {
+        if ( ! is_string($capability)) {
             throw new InvalidDataTypeException('$capability', $capability, 'string');
         }
         $this->capability = $capability;
@@ -222,7 +222,7 @@ 
      */
     private function setCapContext($cap_context)
     {
-        if (! is_string($cap_context)) {
+        if ( ! is_string($cap_context)) {
             throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
         }
         $this->cap_context = $cap_context;
@@ -256,7 +256,7 @@ 
      */
     public function getCapCheck()
     {
-        if (! $this->cap_check instanceof CapCheckInterface) {
+        if ( ! $this->cap_check instanceof CapCheckInterface) {
             $this->setCapCheck(
                 new CapCheck(
                     $this->capability,
@@ -338,7 +338,7 @@ 
      */
     public function confirmRegistered()
     {
-        if (! $this->registered && WP_DEBUG) {
+        if ( ! $this->registered && WP_DEBUG) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

espresso.php

Indentation +192 added lines, -192 removed lines

@@ -38,217 +38,217 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('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()
-        {
-            ?>
+	if (! function_exists('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'
-                    ); ?>
+					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'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	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 {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.46.rc.075');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.46.rc.075');
+		}
 
-        /**
-         * 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);
-        }
+		/**
+		 * 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()
-        {
-            static $error_handling_loaded = false;
-            if ($error_handling_loaded) {
-                return;
-            }
-            // 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'));
-            }
-            $error_handling_loaded = 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()
+		{
+			static $error_handling_loaded = false;
+			if ($error_handling_loaded) {
+				return;
+			}
+			// 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'));
+			}
+			$error_handling_loaded = true;
+		}
 
-        /**
-         *    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)
-        {
-            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)
+		{
+			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
+					)
+				);
+			}
+		}
 
-        /**
-         * @since 4.9.27
-         * @throws \EE_Error
-         * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-         * @throws \EventEspresso\core\exceptions\InvalidEntityException
-         * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-         * @throws \EventEspresso\core\exceptions\InvalidClassException
-         * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
-         * @throws \OutOfBoundsException
-         */
-        function bootstrap_espresso()
-        {
-            require_once __DIR__ . '/core/espresso_definitions.php';
-            try {
-                espresso_load_error_handling();
-                espresso_load_required(
-                    'EEH_Base',
-                    EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_Array',
-                    EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
-                );
-                // instantiate and configure PSR4 autoloader
-                espresso_load_required(
-                    'Psr4Autoloader',
-                    EE_CORE . 'Psr4Autoloader.php'
-                );
-                espresso_load_required(
-                    'EE_Psr4AutoloaderInit',
-                    EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
-                );
-                $AutoloaderInit = new EE_Psr4AutoloaderInit();
-                $AutoloaderInit->initializeAutoloader();
-                espresso_load_required(
-                    'EE_Request',
-                    EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
-                );
-                espresso_load_required(
-                    'EE_Response',
-                    EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
-                );
-                espresso_load_required(
-                    'EE_Bootstrap',
-                    EE_CORE . 'EE_Bootstrap.core.php'
-                );
-                // bootstrap EE and the request stack
-                new EE_Bootstrap(
-                    new EE_Request($_GET, $_POST, $_COOKIE),
-                    new EE_Response()
-                );
-            } catch (Exception $e) {
-                require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
-                new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
-            }
-        }
-        bootstrap_espresso();
-    }
+		/**
+		 * @since 4.9.27
+		 * @throws \EE_Error
+		 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+		 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+		 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+		 * @throws \EventEspresso\core\exceptions\InvalidClassException
+		 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
+		 * @throws \OutOfBoundsException
+		 */
+		function bootstrap_espresso()
+		{
+			require_once __DIR__ . '/core/espresso_definitions.php';
+			try {
+				espresso_load_error_handling();
+				espresso_load_required(
+					'EEH_Base',
+					EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
+				);
+				espresso_load_required(
+					'EEH_Array',
+					EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
+				);
+				// instantiate and configure PSR4 autoloader
+				espresso_load_required(
+					'Psr4Autoloader',
+					EE_CORE . 'Psr4Autoloader.php'
+				);
+				espresso_load_required(
+					'EE_Psr4AutoloaderInit',
+					EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+				);
+				$AutoloaderInit = new EE_Psr4AutoloaderInit();
+				$AutoloaderInit->initializeAutoloader();
+				espresso_load_required(
+					'EE_Request',
+					EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
+				);
+				espresso_load_required(
+					'EE_Response',
+					EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
+				);
+				espresso_load_required(
+					'EE_Bootstrap',
+					EE_CORE . 'EE_Bootstrap.core.php'
+				);
+				// bootstrap EE and the request stack
+				new EE_Bootstrap(
+					new EE_Request($_GET, $_POST, $_COOKIE),
+					new EE_Response()
+				);
+			} catch (Exception $e) {
+				require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
+				new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
+			}
+		}
+		bootstrap_espresso();
+	}
 }
 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);
+	}
 }