eventespresso / event-espresso-core

core/services/notifications/PersistentAdminNoticeManager.php

Indentation +388 added lines, -388 removed lines

@@ -30,392 +30,392 @@
  */
 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.
-     *
-     * @var string $return_url
-     */
-    private $return_url;
-
-    /**
-     * @var CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param RequestInterface    $request
-     * @param string              $return_url where to  redirect to after dismissing notices
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        CapabilitiesChecker $capabilities_checker,
-        RequestInterface $request,
-        string $return_url = ''
-    ) {
-        $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, 'registerAndSaveNotices'), 998);
-    }
-
-
-    /**
-     * @param string $return_url
-     * @throws InvalidDataTypeException
-     */
-    public 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
-     * @throws DuplicateCollectionIdentifierException
-     */
-    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
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        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']
-                        ),
-                        sanitize_key($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)
-                            ),
-                            sanitize_key($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
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $enqueue_assets = false;
-            // 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;
-                }
-                if ($persistent_admin_notice->getMessage() === '') {
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-                $enqueue_assets = true;
-            }
-            if ($enqueue_assets) {
-                $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' => wp_strip_all_tags(
-                    __(
-                        '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 . '/notifications/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
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $return = false)
-    {
-        $pan_name = $this->request->getRequestParam('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->isAjax()) {
-            // 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->getRequestParam('return_url', '')
-            )
-        );
-    }
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    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);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function registerAndSaveNotices()
-    {
-        $this->getPersistentAdminNoticeCollection();
-        $this->registerNotices();
-        $this->saveNotices();
-        add_filter(
-            'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public static function loadRegisterAndSaveNotices()
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        // if shutdown has already run, then call registerAndSaveNotices() manually
-        if (did_action('shutdown')) {
-            $persistent_admin_notice_manager->registerAndSaveNotices();
-        }
-    }
+	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.
+	 *
+	 * @var string $return_url
+	 */
+	private $return_url;
+
+	/**
+	 * @var CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param RequestInterface    $request
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		CapabilitiesChecker $capabilities_checker,
+		RequestInterface $request,
+		string $return_url = ''
+	) {
+		$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, 'registerAndSaveNotices'), 998);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 * @throws InvalidDataTypeException
+	 */
+	public 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
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	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
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		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']
+						),
+						sanitize_key($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)
+							),
+							sanitize_key($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
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$enqueue_assets = false;
+			// 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;
+				}
+				if ($persistent_admin_notice->getMessage() === '') {
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+				$enqueue_assets = true;
+			}
+			if ($enqueue_assets) {
+				$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' => wp_strip_all_tags(
+					__(
+						'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 . '/notifications/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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $return = false)
+	{
+		$pan_name = $this->request->getRequestParam('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->isAjax()) {
+			// 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->getRequestParam('return_url', '')
+			)
+		);
+	}
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	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);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function registerAndSaveNotices()
+	{
+		$this->getPersistentAdminNoticeCollection();
+		$this->registerNotices();
+		$this->saveNotices();
+		add_filter(
+			'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public static function loadRegisterAndSaveNotices()
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		// if shutdown has already run, then call registerAndSaveNotices() manually
+		if (did_action('shutdown')) {
+			$persistent_admin_notice_manager->registerAndSaveNotices();
+		}
+	}
 }

core/EE_Load_Textdomain.core.php

Indentation +91 added lines, -91 removed lines

@@ -12,106 +12,106 @@
  */
 class EE_Load_Textdomain extends EE_Base
 {
-    private const REPO_BASE_URL = 'https://raw.githubusercontent.com/eventespresso/languages-ee4/master/event_espresso';
+	private const REPO_BASE_URL = 'https://raw.githubusercontent.com/eventespresso/languages-ee4/master/event_espresso';
 
 
-    /**
-     * holds the current lang in WP
-     *
-     * @var string
-     */
-    private static $locale;
+	/**
+	 * holds the current lang in WP
+	 *
+	 * @var string
+	 */
+	private static $locale;
 
 
-    /**
-     * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
-     * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_textdomain()
-    {
-        EE_Load_Textdomain::loadTranslationsForLocale();
-        // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($github_mo_path)) {
-                load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
-                return;
-            }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($glotpress_mo_path)) {
-                load_textdomain('event_espresso', $glotpress_mo_path);
-                return;
-            }
-        }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
-    }
+	/**
+	 * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
+	 * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_textdomain()
+	{
+		EE_Load_Textdomain::loadTranslationsForLocale();
+		// now load the textdomain
+		if (!empty(EE_Load_Textdomain::$locale)) {
+			$github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($github_mo_path)) {
+				load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
+				return;
+			}
+			$glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($glotpress_mo_path)) {
+				load_textdomain('event_espresso', $glotpress_mo_path);
+				return;
+			}
+		}
+		load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+	}
 
 
-    /**
-     * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
-     *
-     * @access private
-     * @static
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function loadTranslationsForLocale()
-    {
-        EE_Load_Textdomain::$locale = get_locale();
-        // can't download a language file if a language isn't set <taps temple>
-        if (empty(EE_Load_Textdomain::$locale)) {
-            return;
-        }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
-        // check if language files has already been sideloaded
-        if (get_option($language_check_option_name)) {
-            return;
-        }
+	/**
+	 * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
+	 *
+	 * @access private
+	 * @static
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function loadTranslationsForLocale()
+	{
+		EE_Load_Textdomain::$locale = get_locale();
+		// can't download a language file if a language isn't set <taps temple>
+		if (empty(EE_Load_Textdomain::$locale)) {
+			return;
+		}
+		$language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+		// check if language files has already been sideloaded
+		if (get_option($language_check_option_name)) {
+			return;
+		}
 
-        // load sideloader and sideload the .POT file as this should always be included.
-        $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => EE_Load_Textdomain::REPO_BASE_URL . '.pot',
-            '_new_file_name' => 'event_espresso.pot',
-        );
-        /** @var EEH_Sideloader $sideloader */
-        $sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
-        // sideload the .POT file only for main site of the network, or if not running Multisite.
-        if (is_main_site()) {
-            $sideloader->sideload();
-        }
+		// load sideloader and sideload the .POT file as this should always be included.
+		$sideloader_args = array(
+			'_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
+			'_download_from'   => EE_Load_Textdomain::REPO_BASE_URL . '.pot',
+			'_new_file_name' => 'event_espresso.pot',
+		);
+		/** @var EEH_Sideloader $sideloader */
+		$sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
+		// sideload the .POT file only for main site of the network, or if not running Multisite.
+		if (is_main_site()) {
+			$sideloader->sideload();
+		}
 
-        // if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
-        if (EE_Load_Textdomain::$locale === 'en_US') {
-            // but set option first else we'll forever be downloading the pot file
-            update_option($language_check_option_name, 1);
-            return;
-        }
-        $repo_locale_URL = EE_Load_Textdomain::REPO_BASE_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+		// if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
+		if (EE_Load_Textdomain::$locale === 'en_US') {
+			// but set option first else we'll forever be downloading the pot file
+			update_option($language_check_option_name, 1);
+			return;
+		}
+		$repo_locale_URL = EE_Load_Textdomain::REPO_BASE_URL . '-' . EE_Load_Textdomain::$locale;
+		$file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
 
-        // made it here so let's get the language files from the github repo, first the .mo file
-        $sideloader->set_download_from("{$repo_locale_URL}.mo");
-        $sideloader->set_new_file_name("{$file_name_base}.mo");
-        $sideloader->sideload();
+		// made it here so let's get the language files from the github repo, first the .mo file
+		$sideloader->set_download_from("{$repo_locale_URL}.mo");
+		$sideloader->set_new_file_name("{$file_name_base}.mo");
+		$sideloader->sideload();
 
-        // now the .po file:
-        $sideloader->set_download_from("{$repo_locale_URL}.po");
-        $sideloader->set_new_file_name("{$file_name_base}.po");
-        $sideloader->sideload();
+		// now the .po file:
+		$sideloader->set_download_from("{$repo_locale_URL}.po");
+		$sideloader->set_new_file_name("{$file_name_base}.po");
+		$sideloader->sideload();
 
-        // set option so the above only runs when EE updates.
-        update_option($language_check_option_name, 1);
-    }
+		// set option so the above only runs when EE updates.
+		update_option($language_check_option_name, 1);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -38,19 +38,19 @@ 
     {
         EE_Load_Textdomain::loadTranslationsForLocale();
         // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+        if ( ! empty(EE_Load_Textdomain::$locale)) {
+            $github_mo_path = EE_LANGUAGES_SAFE_DIR.'event_espresso-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($github_mo_path)) {
                 load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
                 return;
             }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR.'event-espresso-4-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($glotpress_mo_path)) {
                 load_textdomain('event_espresso', $glotpress_mo_path);
                 return;
             }
         }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME).'/languages/');
     }
 
 
