eventespresso / event-espresso-core

core/admin/EE_Admin_Page_Sub_Menu.core.php

Indentation +8 added lines, -8 removed lines

@@ -12,12 +12,12 @@
  */
 class EE_Admin_Page_Sub_Menu extends AdminMenuSubItem
 {
-    /**
-     * @return string
-     * @deprecated $VID:$
-     */
-    protected function _add_menu_page()
-    {
-        return $this->registerMenuItem();
-    }
+	/**
+	 * @return string
+	 * @deprecated $VID:$
+	 */
+	protected function _add_menu_page()
+	{
+		return $this->registerMenuItem();
+	}
 }

caffeinated/admin/new/pricing/Pricing_Admin_Page_Init.core.php

Indentation +43 added lines, -43 removed lines

@@ -16,51 +16,51 @@
  */
 class Pricing_Admin_Page_Init extends EE_Admin_Page_Init
 {
-    /**
-     * @Constructor
-     */
-    public function __construct()
-    {
-        if (! defined('PRICING_PG_SLUG')) {
-            define('PRICING_PG_SLUG', 'pricing');
-            define('PRICING_LABEL', esc_html__('Pricing', 'event_espresso'));
-            define('PRICING_PG_NAME', ucwords(str_replace('_', '', PRICING_PG_SLUG)));
-            define('PRICING_ADMIN', EE_CORE_CAF_ADMIN . 'new/' . PRICING_PG_SLUG . '/');
-            define('PRICING_ADMIN_URL', admin_url('admin.php?page=' . PRICING_PG_SLUG));
-            define('PRICING_ASSETS_PATH', PRICING_ADMIN . 'assets/');
-            define('PRICING_ASSETS_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . PRICING_PG_SLUG . '/assets/');
-            define('PRICING_TEMPLATE_PATH', PRICING_ADMIN . 'templates/');
-            define('PRICING_TEMPLATE_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . PRICING_PG_SLUG . '/templates/');
-        }
-        parent::__construct();
-        $this->_folder_path = EE_CORE_CAF_ADMIN . 'new/' . $this->_folder_name . '/';
-    }
+	/**
+	 * @Constructor
+	 */
+	public function __construct()
+	{
+		if (! defined('PRICING_PG_SLUG')) {
+			define('PRICING_PG_SLUG', 'pricing');
+			define('PRICING_LABEL', esc_html__('Pricing', 'event_espresso'));
+			define('PRICING_PG_NAME', ucwords(str_replace('_', '', PRICING_PG_SLUG)));
+			define('PRICING_ADMIN', EE_CORE_CAF_ADMIN . 'new/' . PRICING_PG_SLUG . '/');
+			define('PRICING_ADMIN_URL', admin_url('admin.php?page=' . PRICING_PG_SLUG));
+			define('PRICING_ASSETS_PATH', PRICING_ADMIN . 'assets/');
+			define('PRICING_ASSETS_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . PRICING_PG_SLUG . '/assets/');
+			define('PRICING_TEMPLATE_PATH', PRICING_ADMIN . 'templates/');
+			define('PRICING_TEMPLATE_URL', EE_CORE_CAF_ADMIN_URL . 'new/' . PRICING_PG_SLUG . '/templates/');
+		}
+		parent::__construct();
+		$this->_folder_path = EE_CORE_CAF_ADMIN . 'new/' . $this->_folder_name . '/';
+	}
 
 
-    protected function _set_init_properties()
-    {
-        $this->label = PRICING_LABEL;
-    }
+	protected function _set_init_properties()
+	{
+		$this->label = PRICING_LABEL;
+	}
 
 
-    /**
-     * @return array|void
-     * @throws EE_Error
-     * @since $VID:$
-     */
-    protected function _set_menu_map()
-    {
-        $this->_menu_map = new AdminMenuSubItem(
-            array(
-                'menu_group'      => 'management',
-                'menu_order'      => 20,
-                'show_on_menu'    => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                'parent_slug'     => 'espresso_events',
-                'menu_slug'       => PRICING_PG_SLUG,
-                'menu_label'      => PRICING_LABEL,
-                'capability'      => 'ee_read_default_prices',
-                'admin_init_page' => $this,
-            )
-        );
-    }
+	/**
+	 * @return array|void
+	 * @throws EE_Error
+	 * @since $VID:$
+	 */
+	protected function _set_menu_map()
+	{
+		$this->_menu_map = new AdminMenuSubItem(
+			array(
+				'menu_group'      => 'management',
+				'menu_order'      => 20,
+				'show_on_menu'    => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				'parent_slug'     => 'espresso_events',
+				'menu_slug'       => PRICING_PG_SLUG,
+				'menu_label'      => PRICING_LABEL,
+				'capability'      => 'ee_read_default_prices',
+				'admin_init_page' => $this,
+			)
+		);
+	}
 }

core/services/assets/AssetManager.php

Indentation +323 added lines, -323 removed lines

@@ -23,332 +23,332 @@
 abstract class AssetManager implements AssetManagerInterface
 {
 
-    /**
-     * @var AssetCollection|Asset[] $assets
-     */
-    protected $assets;
-
-    /**
-     * @var DomainInterface
-     */
-    protected $domain;
-
-    /**
-     * @var Registry $registry
-     */
-    protected $registry;
-
-
-    /**
-     * AssetRegister constructor.
-     *
-     * @param DomainInterface $domain
-     * @param AssetCollection $assets
-     * @param Registry        $registry
-     */
-    public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
-    {
-        $this->domain = $domain;
-        $this->assets = $assets;
-        $this->registry = $registry;
-        $this->registry->addAssetCollection($assets);
-        add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
-        add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
-    }
-
-
-    /**
-     * @return AssetCollection
-     */
-    public function getAssets()
-    {
-        return $this->assets;
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->domain->assetNamespace();
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $asset = new JavascriptAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $load_in_footer,
-            $this->domain,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a javascript asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addJs($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_JS,
-            $handle,
-            $extra_dependencies
-        );
-        $source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
-        return $this->addJavascript(
-            $handle,
-            $source,
-            $details['dependencies'],
-            true,
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.71.p
-     */
-    public function addVendorJavascript(
-        $handle,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $dev_suffix = wp_scripts_get_suffix('dev');
-        $vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
-        return $this->addJavascript(
-            $handle,
-            "{$vendor_path}{$handle}{$dev_suffix}". Asset::EXT_JS,
-            $dependencies,
-            $load_in_footer,
-            $version
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @param string $version
-     * @return StylesheetAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all',
-        $version = ''
-    ) {
-        $asset = new StylesheetAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $this->domain,
-            $media,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a css asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addCss($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_CSS,
-            $handle,
-            $extra_dependencies
-        );
-        return $this->addStylesheet(
-            $handle,
-            $this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
-            $details['dependencies'],
-            'all',
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle)
-    {
-        if ($this->assets->has($handle)) {
-            /** @var Asset $asset */
-            $asset = $this->assets->get($handle);
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @return  void
-     * @since   $VID:$
-     */
-    public function enqueueBrowserAssets()
-    {
-        foreach ($this->assets as $asset) {
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-            }
-        }
-    }
-
-
-    /**
-     * @param string $asset_type
-     * @param string $handle
-     * @param array  $extra_dependencies
-     * @return array
-     * @since 4.10.2.p
-     */
-    private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
-    {
-        $getAssetDetails = '';
-        switch ($asset_type) {
-            case Asset::TYPE_JS :
-                $getAssetDetails = 'getJsAssetDetails';
-                break;
-            case Asset::TYPE_CSS :
-                $getAssetDetails = 'getCssAssetDetails';
-                break;
-        }
-        if ($getAssetDetails === '') {
-            return ['dependencies' => [], 'version' => ''];
-        }
-        $details = $this->registry->$getAssetDetails(
-            $this->domain->assetNamespace(),
-            $handle
-        );
-        $details['dependencies'] = isset($details['dependencies'])
-            ? $details['dependencies']
-            : [];
-        $details['version'] = isset($details['version'])
-            ? $details['version']
-            : '';
-        $details['dependencies'] = ! empty($extra_dependencies)
-            ? array_merge($details['dependencies'], (array) $extra_dependencies)
-            : $details['dependencies'];
-        return $details;
-
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @throws DomainException
-     */
-    public function verifyAssetIsRegistered($handle)
-    {
-        if (wp_script_is($handle, 'registered')) {
-            return true;
-        }
-        if (WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" script is not registered when it should be!%2$s
+	/**
+	 * @var AssetCollection|Asset[] $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var DomainInterface
+	 */
+	protected $domain;
+
+	/**
+	 * @var Registry $registry
+	 */
+	protected $registry;
+
+
+	/**
+	 * AssetRegister constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param AssetCollection $assets
+	 * @param Registry        $registry
+	 */
+	public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
+	{
+		$this->domain = $domain;
+		$this->assets = $assets;
+		$this->registry = $registry;
+		$this->registry->addAssetCollection($assets);
+		add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
+		add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
+	}
+
+
+	/**
+	 * @return AssetCollection
+	 */
+	public function getAssets()
+	{
+		return $this->assets;
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->domain->assetNamespace();
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$asset = new JavascriptAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$load_in_footer,
+			$this->domain,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a javascript asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addJs($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_JS,
+			$handle,
+			$extra_dependencies
+		);
+		$source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
+		return $this->addJavascript(
+			$handle,
+			$source,
+			$details['dependencies'],
+			true,
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.71.p
+	 */
+	public function addVendorJavascript(
+		$handle,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$dev_suffix = wp_scripts_get_suffix('dev');
+		$vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
+		return $this->addJavascript(
+			$handle,
+			"{$vendor_path}{$handle}{$dev_suffix}". Asset::EXT_JS,
+			$dependencies,
+			$load_in_footer,
+			$version
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @param string $version
+	 * @return StylesheetAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all',
+		$version = ''
+	) {
+		$asset = new StylesheetAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$this->domain,
+			$media,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a css asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addCss($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_CSS,
+			$handle,
+			$extra_dependencies
+		);
+		return $this->addStylesheet(
+			$handle,
+			$this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
+			$details['dependencies'],
+			'all',
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle)
+	{
+		if ($this->assets->has($handle)) {
+			/** @var Asset $asset */
+			$asset = $this->assets->get($handle);
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return  void
+	 * @since   $VID:$
+	 */
+	public function enqueueBrowserAssets()
+	{
+		foreach ($this->assets as $asset) {
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $asset_type
+	 * @param string $handle
+	 * @param array  $extra_dependencies
+	 * @return array
+	 * @since 4.10.2.p
+	 */
+	private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
+	{
+		$getAssetDetails = '';
+		switch ($asset_type) {
+			case Asset::TYPE_JS :
+				$getAssetDetails = 'getJsAssetDetails';
+				break;
+			case Asset::TYPE_CSS :
+				$getAssetDetails = 'getCssAssetDetails';
+				break;
+		}
+		if ($getAssetDetails === '') {
+			return ['dependencies' => [], 'version' => ''];
+		}
+		$details = $this->registry->$getAssetDetails(
+			$this->domain->assetNamespace(),
+			$handle
+		);
+		$details['dependencies'] = isset($details['dependencies'])
+			? $details['dependencies']
+			: [];
+		$details['version'] = isset($details['version'])
+			? $details['version']
+			: '';
+		$details['dependencies'] = ! empty($extra_dependencies)
+			? array_merge($details['dependencies'], (array) $extra_dependencies)
+			: $details['dependencies'];
+		return $details;
+
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function verifyAssetIsRegistered($handle)
+	{
+		if (wp_script_is($handle, 'registered')) {
+			return true;
+		}
+		if (WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" script is not registered when it should be!%2$s
                         Are you running the Barista plugin for development purposes? 
                         If so, then you need to build the appropriate assets for this domain.%2$s
                         If you are seeing this error on a live website, then you should not have 
                         the WP_DEBUG constant in your wp-config.php file set to "true". 
                         Please contact Event Espresso support for more information.',
-                        'event_espresso'
-                    ),
-                    $handle,
-                    '<br />'
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**************** deprecated ****************/
-
-
-    /**
-     * @return void
-     * @deprecated $VID:$
-     */
-    public function addManifestFile()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated $VID:$
-     */
-    public function getManifestFile()
-    {
-    }
+						'event_espresso'
+					),
+					$handle,
+					'<br />'
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**************** deprecated ****************/
+
+
+	/**
+	 * @return void
+	 * @deprecated $VID:$
+	 */
+	public function addManifestFile()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated $VID:$
+	 */
+	public function getManifestFile()
+	{
+	}
 }

core/services/assets/Registry.php

Indentation +570 added lines, -570 removed lines

@@ -25,581 +25,581 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection[] $assets
-     */
-    protected $assets = [];
-
-    /**
-     * @var AssetManifestInterface
-     */
-    private $asset_manifest;
-
-    /**
-     * This holds the js_data data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $js_data = [];
-
-    /**
-     * 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 = [];
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection        $assets
-     * @param AssetManifestInterface $asset_manifest
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(AssetCollection $assets, AssetManifestInterface $asset_manifest)
-    {
-        $this->addAssetCollection($assets);
-        $this->asset_manifest = $asset_manifest;
-        $this->asset_manifest->initialize();
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 5);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 5);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * @param AssetCollection $asset_collection
-     */
-    public function addAssetCollection(AssetCollection $asset_collection)
-    {
-        $id = $asset_collection->collectionIdentifier();
-        if (! array_key_exists($id, $this->assets)) {
-            $this->assets[ $id ] = $asset_collection;
-        }
-    }
-
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @throws Exception
-     * @since 4.9.62.p
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            foreach ($this->assets as $asset_collection) {
-                $this->registerScripts($asset_collection->getJavascriptAssets());
-                $this->registerStyles($asset_collection->getStylesheetAssets());
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    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->enqueueImmediately()) {
-                wp_enqueue_script($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    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();
-            if ($style->enqueueImmediately()) {
-                wp_enqueue_style($style->handle());
-            }
-            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.
-     *
-     * @throws Exception
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        try {
-            $this->removeAlreadyRegisteredDataForScriptHandles();
-            wp_add_inline_script(
-                CoreAssetManager::JS_HANDLE_JS_CORE,
-                'var eejsdata=' . wp_json_encode(['data' => $this->js_data]),
-                'before'
-            );
-            foreach ($this->assets as $asset_collection) {
-                $scripts = $asset_collection->getJavascriptAssetsWithData();
-                foreach ($scripts as $script) {
-                    $this->addRegisteredScriptHandlesWithData($script->handle());
-                    if ($script->hasInlineDataCallback()) {
-                        $localize = $script->inlineDataCallback();
-                        $localize();
-                    }
-                }
-            }
-        } catch (Exception $exception) {
-            EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * 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(string $key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->js_data[ $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 merged with the 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 (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData(string $key, $value)
-    {
-        if (
-            isset($this->js_data[ $key ])
-            && ! is_array($this->js_data[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        '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 AssetManifestInterface
+	 */
+	private $asset_manifest;
+
+	/**
+	 * This holds the js_data data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $js_data = [];
+
+	/**
+	 * 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 = [];
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection        $assets
+	 * @param AssetManifestInterface $asset_manifest
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(AssetCollection $assets, AssetManifestInterface $asset_manifest)
+	{
+		$this->addAssetCollection($assets);
+		$this->asset_manifest = $asset_manifest;
+		$this->asset_manifest->initialize();
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 5);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 5);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * @param AssetCollection $asset_collection
+	 */
+	public function addAssetCollection(AssetCollection $asset_collection)
+	{
+		$id = $asset_collection->collectionIdentifier();
+		if (! array_key_exists($id, $this->assets)) {
+			$this->assets[ $id ] = $asset_collection;
+		}
+	}
+
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @throws Exception
+	 * @since 4.9.62.p
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			foreach ($this->assets as $asset_collection) {
+				$this->registerScripts($asset_collection->getJavascriptAssets());
+				$this->registerStyles($asset_collection->getStylesheetAssets());
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	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->enqueueImmediately()) {
+				wp_enqueue_script($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	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();
+			if ($style->enqueueImmediately()) {
+				wp_enqueue_style($style->handle());
+			}
+			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.
+	 *
+	 * @throws Exception
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		try {
+			$this->removeAlreadyRegisteredDataForScriptHandles();
+			wp_add_inline_script(
+				CoreAssetManager::JS_HANDLE_JS_CORE,
+				'var eejsdata=' . wp_json_encode(['data' => $this->js_data]),
+				'before'
+			);
+			foreach ($this->assets as $asset_collection) {
+				$scripts = $asset_collection->getJavascriptAssetsWithData();
+				foreach ($scripts as $script) {
+					$this->addRegisteredScriptHandlesWithData($script->handle());
+					if ($script->hasInlineDataCallback()) {
+						$localize = $script->inlineDataCallback();
+						$localize();
+					}
+				}
+			}
+		} catch (Exception $exception) {
+			EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * 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(string $key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->js_data[ $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 merged with the 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 (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData(string $key, $value)
+	{
+		if (
+			isset($this->js_data[ $key ])
+			&& ! is_array($this->js_data[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'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__
-                )
-            );
-        }
-        if (! isset($this->js_data[ $key ])) {
-            $this->js_data[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->js_data[ $key ] = array_merge($this->js_data[ $key ], (array) $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(string $template_reference, string $template_content)
-    {
-        if (! isset($this->js_data['templates'])) {
-            $this->js_data['templates'] = [];
-        }
-        //no overrides allowed.
-        if (isset($this->js_data['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->js_data['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate(string $template_reference): string
-    {
-        return $this->js_data['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(string $key)
-    {
-        return array_key_exists($key, $this->js_data) ? $this->js_data[ $key ] : null;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the js_data 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(string $key): bool
-    {
-        if (isset($this->js_data[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->js_data[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if (! isset($this->js_data[ $key ])) {
+			$this->js_data[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->js_data[ $key ] = array_merge($this->js_data[ $key ], (array) $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(string $template_reference, string $template_content)
+	{
+		if (! isset($this->js_data['templates'])) {
+			$this->js_data['templates'] = [];
+		}
+		//no overrides allowed.
+		if (isset($this->js_data['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->js_data['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate(string $template_reference): string
+	{
+		return $this->js_data['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(string $key)
+	{
+		return array_key_exists($key, $this->js_data) ? $this->js_data[ $key ] : null;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the js_data 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(string $key): bool
+	{
+		if (isset($this->js_data[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->js_data[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'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(
-                    esc_html__(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'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(string $namespace, string $chunk_name, string $asset_type): string
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $this->asset_manifest->getAssetUrl($chunk_name, $asset_type),
-            $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(string $namespace, string $chunk_name): string
-    {
-        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(string $namespace, string $chunk_name): string
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData(string $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(string $namespace, string $chunk_name, string $asset_type): string
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$this->asset_manifest->getAssetUrl($chunk_name, $asset_type),
+			$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(string $namespace, string $chunk_name): string
+	{
+		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(string $namespace, string $chunk_name): string
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData(string $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(string $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 ]);
-            }
-        }
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     * @since 4.9.63.p
-     */
-    private function debug(): bool
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
-
-
-    /**************** deprecated ****************/
-
-
-
-    /**
-     * @return null
-     * @deprecated $VID:$
-     */
-    public function getI18nRegistry()
-    {
-        return null;
-    }
-
-
-    /**
-     * @param string $handle
-     * @deprecated $VID:$
-     */
-    public function registerTranslation($handle)
-    {
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated $VID:$
-     */
-    public function getCssAssetDetails($namespace, $chunk_name)
-    {
-        return [
-            AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_CSS),
-            AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_CSS),
-        ];
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated $VID:$
-     */
-    public function getCssDependencies($namespace, $chunk_name)
-    {
-        return $this->asset_manifest->getAssetDependencies($chunk_name, AssetManifest::ASSET_EXT_CSS);
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated $VID:$
-     */
-    public function getJsAssetDetails($namespace, $chunk_name)
-    {
-        return [
-            AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_JS),
-            AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_JS),
-        ];
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated $VID:$
-     */
-    public function getJsDependencies($namespace, $chunk_name)
-    {
-        return $this->asset_manifest->getAssetDependencies($chunk_name);
-    }
-
-
-    /**
-     * @deprecated $VID:$
-     */
-    public function registerManifestFiles()
-    {
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $url_base
-     * @param string $manifest_file
-     * @param string $manifest_file_path
-     * @deprecated $VID:$
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
-    {
-    }
+	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(string $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 ]);
+			}
+		}
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	private function debug(): bool
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
+
+
+	/**************** deprecated ****************/
+
+
+
+	/**
+	 * @return null
+	 * @deprecated $VID:$
+	 */
+	public function getI18nRegistry()
+	{
+		return null;
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @deprecated $VID:$
+	 */
+	public function registerTranslation($handle)
+	{
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated $VID:$
+	 */
+	public function getCssAssetDetails($namespace, $chunk_name)
+	{
+		return [
+			AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_CSS),
+			AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_CSS),
+		];
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated $VID:$
+	 */
+	public function getCssDependencies($namespace, $chunk_name)
+	{
+		return $this->asset_manifest->getAssetDependencies($chunk_name, AssetManifest::ASSET_EXT_CSS);
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated $VID:$
+	 */
+	public function getJsAssetDetails($namespace, $chunk_name)
+	{
+		return [
+			AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_JS),
+			AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_JS),
+		];
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated $VID:$
+	 */
+	public function getJsDependencies($namespace, $chunk_name)
+	{
+		return $this->asset_manifest->getAssetDependencies($chunk_name);
+	}
+
+
+	/**
+	 * @deprecated $VID:$
+	 */
+	public function registerManifestFiles()
+	{
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $url_base
+	 * @param string $manifest_file
+	 * @param string $manifest_file_path
+	 * @deprecated $VID:$
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
+	{
+	}
 }

core/admin/EE_Admin_Page_Init.core.php

Indentation +490 added lines, -490 removed lines

@@ -18,497 +18,497 @@
  */
 abstract class EE_Admin_Page_Init extends EE_Base
 {
-    // identity properties (set in _set_defaults and _set_init_properties)
-    public $label;
+	// identity properties (set in _set_defaults and _set_init_properties)
+	public $label;
 
-    /**
-     * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
-     * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
-     *
-     * @var string
-     */
-    public $capability;
+	/**
+	 * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
+	 * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
+	 *
+	 * @var string
+	 */
+	public $capability;
 
 
-    /**
-     * This holds the menu map object for this admin page.
-     *
-     * @var AdminMenuItem
-     */
-    protected $_menu_map = null;
-
-    /**
-     * deprecated
-     */
-    public $menu_label;
-
-    public $menu_slug;
-
-
-    // set in _set_defaults
-    protected $_folder_name;
-
-    protected $_folder_path;
-
-    protected $_file_name;
-
-    public $hook_file;
-
-    protected $_wp_page_slug;
-
-    protected $_routing;
-
-
-    /**
-     * This holds the page object.
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_loaded_page_object;
-
-
-    // for caf
-    protected $_files_hooked;
-
-    protected $_hook_paths;
-
-    // load_page?
-    private $_load_page;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(RequestInterface $request = null)
-    {
-        $this->loader  = LoaderFactory::getLoader();
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $this->loader->getShared(RequestInterface::class);
-        // set global defaults
-        $this->_set_defaults();
-        // set properties that are always available with objects.
-        $this->_set_init_properties();
-        // global styles/scripts across all wp admin pages
-        add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
-        // load initial stuff.
-        $this->_set_file_and_folder_name();
-    }
-
-
-    /**
-     * _set_init_properties
-     * Child classes use to set the following properties:
-     * $label
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_init_properties();
-
-
-    /**
-     * @return AdminMenuItem|null
-     * @since       4.4.0
-     * @deprecated  $VID:$
-     */
-    public function get_menu_map()
-    {
-        return $this->adminMenu();
-    }
-
-
-    /**
-     * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
-     * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or AdminMenuSubItem.
-     *
-     * @since       4.4.0
-     * @deprecated  $VID:$
-     */
-    protected function _set_menu_map()
-    {
-        $this->_menu_map = null;
-    }
-
-
-    /**
-     * @since   $VID:$
-     */
-    public function setupLegacyAdminMenuItem()
-    {
-        // will be overridden by child classes not using new system
-        $this->_set_menu_map();
-    }
-
-
-    /**
-     * Child classes should return an array of properties used to construct the AdminMenuItem
-     *
-     * @return array
-     * @since $VID:$
-     */
-    public function getMenuProperties(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * @param AdminMenuItem $menu
-     * @return void
-     * @since $VID:$
-     */
-    public function setAdminMenu(AdminMenuItem $menu): void
-    {
-        $this->_menu_map = $menu;
-    }
-
-
-    /**
-     * returns the menu map for this admin page
-     *
-     * @return AdminMenuItem|null
-     * @since $VID:$
-     */
-    public function adminMenu(): ?AdminMenuItem
-    {
-        return $this->_menu_map;
-    }
-
-
-    /**
-     * @param string $wp_page_slug
-     * @since $VID:$
-     */
-    public function setWpPageSlug(string $wp_page_slug): void
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-    }
-
-
-    /**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
-     * @return void
-     */
-    public function load_wp_global_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_menu');
-    }
-
-
-    /**
-     * this sets default properties (might be overridden in _set_init_properties);
-     *
-     * @return  void
-     */
-    private function _set_defaults()
-    {
-        $this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
-        $this->_routing      = true;
-        $this->_load_page    = false;
-        $this->_files_hooked = $this->_hook_paths = [];
-    }
-
-
-    public function setCapability($capability, $menu_slug)
-    {
-        $this->capability = apply_filters('FHEE_' . $menu_slug . '_capability', $capability);
-    }
-
-
-    /**
-     * @deprecated $VID:$
-     */
-    protected function _set_capability()
-    {
-        if ($this->_menu_map instanceof AdminMenuItem) {
-            $this->setCapability($this->_menu_map->capability(), $this->_menu_map->menuSlug());
-        }
-    }
-
-
-    /**
-     * initialize_admin_page
-     * This method is what executes the loading of the specific page class for the given dir_name as called by the
-     * EE_Admin_Init class.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_admin_page()
-    {
-        // let's check user access first
-        $this->_check_user_access();
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
-            return;
-        }
-        $this->_loaded_page_object->route_admin_request();
-    }
-
-
-    /**
-     * @param string $wp_page_slug
-     * @throws EE_Error
-     */
-    public function set_page_dependencies(string $wp_page_slug)
-    {
-        if (! $this->_load_page) {
-            return;
-        }
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
-            $msg[] = esc_html__(
-                'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
-                'event_espresso'
-            );
-            $msg[] = $msg[0] . "\r\n"
-                     . sprintf(
-                         esc_html__(
-                             'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
-                             'event_espresso'
-                         ),
-                         $this->_file_name,
-                         $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
-                         $this->_menu_map->menuSlug()
-                     );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = "load-$wp_page_slug";
-        // hook into page load hook so all page specific stuff gets loaded.
-        if (! empty($wp_page_slug)) {
-            add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
-        }
-    }
-
-
-    /**
-     * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
-     * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function do_initial_loads()
-    {
-        // no loading or initializing if menu map is setup incorrectly.
-        if (! $this->_menu_map instanceof AdminMenuItem) {
-            return;
-        }
-        $this->_initialize_admin_page();
-    }
-
-
-    /**
-     * all we're doing here is setting the $_file_name property for later use.
-     *
-     * @return void
-     */
-    private function _set_file_and_folder_name()
-    {
-        $bt = debug_backtrace();
-        // for more reliable determination of folder name
-        // we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-        $class = get_class($this);
-        foreach ($bt as $index => $values) {
-            if (isset($values['class']) && $values['class'] == $class) {
-                $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
-                    break;
-                }
-            }
-        }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
-        $this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
-        $this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
-        $this->_file_name   = str_replace(' ', '_', $this->_file_name);
-    }
-
-
-    /**
-     * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
-     * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
-     * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
-     * events_Messages_Hooks.class.php
-     *
-     * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
-     *                     files/classes
-     * @return array
-     */
-    public function register_hooks(bool $extend = false): array
-    {
-        // get a list of files in the directory that have the "Hook" in their name an
-        // if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-        if ($extend) {
-            $hook_files_glob_path = apply_filters(
-                'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
-                EE_CORE_CAF_ADMIN_EXTEND
-                . $this->_folder_name
-                . '/*'
-                . $this->_file_name
-                . '_Hooks_Extend.class.php'
-            );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
-        }
-        // loop through decaf folders
-        $hook_files_glob_path = apply_filters(
-            'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
-        );
-        $this->_hook_paths    = array_merge(
-            $this->_register_hook_files($hook_files_glob_path),
-            $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
-        return $this->_hook_paths;
-    }
-
-
-    protected function _register_hook_files($hook_files_glob_path, $extend = false): array
-    {
-        $hook_paths = glob($hook_files_glob_path);
-        if (empty($hook_paths)) {
-            return [];
-        }
-        foreach ($hook_paths as $file) {
-            // lets get the linked admin.
-            $hook_file = $extend
-                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
-                : str_replace($this->_folder_path, '', $file);
-            $replace   = $extend
-                ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                : '_' . $this->_file_name . '_Hooks.class.php';
-            $rel_admin = str_replace($replace, '', $hook_file);
-            $rel_admin = strtolower($rel_admin);
-            // make sure we haven't already got a hook setup for this page path
-            if (in_array($rel_admin, $this->_files_hooked)) {
-                continue;
-            }
-            require_once $file;
-            $this->hook_file = $hook_file;
-            $rel_admin_hook  = 'FHEE_do_other_page_hooks_' . $rel_admin;
-            add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
-            $this->_files_hooked[] = $rel_admin;
-        }
-        return $hook_paths;
-    }
-
-
-    public function load_admin_hook($registered_pages)
-    {
-        return array_merge((array) $this->hook_file, $registered_pages);
-    }
-
-
-    /**
-     * _initialize_admin_page
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see  initialize_admin_page() for info
-     */
-    protected function _initialize_admin_page()
-    {
-        // JUST CHECK WE'RE ON RIGHT PAGE.
-        $page      = $this->request->getRequestParam('page');
-        $page      = $this->request->getRequestParam('current_page', $page);
-        $menu_slug = $this->_menu_map->menuSlug();
-
-
-        if ($this->_routing && ($page === '' || $page !== $menu_slug)) {
-            // not on the right page so let's get out.
-            return;
-        }
-        $this->_load_page = true;
-
-        // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
-        $hook_suffix = "{$menu_slug}_$admin_page";
-        $admin_page  = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__$hook_suffix",
-            $admin_page
-        );
-        if (empty($admin_page)) {
-            return;
-        }
-        // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
-        // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
-        // FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
-        $path_to_file = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__$hook_suffix",
-            $path_to_file
-        );
-        if (! is_readable($path_to_file)) {
-            return;
-        }
-        // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_$menu_slug");
-        require_once($path_to_file);
-        $this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
-        $this->_loaded_page_object->initializePage();
-
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_$menu_slug");
-    }
-
-
-    public function get_admin_page_name(): string
-    {
-        return $this->_file_name . '_Admin_Page';
-    }
-
-
-    /**
-     * @return EE_Admin_Page|null
-     */
-    public function loaded_page_object(): ?EE_Admin_Page
-    {
-        return $this->_loaded_page_object;
-    }
-
-
-    /**
-     * _check_user_access
-     * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
-     * WordPress die message.
-     *
-     * @return void  wp_die if fail
-     */
-    private function _check_user_access()
-    {
-        if (! $this->_menu_map->currentUserHasAccess()) {
-            wp_die(
-                esc_html__('You don\'t have access to this page.', 'event_espresso'),
-                '',
-                ['back_link' => true]
-            );
-        }
-    }
+	/**
+	 * This holds the menu map object for this admin page.
+	 *
+	 * @var AdminMenuItem
+	 */
+	protected $_menu_map = null;
+
+	/**
+	 * deprecated
+	 */
+	public $menu_label;
+
+	public $menu_slug;
+
+
+	// set in _set_defaults
+	protected $_folder_name;
+
+	protected $_folder_path;
+
+	protected $_file_name;
+
+	public $hook_file;
+
+	protected $_wp_page_slug;
+
+	protected $_routing;
+
+
+	/**
+	 * This holds the page object.
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_loaded_page_object;
+
+
+	// for caf
+	protected $_files_hooked;
+
+	protected $_hook_paths;
+
+	// load_page?
+	private $_load_page;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(RequestInterface $request = null)
+	{
+		$this->loader  = LoaderFactory::getLoader();
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $this->loader->getShared(RequestInterface::class);
+		// set global defaults
+		$this->_set_defaults();
+		// set properties that are always available with objects.
+		$this->_set_init_properties();
+		// global styles/scripts across all wp admin pages
+		add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
+		// load initial stuff.
+		$this->_set_file_and_folder_name();
+	}
+
+
+	/**
+	 * _set_init_properties
+	 * Child classes use to set the following properties:
+	 * $label
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_init_properties();
+
+
+	/**
+	 * @return AdminMenuItem|null
+	 * @since       4.4.0
+	 * @deprecated  $VID:$
+	 */
+	public function get_menu_map()
+	{
+		return $this->adminMenu();
+	}
+
+
+	/**
+	 * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
+	 * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or AdminMenuSubItem.
+	 *
+	 * @since       4.4.0
+	 * @deprecated  $VID:$
+	 */
+	protected function _set_menu_map()
+	{
+		$this->_menu_map = null;
+	}
+
+
+	/**
+	 * @since   $VID:$
+	 */
+	public function setupLegacyAdminMenuItem()
+	{
+		// will be overridden by child classes not using new system
+		$this->_set_menu_map();
+	}
+
+
+	/**
+	 * Child classes should return an array of properties used to construct the AdminMenuItem
+	 *
+	 * @return array
+	 * @since $VID:$
+	 */
+	public function getMenuProperties(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * @param AdminMenuItem $menu
+	 * @return void
+	 * @since $VID:$
+	 */
+	public function setAdminMenu(AdminMenuItem $menu): void
+	{
+		$this->_menu_map = $menu;
+	}
+
+
+	/**
+	 * returns the menu map for this admin page
+	 *
+	 * @return AdminMenuItem|null
+	 * @since $VID:$
+	 */
+	public function adminMenu(): ?AdminMenuItem
+	{
+		return $this->_menu_map;
+	}
+
+
+	/**
+	 * @param string $wp_page_slug
+	 * @since $VID:$
+	 */
+	public function setWpPageSlug(string $wp_page_slug): void
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+	}
+
+
+	/**
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
+	 * @return void
+	 */
+	public function load_wp_global_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_menu');
+	}
+
+
+	/**
+	 * this sets default properties (might be overridden in _set_init_properties);
+	 *
+	 * @return  void
+	 */
+	private function _set_defaults()
+	{
+		$this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
+		$this->_routing      = true;
+		$this->_load_page    = false;
+		$this->_files_hooked = $this->_hook_paths = [];
+	}
+
+
+	public function setCapability($capability, $menu_slug)
+	{
+		$this->capability = apply_filters('FHEE_' . $menu_slug . '_capability', $capability);
+	}
+
+
+	/**
+	 * @deprecated $VID:$
+	 */
+	protected function _set_capability()
+	{
+		if ($this->_menu_map instanceof AdminMenuItem) {
+			$this->setCapability($this->_menu_map->capability(), $this->_menu_map->menuSlug());
+		}
+	}
+
+
+	/**
+	 * initialize_admin_page
+	 * This method is what executes the loading of the specific page class for the given dir_name as called by the
+	 * EE_Admin_Init class.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_admin_page()
+	{
+		// let's check user access first
+		$this->_check_user_access();
+		if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+			return;
+		}
+		$this->_loaded_page_object->route_admin_request();
+	}
+
+
+	/**
+	 * @param string $wp_page_slug
+	 * @throws EE_Error
+	 */
+	public function set_page_dependencies(string $wp_page_slug)
+	{
+		if (! $this->_load_page) {
+			return;
+		}
+		if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+			$msg[] = esc_html__(
+				'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
+				'event_espresso'
+			);
+			$msg[] = $msg[0] . "\r\n"
+					 . sprintf(
+						 esc_html__(
+							 'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
+							 'event_espresso'
+						 ),
+						 $this->_file_name,
+						 $this->_file_name,
+						 $this->_folder_path . $this->_file_name,
+						 $this->_menu_map->menuSlug()
+					 );
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
+		$page_hook = "load-$wp_page_slug";
+		// hook into page load hook so all page specific stuff gets loaded.
+		if (! empty($wp_page_slug)) {
+			add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
+		}
+	}
+
+
+	/**
+	 * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
+	 * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function do_initial_loads()
+	{
+		// no loading or initializing if menu map is setup incorrectly.
+		if (! $this->_menu_map instanceof AdminMenuItem) {
+			return;
+		}
+		$this->_initialize_admin_page();
+	}
+
+
+	/**
+	 * all we're doing here is setting the $_file_name property for later use.
+	 *
+	 * @return void
+	 */
+	private function _set_file_and_folder_name()
+	{
+		$bt = debug_backtrace();
+		// for more reliable determination of folder name
+		// we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
+				$file_index         = $index - 1;
+				$this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
+				if (! empty($this->_folder_name)) {
+					break;
+				}
+			}
+		}
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+		$this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
+		$this->_file_name   = str_replace(' ', '_', $this->_file_name);
+	}
+
+
+	/**
+	 * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
+	 * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
+	 * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
+	 * events_Messages_Hooks.class.php
+	 *
+	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
+	 *                     files/classes
+	 * @return array
+	 */
+	public function register_hooks(bool $extend = false): array
+	{
+		// get a list of files in the directory that have the "Hook" in their name an
+		// if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
+		if ($extend) {
+			$hook_files_glob_path = apply_filters(
+				'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
+				EE_CORE_CAF_ADMIN_EXTEND
+				. $this->_folder_name
+				. '/*'
+				. $this->_file_name
+				. '_Hooks_Extend.class.php'
+			);
+			$this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+		}
+		// loop through decaf folders
+		$hook_files_glob_path = apply_filters(
+			'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
+			$this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+		);
+		$this->_hook_paths    = array_merge(
+			$this->_register_hook_files($hook_files_glob_path),
+			$this->_hook_paths
+		);  // making sure any extended hook paths are later in the array than the core hook paths!
+		return $this->_hook_paths;
+	}
+
+
+	protected function _register_hook_files($hook_files_glob_path, $extend = false): array
+	{
+		$hook_paths = glob($hook_files_glob_path);
+		if (empty($hook_paths)) {
+			return [];
+		}
+		foreach ($hook_paths as $file) {
+			// lets get the linked admin.
+			$hook_file = $extend
+				? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+				: str_replace($this->_folder_path, '', $file);
+			$replace   = $extend
+				? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+				: '_' . $this->_file_name . '_Hooks.class.php';
+			$rel_admin = str_replace($replace, '', $hook_file);
+			$rel_admin = strtolower($rel_admin);
+			// make sure we haven't already got a hook setup for this page path
+			if (in_array($rel_admin, $this->_files_hooked)) {
+				continue;
+			}
+			require_once $file;
+			$this->hook_file = $hook_file;
+			$rel_admin_hook  = 'FHEE_do_other_page_hooks_' . $rel_admin;
+			add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
+			$this->_files_hooked[] = $rel_admin;
+		}
+		return $hook_paths;
+	}
+
+
+	public function load_admin_hook($registered_pages)
+	{
+		return array_merge((array) $this->hook_file, $registered_pages);
+	}
+
+
+	/**
+	 * _initialize_admin_page
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see  initialize_admin_page() for info
+	 */
+	protected function _initialize_admin_page()
+	{
+		// JUST CHECK WE'RE ON RIGHT PAGE.
+		$page      = $this->request->getRequestParam('page');
+		$page      = $this->request->getRequestParam('current_page', $page);
+		$menu_slug = $this->_menu_map->menuSlug();
+
+
+		if ($this->_routing && ($page === '' || $page !== $menu_slug)) {
+			// not on the right page so let's get out.
+			return;
+		}
+		$this->_load_page = true;
+
+		// we don't need to do a page_request check here because it's only called via WP menu system.
+		$admin_page  = $this->_file_name . '_Admin_Page';
+		$hook_suffix = "{$menu_slug}_$admin_page";
+		$admin_page  = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__$hook_suffix",
+			$admin_page
+		);
+		if (empty($admin_page)) {
+			return;
+		}
+		// define requested admin page class name then load the file and instantiate
+		$path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
+		// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
+		// FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__$hook_suffix",
+			$path_to_file
+		);
+		if (! is_readable($path_to_file)) {
+			return;
+		}
+		// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_$menu_slug");
+		require_once($path_to_file);
+		$this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
+		$this->_loaded_page_object->initializePage();
+
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_$menu_slug");
+	}
+
+
+	public function get_admin_page_name(): string
+	{
+		return $this->_file_name . '_Admin_Page';
+	}
+
+
+	/**
+	 * @return EE_Admin_Page|null
+	 */
+	public function loaded_page_object(): ?EE_Admin_Page
+	{
+		return $this->_loaded_page_object;
+	}
+
+
+	/**
+	 * _check_user_access
+	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
+	 * WordPress die message.
+	 *
+	 * @return void  wp_die if fail
+	 */
+	private function _check_user_access()
+	{
+		if (! $this->_menu_map->currentUserHasAccess()) {
+			wp_die(
+				esc_html__('You don\'t have access to this page.', 'event_espresso'),
+				'',
+				['back_link' => true]
+			);
+		}
+	}
 }

core/admin/EE_Admin_Page_Loader.core.php

Indentation +433 added lines, -433 removed lines

@@ -16,437 +16,437 @@
  */
 class EE_Admin_Page_Loader
 {
-    /**
-     * @var AdminMenuManager $menu_manager
-     */
-    protected $menu_manager;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = [];
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = [];
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = [];
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-    /**
-     * @var   int
-     * @since $VID:$
-     */
-    private $maintenance_mode = 0;
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(?LoaderInterface $loader)
-    {
-        $this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
-        $this->menu_manager = $this->loader->getShared(AdminMenuManager::class, [$this->loader]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function init()
-    {
-        $this->menu_manager->initialize();
-        $this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
-        // let's do a scan and see what installed pages we have
-        $this->findAndLoadAdminPages();
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function defineCaffeinatedConstants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function findAndLoadAdminPages()
-    {
-        $admin_pages = $this->findAdminPages();
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
-        // then extensions and hooks, although they don't get added to the admin pages array
-        $this->findAdminPageExtensions();
-        $this->findAdminPageHooks();
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = [];
-        $menu_pages = [];
-        foreach ($admin_pages as $page => $path) {
-            // don't load the page init class IF IT's ALREADY LOADED !!!
-            if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
-            ) {
-                continue;
-            }
-            // build list of installed pages
-            $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
-            $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
-            $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
-            // skip if in full maintenance mode and maintenance_mode_parent is NOT set
-            if ($this->maintenance_mode && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
-                continue;
-            }
-            $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
-            // now that we've got the admin_init objects...
-            // lets see if there are any caffeinated pages extending the originals.
-            // If there are then let's hook into the init admin filter and load our extend instead.
-            // Set flag for register hooks on extended pages b/c extended pages use the default INIT.
-            $extended_hooks = $admin_page_init->register_hooks(
-                $this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
-            );
-            $hooks_ref      += $extended_hooks;
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files
-        // that will extend a class in a different folder.
-        // So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($this->_installed_pages as $page) {
-            $page->do_initial_loads();
-        }
-        $this->menu_manager->setInstalledPages($menu_pages);
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function findAdminPages(): array
-    {
-
-        // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
-        $admin_page_folders = apply_filters(
-            'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
-            $admin_page_folders
-        );
-        if (! empty($admin_page_folders)) {
-            return $admin_page_folders;
-        }
-        $error_msg = esc_html__(
-            'There are no EE_Admin pages detected, it looks like EE did not install properly',
-            'event_espresso'
-        );
-        $error_msg .= '||';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                'event_espresso'
-            ),
-            EE_ADMIN_PAGES
-        );
-        throw new RuntimeException($error_msg);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
-    {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
-            : null;
-    }
-
-
-    /**
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param string $dir_name
-     * @return string
-     */
-    private function getClassnameForAdminPageInit(string $dir_name = ''): string
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param string $page page_reference
-     * @return EE_Admin_Page_Init
-     * @throws EE_Error
-     */
-    private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
-    {
-        $class_name = $this->getClassnameForAdminPageInit($page);
-        if (class_exists($class_name)) {
-            $admin_page_init = $this->loader->getShared($class_name);
-            // verify returned object
-            if ($admin_page_init instanceof EE_Admin_Page_Init) {
-                return $admin_page_init;
-            }
-        }
-        $error_msg = sprintf(
-            esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '||'; // separates public from developer messages
-        $error_msg .= "\r\n";
-        $error_msg .= sprintf(
-            esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '<br />';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                'event_espresso'
-            ),
-            '<strong>' . $class_name . '</strong>'
-        );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     * @throws EE_Error
-     */
-    private function findCaffeinatedAdminPages(array $admin_pages): array
-    {
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin')) {
-            return $admin_pages;
-        }
-        $this->defineCaffeinatedConstants();
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', ['tickets']);
-
-        return apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $admin_pages
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function findAdminPageExtensions()
-    {
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array
-        // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
-        if ($extensions) {
-            foreach ($extensions as $folder => $extension) {
-                // convert lowercase_snake_case to Uppercase_Snake_Case
-                $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
-                $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
-                // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
-            }
-        }
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-    }
-
-
-    private function loadCaffeinatedExtensions(
-        EE_Admin_Page_Init $admin_page_init,
-        string $page,
-        string $menu_slug
-    ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
-            return false;
-        }
-        $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
-                return $caf_path;
-            }
-        );
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
-                return $caf_admin_page;
-            }
-        );
-        return true;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function findAdminPageHooks()
-    {
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
-        if ($admin_page_hooks) {
-            foreach ($admin_page_hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
-                    if (class_exists($classname)) {
-                        $ee_admin_hooks[] = $this->loader->getShared($classname);
-                    }
-                }
-            }
-        }
-        apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link(): bool
-    {
-        return false;
-    }
-
-
-    /**
-     * @param string $path
-     * @param int    $flags
-     * @param array  $exclude
-     * @param bool   $register_autoloaders
-     * @return array
-     * @throws EE_Error
-     * @since $VID:$
-     */
-    private function findAdminPageFolders(
-        string $path,
-        array $exclude = [],
-        int $flags = GLOB_ONLYDIR,
-        bool $register_autoloaders = true
-    ): array {
-        $folders = [];
-        $subfolders = glob($path, $flags);
-        if ($subfolders) {
-            foreach ($subfolders as $admin_screen) {
-                $admin_screen_name = basename($admin_screen);
-                // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
-                    // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
-                    if ($register_autoloaders) {
-                        // set autoloaders for our admin page classes based on included path information
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
-                    }
-                }
-            }
-        }
-        return $folders;
-    }
+	/**
+	 * @var AdminMenuManager $menu_manager
+	 */
+	protected $menu_manager;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = [];
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = [];
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = [];
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+	/**
+	 * @var   int
+	 * @since $VID:$
+	 */
+	private $maintenance_mode = 0;
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(?LoaderInterface $loader)
+	{
+		$this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
+		$this->menu_manager = $this->loader->getShared(AdminMenuManager::class, [$this->loader]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function init()
+	{
+		$this->menu_manager->initialize();
+		$this->maintenance_mode = EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance;
+		// let's do a scan and see what installed pages we have
+		$this->findAndLoadAdminPages();
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function defineCaffeinatedConstants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function findAndLoadAdminPages()
+	{
+		$admin_pages = $this->findAdminPages();
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
+		// then extensions and hooks, although they don't get added to the admin pages array
+		$this->findAdminPageExtensions();
+		$this->findAdminPageHooks();
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = [];
+		$menu_pages = [];
+		foreach ($admin_pages as $page => $path) {
+			// don't load the page init class IF IT's ALREADY LOADED !!!
+			if (
+				isset($this->_installed_pages[ $page ])
+				&& $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+			) {
+				continue;
+			}
+			// build list of installed pages
+			$admin_page_init = $this->loadAdminPageInit($page);
+			$this->_installed_pages[ $page ] = $admin_page_init;
+			$admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
+			$admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
+			// skip if in full maintenance mode and maintenance_mode_parent is NOT set
+			if ($this->maintenance_mode && ! $admin_menu->maintenanceModeParent()) {
+				unset($admin_pages[ $page ]);
+				continue;
+			}
+			$menu_slug = $admin_menu->menuSlug();
+			$this->_menu_slugs[ $menu_slug ] = $page;
+			$menu_pages[ $menu_slug ] = $admin_page_init;
+			// now that we've got the admin_init objects...
+			// lets see if there are any caffeinated pages extending the originals.
+			// If there are then let's hook into the init admin filter and load our extend instead.
+			// Set flag for register hooks on extended pages b/c extended pages use the default INIT.
+			$extended_hooks = $admin_page_init->register_hooks(
+				$this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
+			);
+			$hooks_ref      += $extended_hooks;
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files
+		// that will extend a class in a different folder.
+		// So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($this->_installed_pages as $page) {
+			$page->do_initial_loads();
+		}
+		$this->menu_manager->setInstalledPages($menu_pages);
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function findAdminPages(): array
+	{
+
+		// grab everything in the  admin core directory
+		$admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+		$admin_page_folders = apply_filters(
+			'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
+			$admin_page_folders
+		);
+		if (! empty($admin_page_folders)) {
+			return $admin_page_folders;
+		}
+		$error_msg = esc_html__(
+			'There are no EE_Admin pages detected, it looks like EE did not install properly',
+			'event_espresso'
+		);
+		$error_msg .= '||';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+				'event_espresso'
+			),
+			EE_ADMIN_PAGES
+		);
+		throw new RuntimeException($error_msg);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
+	{
+		return isset($this->_installed_pages[ $page_slug ])
+			   && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
+			? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+			: null;
+	}
+
+
+	/**
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param string $dir_name
+	 * @return string
+	 */
+	private function getClassnameForAdminPageInit(string $dir_name = ''): string
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param string $page page_reference
+	 * @return EE_Admin_Page_Init
+	 * @throws EE_Error
+	 */
+	private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
+	{
+		$class_name = $this->getClassnameForAdminPageInit($page);
+		if (class_exists($class_name)) {
+			$admin_page_init = $this->loader->getShared($class_name);
+			// verify returned object
+			if ($admin_page_init instanceof EE_Admin_Page_Init) {
+				return $admin_page_init;
+			}
+		}
+		$error_msg = sprintf(
+			esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '||'; // separates public from developer messages
+		$error_msg .= "\r\n";
+		$error_msg .= sprintf(
+			esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '<br />';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+				'event_espresso'
+			),
+			'<strong>' . $class_name . '</strong>'
+		);
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function findCaffeinatedAdminPages(array $admin_pages): array
+	{
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin')) {
+			return $admin_pages;
+		}
+		$this->defineCaffeinatedConstants();
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', ['tickets']);
+
+		return apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$admin_pages
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function findAdminPageExtensions()
+	{
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array
+		// (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+		if ($extensions) {
+			foreach ($extensions as $folder => $extension) {
+				// convert lowercase_snake_case to Uppercase_Snake_Case
+				$filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
+				$filename = "Extend_{$filename}_Admin_Page";
+				$filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+				// save filename and filepath for later
+				$this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
+				$this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+			}
+		}
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+	}
+
+
+	private function loadCaffeinatedExtensions(
+		EE_Admin_Page_Init $admin_page_init,
+		string $page,
+		string $menu_slug
+	): bool {
+		if (! isset($this->_caffeinated_extends[ $page ])) {
+			return false;
+		}
+		$admin_page_name = $admin_page_init->get_admin_page_name();
+		$caf_path        = $this->_caffeinated_extends[ $page ]['path'];
+		$caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
+			static function ($path_to_file) use ($caf_path) {
+				return $caf_path;
+			}
+		);
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
+			static function ($admin_page) use ($caf_admin_page) {
+				return $caf_admin_page;
+			}
+		);
+		return true;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function findAdminPageHooks()
+	{
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks   = [];
+		$admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+		if ($admin_page_hooks) {
+			foreach ($admin_page_hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+					if (class_exists($classname)) {
+						$ee_admin_hooks[] = $this->loader->getShared($classname);
+					}
+				}
+			}
+		}
+		apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link(): bool
+	{
+		return false;
+	}
+
+
+	/**
+	 * @param string $path
+	 * @param int    $flags
+	 * @param array  $exclude
+	 * @param bool   $register_autoloaders
+	 * @return array
+	 * @throws EE_Error
+	 * @since $VID:$
+	 */
+	private function findAdminPageFolders(
+		string $path,
+		array $exclude = [],
+		int $flags = GLOB_ONLYDIR,
+		bool $register_autoloaders = true
+	): array {
+		$folders = [];
+		$subfolders = glob($path, $flags);
+		if ($subfolders) {
+			foreach ($subfolders as $admin_screen) {
+				$admin_screen_name = basename($admin_screen);
+				// files and anything in the exclude array need not apply
+				if (! in_array($admin_screen_name, $exclude, true)) {
+					// these folders represent the different EE admin pages
+					$folders[ $admin_screen_name ] = $admin_screen;
+					if ($register_autoloaders) {
+						// set autoloaders for our admin page classes based on included path information
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
+					}
+				}
+			}
+		}
+		return $folders;
+	}
 }

core/domain/services/graphql/types/Event.php

Indentation +217 added lines, -217 removed lines

@@ -24,225 +24,225 @@
  */
 class Event extends TypeBase
 {
-    /**
-     * Event constructor.
-     *
-     * @param EEM_Event $event_model
-     */
-    public function __construct(EEM_Event $event_model)
-    {
-        $this->setName($this->namespace . 'Event');
-        $this->setIsCustomPostType(true);
-        parent::__construct($event_model);
-    }
+	/**
+	 * Event constructor.
+	 *
+	 * @param EEM_Event $event_model
+	 */
+	public function __construct(EEM_Event $event_model)
+	{
+		$this->setName($this->namespace . 'Event');
+		$this->setIsCustomPostType(true);
+		parent::__construct($event_model);
+	}
 
 
-    /**
-     * @return GraphQLFieldInterface[]
-     */
-    public function getFields(): array
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_types__event_fields',
-            [
-                new GraphQLField(
-                    'allowDonations',
-                    'Boolean',
-                    'donations',
-                    esc_html__('Accept Donations?', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'allowOverflow',
-                    'Boolean',
-                    'allow_overflow',
-                    esc_html__('Enable Wait List for Event', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'altRegPage',
-                    'String',
-                    'external_url',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'cacheId',
-                    ['non_null' => 'String'],
-                    null,
-                    esc_html__('The cache ID of the object.', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'created',
-                    'String',
-                    'created',
-                    esc_html__('Date/Time Event Created', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'dbId',
-                    ['non_null' => 'Int'],
-                    'ID',
-                    esc_html__('The event ID.', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'defaultRegStatus',
-                    $this->namespace . 'RegistrationStatusEnum',
-                    'default_registration_status',
-                    esc_html__('Default Event Registration Status', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'description',
-                    'String',
-                    'description',
-                    esc_html__('Event Description', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'displayDescription',
-                    'Boolean',
-                    'display_description',
-                    esc_html__('Display Description Flag', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'displayTicketSelector',
-                    'Boolean',
-                    'display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isActive',
-                    'Boolean',
-                    'is_active',
-                    esc_html__('Flag indicating event is active', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isCancelled',
-                    'Boolean',
-                    'is_cancelled',
-                    esc_html__('Flag indicating whether the event is marked as cancelled', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isExpired',
-                    'Boolean',
-                    'is_expired',
-                    esc_html__('Flag indicating event is expired or not', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isInactive',
-                    'Boolean',
-                    'is_inactive',
-                    esc_html__('Flag indicating event is inactive', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isPostponed',
-                    'Boolean',
-                    'is_postponed',
-                    esc_html__('Flag indicating whether the event is marked as postponed', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'isSoldOut',
-                    'Boolean',
-                    'is_sold_out',
-                    esc_html__(
-                        'Flag indicating whether the tickets sold for the event, met or exceed the registration limit',
-                        'event_espresso'
-                    )
-                ),
-                new GraphQLOutputField(
-                    'isUpcoming',
-                    'Boolean',
-                    'is_upcoming',
-                    esc_html__('Whether the event is upcoming', 'event_espresso')
-                ),
-                new GraphQLInputField(
-                    'manager',
-                    'String',
-                    null,
-                    esc_html__('Globally unique event ID for the event manager', 'event_espresso')
-                ),
-                new GraphQLOutputField(
-                    'manager',
-                    'User',
-                    null,
-                    esc_html__('Event Manager', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'maxRegistrations',
-                    'Int',
-                    'additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'memberOnly',
-                    'Boolean',
-                    'member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'name',
-                    'String',
-                    'name',
-                    esc_html__('Event Name', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'order',
-                    'Int',
-                    'order',
-                    esc_html__('Event Menu Order', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'phoneNumber',
-                    'String',
-                    'phone',
-                    esc_html__('Event Phone Number', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'shortDescription',
-                    'String',
-                    'short_description',
-                    esc_html__('Event Short Description', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'timezoneString',
-                    'String',
-                    'timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'visibleOn',
-                    'String',
-                    'visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso')
-                ),
-                new GraphQLField(
-                    'venue',
-                    'String',
-                    null,
-                    esc_html__('Event venue ID', 'event_espresso'),
-                    null,
-                    function (EE_Event $source) {
-                        $venue_ID = $source->venue_ID();
-                        return $venue_ID
-                            // Since venue is a CPT, $type will be 'post'
-                            ? Relay::toGlobalId('post', $venue_ID)
-                            : null;
-                    }
-                ),
-            ],
-            $this->name,
-            $this->model
-        );
-    }
+	/**
+	 * @return GraphQLFieldInterface[]
+	 */
+	public function getFields(): array
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_types__event_fields',
+			[
+				new GraphQLField(
+					'allowDonations',
+					'Boolean',
+					'donations',
+					esc_html__('Accept Donations?', 'event_espresso')
+				),
+				new GraphQLField(
+					'allowOverflow',
+					'Boolean',
+					'allow_overflow',
+					esc_html__('Enable Wait List for Event', 'event_espresso')
+				),
+				new GraphQLField(
+					'altRegPage',
+					'String',
+					'external_url',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'cacheId',
+					['non_null' => 'String'],
+					null,
+					esc_html__('The cache ID of the object.', 'event_espresso')
+				),
+				new GraphQLField(
+					'created',
+					'String',
+					'created',
+					esc_html__('Date/Time Event Created', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'dbId',
+					['non_null' => 'Int'],
+					'ID',
+					esc_html__('The event ID.', 'event_espresso')
+				),
+				new GraphQLField(
+					'defaultRegStatus',
+					$this->namespace . 'RegistrationStatusEnum',
+					'default_registration_status',
+					esc_html__('Default Event Registration Status', 'event_espresso')
+				),
+				new GraphQLField(
+					'description',
+					'String',
+					'description',
+					esc_html__('Event Description', 'event_espresso')
+				),
+				new GraphQLField(
+					'displayDescription',
+					'Boolean',
+					'display_description',
+					esc_html__('Display Description Flag', 'event_espresso')
+				),
+				new GraphQLField(
+					'displayTicketSelector',
+					'Boolean',
+					'display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isActive',
+					'Boolean',
+					'is_active',
+					esc_html__('Flag indicating event is active', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isCancelled',
+					'Boolean',
+					'is_cancelled',
+					esc_html__('Flag indicating whether the event is marked as cancelled', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isExpired',
+					'Boolean',
+					'is_expired',
+					esc_html__('Flag indicating event is expired or not', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isInactive',
+					'Boolean',
+					'is_inactive',
+					esc_html__('Flag indicating event is inactive', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isPostponed',
+					'Boolean',
+					'is_postponed',
+					esc_html__('Flag indicating whether the event is marked as postponed', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'isSoldOut',
+					'Boolean',
+					'is_sold_out',
+					esc_html__(
+						'Flag indicating whether the tickets sold for the event, met or exceed the registration limit',
+						'event_espresso'
+					)
+				),
+				new GraphQLOutputField(
+					'isUpcoming',
+					'Boolean',
+					'is_upcoming',
+					esc_html__('Whether the event is upcoming', 'event_espresso')
+				),
+				new GraphQLInputField(
+					'manager',
+					'String',
+					null,
+					esc_html__('Globally unique event ID for the event manager', 'event_espresso')
+				),
+				new GraphQLOutputField(
+					'manager',
+					'User',
+					null,
+					esc_html__('Event Manager', 'event_espresso')
+				),
+				new GraphQLField(
+					'maxRegistrations',
+					'Int',
+					'additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso')
+				),
+				new GraphQLField(
+					'memberOnly',
+					'Boolean',
+					'member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso')
+				),
+				new GraphQLField(
+					'name',
+					'String',
+					'name',
+					esc_html__('Event Name', 'event_espresso')
+				),
+				new GraphQLField(
+					'order',
+					'Int',
+					'order',
+					esc_html__('Event Menu Order', 'event_espresso')
+				),
+				new GraphQLField(
+					'phoneNumber',
+					'String',
+					'phone',
+					esc_html__('Event Phone Number', 'event_espresso')
+				),
+				new GraphQLField(
+					'shortDescription',
+					'String',
+					'short_description',
+					esc_html__('Event Short Description', 'event_espresso')
+				),
+				new GraphQLField(
+					'timezoneString',
+					'String',
+					'timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso')
+				),
+				new GraphQLField(
+					'visibleOn',
+					'String',
+					'visible_on',
+					esc_html__('Event Visible Date', 'event_espresso')
+				),
+				new GraphQLField(
+					'venue',
+					'String',
+					null,
+					esc_html__('Event venue ID', 'event_espresso'),
+					null,
+					function (EE_Event $source) {
+						$venue_ID = $source->venue_ID();
+						return $venue_ID
+							// Since venue is a CPT, $type will be 'post'
+							? Relay::toGlobalId('post', $venue_ID)
+							: null;
+					}
+				),
+			],
+			$this->name,
+			$this->model
+		);
+	}
 
 
-    /**
-     * Extends the existing WP GraphQL mutations.
-     *
-     * @since $VID:$
-     */
-    public function extendMutations()
-    {
-        add_action(
-            'graphql_post_object_mutation_update_additional_data',
-            EventUpdate::mutateFields($this->model, $this),
-            10,
-            6
-        );
-    }
+	/**
+	 * Extends the existing WP GraphQL mutations.
+	 *
+	 * @since $VID:$
+	 */
+	public function extendMutations()
+	{
+		add_action(
+			'graphql_post_object_mutation_update_additional_data',
+			EventUpdate::mutateFields($this->model, $this),
+			10,
+			6
+		);
+	}
 }

core/db_classes/EE_Datetime.class.php

Indentation +1552 added lines, -1552 removed lines

@@ -12,1560 +12,1560 @@
  */
 class EE_Datetime extends EE_Soft_Delete_Base_Class
 {
-    /**
-     * constant used by get_active_status, indicates datetime has no more available spaces
-     */
-    const sold_out = 'DTS';
-
-    /**
-     * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
-     */
-    const active = 'DTA';
-
-    /**
-     * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
-     * expired
-     */
-    const upcoming = 'DTU';
-
-    /**
-     * Datetime is postponed
-     */
-    const postponed = 'DTP';
-
-    /**
-     * Datetime is cancelled
-     */
-    const cancelled = 'DTC';
-
-    /**
-     * constant used by get_active_status, indicates datetime has expired (event is over)
-     */
-    const expired = 'DTE';
-
-    /**
-     * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
-     */
-    const inactive = 'DTI';
-
-
-    /**
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats      incoming date_formats in an array where the first value is the date_format
-     *                                  and the second value is the time format
-     * @return EE_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            __CLASS__,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param $name
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('DTT_name', $name);
-    }
-
-
-    /**
-     * @param $description
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_description($description)
-    {
-        $this->set('DTT_description', $description);
-    }
-
-
-    /**
-     * Set event start date
-     * set the start date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event start time
-     * set the start time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event end date
-     * set the end date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set event end time
-     * set the end time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set registration limit
-     * set the maximum number of attendees that can be registered for this datetime slot
-     *
-     * @param int|float $reg_limit
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reg_limit($reg_limit)
-    {
-        $this->set('DTT_reg_limit', $reg_limit);
-    }
-
-
-    /**
-     * get the number of tickets sold for this datetime slot
-     *
-     * @return mixed int on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold()
-    {
-        return $this->get_raw('DTT_sold');
-    }
-
-
-    /**
-     * @param int $sold
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('DTT_sold', $sold);
-    }
-
-
-    /**
-     * Increments sold by amount passed by $qty, and persists it immediately to the database.
-     * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false.
-     *
-     * @param int $qty
-     * @param boolean $also_decrease_reserved
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increaseSold(int $qty = 1, bool $also_decrease_reserved = true): bool
-    {
-        $qty = absint($qty);
-        if ($also_decrease_reserved) {
-            $success = $this->adjustNumericFieldsInDb(
-                [
-                    'DTT_reserved' => $qty * -1,
-                    'DTT_sold' => $qty
-                ]
-            );
-        } else {
-            $success = $this->adjustNumericFieldsInDb(
-                [
-                    'DTT_sold' => $qty
-                ]
-            );
-        }
-
-        do_action(
-            'AHEE__EE_Datetime__increase_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
-     * to save afterwards.)
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decreaseSold(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'DTT_sold' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Datetime__decrease_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Gets qty of reserved tickets for this datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reserved(): int
-    {
-        return $this->get_raw('DTT_reserved');
-    }
-
-
-    /**
-     * Sets qty of reserved tickets for this datetime
-     *
-     * @param int $reserved
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reserved(int $reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, $reserved);
-        $this->set('DTT_reserved', $reserved);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increaseReserved(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->incrementFieldConditionallyInDb(
-            'DTT_reserved',
-            'DTT_sold',
-            'DTT_reg_limit',
-            $qty
-        );
-        do_action(
-            'AHEE__EE_Datetime__increase_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decreaseReserved(int $qty = 1): bool
-    {
-        $qty = absint($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'DTT_reserved' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Datetime__decrease_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * total sold and reserved tickets
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_and_reserved(): int
-    {
-        return $this->sold() + $this->reserved();
-    }
-
-
-    /**
-     * returns the datetime name
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function name(): string
-    {
-        return $this->get('DTT_name');
-    }
-
-
-    /**
-     * returns the datetime description
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function description(): string
-    {
-        return $this->get('DTT_description');
-    }
-
-
-    /**
-     * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
-     *
-     * @return boolean  TRUE if is primary, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_primary(): bool
-    {
-        return $this->get('DTT_is_primary');
-    }
-
-
-    /**
-     * This helper simply returns the order for the datetime
-     *
-     * @return int  The order of the datetime for this event.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function order(): int
-    {
-        return $this->get('DTT_order');
-    }
-
-
-    /**
-     * This helper simply returns the parent id for the datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function parent(): int
-    {
-        return $this->get('DTT_parent');
-    }
-
-
-    /**
-     * show date and/or time
-     *
-     * @param string $date_or_time    whether to display a date or time or both
-     * @param string $start_or_end    whether to display start or end datetimes
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
-     *                                otherwise we use the standard formats)
-     * @return string|bool  string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function _show_datetime(
-        $date_or_time = null,
-        $start_or_end = 'start',
-        $dt_frmt = '',
-        $tm_frmt = '',
-        $echo = false
-    ) {
-        $field_name = "DTT_EVT_{$start_or_end}";
-        $dtt = $this->_get_datetime(
-            $field_name,
-            $dt_frmt,
-            $tm_frmt,
-            $date_or_time,
-            $echo
-        );
-        if (! $echo) {
-            return $dtt;
-        }
-        return '';
-    }
-
-
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'start', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes start_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'start', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'end', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes the end date. See end_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'end', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get date_range - meaning the start AND end date
-     *
-     * @access public
-     * @param string $dt_frmt     string representation of date format defaults to WP settings
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
-        $start = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
-        );
-        $end = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->date_range($dt_frmt, $conjunction));
-    }
-
-
-    /**
-     * get start time
-     *
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return mixed        string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'start', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'start', null, $tm_format, true);
-    }
-
-
-    /**
-     * get end time
-     *
-     * @param string $tm_format string representation of time format defaults to 'g:i a'
-     * @return mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'end', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'end', null, $tm_format, true);
-    }
-
-
-    /**
-     * get time_range
-     *
-     * @access public
-     * @param string $tm_format   string representation of time format defaults to 'g:i a'
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function time_range($tm_format = '', $conjunction = ' - ')
-    {
-        $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $start = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $tm_format)
-        );
-        $end = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $tm_format)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_time_range($tm_format = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->time_range($tm_format, $conjunction));
-    }
-
-
-    /**
-     * This returns a range representation of the date and times.
-     * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_and_time_range(
-        $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ',
-        $separator = ' '
-    ) {
-        $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
-        $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $full_format = $dt_format . $separator . $tm_format;
-        // the range output depends on various conditions
-        switch (true) {
-            // start date timestamp and end date timestamp are the same.
-            case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')):
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
-                break;
-            // start and end date are the same but times are different
-            case ($this->start_date() === $this->end_date()):
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
-                break;
-            // all other conditions
-            default:
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
-                break;
-        }
-        return $output;
-    }
-
-
-    /**
-     * This echos the results of date and time range.
-     *
-     * @see date_and_time_range() for more details on purpose.
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
-    {
-        echo esc_html($this->date_and_time_range($dt_format, $tm_format, $conjunction));
-    }
-
-
-    /**
-     * get start date and start time
-     *
-     * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
-     * @param    string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed    string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date_and_time($dt_format = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'start', $dt_format, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     * Shows the length of the event (start to end time).
-     * Can be shown in 'seconds','minutes','hours', or 'days'.
-     * By default, rounds up. (So if you use 'days', and then event
-     * only occurs for 1 hour, it will return 1 day).
-     *
-     * @param string $units 'seconds','minutes','hours','days'
-     * @param bool   $round_up
-     * @return float|int|mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function length($units = 'seconds', $round_up = false)
-    {
-        $start = $this->get_raw('DTT_EVT_start');
-        $end = $this->get_raw('DTT_EVT_end');
-        $length_in_units = $end - $start;
-        switch ($units) {
-            // NOTE: We purposefully don't use "break;" in order to chain the divisions
-            /** @noinspection PhpMissingBreakStatementInspection */
-            // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-            case 'days':
-                $length_in_units /= 24;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'hours':
-                // fall through is intentional
-                $length_in_units /= 60;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'minutes':
-                // fall through is intentional
-                $length_in_units /= 60;
-            case 'seconds':
-            default:
-                $length_in_units = ceil($length_in_units);
-        }
-        // phpcs:enable
-        if ($round_up) {
-            $length_in_units = max($length_in_units, 1);
-        }
-        return $length_in_units;
-    }
-
-
-    /**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     *        get start timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start()
-    {
-        return $this->get_raw('DTT_EVT_start');
-    }
-
-
-    /**
-     *        get end timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end()
-    {
-        return $this->get_raw('DTT_EVT_end');
-    }
-
-
-    /**
-     *    get the registration limit for this datetime slot
-     *
-     * @return int|float                int = finite limit   EE_INF(float) = unlimited
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reg_limit()
-    {
-        return $this->get_raw('DTT_reg_limit');
-    }
-
-
-    /**
-     *    have the tickets sold for this datetime, met or exceed the registration limit ?
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_out()
-    {
-        return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
-    }
-
-
-    /**
-     * return the total number of spaces remaining at this venue.
-     * This only takes the venue's capacity into account, NOT the tickets available for sale
-     *
-     * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
-     *                               Because if all tickets attached to this datetime have no spaces left,
-     *                               then this datetime IS effectively sold out.
-     *                               However, there are cases where we just want to know the spaces
-     *                               remaining for this particular datetime, hence the flag.
-     * @return int|float
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function spaces_remaining($consider_tickets = false)
-    {
-        // tickets remaining available for purchase
-        // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
-        $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-        if (! $consider_tickets) {
-            return $dtt_remaining;
-        }
-        $tickets_remaining = $this->tickets_remaining();
-        return min($dtt_remaining, $tickets_remaining);
-    }
-
-
-    /**
-     * Counts the total tickets available
-     * (from all the different types of tickets which are available for this datetime).
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets_remaining($query_params = array())
-    {
-        $sum = 0;
-        $tickets = $this->tickets($query_params);
-        if (! empty($tickets)) {
-            foreach ($tickets as $ticket) {
-                if ($ticket instanceof EE_Ticket) {
-                    // get the actual amount of tickets that can be sold
-                    $qty = $ticket->qty('saleable');
-                    if ($qty === EE_INF) {
-                        return EE_INF;
-                    }
-                    // no negative ticket quantities plz
-                    if ($qty > 0) {
-                        $sum += $qty;
-                    }
-                }
-            }
-        }
-        return $sum;
-    }
-
-
-    /**
-     * Gets the count of all the tickets available at this datetime (not ticket types)
-     * before any were sold
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sum_tickets_initially_available($query_params = array())
-    {
-        return $this->sum_related('Ticket', $query_params, 'TKT_qty');
-    }
-
-
-    /**
-     * Returns the lesser-of-the two: spaces remaining at this datetime, or
-     * the total tickets remaining (a sum of the tickets remaining for each ticket type
-     * that is available for this datetime).
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function total_tickets_available_at_this_datetime()
-    {
-        return $this->spaces_remaining(true);
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is upcoming or not.
-     *
-     * @access public
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        return ($this->get_raw('DTT_EVT_start') > time());
-    }
-
-
-    /**
-     * This simply compares the internal datetime for the given string with NOW
-     * and returns if the date is active (i.e. start and end time)
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is expired or not.
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('DTT_EVT_end') < time());
-    }
-
-
-    /**
-     * This returns the active status for whether an event is active, upcoming, or expired
-     *
-     * @return int return value will be one of the EE_Datetime status constants.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_active_status()
-    {
-        $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-        if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
-            return EE_Datetime::sold_out;
-        }
-        if ($this->is_expired()) {
-            return EE_Datetime::expired;
-        }
-        if ($this->is_upcoming()) {
-            return EE_Datetime::upcoming;
-        }
-        if ($this->is_active()) {
-            return EE_Datetime::active;
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
-     *
-     * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_dtt_display_name($use_dtt_name = false)
-    {
-        if ($use_dtt_name) {
-            $dtt_name = $this->name();
-            if (! empty($dtt_name)) {
-                return $dtt_name;
-            }
-        }
-        // first condition is to see if the months are different
-        if (
-            date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
-        ) {
-            $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
-            // next condition is if its the same month but different day
-        } else {
-            if (
-                date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
-                && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
-            ) {
-                $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
-            } else {
-                $display_date = $this->start_date('F j\, Y')
-                                . ' @ '
-                                . $this->start_date('g:i a')
-                                . ' - '
-                                . $this->end_date('g:i a');
-            }
-        }
-        return $display_date;
-    }
-
-
-    /**
-     * Gets all the tickets for this datetime
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        return $this->get_many_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket types currently available for purchase
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function ticket_types_available_for_purchase($query_params = array())
-    {
-        // first check if datetime is valid
-        if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
-            return array();
-        }
-        if (empty($query_params)) {
-            $query_params = array(
-                array(
-                    'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
-                    'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'    => false,
-                ),
-            );
-        }
-        return $this->tickets($query_params);
-    }
-
-
-    /**
-     * @return EE_Base_Class|EE_Event
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function event()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
-     * (via the tickets).
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function update_sold()
-    {
-        $count_regs_for_this_datetime = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID'                 => EEM_Registration::status_id_approved,
-                    'REG_deleted'            => 0,
-                    'Ticket.Datetime.DTT_ID' => $this->ID(),
-                ),
-            )
-        );
-        $this->set_sold($count_regs_for_this_datetime);
-        $this->save();
-        return $count_regs_for_this_datetime;
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param int|EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj): EE_Venue
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj): EE_Venue
-    {
-        $venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_ID(array $query_params = []): int
-    {
-        $venue = $this->get_first_related('Venue', $query_params);
-        return $venue instanceof EE_Venue
-            ? $venue->ID()
-            : 0;
-    }
-
-
-    /**
-     * Gets the venue related to the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue(array $query_params = [])
-    {
-        return $this->get_first_related('Venue', $query_params);
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $extra_join_model_fields_n_values
-     * @param string|null              $cache_id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = [],
-        $cache_id = null
-    ) {
-        // if we're adding a new relation to a ticket
-        if ($relationName === 'Ticket' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Ticket $ticket */
-            $ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $this->increaseSold($ticket->sold(), false);
-            $this->increaseReserved($ticket->reserved());
-            $this->save();
-            $otherObjectModelObjectOrID = $ticket;
-        }
-        return parent::_add_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $extra_join_model_fields_n_values,
-            $cache_id
-        );
-    }
-
-
-    /**
-     * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
-     * @param string                   $relationName
-     * @param array                    $where_query
-     * @return bool|EE_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
-    {
-        if ($relationName === 'Ticket' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
-            /** @var EE_Ticket $ticket */
-            $ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
-            $this->decreaseSold($ticket->sold());
-            $this->decreaseReserved($ticket->reserved());
-            $this->save();
-            $otherObjectModelObjectOrID = $ticket;
-        }
-        return parent::_remove_relation_to(
-            $otherObjectModelObjectOrID,
-            $relationName,
-            $where_query
-        );
-    }
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public function _remove_relations($relationName, $where_query_params = [])
-    {
-        if ($relationName === 'Ticket') {
-            $tickets = $this->tickets();
-            foreach ($tickets as $ticket) {
-                $this->decreaseSold($ticket->sold());
-                $this->decreaseReserved($ticket->reserved());
-                $this->save();
-            }
-        }
-        return parent::_remove_relations($relationName, $where_query_params);
-    }
-
-
-    /*******************************************************************
+	/**
+	 * constant used by get_active_status, indicates datetime has no more available spaces
+	 */
+	const sold_out = 'DTS';
+
+	/**
+	 * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
+	 */
+	const active = 'DTA';
+
+	/**
+	 * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
+	 * expired
+	 */
+	const upcoming = 'DTU';
+
+	/**
+	 * Datetime is postponed
+	 */
+	const postponed = 'DTP';
+
+	/**
+	 * Datetime is cancelled
+	 */
+	const cancelled = 'DTC';
+
+	/**
+	 * constant used by get_active_status, indicates datetime has expired (event is over)
+	 */
+	const expired = 'DTE';
+
+	/**
+	 * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
+	 */
+	const inactive = 'DTI';
+
+
+	/**
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats      incoming date_formats in an array where the first value is the date_format
+	 *                                  and the second value is the time format
+	 * @return EE_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			__CLASS__,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('DTT_name', $name);
+	}
+
+
+	/**
+	 * @param $description
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_description($description)
+	{
+		$this->set('DTT_description', $description);
+	}
+
+
+	/**
+	 * Set event start date
+	 * set the start date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event start time
+	 * set the start time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event end date
+	 * set the end date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set event end time
+	 * set the end time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set registration limit
+	 * set the maximum number of attendees that can be registered for this datetime slot
+	 *
+	 * @param int|float $reg_limit
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reg_limit($reg_limit)
+	{
+		$this->set('DTT_reg_limit', $reg_limit);
+	}
+
+
+	/**
+	 * get the number of tickets sold for this datetime slot
+	 *
+	 * @return mixed int on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold()
+	{
+		return $this->get_raw('DTT_sold');
+	}
+
+
+	/**
+	 * @param int $sold
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
+	}
+
+
+	/**
+	 * Increments sold by amount passed by $qty, and persists it immediately to the database.
+	 * Simultaneously decreases the reserved count, unless $also_decrease_reserved is false.
+	 *
+	 * @param int $qty
+	 * @param boolean $also_decrease_reserved
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increaseSold(int $qty = 1, bool $also_decrease_reserved = true): bool
+	{
+		$qty = absint($qty);
+		if ($also_decrease_reserved) {
+			$success = $this->adjustNumericFieldsInDb(
+				[
+					'DTT_reserved' => $qty * -1,
+					'DTT_sold' => $qty
+				]
+			);
+		} else {
+			$success = $this->adjustNumericFieldsInDb(
+				[
+					'DTT_sold' => $qty
+				]
+			);
+		}
+
+		do_action(
+			'AHEE__EE_Datetime__increase_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
+	 * to save afterwards.)
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decreaseSold(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'DTT_sold' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Datetime__decrease_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets for this datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reserved(): int
+	{
+		return $this->get_raw('DTT_reserved');
+	}
+
+
+	/**
+	 * Sets qty of reserved tickets for this datetime
+	 *
+	 * @param int $reserved
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reserved(int $reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, $reserved);
+		$this->set('DTT_reserved', $reserved);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increaseReserved(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->incrementFieldConditionallyInDb(
+			'DTT_reserved',
+			'DTT_sold',
+			'DTT_reg_limit',
+			$qty
+		);
+		do_action(
+			'AHEE__EE_Datetime__increase_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decreaseReserved(int $qty = 1): bool
+	{
+		$qty = absint($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'DTT_reserved' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Datetime__decrease_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * total sold and reserved tickets
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_and_reserved(): int
+	{
+		return $this->sold() + $this->reserved();
+	}
+
+
+	/**
+	 * returns the datetime name
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function name(): string
+	{
+		return $this->get('DTT_name');
+	}
+
+
+	/**
+	 * returns the datetime description
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function description(): string
+	{
+		return $this->get('DTT_description');
+	}
+
+
+	/**
+	 * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
+	 *
+	 * @return boolean  TRUE if is primary, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_primary(): bool
+	{
+		return $this->get('DTT_is_primary');
+	}
+
+
+	/**
+	 * This helper simply returns the order for the datetime
+	 *
+	 * @return int  The order of the datetime for this event.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function order(): int
+	{
+		return $this->get('DTT_order');
+	}
+
+
+	/**
+	 * This helper simply returns the parent id for the datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function parent(): int
+	{
+		return $this->get('DTT_parent');
+	}
+
+
+	/**
+	 * show date and/or time
+	 *
+	 * @param string $date_or_time    whether to display a date or time or both
+	 * @param string $start_or_end    whether to display start or end datetimes
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
+	 *                                otherwise we use the standard formats)
+	 * @return string|bool  string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function _show_datetime(
+		$date_or_time = null,
+		$start_or_end = 'start',
+		$dt_frmt = '',
+		$tm_frmt = '',
+		$echo = false
+	) {
+		$field_name = "DTT_EVT_{$start_or_end}";
+		$dtt = $this->_get_datetime(
+			$field_name,
+			$dt_frmt,
+			$tm_frmt,
+			$date_or_time,
+			$echo
+		);
+		if (! $echo) {
+			return $dtt;
+		}
+		return '';
+	}
+
+
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'start', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes start_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'start', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'end', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes the end date. See end_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'end', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get date_range - meaning the start AND end date
+	 *
+	 * @access public
+	 * @param string $dt_frmt     string representation of date format defaults to WP settings
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
+		);
+		$end = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->date_range($dt_frmt, $conjunction));
+	}
+
+
+	/**
+	 * get start time
+	 *
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return mixed        string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'start', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'start', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get end time
+	 *
+	 * @param string $tm_format string representation of time format defaults to 'g:i a'
+	 * @return mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'end', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'end', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get time_range
+	 *
+	 * @access public
+	 * @param string $tm_format   string representation of time format defaults to 'g:i a'
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function time_range($tm_format = '', $conjunction = ' - ')
+	{
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $tm_format)
+		);
+		$end = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $tm_format)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_time_range($tm_format = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->time_range($tm_format, $conjunction));
+	}
+
+
+	/**
+	 * This returns a range representation of the date and times.
+	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction used between two different dates or times.
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_and_time_range(
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ',
+		$separator = ' '
+	) {
+		$dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format . $separator . $tm_format;
+		// the range output depends on various conditions
+		switch (true) {
+			// start date timestamp and end date timestamp are the same.
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')):
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
+				break;
+			// start and end date are the same but times are different
+			case ($this->start_date() === $this->end_date()):
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
+				break;
+			// all other conditions
+			default:
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
+				break;
+		}
+		return $output;
+	}
+
+
+	/**
+	 * This echos the results of date and time range.
+	 *
+	 * @see date_and_time_range() for more details on purpose.
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
+	{
+		echo esc_html($this->date_and_time_range($dt_format, $tm_format, $conjunction));
+	}
+
+
+	/**
+	 * get start date and start time
+	 *
+	 * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
+	 * @param    string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed    string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date_and_time($dt_format = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 * Shows the length of the event (start to end time).
+	 * Can be shown in 'seconds','minutes','hours', or 'days'.
+	 * By default, rounds up. (So if you use 'days', and then event
+	 * only occurs for 1 hour, it will return 1 day).
+	 *
+	 * @param string $units 'seconds','minutes','hours','days'
+	 * @param bool   $round_up
+	 * @return float|int|mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function length($units = 'seconds', $round_up = false)
+	{
+		$start = $this->get_raw('DTT_EVT_start');
+		$end = $this->get_raw('DTT_EVT_end');
+		$length_in_units = $end - $start;
+		switch ($units) {
+			// NOTE: We purposefully don't use "break;" in order to chain the divisions
+			/** @noinspection PhpMissingBreakStatementInspection */
+			// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+			case 'days':
+				$length_in_units /= 24;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'hours':
+				// fall through is intentional
+				$length_in_units /= 60;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'minutes':
+				// fall through is intentional
+				$length_in_units /= 60;
+			case 'seconds':
+			default:
+				$length_in_units = ceil($length_in_units);
+		}
+		// phpcs:enable
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
+		}
+		return $length_in_units;
+	}
+
+
+	/**
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 *        get start timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start()
+	{
+		return $this->get_raw('DTT_EVT_start');
+	}
+
+
+	/**
+	 *        get end timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end()
+	{
+		return $this->get_raw('DTT_EVT_end');
+	}
+
+
+	/**
+	 *    get the registration limit for this datetime slot
+	 *
+	 * @return int|float                int = finite limit   EE_INF(float) = unlimited
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reg_limit()
+	{
+		return $this->get_raw('DTT_reg_limit');
+	}
+
+
+	/**
+	 *    have the tickets sold for this datetime, met or exceed the registration limit ?
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_out()
+	{
+		return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
+	}
+
+
+	/**
+	 * return the total number of spaces remaining at this venue.
+	 * This only takes the venue's capacity into account, NOT the tickets available for sale
+	 *
+	 * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
+	 *                               Because if all tickets attached to this datetime have no spaces left,
+	 *                               then this datetime IS effectively sold out.
+	 *                               However, there are cases where we just want to know the spaces
+	 *                               remaining for this particular datetime, hence the flag.
+	 * @return int|float
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function spaces_remaining($consider_tickets = false)
+	{
+		// tickets remaining available for purchase
+		// no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
+		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
+		if (! $consider_tickets) {
+			return $dtt_remaining;
+		}
+		$tickets_remaining = $this->tickets_remaining();
+		return min($dtt_remaining, $tickets_remaining);
+	}
+
+
+	/**
+	 * Counts the total tickets available
+	 * (from all the different types of tickets which are available for this datetime).
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets_remaining($query_params = array())
+	{
+		$sum = 0;
+		$tickets = $this->tickets($query_params);
+		if (! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
+					// get the actual amount of tickets that can be sold
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
+						return EE_INF;
+					}
+					// no negative ticket quantities plz
+					if ($qty > 0) {
+						$sum += $qty;
+					}
+				}
+			}
+		}
+		return $sum;
+	}
+
+
+	/**
+	 * Gets the count of all the tickets available at this datetime (not ticket types)
+	 * before any were sold
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sum_tickets_initially_available($query_params = array())
+	{
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
+	}
+
+
+	/**
+	 * Returns the lesser-of-the two: spaces remaining at this datetime, or
+	 * the total tickets remaining (a sum of the tickets remaining for each ticket type
+	 * that is available for this datetime).
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function total_tickets_available_at_this_datetime()
+	{
+		return $this->spaces_remaining(true);
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		return ($this->get_raw('DTT_EVT_start') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal datetime for the given string with NOW
+	 * and returns if the date is active (i.e. start and end time)
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is expired or not.
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('DTT_EVT_end') < time());
+	}
+
+
+	/**
+	 * This returns the active status for whether an event is active, upcoming, or expired
+	 *
+	 * @return int return value will be one of the EE_Datetime status constants.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_active_status()
+	{
+		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
+		if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
+			return EE_Datetime::sold_out;
+		}
+		if ($this->is_expired()) {
+			return EE_Datetime::expired;
+		}
+		if ($this->is_upcoming()) {
+			return EE_Datetime::upcoming;
+		}
+		if ($this->is_active()) {
+			return EE_Datetime::active;
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
+	 *
+	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_dtt_display_name($use_dtt_name = false)
+	{
+		if ($use_dtt_name) {
+			$dtt_name = $this->name();
+			if (! empty($dtt_name)) {
+				return $dtt_name;
+			}
+		}
+		// first condition is to see if the months are different
+		if (
+			date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
+		) {
+			$display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
+			// next condition is if its the same month but different day
+		} else {
+			if (
+				date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
+				&& date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
+			) {
+				$display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
+			} else {
+				$display_date = $this->start_date('F j\, Y')
+								. ' @ '
+								. $this->start_date('g:i a')
+								. ' - '
+								. $this->end_date('g:i a');
+			}
+		}
+		return $display_date;
+	}
+
+
+	/**
+	 * Gets all the tickets for this datetime
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		return $this->get_many_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket types currently available for purchase
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function ticket_types_available_for_purchase($query_params = array())
+	{
+		// first check if datetime is valid
+		if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
+			return array();
+		}
+		if (empty($query_params)) {
+			$query_params = array(
+				array(
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'    => false,
+				),
+			);
+		}
+		return $this->tickets($query_params);
+	}
+
+
+	/**
+	 * @return EE_Base_Class|EE_Event
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function event()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
+	 * (via the tickets).
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function update_sold()
+	{
+		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID'                 => EEM_Registration::status_id_approved,
+					'REG_deleted'            => 0,
+					'Ticket.Datetime.DTT_ID' => $this->ID(),
+				),
+			)
+		);
+		$this->set_sold($count_regs_for_this_datetime);
+		$this->save();
+		return $count_regs_for_this_datetime;
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param int|EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj): EE_Venue
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj): EE_Venue
+	{
+		$venue_id_or_obj = ! empty($venue_id_or_obj) ? $venue_id_or_obj : $this->venue();
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_ID(array $query_params = []): int
+	{
+		$venue = $this->get_first_related('Venue', $query_params);
+		return $venue instanceof EE_Venue
+			? $venue->ID()
+			: 0;
+	}
+
+
+	/**
+	 * Gets the venue related to the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue(array $query_params = [])
+	{
+		return $this->get_first_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $extra_join_model_fields_n_values
+	 * @param string|null              $cache_id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = [],
+		$cache_id = null
+	) {
+		// if we're adding a new relation to a ticket
+		if ($relationName === 'Ticket' && ! $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Ticket $ticket */
+			$ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$this->increaseSold($ticket->sold(), false);
+			$this->increaseReserved($ticket->reserved());
+			$this->save();
+			$otherObjectModelObjectOrID = $ticket;
+		}
+		return parent::_add_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$extra_join_model_fields_n_values,
+			$cache_id
+		);
+	}
+
+
+	/**
+	 * @param EE_Base_Class|int|string $otherObjectModelObjectOrID
+	 * @param string                   $relationName
+	 * @param array                    $where_query
+	 * @return bool|EE_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = [])
+	{
+		if ($relationName === 'Ticket' && $this->hasRelation($otherObjectModelObjectOrID, $relationName)) {
+			/** @var EE_Ticket $ticket */
+			$ticket = EEM_Ticket::instance()->ensure_is_obj($otherObjectModelObjectOrID);
+			$this->decreaseSold($ticket->sold());
+			$this->decreaseReserved($ticket->reserved());
+			$this->save();
+			$otherObjectModelObjectOrID = $ticket;
+		}
+		return parent::_remove_relation_to(
+			$otherObjectModelObjectOrID,
+			$relationName,
+			$where_query
+		);
+	}
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public function _remove_relations($relationName, $where_query_params = [])
+	{
+		if ($relationName === 'Ticket') {
+			$tickets = $this->tickets();
+			foreach ($tickets as $ticket) {
+				$this->decreaseSold($ticket->sold());
+				$this->decreaseReserved($ticket->reserved());
+				$this->save();
+			}
+		}
+		return parent::_remove_relations($relationName, $where_query_params);
+	}
+
+
+	/*******************************************************************
      ***********************  DEPRECATED METHODS  **********************
      *******************************************************************/
 
 
-    /**
-     * Increments sold by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseSold($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
-     * to save afterwards.)
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->decreaseSold($qty);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_reserved($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReserved($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_reserved($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->decreaseReserved($qty);
-    }
+	/**
+	 * Increments sold by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::increaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseSold($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold amount passed by $qty directly in the DB and on the model object. (Ie, no need
+	 * to save afterwards.)
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::decreaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->decreaseSold($qty);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_reserved($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::increaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReserved($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_reserved($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Datetime::decreaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->decreaseReserved($qty);
+	}
 }

core/libraries/batch/JobHandlerBaseClasses/JobHandler.php

Indentation +238 added lines, -238 removed lines

@@ -17,271 +17,271 @@
  */
 abstract class JobHandler implements JobHandlerInterface
 {
-    /**
-     * @var array
-     */
-    protected $feedback = [];
-
-    /**
-     * incoming Request data
-     *
-     * @var array
-     */
-    protected $request_data = [];
-
-    /**
-     * Extra data to include as part of the response, literally gets set as JobStepResponse::$_extra_data
-     *
-     * @var array
-     */
-    protected $response_data = [];
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since $VID:$
-     */
-    public function createJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->create_job($job_parameters);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since $VID:$
-     */
-    public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        return $this->continue_job($job_parameters, $batch_size);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @since $VID:$
-     */
-    public function advanceJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->advance_job($job_parameters);
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     * By default, this function won't do anything until overridden in a chile class.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @since $VID:$
-     */
-    public function advance_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $job_parameters->set_status(JobParameters::status_continue);
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since $VID:$
-     */
-    public function cleanupJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->cleanup_job($job_parameters);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function requestData(): array
-    {
-        return $this->request_data;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function getRequestData($key)
-    {
-        return $this->request_data[ $key ] ?? null;
-    }
-
-
-    /**
-     * @param array $request_data
-     */
-    public function setRequestData(array $request_data): void
-    {
-        $this->request_data = $request_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function responseData(): array
-    {
-        return $this->response_data;
-    }
-
-
-    /**
-     * @param array $response_data
-     */
-    public function addResponseData(array $response_data): void
-    {
-        $this->response_data += $response_data;
-    }
-
-
-
-    /**
-     * @param array $response_data
-     */
-    public function setResponseData(array $response_data): void
-    {
-        $this->response_data = $response_data;
-    }
-
-
-
-
-    protected function displayJobStepResults(int $processed, string $custom_message = '')
-    {
-        $this->feedback[] = '
+	/**
+	 * @var array
+	 */
+	protected $feedback = [];
+
+	/**
+	 * incoming Request data
+	 *
+	 * @var array
+	 */
+	protected $request_data = [];
+
+	/**
+	 * Extra data to include as part of the response, literally gets set as JobStepResponse::$_extra_data
+	 *
+	 * @var array
+	 */
+	protected $response_data = [];
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since $VID:$
+	 */
+	public function createJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->create_job($job_parameters);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since $VID:$
+	 */
+	public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		return $this->continue_job($job_parameters, $batch_size);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @since $VID:$
+	 */
+	public function advanceJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->advance_job($job_parameters);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 * By default, this function won't do anything until overridden in a chile class.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @since $VID:$
+	 */
+	public function advance_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$job_parameters->set_status(JobParameters::status_continue);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since $VID:$
+	 */
+	public function cleanupJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->cleanup_job($job_parameters);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function requestData(): array
+	{
+		return $this->request_data;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function getRequestData($key)
+	{
+		return $this->request_data[ $key ] ?? null;
+	}
+
+
+	/**
+	 * @param array $request_data
+	 */
+	public function setRequestData(array $request_data): void
+	{
+		$this->request_data = $request_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function responseData(): array
+	{
+		return $this->response_data;
+	}
+
+
+	/**
+	 * @param array $response_data
+	 */
+	public function addResponseData(array $response_data): void
+	{
+		$this->response_data += $response_data;
+	}
+
+
+
+	/**
+	 * @param array $response_data
+	 */
+	public function setResponseData(array $response_data): void
+	{
+		$this->response_data = $response_data;
+	}
+
+
+
+
+	protected function displayJobStepResults(int $processed, string $custom_message = '')
+	{
+		$this->feedback[] = '
 			<div class="ee-batch-job-step-results">
 			' . $this->infoWrapper(
-            sprintf(
-                $custom_message !== ''
-                        ? $custom_message
-                        : esc_html__('processed this batch: %d', 'event_espresso'),
-                $processed
-            )
-        ) . '
+			sprintf(
+				$custom_message !== ''
+						? $custom_message
+						: esc_html__('processed this batch: %d', 'event_espresso'),
+				$processed
+			)
+		) . '
 			</div>';
-    }
+	}
 
 
-    protected function displayJobFinalResults(JobParameters $job_parameters, string $custom_message = '')
-    {
-        if ($job_parameters->status() === JobParameters::status_complete) {
-            $this->feedback[] = '
+	protected function displayJobFinalResults(JobParameters $job_parameters, string $custom_message = '')
+	{
+		if ($job_parameters->status() === JobParameters::status_complete) {
+			$this->feedback[] = '
 			<div class="ee-batch-job-final-results">
 				' . $this->okWrapper(
-                sprintf(
-                    $custom_message !== ''
-                            ? $custom_message
-                            : esc_html__('total units processed: %d', 'event_espresso'),
-                    $job_parameters->units_processed()
-                )
-            ) . '
+				sprintf(
+					$custom_message !== ''
+							? $custom_message
+							: esc_html__('total units processed: %d', 'event_espresso'),
+					$job_parameters->units_processed()
+				)
+			) . '
 				' . $this->jobStatusNotice($job_parameters) . '
 			</div>';
-        }
-    }
+		}
+	}
 
 
-    protected function jobStatusNotice(JobParameters $job_parameters): string
-    {
-        switch ($job_parameters->status()) {
-            case JobParameters::status_cleaned_up:
-            case JobParameters::status_continue:
-            case JobParameters::status_pause:
-                break;
-            case JobParameters::status_complete:
-                return $this->successWrapper('job status: COMPLETE');
-            case JobParameters::status_error:
-                return $this->errorWrapper('job status: ERROR');
-        }
-        return '';
-    }
+	protected function jobStatusNotice(JobParameters $job_parameters): string
+	{
+		switch ($job_parameters->status()) {
+			case JobParameters::status_cleaned_up:
+			case JobParameters::status_continue:
+			case JobParameters::status_pause:
+				break;
+			case JobParameters::status_complete:
+				return $this->successWrapper('job status: COMPLETE');
+			case JobParameters::status_error:
+				return $this->errorWrapper('job status: ERROR');
+		}
+		return '';
+	}
 
 
-    /**
-     * @param string $update_text
-     */
-    protected function updateText(string $update_text)
-    {
-        $this->feedback[] = "<p class='ee-batch-job-update'>$update_text</p>";
-    }
+	/**
+	 * @param string $update_text
+	 */
+	protected function updateText(string $update_text)
+	{
+		$this->feedback[] = "<p class='ee-batch-job-update'>$update_text</p>";
+	}
 
 
-    protected function updateTextHeader(string $update_text)
-    {
-        $this->feedback[] = "<h4 class='ee-batch-job-update-heading'>$update_text</h4>";
-    }
+	protected function updateTextHeader(string $update_text)
+	{
+		$this->feedback[] = "<h4 class='ee-batch-job-update-heading'>$update_text</h4>";
+	}
 
 
-    protected function attentionWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--attention'>$update_text</span>";
-    }
+	protected function attentionWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--attention'>$update_text</span>";
+	}
 
 
-    protected function errorWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--error'>$update_text</span>";
-    }
+	protected function errorWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--error'>$update_text</span>";
+	}
 
 
-    protected function infoWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--info'>$update_text</span>";
-    }
+	protected function infoWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--info'>$update_text</span>";
+	}
 
 
-    protected function okWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--ok'>$update_text</span>";
-    }
+	protected function okWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--ok'>$update_text</span>";
+	}
 
 
-    protected function successWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--success'>$update_text</span>";
-    }
+	protected function successWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--success'>$update_text</span>";
+	}
 
 
-    protected function warningWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--warning'>$update_text</span>";
-    }
+	protected function warningWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--warning'>$update_text</span>";
+	}
 
 
-    /**
-     * @return string
-     */
-    protected function spinner(): string
-    {
-        return '<span class="spinner"></span>';
-    }
+	/**
+	 * @return string
+	 */
+	protected function spinner(): string
+	{
+		return '<span class="spinner"></span>';
+	}
 }