eventespresso / event-espresso-core

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.64.rc.000');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.64.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/services/assets/Registry.php

Indentation +573 added lines, -573 removed lines

@@ -23,584 +23,584 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     *
-     * @var array
-     */
-    private $script_handles_with_data = array();
-
-    /**
-     * Holds the manifest data obtained from registered manifest files.
-     * Manifests are maps of asset chunk name to actual built asset file names.
-     * Shape of this array is:
-     * array(
-     *  'some_namespace_slug' => array(
-     *      'some_chunk_name' => array(
-     *          'js' => 'filename.js'
-     *          'css' => 'filename.js'
-     *      ),
-     *      'url_base' => 'https://baseurl.com/to/assets
-     *  )
-     * )
-     *
-     * @var array
-     */
-    private $manifest_data = array();
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection $assets
-     * @param I18nRegistry    $i18n_registry
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
-     * translation handling.
-     *
-     * @return I18nRegistry
-     */
-    public function getI18nRegistry()
-    {
-        return $this->i18n_registry;
-    }
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @since 4.9.62.p
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_add_inline_script(
-            'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
-            'before'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasInlineDataCallback()) {
-                $localize = $script->inlineDataCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     * When you use this method, the value you include will be appended to the end of an array on $key.
-     * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key, then
-     * this will throw an exception.
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 *
+	 * @var array
+	 */
+	private $script_handles_with_data = array();
+
+	/**
+	 * Holds the manifest data obtained from registered manifest files.
+	 * Manifests are maps of asset chunk name to actual built asset file names.
+	 * Shape of this array is:
+	 * array(
+	 *  'some_namespace_slug' => array(
+	 *      'some_chunk_name' => array(
+	 *          'js' => 'filename.js'
+	 *          'css' => 'filename.js'
+	 *      ),
+	 *      'url_base' => 'https://baseurl.com/to/assets
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	private $manifest_data = array();
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection $assets
+	 * @param I18nRegistry    $i18n_registry
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
+	 * translation handling.
+	 *
+	 * @return I18nRegistry
+	 */
+	public function getI18nRegistry()
+	{
+		return $this->i18n_registry;
+	}
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @since 4.9.62.p
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_add_inline_script(
+			'eejs-core',
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+			'before'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasInlineDataCallback()) {
+				$localize = $script->inlineDataCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 * When you use this method, the value you include will be appended to the end of an array on $key.
+	 * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key, then
+	 * this will throw an exception.
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[ $key ])
+			&& ! is_array($this->jsdata[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        $this->jsdata[ $key ][] = $value;
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
-            : '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
-            : false;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		$this->jsdata[ $key ][] = $value;
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'][ $template_reference ])
+			? $this->jsdata['templates'][ $template_reference ]
+			: '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[ $key ])
+			? $this->jsdata[ $key ]
+			: false;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->jsdata[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Get the actual asset path for asset manifests.
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
-     *
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
-     *                           asset file location.
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return string
-     * @since 4.9.59.p
-     */
-    public function getAssetUrl($namespace, $chunk_name, $asset_type)
-    {
-        $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
-        )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
-            : $chunk_name;
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $url,
-            $namespace,
-            $chunk_name,
-            $asset_type
-        );
-    }
-
-
-    /**
-     * Return the url to a js file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getJsUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Return the url to a css file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getCssUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
-            );
-        }
-    }
-
-
-    /**
-     * Used to register a js/css manifest file with the registered_manifest_files property.
-     *
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
-     * @param string $url_base      The url base for the manifest file location.
-     * @param string $manifest_file The absolute path to the manifest file.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file)
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
-                        'event_espresso'
-                    ),
-                    $namespace
-                )
-            );
-        }
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
-            if (is_admin()) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
-                            'event_espresso'
-                        ),
-                        'Event Espresso',
-                        $url_base,
-                        'plugins_url',
-                        'WP_PLUGIN_URL'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return;
-        }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
-        }
-    }
-
-
-    /**
-     * Decodes json from the provided manifest file.
-     *
-     * @since 4.9.59.p
-     * @param string $manifest_file Path to manifest file.
-     * @return array
-     * @throws InvalidFilePathException
-     */
-    private function decodeManifestFile($manifest_file)
-    {
-        if (! file_exists($manifest_file)) {
-            throw new InvalidFilePathException($manifest_file);
-        }
-        return json_decode(file_get_contents($manifest_file), true);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($script_handle)
-    {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
-    }
-
-
-    /**i
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get the actual asset path for asset manifests.
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
+	 *
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
+	 *                           asset file location.
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public function getAssetUrl($namespace, $chunk_name, $asset_type)
+	{
+		$url = isset(
+			$this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
+			$this->manifest_data[ $namespace ]['url_base']
+		)
+			? $this->manifest_data[ $namespace ]['url_base']
+			  . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+			: $chunk_name;
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$url,
+			$namespace,
+			$chunk_name,
+			$asset_type
+		);
+	}
+
+
+	/**
+	 * Return the url to a js file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getJsUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Return the url to a css file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getCssUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+			);
+		}
+	}
+
+
+	/**
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
+	 *
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
+	 * @param string $url_base      The url base for the manifest file location.
+	 * @param string $manifest_file The absolute path to the manifest file.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file)
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
+						'event_espresso'
+					),
+					$namespace
+				)
+			);
+		}
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
+			if (is_admin()) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
+							'event_espresso'
+						),
+						'Event Espresso',
+						$url_base,
+						'plugins_url',
+						'WP_PLUGIN_URL'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return;
+		}
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+		}
+	}
+
+
+	/**
+	 * Decodes json from the provided manifest file.
+	 *
+	 * @since 4.9.59.p
+	 * @param string $manifest_file Path to manifest file.
+	 * @return array
+	 * @throws InvalidFilePathException
+	 */
+	private function decodeManifestFile($manifest_file)
+	{
+		if (! file_exists($manifest_file)) {
+			throw new InvalidFilePathException($manifest_file);
+		}
+		return json_decode(file_get_contents($manifest_file), true);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($script_handle)
+	{
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
+	}
+
+
+	/**i
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
      * Dependency stored in WP_Scripts if its set.
      */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     *
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
-    {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
-            global $wp_scripts;
-            $unset_handle = false;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
-                $unset_handle = true;
-            }
-            //deal with inline_scripts
-            if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
-                $unset_handle = true;
-            }
-            if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
-            }
-            if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     */
-    private function debug()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 *
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
+	{
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
+			global $wp_scripts;
+			$unset_handle = false;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+				$unset_handle = true;
+			}
+			//deal with inline_scripts
+			if ($wp_scripts->get_data($script_handle, 'before')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+				$unset_handle = true;
+			}
+			if ($wp_scripts->get_data($script_handle, 'after')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+			}
+			if ($unset_handle) {
+				unset($this->script_handles_with_data[ $script_handle ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 */
+	private function debug()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
 }

core/services/assets/AssetCollection.php

Indentation +197 added lines, -197 removed lines

@@ -21,201 +21,201 @@
 {
 
 
-    /**
-     * AssetCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\values\assets\Asset');
-    }
-
-
-    /**
-     * @return StylesheetAsset[]
-     * @since 4.9.62.p
-     */
-    public function getStylesheetAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_JS);
-    }
-
-
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFiles()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
-    }
-
-
-    /**
-     * @param $type
-     * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
-     * @since 4.9.62.p
-     */
-    protected function getAssetsOfType($type)
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var Asset $asset */
-            $asset = $this->current();
-            if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssetsWithData()
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var JavascriptAsset $asset */
-            $asset = $this->current();
-            if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Stylesheet Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasStylesheetAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Javascript Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasJavascriptAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
-    }
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return JavascriptAsset|StylesheetAsset
-     * @since 4.9.63.p
-     */
-    public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                /** @var JavascriptAsset|StylesheetAsset $object */
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Stylesheet Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return StylesheetAsset
-     * @since 4.9.63.p
-     */
-    public function getStylesheetAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the Javascript Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return JavascriptAsset
-     * @since 4.9.63.p
-     */
-    public function getJavascriptAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_JS);
-    }
+	/**
+	 * AssetCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\values\assets\Asset');
+	}
+
+
+	/**
+	 * @return StylesheetAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getStylesheetAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFiles()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
+	}
+
+
+	/**
+	 * @param $type
+	 * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	protected function getAssetsOfType($type)
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var Asset $asset */
+			$asset = $this->current();
+			if ($asset->type() === $type) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssetsWithData()
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var JavascriptAsset $asset */
+			$asset = $this->current();
+			if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Stylesheet Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasStylesheetAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Javascript Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasJavascriptAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
+	}
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return JavascriptAsset|StylesheetAsset
+	 * @since 4.9.63.p
+	 */
+	public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				/** @var JavascriptAsset|StylesheetAsset $object */
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Stylesheet Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return StylesheetAsset
+	 * @since 4.9.63.p
+	 */
+	public function getStylesheetAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the Javascript Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return JavascriptAsset
+	 * @since 4.9.63.p
+	 */
+	public function getJavascriptAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_JS);
+	}
 }