@@ -73,7 +73,7 @@ 
         if (empty(EE_Load_Textdomain::$locale)) {
             return;
         }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+        $language_check_option_name = 'ee_lang_check_'.EE_Load_Textdomain::$locale.'_'.EVENT_ESPRESSO_VERSION;
         // check if language files has already been sideloaded
         if (get_option($language_check_option_name)) {
             return;
@@ -81,8 +81,8 @@ 
 
         // load sideloader and sideload the .POT file as this should always be included.
         $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => EE_Load_Textdomain::REPO_BASE_URL . '.pot',
+            '_upload_to'     => EE_PLUGIN_DIR_PATH.'languages/',
+            '_download_from'   => EE_Load_Textdomain::REPO_BASE_URL.'.pot',
             '_new_file_name' => 'event_espresso.pot',
         );
         /** @var EEH_Sideloader $sideloader */
@@ -98,8 +98,8 @@ 
             update_option($language_check_option_name, 1);
             return;
         }
-        $repo_locale_URL = EE_Load_Textdomain::REPO_BASE_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+        $repo_locale_URL = EE_Load_Textdomain::REPO_BASE_URL.'-'.EE_Load_Textdomain::$locale;
+        $file_name_base = 'event_espresso-'.EE_Load_Textdomain::$locale;
 
         // made it here so let's get the language files from the github repo, first the .mo file
         $sideloader->set_download_from("{$repo_locale_URL}.mo");

core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php

Indentation +165 added lines, -165 removed lines

@@ -15,181 +15,181 @@
  */
 class RegisterCustomTaxonomyTerms
 {
-    /**
-     * @var array[] $custom_taxonomy_terms
-     */
-    public $custom_taxonomy_terms = array();
+	/**
+	 * @var array[] $custom_taxonomy_terms
+	 */
+	public $custom_taxonomy_terms = array();
 
 
-    /**
-     * RegisterCustomTaxonomyTerms constructor.
-     */
-    public function __construct()
-    {
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
-        // IF they don't have a term for that taxonomy set.
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
-        do_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            $this
-        );
-    }
+	/**
+	 * RegisterCustomTaxonomyTerms constructor.
+	 */
+	public function __construct()
+	{
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
+		// IF they don't have a term for that taxonomy set.
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
+		do_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			$this
+		);
+	}
 
 
-    public function registerCustomTaxonomyTerms()
-    {
-        // setup default terms in any of our taxonomies (but only if we're in admin).
-        // Why not added via register_activation_hook?
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
-        // if ( is_admin() ) {
-        // $this->set_must_use_event_types();
-        // }
-        // set default terms
-        $this->registerCustomTaxonomyTerm(
-            'espresso_event_type',
-            'single-event',
-            array('espresso_events')
-        );
-    }
+	public function registerCustomTaxonomyTerms()
+	{
+		// setup default terms in any of our taxonomies (but only if we're in admin).
+		// Why not added via register_activation_hook?
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
+		// if ( is_admin() ) {
+		// $this->set_must_use_event_types();
+		// }
+		// set default terms
+		$this->registerCustomTaxonomyTerm(
+			'espresso_event_type',
+			'single-event',
+			array('espresso_events')
+		);
+	}
 
 
-    /**
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
-     *
-     * @param string $taxonomy  The taxonomy we're using for the default term
-     * @param string $term_slug The slug of the term that will be the default.
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
-     */
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
-    {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
-            $taxonomy,
-            $term_slug,
-            $cpt_slugs
-        );
-    }
+	/**
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
+	 *
+	 * @param string $taxonomy  The taxonomy we're using for the default term
+	 * @param string $term_slug The slug of the term that will be the default.
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
+	 */
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
+	{
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+			$taxonomy,
+			$term_slug,
+			$cpt_slugs
+		);
+	}
 
 
-    /**
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
-     *
-     * @param  int          $post_id ID of CPT being saved
-     * @param  WP_Post|null $post    Post object
-     * @return void
-     */
-    public function saveDefaultTerm(int $post_id, ?WP_Post $post)
-    {
-        if (! $post || empty($this->custom_taxonomy_terms)) {
-            return;
-        }
-        // no default terms set so lets just exit.
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
-                if (
-                    $post->post_status === 'publish'
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
-                ) {
-                    // note some error proofing going on here to save unnecessary db queries
-                    $taxonomies = get_object_taxonomies($post->post_type);
-                    foreach ($taxonomies as $taxonomy) {
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
-                            wp_set_object_terms(
-                                $post_id,
-                                array($custom_taxonomy_term->termSlug()),
-                                $taxonomy
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
+	/**
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
+	 *
+	 * @param  int          $post_id ID of CPT being saved
+	 * @param  WP_Post|null $post    Post object
+	 * @return void
+	 */
+	public function saveDefaultTerm(int $post_id, ?WP_Post $post)
+	{
+		if (! $post || empty($this->custom_taxonomy_terms)) {
+			return;
+		}
+		// no default terms set so lets just exit.
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
+				if (
+					$post->post_status === 'publish'
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
+				) {
+					// note some error proofing going on here to save unnecessary db queries
+					$taxonomies = get_object_taxonomies($post->post_type);
+					foreach ($taxonomies as $taxonomy) {
+						$terms = wp_get_post_terms($post_id, $taxonomy);
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
+							wp_set_object_terms(
+								$post_id,
+								array($custom_taxonomy_term->termSlug()),
+								$taxonomy
+							);
+						}
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @return void
-     */
-    public function setMustUseEventTypes()
-    {
-        $term_details = array(
-            // Attendee's register for the first date-time only
-            'single-event'    => array(
-                'term' => esc_html__('Single Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'A single event that spans one or more consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a party or two-day long workshop
-            // Attendee's can register for any of the date-times
-            'multi-event'     => array(
-                'term' => esc_html__('Multi Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple, separate, but related events that occur on consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a three day music festival or week long conference
-            // Attendee's register for the first date-time only
-            'event-series'    => array(
-                'term' => esc_html__('Event Series', 'event_espresso'),
-                'desc' => esc_html__(
-                    ' Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: an 8 week introduction to basket weaving course
-            // Attendee's can register for any of the date-times.
-            'recurring-event' => array(
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a yoga class
-            'ongoing'         => array(
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
-                    'event_espresso'
-                ),
-            )
-            // example: access to a museum
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
-        );
-        $this->setMustUseTerms('espresso_event_type', $term_details);
-    }
+	/**
+	 * @return void
+	 */
+	public function setMustUseEventTypes()
+	{
+		$term_details = array(
+			// Attendee's register for the first date-time only
+			'single-event'    => array(
+				'term' => esc_html__('Single Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'A single event that spans one or more consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a party or two-day long workshop
+			// Attendee's can register for any of the date-times
+			'multi-event'     => array(
+				'term' => esc_html__('Multi Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple, separate, but related events that occur on consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a three day music festival or week long conference
+			// Attendee's register for the first date-time only
+			'event-series'    => array(
+				'term' => esc_html__('Event Series', 'event_espresso'),
+				'desc' => esc_html__(
+					' Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: an 8 week introduction to basket weaving course
+			// Attendee's can register for any of the date-times.
+			'recurring-event' => array(
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a yoga class
+			'ongoing'         => array(
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
+					'event_espresso'
+				),
+			)
+			// example: access to a museum
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
+		);
+		$this->setMustUseTerms('espresso_event_type', $term_details);
+	}
 
 
-    /**
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
-     * deleted then it WILL be recreated.
-     *
-     * @param string $taxonomy     The name of the taxonomy
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
-     *                             description as the elements in the array
-     * @return void
-     */
-    public function setMustUseTerms($taxonomy, $term_details)
-    {
-        $term_details = (array) $term_details;
-        foreach ($term_details as $slug => $details) {
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
-                $insert_arr = array(
-                    'slug'        => $slug,
-                    'description' => $details['desc'],
-                );
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
-            }
-        }
-    }
+	/**
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
+	 * deleted then it WILL be recreated.
+	 *
+	 * @param string $taxonomy     The name of the taxonomy
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
+	 *                             description as the elements in the array
+	 * @return void
+	 */
+	public function setMustUseTerms($taxonomy, $term_details)
+	{
+		$term_details = (array) $term_details;
+		foreach ($term_details as $slug => $details) {
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
+				$insert_arr = array(
+					'slug'        => $slug,
+					'description' => $details['desc'],
+				);
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
+			}
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
      */
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
     {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
             $taxonomy,
             $term_slug,
             $cpt_slugs
@@ -81,7 +81,7 @@ 
      */
     public function saveDefaultTerm(int $post_id, ?WP_Post $post)
     {
-        if (! $post || empty($this->custom_taxonomy_terms)) {
+        if ( ! $post || empty($this->custom_taxonomy_terms)) {
             return;
         }
         // no default terms set so lets just exit.

core/domain/services/admin/menu/AdminMenuManager.php

Indentation +403 added lines, -403 removed lines

@@ -15,407 +15,407 @@
 
 class AdminMenuManager
 {
-    /**
-     * Default: null - defaults to below Comments
-     *
-     * 5 - below Posts
-     * 10 - below Media
-     * 15 - below Links
-     * 20 - below Pages
-     * 25 - below comments
-     * 60 - below first separator
-     * 65 - below Plugins
-     * 70 - below Users
-     * 75 - below Tools
-     * 80 - below Settings
-     * 100 - below second separator
-     */
-    const MENU_POSITION = 100;
-
-
-    /**
-     * @var AdminMenuItem[]
-     */
-    private $menu_items = [];
-
-    /**
-     * objects for page_init objects detected and loaded
-     *
-     * @var EE_Admin_Page_Init[]
-     */
-    private $installed_pages = [];
-
-    /**
-     * set to TRUE if site is currently in maintenance mode level 2
-     *
-     * @var bool
-     */
-    protected $maintenance_mode = false;
-
-    /**
-     * @var AdminMenuItem
-     */
-    private $top_level_menu_item;
-
-
-    public function __construct()
-    {
-    }
-
-
-    public function initialize()
-    {
-        $this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
-        $this->addTopLevelMenuItem();
-        $this->initializeMenuGroups();
-        add_action('admin_menu', [$this, 'generateAdminMenu']);
-        add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
-        add_filter('custom_menu_order', '__return_true');
-        add_filter('menu_order', [$this, 'reorderAdminMenu']);
-    }
-
-
-    /**
-     * adds the top level menu item that everything else descends from.
-     * changes depending on whether site is in full maintenance mode or not
-     *
-     * @return void
-     */
-    private function addTopLevelMenuItem()
-    {
-        $this->top_level_menu_item = $this->maintenance_mode
-            ? $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => 'espresso_maintenance_settings',
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'manage_options',
-                    'menu_group'   => 'main',
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => 'espresso_maintenance_settings',
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            )
-            : $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => 'espresso_events',
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'ee_read_events',
-                    'menu_group'   => 'main',
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => 'espresso_events',
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            );
-    }
-
-
-    /**
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @return void
-     */
-    private function initializeMenuGroups()
-    {
-        $this->menu_items = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            [
-                'main'       => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => 'main',
-                        'menu_label'              => esc_html__('Main', 'event_espresso'),
-                        'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
-                        'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                        'menu_order'              => 0,
-                        'parent_slug'             => 'espresso_events',
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
-                    ]
-                ),
-                'management' => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'management',
-                        'menu_label'   => esc_html__('Management', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 10,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'addons'     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'addons',
-                        'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 20,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                'settings'   => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'settings',
-                        'menu_label'   => esc_html__('Settings', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 30,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'templates'  => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'templates',
-                        'menu_label'   => esc_html__('Templates', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 40,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'extras'     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => 'extras',
-                        'menu_label'              => esc_html__('Extras', 'event_espresso'),
-                        'capability'              => 'ee_read_ee',
-                        'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                        'menu_order'              => 50,
-                        'parent_slug'             => 'espresso_events',
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                'tools'      => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'tools',
-                        'menu_label'   => esc_html__('Tools', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 60,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
-     *
-     * @param EE_Admin_Page_Init $admin_page_init
-     * @return AdminMenuItem
-     */
-    public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
-    {
-        // see if admin page init is using new classes
-        $menu_properties = $admin_page_init->getMenuProperties();
-        if (empty($menu_properties)) {
-            // no? ok setup the admin menu item the old way
-            $admin_page_init->setupLegacyAdminMenuItem();
-        } else {
-            // adding the admin page init callback here means the menu doesn't have to cart that object around
-            $menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
-            $admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
-        }
-        $admin_menu = $admin_page_init->adminMenu();
-        if (! $admin_menu instanceof AdminMenuItem) {
-            throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-        }
-        if (! is_callable($admin_menu->menuCallback())) {
-            $admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
-        }
-        // get the menu group that this menu item belongs to and then add it
-        $admin_group = $this->getMenuGroup($admin_menu);
-        $admin_group->addMenuItem($admin_menu);
-        return $admin_menu;
-    }
-
-
-    /**
-     * @param array $menu_properties
-     * @return AdminMenuItem|null
-     */
-    private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
-    {
-        $type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
-        unset($menu_properties['menu_type']);
-        switch ($type) {
-            case AdminMenuItem::TYPE_MENU_GROUP:
-                unset($menu_properties['menu_callback']);
-                return new AdminMenuGroup($menu_properties);
-            case AdminMenuItem::TYPE_MENU_TOP:
-                return new AdminMenuTopLevel($menu_properties);
-            case AdminMenuItem::TYPE_MENU_SUB_ITEM:
-                return new AdminMenuSubItem($menu_properties);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param AdminMenuItem $admin_menu
-     * @return AdminMenuGroup
-     * @throws DomainException
-     * @throws OutOfRangeException
-     */
-    private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
-    {
-        if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
-            throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
-        }
-        $admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
-        if (! $admin_group instanceof AdminMenuGroup) {
-            throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
-        }
-        return $admin_group;
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateNetworkAdminMenu()
-    {
-        $this->generateAdminMenu(true);
-    }
-
-
-    /**
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateAdminMenu(bool $network_admin = false)
-    {
-        $admin_menu = $this->sortMenu($this->menu_items);
-        $this->top_level_menu_item->registerAdminMenuItem($network_admin);
-        $this->registerAdminMenu($admin_menu, $network_admin);
-    }
-
-
-    /**
-     * @param array $admin_menu
-     * @param bool  $network_admin
-     */
-    private function registerAdminMenu(array $admin_menu, bool $network_admin)
-    {
-        foreach ($admin_menu as $menu_item) {
-            if ($this->skipMenuItem($menu_item)) {
-                continue;
-            }
-            try {
-                $wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
-                $admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
-                if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
-                    $admin_init_page->setWpPageSlug($wp_page_slug);
-                    $admin_init_page->set_page_dependencies($wp_page_slug);
-                }
-                if ($menu_item instanceof AdminMenuGroup) {
-                    $this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
-                }
-            } catch (Exception $e) {
-                EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
-            }
-        }
-    }
-
-
-    /**
-     * returns TRUE if any of the following conditions is met:
-     * - menu item is NOT an instanceof AdminMenuItem
-     * - menu item has already been registered
-     * - menu item should not be shown when site is in full maintenance mode
-     * - current user does not have the required access permission
-     * - menu item is a group but has no sub items
-     *
-     * @param AdminMenuItem|null $menu_item
-     * @return bool
-     */
-    private function skipMenuItem(?AdminMenuItem $menu_item): bool
-    {
-        return ! $menu_item instanceof AdminMenuItem
-               || $menu_item->isRegistered()
-               || ! $menu_item->showOnMaintenanceModeMenu()
-               || ! $menu_item->currentUserHasAccess()
-               || (
-                   $menu_item instanceof AdminMenuGroup
-                   && $menu_item->hasNoMenuItems()
-               );
-    }
-
-
-    /**
-     * @param EE_Admin_Page_Init[] $installed_pages
-     */
-    public function setInstalledPages(array $installed_pages): void
-    {
-        $this->installed_pages = $installed_pages;
-    }
-
-
-    /**
-     * Recursively sort menu groups and their sub items
-     *
-     * @return AdminMenuItem[]
-     * @throws DomainException
-     */
-    public function sortMenu(array $admin_menu): array
-    {
-        foreach ($admin_menu as $menu_group) {
-            if (! $menu_group instanceof AdminMenuItem) {
-                throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-            }
-            if ($menu_group instanceof AdminMenuGroup) {
-                // sort sub items
-                $menu_items = $this->sortMenu($menu_group->getMenuItems());
-                $menu_group->setMenuItems($menu_items);
-            }
-        }
-        // sort incoming array AFTER it's been looped through and elements have been validated
-        usort($admin_menu, [$this, 'sortMenuItems']);
-        return $admin_menu;
-    }
-
-
-    /**
-     *  sort sub menu items
-     *
-     * @param AdminMenuItem $a menu_item
-     * @param AdminMenuItem $b being compared to
-     * @return int    sort order
-     */
-    private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
-    {
-        if ($a->menuOrder() === $b->menuOrder()) {
-            return 0;
-        }
-        return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
-    }
-
-
-    /**
-     * Moves the Event Espresso admin menu to the position set by the AdminMenuManager::MENU_POSITION constant
-     *
-     * @param array $menu_order
-     * @return array
-     */
-    public function reorderAdminMenu(array $menu_order): array
-    {
-        $menu_slug     = $this->maintenance_mode ? 'espresso_maintenance_settings' : 'espresso_events';
-        $current_index = array_search($menu_slug, $menu_order);
-        if ($current_index === false) {
-            return $menu_order;
-        }
-        // chop out the espresso admin menu if found
-        $espresso_menu = array_splice($menu_order, $current_index, 1);
-        // reinsert at position set by AdminMenuManager::MENU_POSITION constant
-        array_splice($menu_order, AdminMenuManager::MENU_POSITION, 0, $espresso_menu);
-        return $menu_order;
-    }
+	/**
+	 * Default: null - defaults to below Comments
+	 *
+	 * 5 - below Posts
+	 * 10 - below Media
+	 * 15 - below Links
+	 * 20 - below Pages
+	 * 25 - below comments
+	 * 60 - below first separator
+	 * 65 - below Plugins
+	 * 70 - below Users
+	 * 75 - below Tools
+	 * 80 - below Settings
+	 * 100 - below second separator
+	 */
+	const MENU_POSITION = 100;
+
+
+	/**
+	 * @var AdminMenuItem[]
+	 */
+	private $menu_items = [];
+
+	/**
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private $installed_pages = [];
+
+	/**
+	 * set to TRUE if site is currently in maintenance mode level 2
+	 *
+	 * @var bool
+	 */
+	protected $maintenance_mode = false;
+
+	/**
+	 * @var AdminMenuItem
+	 */
+	private $top_level_menu_item;
+
+
+	public function __construct()
+	{
+	}
+
+
+	public function initialize()
+	{
+		$this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
+		$this->addTopLevelMenuItem();
+		$this->initializeMenuGroups();
+		add_action('admin_menu', [$this, 'generateAdminMenu']);
+		add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
+		add_filter('custom_menu_order', '__return_true');
+		add_filter('menu_order', [$this, 'reorderAdminMenu']);
+	}
+
+
+	/**
+	 * adds the top level menu item that everything else descends from.
+	 * changes depending on whether site is in full maintenance mode or not
+	 *
+	 * @return void
+	 */
+	private function addTopLevelMenuItem()
+	{
+		$this->top_level_menu_item = $this->maintenance_mode
+			? $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => 'espresso_maintenance_settings',
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'manage_options',
+					'menu_group'   => 'main',
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => 'espresso_maintenance_settings',
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			)
+			: $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => 'espresso_events',
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'ee_read_events',
+					'menu_group'   => 'main',
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => 'espresso_events',
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			);
+	}
+
+
+	/**
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @return void
+	 */
+	private function initializeMenuGroups()
+	{
+		$this->menu_items = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			[
+				'main'       => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => 'main',
+						'menu_label'              => esc_html__('Main', 'event_espresso'),
+						'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
+						'maintenance_mode_parent' => 'espresso_maintenance_settings',
+						'menu_order'              => 0,
+						'parent_slug'             => 'espresso_events',
+						'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
+					]
+				),
+				'management' => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'management',
+						'menu_label'   => esc_html__('Management', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 10,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'addons'     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'addons',
+						'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 20,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				'settings'   => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'settings',
+						'menu_label'   => esc_html__('Settings', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 30,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'templates'  => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'templates',
+						'menu_label'   => esc_html__('Templates', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 40,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'extras'     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => 'extras',
+						'menu_label'              => esc_html__('Extras', 'event_espresso'),
+						'capability'              => 'ee_read_ee',
+						'maintenance_mode_parent' => 'espresso_maintenance_settings',
+						'menu_order'              => 50,
+						'parent_slug'             => 'espresso_events',
+						'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				'tools'      => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'tools',
+						'menu_label'   => esc_html__('Tools', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 60,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
+	 *
+	 * @param EE_Admin_Page_Init $admin_page_init
+	 * @return AdminMenuItem
+	 */
+	public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
+	{
+		// see if admin page init is using new classes
+		$menu_properties = $admin_page_init->getMenuProperties();
+		if (empty($menu_properties)) {
+			// no? ok setup the admin menu item the old way
+			$admin_page_init->setupLegacyAdminMenuItem();
+		} else {
+			// adding the admin page init callback here means the menu doesn't have to cart that object around
+			$menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
+			$admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
+		}
+		$admin_menu = $admin_page_init->adminMenu();
+		if (! $admin_menu instanceof AdminMenuItem) {
+			throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+		}
+		if (! is_callable($admin_menu->menuCallback())) {
+			$admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
+		}
+		// get the menu group that this menu item belongs to and then add it
+		$admin_group = $this->getMenuGroup($admin_menu);
+		$admin_group->addMenuItem($admin_menu);
+		return $admin_menu;
+	}
+
+
+	/**
+	 * @param array $menu_properties
+	 * @return AdminMenuItem|null
+	 */
+	private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
+	{
+		$type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
+		unset($menu_properties['menu_type']);
+		switch ($type) {
+			case AdminMenuItem::TYPE_MENU_GROUP:
+				unset($menu_properties['menu_callback']);
+				return new AdminMenuGroup($menu_properties);
+			case AdminMenuItem::TYPE_MENU_TOP:
+				return new AdminMenuTopLevel($menu_properties);
+			case AdminMenuItem::TYPE_MENU_SUB_ITEM:
+				return new AdminMenuSubItem($menu_properties);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param AdminMenuItem $admin_menu
+	 * @return AdminMenuGroup
+	 * @throws DomainException
+	 * @throws OutOfRangeException
+	 */
+	private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
+	{
+		if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
+			throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
+		}
+		$admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
+		if (! $admin_group instanceof AdminMenuGroup) {
+			throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
+		}
+		return $admin_group;
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateNetworkAdminMenu()
+	{
+		$this->generateAdminMenu(true);
+	}
+
+
+	/**
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateAdminMenu(bool $network_admin = false)
+	{
+		$admin_menu = $this->sortMenu($this->menu_items);
+		$this->top_level_menu_item->registerAdminMenuItem($network_admin);
+		$this->registerAdminMenu($admin_menu, $network_admin);
+	}
+
+
+	/**
+	 * @param array $admin_menu
+	 * @param bool  $network_admin
+	 */
+	private function registerAdminMenu(array $admin_menu, bool $network_admin)
+	{
+		foreach ($admin_menu as $menu_item) {
+			if ($this->skipMenuItem($menu_item)) {
+				continue;
+			}
+			try {
+				$wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
+				$admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
+				if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
+					$admin_init_page->setWpPageSlug($wp_page_slug);
+					$admin_init_page->set_page_dependencies($wp_page_slug);
+				}
+				if ($menu_item instanceof AdminMenuGroup) {
+					$this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
+				}
+			} catch (Exception $e) {
+				EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
+			}
+		}
+	}
+
+
+	/**
+	 * returns TRUE if any of the following conditions is met:
+	 * - menu item is NOT an instanceof AdminMenuItem
+	 * - menu item has already been registered
+	 * - menu item should not be shown when site is in full maintenance mode
+	 * - current user does not have the required access permission
+	 * - menu item is a group but has no sub items
+	 *
+	 * @param AdminMenuItem|null $menu_item
+	 * @return bool
+	 */
+	private function skipMenuItem(?AdminMenuItem $menu_item): bool
+	{
+		return ! $menu_item instanceof AdminMenuItem
+			   || $menu_item->isRegistered()
+			   || ! $menu_item->showOnMaintenanceModeMenu()
+			   || ! $menu_item->currentUserHasAccess()
+			   || (
+				   $menu_item instanceof AdminMenuGroup
+				   && $menu_item->hasNoMenuItems()
+			   );
+	}
+
+
+	/**
+	 * @param EE_Admin_Page_Init[] $installed_pages
+	 */
+	public function setInstalledPages(array $installed_pages): void
+	{
+		$this->installed_pages = $installed_pages;
+	}
+
+
+	/**
+	 * Recursively sort menu groups and their sub items
+	 *
+	 * @return AdminMenuItem[]
+	 * @throws DomainException
+	 */
+	public function sortMenu(array $admin_menu): array
+	{
+		foreach ($admin_menu as $menu_group) {
+			if (! $menu_group instanceof AdminMenuItem) {
+				throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+			}
+			if ($menu_group instanceof AdminMenuGroup) {
+				// sort sub items
+				$menu_items = $this->sortMenu($menu_group->getMenuItems());
+				$menu_group->setMenuItems($menu_items);
+			}
+		}
+		// sort incoming array AFTER it's been looped through and elements have been validated
+		usort($admin_menu, [$this, 'sortMenuItems']);
+		return $admin_menu;
+	}
+
+
+	/**
+	 *  sort sub menu items
+	 *
+	 * @param AdminMenuItem $a menu_item
+	 * @param AdminMenuItem $b being compared to
+	 * @return int    sort order
+	 */
+	private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
+	{
+		if ($a->menuOrder() === $b->menuOrder()) {
+			return 0;
+		}
+		return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
+	}
+
+
+	/**
+	 * Moves the Event Espresso admin menu to the position set by the AdminMenuManager::MENU_POSITION constant
+	 *
+	 * @param array $menu_order
+	 * @return array
+	 */
+	public function reorderAdminMenu(array $menu_order): array
+	{
+		$menu_slug     = $this->maintenance_mode ? 'espresso_maintenance_settings' : 'espresso_events';
+		$current_index = array_search($menu_slug, $menu_order);
+		if ($current_index === false) {
+			return $menu_order;
+		}
+		// chop out the espresso admin menu if found
+		$espresso_menu = array_splice($menu_order, $current_index, 1);
+		// reinsert at position set by AdminMenuManager::MENU_POSITION constant
+		array_splice($menu_order, AdminMenuManager::MENU_POSITION, 0, $espresso_menu);
+		return $menu_order;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -217,10 +217,10 @@ 
             $admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
         }
         $admin_menu = $admin_page_init->adminMenu();
-        if (! $admin_menu instanceof AdminMenuItem) {
+        if ( ! $admin_menu instanceof AdminMenuItem) {
             throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
         }
-        if (! is_callable($admin_menu->menuCallback())) {
+        if ( ! is_callable($admin_menu->menuCallback())) {
             $admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
         }
         // get the menu group that this menu item belongs to and then add it
@@ -259,11 +259,11 @@ 
      */
     private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
     {
-        if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
+        if ( ! isset($this->menu_items[$admin_menu->menuGroup()])) {
             throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
         }
-        $admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
-        if (! $admin_group instanceof AdminMenuGroup) {
+        $admin_group = $this->menu_items[$admin_menu->menuGroup()];
+        if ( ! $admin_group instanceof AdminMenuGroup) {
             throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
         }
         return $admin_group;
@@ -311,7 +311,7 @@ 
             }
             try {
                 $wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
-                $admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
+                $admin_init_page = $this->installed_pages[$menu_item->menuSlug()] ?? null;
                 if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
                     $admin_init_page->setWpPageSlug($wp_page_slug);
                     $admin_init_page->set_page_dependencies($wp_page_slug);
@@ -368,7 +368,7 @@ 
     public function sortMenu(array $admin_menu): array
     {
         foreach ($admin_menu as $menu_group) {
-            if (! $menu_group instanceof AdminMenuItem) {
+            if ( ! $menu_group instanceof AdminMenuItem) {
                 throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
             }
             if ($menu_group instanceof AdminMenuGroup) {

core/domain/entities/admin/menu/AdminMenuSubItem.php

Indentation +11 added lines, -11 removed lines

@@ -4,15 +4,15 @@
 
 class AdminMenuSubItem extends AdminMenuTopLevel
 {
-    protected function registerMenuItem(): string
-    {
-        return add_submenu_page(
-            $this->parentSlug(),
-            $this->title(),
-            $this->menuLabel(),
-            $this->capability(),
-            $this->menuSlug(),
-            $this->menuCallback()
-        );
-    }
+	protected function registerMenuItem(): string
+	{
+		return add_submenu_page(
+			$this->parentSlug(),
+			$this->title(),
+			$this->menuLabel(),
+			$this->capability(),
+			$this->menuSlug(),
+			$this->menuCallback()
+		);
+	}
 }

core/domain/entities/admin/menu/AdminMenuItem.php

Indentation +513 added lines, -513 removed lines

@@ -11,517 +11,517 @@
 
 abstract class AdminMenuItem
 {
-    public const DISPLAY_NONE             = 0;
-
-    public const DISPLAY_BLOG_ONLY        = 1;
-
-    public const DISPLAY_BLOG_AND_NETWORK = 2;
-
-    public const DISPLAY_NETWORK_ONLY     = 3;
-
-    public const TYPE_MENU_TOP           = 'top';
-
-    public const TYPE_MENU_GROUP          = 'group';
-
-    public const TYPE_MENU_SUB_ITEM       = 'sub-item';
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $capability = 'administrator';
-
-    /**
-     * set to TRUE if site is currently in maintenance mode level 2
-     *
-     * @var bool
-     */
-    protected $maintenance_mode = false;
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::level_2_complete_maintenance is active.
-     *
-     * @var string
-     */
-    public $maintenance_mode_parent = '';
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $menu_callback;
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $menu_group;
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $menu_label;
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    protected $menu_order;
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $menu_slug;
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $parent_slug;
-
-    /**
-     * set to TRUE once menu item has been added to generated menu
-     *
-     * @var bool
-     */
-    protected $registered = false;
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    protected $show_on_menu = self::DISPLAY_BLOG_ONLY;
-
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    protected $title;
-
-
-    /**
-     * @param array $menu_args            An array of arguments used to setup the menu properties on construct.
-     * @param array $required             An array of keys that should be in the $menu_args,
-     *                                    this is used to validate that the items that should be defined are present.
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws OutOfBoundsException
-     */
-    public function __construct(array $menu_args, array $required)
-    {
-        // we don't want this coupling anymore >:(
-        unset($menu_args['admin_init_page'], $required['admin_init_page']);
-        $this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
-
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-        $this->verifyRequired($menu_args, $required);
-        $this->setProperties($menu_args);
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @return string wp_page_slug.
-     * @since  4.4.0
-     */
-    abstract protected function registerMenuItem(): string;
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function registerAdminMenuItem(bool $network_admin = false): string
-    {
-        $this->registered = true;
-        return $this->displayOnBlogAndNetworkAdmin()
-               || $this->displayOnBlogAdmin($network_admin)
-               || $this->displayOnNetworkAdmin($network_admin)
-            ? $this->registerMenuItem()
-            : '';
-    }
-
-
-    /**
-     * @param array $menu_args
-     * @param array $required
-     * @throws DomainException
-     */
-    private function verifyRequired(array $menu_args, array $required)
-    {
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff($required, array_keys($menu_args));
-
-        if (! empty($missing)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '%1$s is missing some expected keys in the argument array.  The following keys are missing: %2$s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        if (
-            in_array('admin_init_page', $required, true)
-            && ! (isset($menu_args['admin_init_page']) && $menu_args['admin_init_page'] instanceof EE_Admin_Page_Init)
-        ) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                        'event_espresso'
-                    ),
-                    print_r($menu_args['admin_init_page'] ?? null, true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param array $menu_args
-     * @throws InvalidArgumentException
-     * @throws OutOfBoundsException
-     */
-    private function setProperties(array $menu_args)
-    {
-        $menu_args += [
-            'capability'              => 'ee_read_ee',
-            'maintenance_mode_parent' => '',
-            'menu_callback'           => null,
-            'menu_group'              => '',
-            'menu_label'              => '',
-            'menu_order'              => 100,
-            'menu_slug'               => '',
-            'parent_slug'             => 'espresso_events',
-            'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
-            'title'                   => '',
-        ];
-
-        $this->setMenuSlug($menu_args['menu_slug']);
-        $this->setCapability($menu_args['capability']);
-        $this->setMaintenanceModeParent($menu_args['maintenance_mode_parent']);
-        $this->setMenuCallback($menu_args['menu_callback']);
-        $this->setMenuGroup($menu_args['menu_group']);
-        $this->setMenuLabel($menu_args['menu_label']);
-        $this->setMenuOrder($menu_args['menu_order']);
-        $this->setParentSlug($menu_args['parent_slug']);
-        $this->setShowOnMenu($menu_args['show_on_menu']);
-        $this->setTitle($menu_args['title']);
-    }
-
-
-    /**
-     * The capability required for this menu to be displayed to the user.
-     *
-     * @return string
-     */
-    public function capability(): string
-    {
-        return $this->capability;
-    }
-
-
-    /**
-     * @param string $capability
-     */
-    public function setCapability(string $capability): void
-    {
-        $this->capability = $capability;
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-    }
-
-
-    public function currentUserHasAccess(): bool
-    {
-        return EE_Capabilities::instance()->current_user_can($this->capability(), $this->menuSlug());
-    }
-
-
-    /**
-     * @param bool $network_admin
-     * @return bool
-     */
-    public function displayOnBlogAdmin(bool $network_admin): bool
-    {
-        return ! $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_ONLY;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function displayOnBlogAndNetworkAdmin(): bool
-    {
-        return $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_AND_NETWORK;
-    }
-
-
-    /**
-     * @param bool $network_admin
-     * @return bool
-     */
-    public function displayOnNetworkAdmin(bool $network_admin): bool
-    {
-        return $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_NETWORK_ONLY;
-    }
-
-
-    /**
-     * parent slug to use when site is in full maintenance mode
-     *
-     * @return string
-     */
-    public function maintenanceModeParent(): string
-    {
-        return $this->maintenance_mode_parent;
-    }
-
-
-    /**
-     * @param string $maintenance_mode_parent
-     */
-    public function setMaintenanceModeParent(string $maintenance_mode_parent): void
-    {
-        $this->maintenance_mode_parent = $maintenance_mode_parent;
-    }
-
-
-    /**
-     *  Optional. The function to be called to output the content for this page.
-     *
-     * @return callable|null
-     */
-    public function menuCallback(): ?callable
-    {
-        return $this->menu_callback;
-    }
-
-
-    /**
-     * @param callable|null $menu_callback
-     */
-    public function setMenuCallback(?callable $menu_callback): void
-    {
-        $this->menu_callback = $menu_callback;
-    }
-
-
-    /**
-     * Slug for menu group that this menu item will appear under
-     *
-     * @return string
-     */
-    public function menuGroup(): string
-    {
-        return $this->menu_group;
-    }
-
-
-    /**
-     * @param string $menu_group
-     */
-    public function setMenuGroup(string $menu_group): void
-    {
-        $this->menu_group = $menu_group;
-    }
-
-
-    /**
-     * The text to be used for the menu.
-     *
-     * @return string
-     */
-    public function menuLabel(): string
-    {
-        return $this->menu_label;
-    }
-
-
-    /**
-     * @param string $menu_label
-     */
-    public function setMenuLabel(string $menu_label): void
-    {
-        $this->menu_label = $menu_label;
-    }
-
-
-    /**
-     * Optional. The position in the menu order this item should appear.
-     *
-     * @return int
-     */
-    public function menuOrder(): int
-    {
-        return $this->menu_order;
-    }
-
-
-    /**
-     * @param int $menu_order
-     */
-    public function setMenuOrder(int $menu_order): void
-    {
-        $this->menu_order = absint($menu_order);
-    }
-
-
-    /**
-     * The slug name to refer to this menu by. Should be unique for this menu
-     *
-     * @return string
-     */
-    public function menuSlug(): string
-    {
-        return $this->menu_slug;
-    }
-
-
-    /**
-     * @param string $menu_slug
-     */
-    public function setMenuSlug(string $menu_slug): void
-    {
-        $this->menu_slug = sanitize_key($menu_slug);
-    }
-
-
-    /**
-     * The slug name for the parent menu (or the file name of a standard WordPress admin page).
-     *
-     * @return string
-     */
-    public function parentSlug(): string
-    {
-        return $this->parent_slug;
-    }
-
-
-    /**
-     * if site is in full maintenance mode,
-     * then parent slug will be swapped with the maintenance_mode_parent if that property has been set
-     *
-     * @param string $parent_slug
-     */
-    public function setParentSlug(string $parent_slug): void
-    {
-        $this->parent_slug = $this->maintenance_mode && $this->maintenance_mode_parent
-            ? $this->maintenance_mode_parent
-            : $parent_slug;
-    }
-
-
-    /**
-     * returns true if menu item has already been registered with WP core
-     *
-     * @return bool
-     */
-    public function isRegistered(): bool
-    {
-        return $this->registered;
-    }
-
-
-    /**
-     * returns TRUE if:
-     * - site is currently NOT in full site maintenance mode
-     * - site IS in full site maintenance mode and menu item has a valid maintenance mode parent
-     *
-     * @return int
-     */
-    public function showOnMaintenanceModeMenu(): int
-    {
-        return ! $this->maintenance_mode || $this->maintenanceModeParent() !== '';
-    }
-
-
-    /**
-     * @param int $show_on_menu
-     * @throws DomainException
-     */
-    public function setShowOnMenu(int $show_on_menu): void
-    {
-        $valid_menu_options = [
-            AdminMenuItem::DISPLAY_NONE,
-            AdminMenuItem::DISPLAY_BLOG_ONLY,
-            AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-            AdminMenuItem::DISPLAY_NETWORK_ONLY,
-        ];
-        if (! in_array($show_on_menu, $valid_menu_options, true)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Invalid "ShowOnMenu" option of "%1$s" supplied. You must use one of the AdminMenuItem::DISPLAY_* constants.',
-                        'event_espresso'
-                    ),
-                    $show_on_menu
-                )
-            );
-        }
-        $this->show_on_menu = $show_on_menu;
-    }
-
-
-    /**
-     * The text to be displayed in the title tags of the page when the menu is selected
-     *
-     * @return string
-     */
-    public function title(): string
-    {
-        return $this->title;
-    }
-
-
-    /**
-     * @param string $title
-     */
-    public function setTitle(string $title): void
-    {
-        $this->title = $title;
-    }
+	public const DISPLAY_NONE             = 0;
+
+	public const DISPLAY_BLOG_ONLY        = 1;
+
+	public const DISPLAY_BLOG_AND_NETWORK = 2;
+
+	public const DISPLAY_NETWORK_ONLY     = 3;
+
+	public const TYPE_MENU_TOP           = 'top';
+
+	public const TYPE_MENU_GROUP          = 'group';
+
+	public const TYPE_MENU_SUB_ITEM       = 'sub-item';
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $capability = 'administrator';
+
+	/**
+	 * set to TRUE if site is currently in maintenance mode level 2
+	 *
+	 * @var bool
+	 */
+	protected $maintenance_mode = false;
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::level_2_complete_maintenance is active.
+	 *
+	 * @var string
+	 */
+	public $maintenance_mode_parent = '';
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $menu_callback;
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $menu_group;
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $menu_label;
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	protected $menu_order;
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $menu_slug;
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $parent_slug;
+
+	/**
+	 * set to TRUE once menu item has been added to generated menu
+	 *
+	 * @var bool
+	 */
+	protected $registered = false;
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	protected $show_on_menu = self::DISPLAY_BLOG_ONLY;
+
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	protected $title;
+
+
+	/**
+	 * @param array $menu_args            An array of arguments used to setup the menu properties on construct.
+	 * @param array $required             An array of keys that should be in the $menu_args,
+	 *                                    this is used to validate that the items that should be defined are present.
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws OutOfBoundsException
+	 */
+	public function __construct(array $menu_args, array $required)
+	{
+		// we don't want this coupling anymore >:(
+		unset($menu_args['admin_init_page'], $required['admin_init_page']);
+		$this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
+
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+		$this->verifyRequired($menu_args, $required);
+		$this->setProperties($menu_args);
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @return string wp_page_slug.
+	 * @since  4.4.0
+	 */
+	abstract protected function registerMenuItem(): string;
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function registerAdminMenuItem(bool $network_admin = false): string
+	{
+		$this->registered = true;
+		return $this->displayOnBlogAndNetworkAdmin()
+			   || $this->displayOnBlogAdmin($network_admin)
+			   || $this->displayOnNetworkAdmin($network_admin)
+			? $this->registerMenuItem()
+			: '';
+	}
+
+
+	/**
+	 * @param array $menu_args
+	 * @param array $required
+	 * @throws DomainException
+	 */
+	private function verifyRequired(array $menu_args, array $required)
+	{
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff($required, array_keys($menu_args));
+
+		if (! empty($missing)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'%1$s is missing some expected keys in the argument array.  The following keys are missing: %2$s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		if (
+			in_array('admin_init_page', $required, true)
+			&& ! (isset($menu_args['admin_init_page']) && $menu_args['admin_init_page'] instanceof EE_Admin_Page_Init)
+		) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+						'event_espresso'
+					),
+					print_r($menu_args['admin_init_page'] ?? null, true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param array $menu_args
+	 * @throws InvalidArgumentException
+	 * @throws OutOfBoundsException
+	 */
+	private function setProperties(array $menu_args)
+	{
+		$menu_args += [
+			'capability'              => 'ee_read_ee',
+			'maintenance_mode_parent' => '',
+			'menu_callback'           => null,
+			'menu_group'              => '',
+			'menu_label'              => '',
+			'menu_order'              => 100,
+			'menu_slug'               => '',
+			'parent_slug'             => 'espresso_events',
+			'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
+			'title'                   => '',
+		];
+
+		$this->setMenuSlug($menu_args['menu_slug']);
+		$this->setCapability($menu_args['capability']);
+		$this->setMaintenanceModeParent($menu_args['maintenance_mode_parent']);
+		$this->setMenuCallback($menu_args['menu_callback']);
+		$this->setMenuGroup($menu_args['menu_group']);
+		$this->setMenuLabel($menu_args['menu_label']);
+		$this->setMenuOrder($menu_args['menu_order']);
+		$this->setParentSlug($menu_args['parent_slug']);
+		$this->setShowOnMenu($menu_args['show_on_menu']);
+		$this->setTitle($menu_args['title']);
+	}
+
+
+	/**
+	 * The capability required for this menu to be displayed to the user.
+	 *
+	 * @return string
+	 */
+	public function capability(): string
+	{
+		return $this->capability;
+	}
+
+
+	/**
+	 * @param string $capability
+	 */
+	public function setCapability(string $capability): void
+	{
+		$this->capability = $capability;
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+	}
+
+
+	public function currentUserHasAccess(): bool
+	{
+		return EE_Capabilities::instance()->current_user_can($this->capability(), $this->menuSlug());
+	}
+
+
+	/**
+	 * @param bool $network_admin
+	 * @return bool
+	 */
+	public function displayOnBlogAdmin(bool $network_admin): bool
+	{
+		return ! $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_ONLY;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function displayOnBlogAndNetworkAdmin(): bool
+	{
+		return $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_AND_NETWORK;
+	}
+
+
+	/**
+	 * @param bool $network_admin
+	 * @return bool
+	 */
+	public function displayOnNetworkAdmin(bool $network_admin): bool
+	{
+		return $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_NETWORK_ONLY;
+	}
+
+
+	/**
+	 * parent slug to use when site is in full maintenance mode
+	 *
+	 * @return string
+	 */
+	public function maintenanceModeParent(): string
+	{
+		return $this->maintenance_mode_parent;
+	}
+
+
+	/**
+	 * @param string $maintenance_mode_parent
+	 */
+	public function setMaintenanceModeParent(string $maintenance_mode_parent): void
+	{
+		$this->maintenance_mode_parent = $maintenance_mode_parent;
+	}
+
+
+	/**
+	 *  Optional. The function to be called to output the content for this page.
+	 *
+	 * @return callable|null
+	 */
+	public function menuCallback(): ?callable
+	{
+		return $this->menu_callback;
+	}
+
+
+	/**
+	 * @param callable|null $menu_callback
+	 */
+	public function setMenuCallback(?callable $menu_callback): void
+	{
+		$this->menu_callback = $menu_callback;
+	}
+
+
+	/**
+	 * Slug for menu group that this menu item will appear under
+	 *
+	 * @return string
+	 */
+	public function menuGroup(): string
+	{
+		return $this->menu_group;
+	}
+
+
+	/**
+	 * @param string $menu_group
+	 */
+	public function setMenuGroup(string $menu_group): void
+	{
+		$this->menu_group = $menu_group;
+	}
+
+
+	/**
+	 * The text to be used for the menu.
+	 *
+	 * @return string
+	 */
+	public function menuLabel(): string
+	{
+		return $this->menu_label;
+	}
+
+
+	/**
+	 * @param string $menu_label
+	 */
+	public function setMenuLabel(string $menu_label): void
+	{
+		$this->menu_label = $menu_label;
+	}
+
+
+	/**
+	 * Optional. The position in the menu order this item should appear.
+	 *
+	 * @return int
+	 */
+	public function menuOrder(): int
+	{
+		return $this->menu_order;
+	}
+
+
+	/**
+	 * @param int $menu_order
+	 */
+	public function setMenuOrder(int $menu_order): void
+	{
+		$this->menu_order = absint($menu_order);
+	}
+
+
+	/**
+	 * The slug name to refer to this menu by. Should be unique for this menu
+	 *
+	 * @return string
+	 */
+	public function menuSlug(): string
+	{
+		return $this->menu_slug;
+	}
+
+
+	/**
+	 * @param string $menu_slug
+	 */
+	public function setMenuSlug(string $menu_slug): void
+	{
+		$this->menu_slug = sanitize_key($menu_slug);
+	}
+
+
+	/**
+	 * The slug name for the parent menu (or the file name of a standard WordPress admin page).
+	 *
+	 * @return string
+	 */
+	public function parentSlug(): string
+	{
+		return $this->parent_slug;
+	}
+
+
+	/**
+	 * if site is in full maintenance mode,
+	 * then parent slug will be swapped with the maintenance_mode_parent if that property has been set
+	 *
+	 * @param string $parent_slug
+	 */
+	public function setParentSlug(string $parent_slug): void
+	{
+		$this->parent_slug = $this->maintenance_mode && $this->maintenance_mode_parent
+			? $this->maintenance_mode_parent
+			: $parent_slug;
+	}
+
+
+	/**
+	 * returns true if menu item has already been registered with WP core
+	 *
+	 * @return bool
+	 */
+	public function isRegistered(): bool
+	{
+		return $this->registered;
+	}
+
+
+	/**
+	 * returns TRUE if:
+	 * - site is currently NOT in full site maintenance mode
+	 * - site IS in full site maintenance mode and menu item has a valid maintenance mode parent
+	 *
+	 * @return int
+	 */
+	public function showOnMaintenanceModeMenu(): int
+	{
+		return ! $this->maintenance_mode || $this->maintenanceModeParent() !== '';
+	}
+
+
+	/**
+	 * @param int $show_on_menu
+	 * @throws DomainException
+	 */
+	public function setShowOnMenu(int $show_on_menu): void
+	{
+		$valid_menu_options = [
+			AdminMenuItem::DISPLAY_NONE,
+			AdminMenuItem::DISPLAY_BLOG_ONLY,
+			AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+			AdminMenuItem::DISPLAY_NETWORK_ONLY,
+		];
+		if (! in_array($show_on_menu, $valid_menu_options, true)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Invalid "ShowOnMenu" option of "%1$s" supplied. You must use one of the AdminMenuItem::DISPLAY_* constants.',
+						'event_espresso'
+					),
+					$show_on_menu
+				)
+			);
+		}
+		$this->show_on_menu = $show_on_menu;
+	}
+
+
+	/**
+	 * The text to be displayed in the title tags of the page when the menu is selected
+	 *
+	 * @return string
+	 */
+	public function title(): string
+	{
+		return $this->title;
+	}
+
+
+	/**
+	 * @param string $title
+	 */
+	public function setTitle(string $title): void
+	{
+		$this->title = $title;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
 
     public const DISPLAY_NETWORK_ONLY     = 3;
 
-    public const TYPE_MENU_TOP           = 'top';
+    public const TYPE_MENU_TOP = 'top';
 
     public const TYPE_MENU_GROUP          = 'group';
 
@@ -189,7 +189,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff($required, array_keys($menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -271,7 +271,7 @@ 
         $this->capability = $capability;
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
     }
 
 
@@ -491,7 +491,7 @@ 
             AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
             AdminMenuItem::DISPLAY_NETWORK_ONLY,
         ];
-        if (! in_array($show_on_menu, $valid_menu_options, true)) {
+        if ( ! in_array($show_on_menu, $valid_menu_options, true)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/domain/entities/admin/menu/AdminMenuTopLevel.php

Indentation +119 added lines, -119 removed lines

@@ -4,123 +4,123 @@
 
 class AdminMenuTopLevel extends AdminMenuItem
 {
-    /**
-     * The page to a icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    protected $icon_url = '';
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    protected $position = 0;
-
-    /**
-     * If included int incoming params, then this class will also register a Sub Menu Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected $subtitle = '';
-
-
-    public function __construct(array $menu_args)
-    {
-        $this->setIconUrl($menu_args['icon_url'] ?? '');
-        $this->setPosition($menu_args['position'] ?? 0);
-        $this->setSubtitle($menu_args['subtitle'] ?? '');
-        unset($menu_args['icon_url'], $menu_args['position'], $menu_args['subtitle']);
-        parent::__construct(
-            $menu_args,
-            // required args
-            [
-                'menu_label',
-                'menu_slug',
-                'menu_group',
-                'menu_order',
-            ]
-        );
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function registerMenuItem(): string
-    {
-        return add_menu_page(
-            $this->title(),
-            $this->menuLabel(),
-            $this->capability(),
-            $this->parentSlug(),
-            $this->menuCallback(),
-            $this->iconUrl(),
-            $this->position()
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function iconUrl(): string
-    {
-        return $this->icon_url;
-    }
-
-
-    /**
-     * @param string $icon_url
-     */
-    public function setIconUrl(string $icon_url): void
-    {
-        $this->icon_url = $icon_url;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function position(): int
-    {
-        return $this->position;
-    }
-
-
-    /**
-     * @param int $position
-     */
-    public function setPosition(int $position): void
-    {
-        $this->position = absint($position);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function subtitle(): string
-    {
-        return $this->subtitle;
-    }
-
-
-    /**
-     * @param string $subtitle
-     */
-    public function setSubtitle(string $subtitle): void
-    {
-        $this->subtitle = $subtitle;
-    }
+	/**
+	 * The page to a icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	protected $icon_url = '';
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	protected $position = 0;
+
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menu Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected $subtitle = '';
+
+
+	public function __construct(array $menu_args)
+	{
+		$this->setIconUrl($menu_args['icon_url'] ?? '');
+		$this->setPosition($menu_args['position'] ?? 0);
+		$this->setSubtitle($menu_args['subtitle'] ?? '');
+		unset($menu_args['icon_url'], $menu_args['position'], $menu_args['subtitle']);
+		parent::__construct(
+			$menu_args,
+			// required args
+			[
+				'menu_label',
+				'menu_slug',
+				'menu_group',
+				'menu_order',
+			]
+		);
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function registerMenuItem(): string
+	{
+		return add_menu_page(
+			$this->title(),
+			$this->menuLabel(),
+			$this->capability(),
+			$this->parentSlug(),
+			$this->menuCallback(),
+			$this->iconUrl(),
+			$this->position()
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function iconUrl(): string
+	{
+		return $this->icon_url;
+	}
+
+
+	/**
+	 * @param string $icon_url
+	 */
+	public function setIconUrl(string $icon_url): void
+	{
+		$this->icon_url = $icon_url;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function position(): int
+	{
+		return $this->position;
+	}
+
+
+	/**
+	 * @param int $position
+	 */
+	public function setPosition(int $position): void
+	{
+		$this->position = absint($position);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function subtitle(): string
+	{
+		return $this->subtitle;
+	}
+
+
+	/**
+	 * @param string $subtitle
+	 */
+	public function setSubtitle(string $subtitle): void
+	{
+		$this->subtitle = $subtitle;
+	}
 }

core/domain/entities/admin/menu/AdminMenuGroup.php

Indentation +48 added lines, -48 removed lines

@@ -16,64 +16,64 @@
  */
 class AdminMenuGroup extends AdminMenuItem
 {
-    /**
-     * @var AdminMenuItem[]
-     */
-    private $menu_items = [];
+	/**
+	 * @var AdminMenuItem[]
+	 */
+	private $menu_items = [];
 
 
 
-    public function __construct(array $menu_args)
-    {
-        parent::__construct(
-            $menu_args,
-            // required args
-            [
-                'menu_label',
-                'menu_slug',
-                'menu_order',
-                'parent_slug'
-            ]
-        );
-    }
+	public function __construct(array $menu_args)
+	{
+		parent::__construct(
+			$menu_args,
+			// required args
+			[
+				'menu_label',
+				'menu_slug',
+				'menu_order',
+				'parent_slug'
+			]
+		);
+	}
 
 
-    public function addMenuItem(AdminMenuItem $menu_item): void
-    {
-        $this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
-    }
+	public function addMenuItem(AdminMenuItem $menu_item): void
+	{
+		$this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
+	}
 
-    public function getMenuItems(): array
-    {
-        return $this->menu_items;
-    }
+	public function getMenuItems(): array
+	{
+		return $this->menu_items;
+	}
 
-    public function hasNoMenuItems(): bool
-    {
-        return empty($this->menu_items);
-    }
+	public function hasNoMenuItems(): bool
+	{
+		return empty($this->menu_items);
+	}
 
-    public function setMenuItems(array $menu_items): void
-    {
-        $this->menu_items = $menu_items;
-    }
+	public function setMenuItems(array $menu_items): void
+	{
+		$this->menu_items = $menu_items;
+	}
 
 
-    protected function registerMenuItem(): string
-    {
-        return add_submenu_page(
-            $this->parentSlug(),
-            $this->menuLabel(),
-            $this->groupLink(),
-            $this->capability(),
-            $this->menuSlug(),
-            '__return_false'
-        );
-    }
+	protected function registerMenuItem(): string
+	{
+		return add_submenu_page(
+			$this->parentSlug(),
+			$this->menuLabel(),
+			$this->groupLink(),
+			$this->capability(),
+			$this->menuSlug(),
+			'__return_false'
+		);
+	}
 
 
-    protected function groupLink(): string
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
-    }
+	protected function groupLink(): string
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
 
     public function addMenuItem(AdminMenuItem $menu_item): void
     {
-        $this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
+        $this->menu_items[$menu_item->menuSlug()] = $menu_item;
     }
 
     public function getMenuItems(): array
@@ -74,6 +74,6 @@ 
 
     protected function groupLink(): string
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menuLabel().'</span>';
     }
 }

core/domain/entities/routing/handlers/admin/ActivationRequests.php

Indentation +40 added lines, -40 removed lines

@@ -17,48 +17,48 @@
  */
 class ActivationRequests extends PrimaryRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isActivation();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isActivation();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $admin_dependencies = ['EE_Admin_Config' => EE_Dependency_Map::load_from_cache] + Route::$default_dependencies;
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
-            $admin_dependencies
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\PueRequests',
-            Route::$default_dependencies
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
-            $admin_dependencies
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$admin_dependencies = ['EE_Admin_Config' => EE_Dependency_Map::load_from_cache] + Route::$default_dependencies;
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
+			$admin_dependencies
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\PueRequests',
+			Route::$default_dependencies
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
+			$admin_dependencies
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
+		return true;
+	}
 }