core/CPTs/EE_CPT_Event_Strategy.core.php

Indentation +226 added lines, -226 removed lines

@@ -13,252 +13,252 @@
 class EE_CPT_Event_Strategy
 {
 
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var object $CPT
-     */
-    protected $CPT;
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var object $CPT
+	 */
+	protected $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct($wp_query, $CPT = array())
-    {
-        if ($wp_query instanceof WP_Query) {
-            $WP_Query = $wp_query;
-            $this->CPT = $CPT;
-        } else {
-            $WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
-            $this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
-        }
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where'
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        $this->_add_filters();
-        if ($WP_Query instanceof WP_Query) {
-            $WP_Query->is_espresso_event_single = is_singular()
-                                                  && isset($WP_Query->query->post_type)
-                                                  && $WP_Query->query->post_type === 'espresso_events';
-            $WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
-            $WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
-        }
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct($wp_query, $CPT = array())
+	{
+		if ($wp_query instanceof WP_Query) {
+			$WP_Query = $wp_query;
+			$this->CPT = $CPT;
+		} else {
+			$WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
+			$this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
+		}
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where'
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		$this->_add_filters();
+		if ($WP_Query instanceof WP_Query) {
+			$WP_Query->is_espresso_event_single = is_singular()
+												  && isset($WP_Query->query->post_type)
+												  && $WP_Query->query->post_type === 'espresso_events';
+			$WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
+			$WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
+		}
+	}
 
 
-    /**
-     * When an instance of this class is created, we add our filters
-     * (which will get removed in case the next call to get_posts ISN'T
-     * for event CPTs)
-     */
-    protected function _add_filters()
-    {
-        add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
-        add_filter('posts_join', array($this, 'posts_join'), 1, 2);
-        add_filter('posts_where', array($this, 'posts_where'), 10, 2);
-        // add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
-        add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
-        add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
-        add_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * When an instance of this class is created, we add our filters
+	 * (which will get removed in case the next call to get_posts ISN'T
+	 * for event CPTs)
+	 */
+	protected function _add_filters()
+	{
+		add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
+		add_filter('posts_join', array($this, 'posts_join'), 1, 2);
+		add_filter('posts_where', array($this, 'posts_where'), 10, 2);
+		// add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
+		add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
+		add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
+		add_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * public access to _remove_filters()
-     *
-     * @since 4.9.63.p
-     */
-    public function remove_filters()
-    {
-        $this->_remove_filters();
-    }
+	/**
+	 * public access to _remove_filters()
+	 *
+	 * @since 4.9.63.p
+	 */
+	public function remove_filters()
+	{
+		$this->_remove_filters();
+	}
 
 
-    /**
-     * Should eb called when the last filter or hook is fired for this CPT strategy.
-     * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
-     * we don't want to join to the datetime table when querying for venues, do we!?)
-     */
-    protected function _remove_filters()
-    {
-        remove_filter('posts_fields', array($this, 'posts_fields'), 1);
-        remove_filter('posts_join', array($this, 'posts_join'), 1);
-        remove_filter('posts_where', array($this, 'posts_where'), 10);
-        // remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
-        remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
-        remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
-        remove_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * Should eb called when the last filter or hook is fired for this CPT strategy.
+	 * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
+	 * we don't want to join to the datetime table when querying for venues, do we!?)
+	 */
+	protected function _remove_filters()
+	{
+		remove_filter('posts_fields', array($this, 'posts_fields'), 1);
+		remove_filter('posts_join', array($this, 'posts_join'), 1);
+		remove_filter('posts_where', array($this, 'posts_where'), 10);
+		// remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
+		remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
+		remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
+		remove_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return    string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
-            if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
-                // because we only want to retrieve the next upcoming datetime for each event:
-                // add something like:
-                // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
-                // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+			if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
+				// because we only want to retrieve the next upcoming datetime for each event:
+				// add something like:
+				// ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
+				// to WP Query SELECT statement
+				$SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like:
-            // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
-            // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like:
+			// " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
+			// to WP Query JOIN statement
+			$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
+					. '.ID = ' . EEM_Datetime::instance()->table() . '.'
+					. EEM_Event::instance()->primary_key_name() . ' ) ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            if (! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
-                || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
-                || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
-            ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			if (! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
+				|| ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
+				|| ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
+			) {
+				$SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
+						. current_time('mysql', true) . "' ";
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            $SQL = ' event_start_date ASC ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			$SQL = ' event_start_date ASC ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_groupby($SQL, WP_Query $wp_query)
-    {
-        if ($wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
-            // we're joining to the datetimes table, where there can be MANY datetimes for a single event,
-            // but we want to only show each event only once
-            // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
-            global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_groupby($SQL, WP_Query $wp_query)
+	{
+		if ($wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
+			// we're joining to the datetimes table, where there can be MANY datetimes for a single event,
+			// but we want to only show each event only once
+			// (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
+			global $wpdb;
+			$SQL = $wpdb->posts . '.ID ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param null $meta_value
-     * @param      $post_id
-     * @param      $meta_key
-     * @param      $single
-     * @return    string
-     */
-    public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
-    {
-        return $meta_value;
-    }
+	/**
+	 * @param null $meta_value
+	 * @param      $post_id
+	 * @param      $meta_key
+	 * @param      $single
+	 * @return    string
+	 */
+	public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
+	{
+		return $meta_value;
+	}
 }

core/CPTs/CptQueryModifier.php

Indentation +565 added lines, -565 removed lines

@@ -28,569 +28,569 @@
 class CptQueryModifier
 {
 
-    /**
-     * @var string $post_type
-     */
-    protected $post_type = '';
-
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     *
-     * @var array $cpt_details
-     */
-    protected $cpt_details = array();
-
-    /**
-     * @var EE_Table_Base[] $model_tables
-     */
-    protected $model_tables = array();
-
-    /**
-     * @var array $taxonomies
-     */
-    protected $taxonomies = array();
-
-    /**
-     * meta table for the related CPT
-     *
-     * @var EE_Secondary_Table $meta_table
-     */
-    protected $meta_table;
-
-    /**
-     * EEM_CPT_Base model for the related CPT
-     *
-     * @var EEM_CPT_Base $model
-     */
-    protected $model;
-
-    /**
-     * @var EE_Request_Handler $request_handler
-     */
-    protected $request_handler;
-
-    /**
-     * @var WP_Query $wp_query
-     */
-    protected $wp_query;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * CptQueryModifier constructor
-     *
-     * @param string             $post_type
-     * @param array              $cpt_details
-     * @param WP_Query           $WP_Query
-     * @param EE_Request_Handler $request_handler
-     * @param RequestInterface   $request
-     * @param LoaderInterface    $loader
-     * @throws EE_Error
-     */
-    public function __construct(
-        $post_type,
-        array $cpt_details,
-        WP_Query $WP_Query,
-        EE_Request_Handler $request_handler,
-        RequestInterface $request,
-        LoaderInterface $loader
-    ) {
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->request_handler = $request_handler;
-        $this->setWpQuery($WP_Query);
-        $this->setPostType($post_type);
-        $this->setCptDetails($cpt_details);
-        $this->init();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * @param string $post_type
-     */
-    protected function setPostType($post_type)
-    {
-        $this->post_type = $post_type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cptDetails()
-    {
-        return $this->cpt_details;
-    }
-
-
-    /**
-     * @param array $cpt_details
-     */
-    protected function setCptDetails($cpt_details)
-    {
-        $this->cpt_details = $cpt_details;
-    }
-
-
-    /**
-     * @return EE_Table_Base[]
-     */
-    public function modelTables()
-    {
-        return $this->model_tables;
-    }
-
-
-    /**
-     * @param EE_Table_Base[] $model_tables
-     */
-    protected function setModelTables($model_tables)
-    {
-        $this->model_tables = $model_tables;
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function taxonomies()
-    {
-        if (empty($this->taxonomies)) {
-            $this->initializeTaxonomies();
-        }
-        return $this->taxonomies;
-    }
-
-
-    /**
-     * @param array $taxonomies
-     */
-    protected function setTaxonomies(array $taxonomies)
-    {
-        $this->taxonomies = $taxonomies;
-    }
-
-
-    /**
-     * @return EE_Secondary_Table
-     */
-    public function metaTable()
-    {
-        return $this->meta_table;
-    }
-
-
-    /**
-     * @param EE_Secondary_Table $meta_table
-     */
-    public function setMetaTable(EE_Secondary_Table $meta_table)
-    {
-        $this->meta_table = $meta_table;
-    }
-
-
-    /**
-     * @return EEM_Base
-     */
-    public function model()
-    {
-        return $this->model;
-    }
-
-
-    /**
-     * @param EEM_Base $CPT_model
-     */
-    protected function setModel(EEM_Base $CPT_model)
-    {
-        $this->model = $CPT_model;
-    }
-
-
-    /**
-     * @deprecated 4.9.63.p
-     * @return EE_Request_Handler
-     */
-    public function request()
-    {
-        return $this->request_handler;
-    }
-
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * @return WP_Query
-     */
-    public function WpQuery()
-    {
-        return $this->wp_query;
-    }
-    // phpcs:enable
-
-
-    /**
-     * @param WP_Query $wp_query
-     */
-    public function setWpQuery(WP_Query $wp_query)
-    {
-        $this->wp_query = $wp_query;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function initializeTaxonomies()
-    {
-        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
-        if (empty($this->taxonomies)
-            && isset($this->cpt_details['args']['taxonomies'])
-        ) {
-            // if so then grab them, but we want the taxonomy name as the key
-            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
-            // then grab the list of ALL taxonomies
-            /** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
-             * $taxonomy_definitions
-             */
-            $taxonomy_definitions = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
-            );
-            $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
-            foreach ($taxonomies as $taxonomy => &$details) {
-                // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[ $taxonomy ])
-                    ? $all_taxonomies[ $taxonomy ]
-                    : array();
-            }
-            // ALWAYS unset() variables that were passed by reference
-            unset($details);
-            $this->setTaxonomies($taxonomies);
-        }
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @throws EE_Error
-     */
-    protected function init()
-    {
-        $this->setAdditionalCptDetails();
-        $this->setRequestVarsIfCpt();
-        // convert post_type to model name
-        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
-        // load all tables related to CPT
-        $this->setupModelsAndTables($model_name);
-        // load and instantiate CPT_*_Strategy
-        $CPT_Strategy = $this->cptStrategyClass($model_name);
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        add_filter('posts_fields', array($this, 'postsFields'));
-        add_filter('posts_join', array($this, 'postsJoin'));
-        add_filter(
-            'get_' . $this->post_type . '_metadata',
-            array($CPT_Strategy, 'get_EE_post_type_metadata'),
-            1,
-            4
-        );
-        add_filter('the_posts', array($this, 'thePosts'), 1, 1);
-        if ($this->wp_query->is_main_query()) {
-            add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
-            $this->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * sets some basic query vars that pertain to the CPT
-     *
-     * @access protected
-     * @return void
-     */
-    protected function setAdditionalCptDetails()
-    {
-        // the post or category or term that is triggering EE
-        $this->cpt_details['espresso_page'] = $this->request_handler->is_espresso_page();
-        // requested post name
-        $this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
-        // add support for viewing 'private', 'draft', or 'pending' posts
-        if (isset($this->wp_query->query_vars['p'])
-            && $this->wp_query->query_vars['p'] !== 0
-            && is_user_logged_in()
-            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
-        ) {
-            // we can just inject directly into the WP_Query object
-            $this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
-            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
-            $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-        }
-    }
-
-
-    /**
-     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
-     * If so, sets the 'ee' request variable
-     * so other parts of EE can know what CPT is getting queried.
-     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
-     * in order for is_archive() and is_single() methods to work properly.
-     *
-     * @return void
-     */
-    public function setRequestVarsIfCpt()
-    {
-        // check if ee action var has been set
-        if (! $this->request->requestParamIsSet('ee')) {
-            // check that route exists for CPT archive slug
-            if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
-                // ie: set "ee" to "events"
-                $this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
-                // or does it match a single page CPT like /event/
-            } elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
-                // ie: set "ee" to "event"
-                $this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
-            }
-        }
-    }
-
-
-    /**
-     * setupModelsAndTables
-     *
-     * @access protected
-     * @param string $model_name
-     * @throws EE_Error
-     */
-    protected function setupModelsAndTables($model_name)
-    {
-        // get CPT table data via CPT Model
-        $full_model_name = strpos($model_name, 'EEM_') !== 0
-            ? 'EEM_' . $model_name
-            : $model_name;
-        $model = $this->loader->getShared($full_model_name);
-        if (! $model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" model could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $full_model_name
-                )
-            );
-        }
-        $this->setModel($model);
-        $this->setModelTables($this->model->get_tables());
-        $meta_model = $model_name . '_Meta';
-        // is there a Meta Table for this CPT?
-        if (isset($this->cpt_details['tables'][ $meta_model ])
-            && $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
-        ) {
-            $this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
-        }
-    }
-
-
-    /**
-     * cptStrategyClass
-     *
-     * @access protected
-     * @param  string $model_name
-     * @return string
-     */
-    protected function cptStrategyClass($model_name)
-    {
-        // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
-        // load and instantiate
-        $CPT_Strategy = $this->loader->getShared(
-            $CPT_Strategy_class_name,
-            array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-        );
-        if ($CPT_Strategy === null) {
-            $CPT_Strategy = $this->loader->getShared(
-                'EE_CPT_Default_Strategy',
-                array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-            );
-        }
-        return $CPT_Strategy;
-    }
-
-
-    /**
-     * postsFields
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsFields($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
-        }
-        remove_filter('posts_fields', array($this, 'postsFields'));
-        return $SQL;
-    }
-
-
-    /**
-     * postsJoin
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsJoin($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof EE_Secondary_Table) {
-            global $wpdb;
-            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
-            $SQL .= ' LEFT JOIN '
-                    . $this->meta_table->get_table_name()
-                    . ' ON ( '
-                    . $this->meta_table->get_table_name()
-                    . '.'
-                    . $this->meta_table->get_fk_on_table()
-                    . ' = '
-                    . $wpdb->posts
-                    . '.ID ) ';
-        }
-        remove_filter('posts_join', array($this, 'postsJoin'));
-        return $SQL;
-    }
-
-
-    /**
-     * thePosts
-     *
-     * @access public
-     * @param  WP_Post[] $posts
-     * @return WP_Post[]
-     */
-    public function thePosts($posts)
-    {
-        $CPT_class = $this->cpt_details['class_name'];
-        // loop thru posts
-        if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
-            foreach ($posts as $key => $post) {
-                if ($post->post_type === $this->post_type) {
-                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
-                }
-            }
-        }
-        remove_filter('the_posts', array($this, 'thePosts'), 1);
-        return $posts;
-    }
-
-
-    /**
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function getEditPostLink($url, $ID)
-    {
-        // need to make sure we only edit links if our cpt
-        global $post;
-        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
-        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (! $post instanceof WP_Post
-            || $post->post_type !== $this->post_type
-            || (
-                isset($this->cpt_details['args']['show_ee_ui'])
-                && ! $this->cpt_details['args']['show_ee_ui']
-            )
-        ) {
-            return $url;
-        }
-        // k made it here so all is good.
-        return wp_nonce_url(
-            add_query_arg(
-                array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
-                admin_url('admin.php')
-            ),
-            'edit',
-            'edit_nonce'
-        );
-    }
-
-
-    /**
-     * Execute any template filters.
-     * This method is only called if in main query.
-     *
-     * @return void
-     */
-    public function addTemplateFilters()
-    {
-        // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
-            // then let's hook into the appropriate query_template hook
-            add_filter('single_template', array($this, 'singleCptTemplate'));
-        }
-    }
-
-
-    /**
-     * Callback for single_template wp filter.
-     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
-     * hierarchy.
-     *
-     * @access public
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function singleCptTemplate($current_template)
-    {
-        $object = get_queried_object();
-        // does this called object HAVE a page template set that is something other than the default.
-        $template = get_post_meta($object->ID, '_wp_page_template', true);
-        // exit early if default or not set or invalid path (accounts for theme changes)
-        if ($template === 'default'
-            || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
-        ) {
-            return $current_template;
-        }
-        // made it here so we SHOULD be able to just locate the template and then return it.
-        return locate_template(array($template));
-    }
+	/**
+	 * @var string $post_type
+	 */
+	protected $post_type = '';
+
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 *
+	 * @var array $cpt_details
+	 */
+	protected $cpt_details = array();
+
+	/**
+	 * @var EE_Table_Base[] $model_tables
+	 */
+	protected $model_tables = array();
+
+	/**
+	 * @var array $taxonomies
+	 */
+	protected $taxonomies = array();
+
+	/**
+	 * meta table for the related CPT
+	 *
+	 * @var EE_Secondary_Table $meta_table
+	 */
+	protected $meta_table;
+
+	/**
+	 * EEM_CPT_Base model for the related CPT
+	 *
+	 * @var EEM_CPT_Base $model
+	 */
+	protected $model;
+
+	/**
+	 * @var EE_Request_Handler $request_handler
+	 */
+	protected $request_handler;
+
+	/**
+	 * @var WP_Query $wp_query
+	 */
+	protected $wp_query;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * CptQueryModifier constructor
+	 *
+	 * @param string             $post_type
+	 * @param array              $cpt_details
+	 * @param WP_Query           $WP_Query
+	 * @param EE_Request_Handler $request_handler
+	 * @param RequestInterface   $request
+	 * @param LoaderInterface    $loader
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		$post_type,
+		array $cpt_details,
+		WP_Query $WP_Query,
+		EE_Request_Handler $request_handler,
+		RequestInterface $request,
+		LoaderInterface $loader
+	) {
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->request_handler = $request_handler;
+		$this->setWpQuery($WP_Query);
+		$this->setPostType($post_type);
+		$this->setCptDetails($cpt_details);
+		$this->init();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * @param string $post_type
+	 */
+	protected function setPostType($post_type)
+	{
+		$this->post_type = $post_type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cptDetails()
+	{
+		return $this->cpt_details;
+	}
+
+
+	/**
+	 * @param array $cpt_details
+	 */
+	protected function setCptDetails($cpt_details)
+	{
+		$this->cpt_details = $cpt_details;
+	}
+
+
+	/**
+	 * @return EE_Table_Base[]
+	 */
+	public function modelTables()
+	{
+		return $this->model_tables;
+	}
+
+
+	/**
+	 * @param EE_Table_Base[] $model_tables
+	 */
+	protected function setModelTables($model_tables)
+	{
+		$this->model_tables = $model_tables;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function taxonomies()
+	{
+		if (empty($this->taxonomies)) {
+			$this->initializeTaxonomies();
+		}
+		return $this->taxonomies;
+	}
+
+
+	/**
+	 * @param array $taxonomies
+	 */
+	protected function setTaxonomies(array $taxonomies)
+	{
+		$this->taxonomies = $taxonomies;
+	}
+
+
+	/**
+	 * @return EE_Secondary_Table
+	 */
+	public function metaTable()
+	{
+		return $this->meta_table;
+	}
+
+
+	/**
+	 * @param EE_Secondary_Table $meta_table
+	 */
+	public function setMetaTable(EE_Secondary_Table $meta_table)
+	{
+		$this->meta_table = $meta_table;
+	}
+
+
+	/**
+	 * @return EEM_Base
+	 */
+	public function model()
+	{
+		return $this->model;
+	}
+
+
+	/**
+	 * @param EEM_Base $CPT_model
+	 */
+	protected function setModel(EEM_Base $CPT_model)
+	{
+		$this->model = $CPT_model;
+	}
+
+
+	/**
+	 * @deprecated 4.9.63.p
+	 * @return EE_Request_Handler
+	 */
+	public function request()
+	{
+		return $this->request_handler;
+	}
+
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * @return WP_Query
+	 */
+	public function WpQuery()
+	{
+		return $this->wp_query;
+	}
+	// phpcs:enable
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 */
+	public function setWpQuery(WP_Query $wp_query)
+	{
+		$this->wp_query = $wp_query;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function initializeTaxonomies()
+	{
+		// check if taxonomies have already been set and that this CPT has taxonomies registered for it
+		if (empty($this->taxonomies)
+			&& isset($this->cpt_details['args']['taxonomies'])
+		) {
+			// if so then grab them, but we want the taxonomy name as the key
+			$taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
+			// then grab the list of ALL taxonomies
+			/** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
+			 * $taxonomy_definitions
+			 */
+			$taxonomy_definitions = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
+			);
+			$all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
+			foreach ($taxonomies as $taxonomy => &$details) {
+				// add details to our taxonomies if they exist
+				$details = isset($all_taxonomies[ $taxonomy ])
+					? $all_taxonomies[ $taxonomy ]
+					: array();
+			}
+			// ALWAYS unset() variables that were passed by reference
+			unset($details);
+			$this->setTaxonomies($taxonomies);
+		}
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @throws EE_Error
+	 */
+	protected function init()
+	{
+		$this->setAdditionalCptDetails();
+		$this->setRequestVarsIfCpt();
+		// convert post_type to model name
+		$model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
+		// load all tables related to CPT
+		$this->setupModelsAndTables($model_name);
+		// load and instantiate CPT_*_Strategy
+		$CPT_Strategy = $this->cptStrategyClass($model_name);
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		add_filter('posts_fields', array($this, 'postsFields'));
+		add_filter('posts_join', array($this, 'postsJoin'));
+		add_filter(
+			'get_' . $this->post_type . '_metadata',
+			array($CPT_Strategy, 'get_EE_post_type_metadata'),
+			1,
+			4
+		);
+		add_filter('the_posts', array($this, 'thePosts'), 1, 1);
+		if ($this->wp_query->is_main_query()) {
+			add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
+			$this->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * sets some basic query vars that pertain to the CPT
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function setAdditionalCptDetails()
+	{
+		// the post or category or term that is triggering EE
+		$this->cpt_details['espresso_page'] = $this->request_handler->is_espresso_page();
+		// requested post name
+		$this->cpt_details['post_name'] = $this->request->getRequestParam('post_name');
+		// add support for viewing 'private', 'draft', or 'pending' posts
+		if (isset($this->wp_query->query_vars['p'])
+			&& $this->wp_query->query_vars['p'] !== 0
+			&& is_user_logged_in()
+			&& current_user_can('edit_post', $this->wp_query->query_vars['p'])
+		) {
+			// we can just inject directly into the WP_Query object
+			$this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
+			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
+			$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+		}
+	}
+
+
+	/**
+	 * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
+	 * If so, sets the 'ee' request variable
+	 * so other parts of EE can know what CPT is getting queried.
+	 * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
+	 * in order for is_archive() and is_single() methods to work properly.
+	 *
+	 * @return void
+	 */
+	public function setRequestVarsIfCpt()
+	{
+		// check if ee action var has been set
+		if (! $this->request->requestParamIsSet('ee')) {
+			// check that route exists for CPT archive slug
+			if (is_archive() && EE_Config::get_route($this->cpt_details['plural_slug'])) {
+				// ie: set "ee" to "events"
+				$this->request->setRequestParam('ee', $this->cpt_details['plural_slug']);
+				// or does it match a single page CPT like /event/
+			} elseif (is_single() && EE_Config::get_route($this->cpt_details['singular_slug'])) {
+				// ie: set "ee" to "event"
+				$this->request->setRequestParam('ee', $this->cpt_details['singular_slug']);
+			}
+		}
+	}
+
+
+	/**
+	 * setupModelsAndTables
+	 *
+	 * @access protected
+	 * @param string $model_name
+	 * @throws EE_Error
+	 */
+	protected function setupModelsAndTables($model_name)
+	{
+		// get CPT table data via CPT Model
+		$full_model_name = strpos($model_name, 'EEM_') !== 0
+			? 'EEM_' . $model_name
+			: $model_name;
+		$model = $this->loader->getShared($full_model_name);
+		if (! $model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" model could not be loaded.',
+						'event_espresso'
+					),
+					$full_model_name
+				)
+			);
+		}
+		$this->setModel($model);
+		$this->setModelTables($this->model->get_tables());
+		$meta_model = $model_name . '_Meta';
+		// is there a Meta Table for this CPT?
+		if (isset($this->cpt_details['tables'][ $meta_model ])
+			&& $this->cpt_details['tables'][ $meta_model ] instanceof EE_Secondary_Table
+		) {
+			$this->setMetaTable($this->cpt_details['tables'][ $meta_model ]);
+		}
+	}
+
+
+	/**
+	 * cptStrategyClass
+	 *
+	 * @access protected
+	 * @param  string $model_name
+	 * @return string
+	 */
+	protected function cptStrategyClass($model_name)
+	{
+		// creates classname like:  CPT_Event_Strategy
+		$CPT_Strategy_class_name = 'EE_CPT_' . $model_name . '_Strategy';
+		// load and instantiate
+		$CPT_Strategy = $this->loader->getShared(
+			$CPT_Strategy_class_name,
+			array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+		);
+		if ($CPT_Strategy === null) {
+			$CPT_Strategy = $this->loader->getShared(
+				'EE_CPT_Default_Strategy',
+				array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+			);
+		}
+		return $CPT_Strategy;
+	}
+
+
+	/**
+	 * postsFields
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsFields($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
+			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+		}
+		remove_filter('posts_fields', array($this, 'postsFields'));
+		return $SQL;
+	}
+
+
+	/**
+	 * postsJoin
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsJoin($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof EE_Secondary_Table) {
+			global $wpdb;
+			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
+			$SQL .= ' LEFT JOIN '
+					. $this->meta_table->get_table_name()
+					. ' ON ( '
+					. $this->meta_table->get_table_name()
+					. '.'
+					. $this->meta_table->get_fk_on_table()
+					. ' = '
+					. $wpdb->posts
+					. '.ID ) ';
+		}
+		remove_filter('posts_join', array($this, 'postsJoin'));
+		return $SQL;
+	}
+
+
+	/**
+	 * thePosts
+	 *
+	 * @access public
+	 * @param  WP_Post[] $posts
+	 * @return WP_Post[]
+	 */
+	public function thePosts($posts)
+	{
+		$CPT_class = $this->cpt_details['class_name'];
+		// loop thru posts
+		if (is_array($posts) && $this->model instanceof EEM_CPT_Base) {
+			foreach ($posts as $key => $post) {
+				if ($post->post_type === $this->post_type) {
+					$post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
+				}
+			}
+		}
+		remove_filter('the_posts', array($this, 'thePosts'), 1);
+		return $posts;
+	}
+
+
+	/**
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function getEditPostLink($url, $ID)
+	{
+		// need to make sure we only edit links if our cpt
+		global $post;
+		// notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
+		// for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
+		if (! $post instanceof WP_Post
+			|| $post->post_type !== $this->post_type
+			|| (
+				isset($this->cpt_details['args']['show_ee_ui'])
+				&& ! $this->cpt_details['args']['show_ee_ui']
+			)
+		) {
+			return $url;
+		}
+		// k made it here so all is good.
+		return wp_nonce_url(
+			add_query_arg(
+				array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
+				admin_url('admin.php')
+			),
+			'edit',
+			'edit_nonce'
+		);
+	}
+
+
+	/**
+	 * Execute any template filters.
+	 * This method is only called if in main query.
+	 *
+	 * @return void
+	 */
+	public function addTemplateFilters()
+	{
+		// if requested cpt supports page_templates and it's the main query
+		if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+			// then let's hook into the appropriate query_template hook
+			add_filter('single_template', array($this, 'singleCptTemplate'));
+		}
+	}
+
+
+	/**
+	 * Callback for single_template wp filter.
+	 * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
+	 * hierarchy.
+	 *
+	 * @access public
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function singleCptTemplate($current_template)
+	{
+		$object = get_queried_object();
+		// does this called object HAVE a page template set that is something other than the default.
+		$template = get_post_meta($object->ID, '_wp_page_template', true);
+		// exit early if default or not set or invalid path (accounts for theme changes)
+		if ($template === 'default'
+			|| empty($template)
+			|| ! is_readable(get_stylesheet_directory() . '/' . $template)
+		) {
+			return $current_template;
+		}
+		// made it here so we SHOULD be able to just locate the template and then return it.
+		return locate_template(array($template));
+	}
 }

core/admin/EE_Admin.core.php

Indentation +957 added lines, -957 removed lines

@@ -20,486 +20,486 @@ 
 final class EE_Admin implements InterminableInterface
 {
 
-    /**
-     * @var EE_Admin $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
-     */
-    private $persistent_admin_notice_manager;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * class constructor
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct()
-    {
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // admin hooks
-        add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
-        add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
-        add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
-        add_action('wp_loaded', array($this, 'wp_loaded'), 100);
-        add_action('admin_init', array($this, 'admin_init'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
-        add_action('admin_notices', array($this, 'display_admin_notices'), 10);
-        add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
-        add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
-        add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
-        add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param    array  $links
-     * @param    string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link = '<a href="admin.php?page=espresso_events">'
-                               . esc_html__('Events', 'event_espresso')
-                               . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * _get_request
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_request()
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
-    {
-        return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
-        );
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                EE_Registry::instance()->load_core('Admin_Page_Loader');
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
-        add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     * @since 4.9.63.p
-     * @return void
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => EE_Registry::instance()->REQ->get('page', ''),
-                    'action' => EE_Registry::instance()->REQ->get('action', ''),
-                ),
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ),
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = array(
-            'post__not_in' => $critical_pages,
-        );
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
-     * metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            array(
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            )
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     * @return void
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            array($this, 'ee_cpt_archive_pages'),
-            'nav-menus',
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @since   4.3.0
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = array(
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            );
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $db_fields = false;
-        $walker = new Walker_Nav_Menu_Checklist($db_fields);
-        $current_tab = 'event-archives';
-        $removed_args = array(
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        );
-        ?>
+	/**
+	 * @var EE_Admin $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
+	 */
+	private $persistent_admin_notice_manager;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Admin) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * class constructor
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct()
+	{
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// admin hooks
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
+		add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param    array  $links
+	 * @param    string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link = '<a href="admin.php?page=espresso_events">'
+							   . esc_html__('Events', 'event_espresso')
+							   . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * _get_request
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_request()
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
+	{
+		return array(
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
+			'about'       => EE_ADMIN_PAGES . 'about' . DS,
+			'support'     => EE_ADMIN_PAGES . 'support' . DS,
+		);
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if we are doing an ee admin ajax request
+		if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 * @since 4.9.63.p
+	 * @return void
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => EE_Registry::instance()->REQ->get('page', ''),
+					'action' => EE_Registry::instance()->REQ->get('action', ''),
+				),
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						),
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = array(
+			'post__not_in' => $critical_pages,
+		);
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
+	 * metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			array(
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			)
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 * @return void
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			array($this, 'ee_cpt_archive_pages'),
+			'nav-menus',
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @since   4.3.0
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = array(
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			);
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$db_fields = false;
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
+		$current_tab = 'event-archives';
+		$removed_args = array(
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		);
+		?>
         <div id="posttype-extra-nav-menu-pages" class="posttypediv">
             <ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
                 <li <?php echo('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
                     <a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives"
                        href="<?php
-                        if ($nav_menu_selected_id) {
-                            echo esc_url(
-                                add_query_arg(
-                                    'extra-nav-menu-pages-tab',
-                                    'event-archives',
-                                    remove_query_arg($removed_args)
-                                )
-                            );
-                        }
-                        ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+						if ($nav_menu_selected_id) {
+							echo esc_url(
+								add_query_arg(
+									'extra-nav-menu-pages-tab',
+									'event-archives',
+									remove_query_arg($removed_args)
+								)
+							);
+						}
+						?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
                         <?php _e('Event Archive Pages', 'event_espresso'); ?>
                     </a>
                 </li>
             </ul><!-- .posttype-tabs -->
 
             <div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-            echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
-            ?>">
+			echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
+			?>">
                 <ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
                     <?php
-                    $pages = $this->_get_extra_nav_menu_pages_items();
-                    $args['walker'] = $walker;
-                    echo walk_nav_menu_tree(
-                        array_map(
-                            array($this, '_setup_extra_nav_menu_pages_items'),
-                            $pages
-                        ),
-                        0,
-                        (object) $args
-                    );
-                    ?>
+					$pages = $this->_get_extra_nav_menu_pages_items();
+					$args['walker'] = $walker;
+					echo walk_nav_menu_tree(
+						array_map(
+							array($this, '_setup_extra_nav_menu_pages_items'),
+							$pages
+						),
+						0,
+						(object) $args
+					);
+					?>
                 </ul>
             </div><!-- /.tabs-panel -->
 
             <p class="button-controls">
                 <span class="list-controls">
                     <a href="<?php
-                             echo esc_url(
-                                 add_query_arg(
-                                     array(
-                                         'extra-nav-menu-pages-tab' => 'event-archives',
-                                         'selectall'                => 1,
-                                     ),
-                                     remove_query_arg($removed_args)
-                                 )
-                             );
-                        ?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
+							 echo esc_url(
+								 add_query_arg(
+									 array(
+										 'extra-nav-menu-pages-tab' => 'event-archives',
+										 'selectall'                => 1,
+									 ),
+									 remove_query_arg($removed_args)
+								 )
+							 );
+						?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
                 </span>
                 <span class="add-to-menu">
                     <input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?>
@@ -512,500 +512,500 @@ 
 
         </div><!-- /.posttypediv -->
         <?php
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     * @return array
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = array(
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        );
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     * @param $menu_item_values
-     * @return stdClass
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys = array(
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => array(),
-            'xfn'              => '',
-        );
-
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $custom_post_types->getCustomPostTypeModels($_POST['post_type']);
-        }
-
-
-        /**
-         * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-         * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-         * Pages" tab in the EE General Settings Admin page.
-         * This is for user-proofing.
-         */
-        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->adminInitModelsReady();
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * enqueue all admin scripts that need loaded for admin pages
-     *
-     * @return void
-     */
-    public function enqueue_admin_scripts()
-    {
-        // this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
-        // Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
-        // calls.
-        wp_enqueue_script(
-            'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // register cookie script for future dependencies
-        wp_register_script(
-            'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
-            array('jquery'),
-            '2.1',
-            true
-        );
-        // joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
-        // via: add_filter('FHEE_load_joyride', '__return_true' );
-        if (apply_filters('FHEE_load_joyride', false)) {
-            // joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-            wp_register_style(
-                'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
-                array('joyride-css'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_register_script(
-                'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
-                array(),
-                '2.1',
-                true
-            );
-            // joyride JS
-            wp_register_script(
-                'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
-                array('jquery-cookie', 'joyride-modernizr'),
-                '2.1',
-                true
-            );
-            // wanna go for a joyride?
-            wp_enqueue_style('ee-joyride-css');
-            wp_enqueue_script('jquery-joyride');
-        }
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices();
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements = is_array($elements) ? $elements : array($elements);
-        $events = EEM_Event::instance()->count();
-        $items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_events'),
-            admin_url('admin.php')
-        );
-        $items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
-        $items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-                ),
-            )
-        );
-        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_registrations'),
-            admin_url('admin.php')
-        );
-        $items['registrations']['text'] = sprintf(
-            _n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @throws EE_Error
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     * @see        EE_Register_Admin_Page::register()
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  int      $post_ID
-     * @param  \WP_Post $post
-     * @return void
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @return void
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function hookIntoWpPluginsPage()
-    {
-        $this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
-        $this->getLoader()
-                     ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
-                     ->decafUpsells();
-    }
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 * @return array
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = array(
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		);
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 * @param $menu_item_values
+	 * @return stdClass
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys = array(
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => array(),
+			'xfn'              => '',
+		);
+
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$custom_post_types->getCustomPostTypeModels($_POST['post_type']);
+		}
+
+
+		/**
+		 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+		 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+		 * Pages" tab in the EE General Settings Admin page.
+		 * This is for user-proofing.
+		 */
+		add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->adminInitModelsReady();
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * enqueue all admin scripts that need loaded for admin pages
+	 *
+	 * @return void
+	 */
+	public function enqueue_admin_scripts()
+	{
+		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
+		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
+		// calls.
+		wp_enqueue_script(
+			'ee-inject-wp',
+			EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// register cookie script for future dependencies
+		wp_register_script(
+			'jquery-cookie',
+			EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+			array('jquery'),
+			'2.1',
+			true
+		);
+		// joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
+		// via: add_filter('FHEE_load_joyride', '__return_true' );
+		if (apply_filters('FHEE_load_joyride', false)) {
+			// joyride style
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style(
+				'ee-joyride-css',
+				EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+				array('joyride-css'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_register_script(
+				'joyride-modernizr',
+				EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+				array(),
+				'2.1',
+				true
+			);
+			// joyride JS
+			wp_register_script(
+				'jquery-joyride',
+				EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+				array('jquery-cookie', 'joyride-modernizr'),
+				'2.1',
+				true
+			);
+			// wanna go for a joyride?
+			wp_enqueue_style('ee-joyride-css');
+			wp_enqueue_script('jquery-joyride');
+		}
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices();
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements = is_array($elements) ? $elements : array($elements);
+		$events = EEM_Event::instance()->count();
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_events'),
+			admin_url('admin.php')
+		);
+		$items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
+		$items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+				),
+			)
+		);
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_registrations'),
+			admin_url('admin.php')
+		);
+		$items['registrations']['text'] = sprintf(
+			_n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 * @see        EE_Register_Admin_Page::register()
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  int      $post_ID
+	 * @param  \WP_Post $post
+	 * @return void
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @return void
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+		$this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
+		$this->getLoader()
+					 ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
+					 ->decafUpsells();
+	}
 }