eventespresso / event-espresso-core

core/services/licensing/LicenseKeyData.php

Indentation +70 added lines, -70 removed lines

@@ -16,85 +16,85 @@
  */
 class LicenseKeyData extends WordPressOption
 {
-    /**
-     * The name of the WordPress option where license data is stored.
-     */
-    const OPTION_NAME = 'event-espresso-license-keys';
+	/**
+	 * The name of the WordPress option where license data is stored.
+	 */
+	const OPTION_NAME = 'event-espresso-license-keys';
 
-    private static array $no_license = [
-        'item_id'     => false,
-        'item_name'   => '',
-        'license'     => 'none',
-        'license_key' => '',
-        'success'     => false,
-    ];
+	private static array $no_license = [
+		'item_id'     => false,
+		'item_name'   => '',
+		'license'     => 'none',
+		'license_key' => '',
+		'success'     => false,
+	];
 
 
-    public function __construct()
-    {
-        parent::__construct(LicenseKeyData::OPTION_NAME, [], true);
-    }
+	public function __construct()
+	{
+		parent::__construct(LicenseKeyData::OPTION_NAME, [], true);
+	}
 
 
-    /**
-     * Retrieves all stored license data for all plugins.
-     *
-     * @return array An associative array of all license data, keyed by plugin identifier.
-     */
-    public function getAllLicenses(): array
-    {
-        return $this->loadOption();
-    }
+	/**
+	 * Retrieves all stored license data for all plugins.
+	 *
+	 * @return array An associative array of all license data, keyed by plugin identifier.
+	 */
+	public function getAllLicenses(): array
+	{
+		return $this->loadOption();
+	}
 
 
-    /**
-     * Retrieves the license data for a specific plugin.
-     *
-     * @param string $plugin The plugin identifier.
-     * @return stdClass An object containing the license data for the specified plugin.
-     *                       Returns a default structure if no data exists.
-     */
-    public function getLicenseDataForPlugin(string $plugin): stdCLass
-    {
-        $licenses     = $this->loadOption();
-        $license_data = $licenses[ $plugin ] ?? LicenseKeyData::$no_license;
-        return (object) $license_data;
-    }
+	/**
+	 * Retrieves the license data for a specific plugin.
+	 *
+	 * @param string $plugin The plugin identifier.
+	 * @return stdClass An object containing the license data for the specified plugin.
+	 *                       Returns a default structure if no data exists.
+	 */
+	public function getLicenseDataForPlugin(string $plugin): stdCLass
+	{
+		$licenses     = $this->loadOption();
+		$license_data = $licenses[ $plugin ] ?? LicenseKeyData::$no_license;
+		return (object) $license_data;
+	}
 
 
-    /**
-     * Updates or adds the license data for a specific plugin.
-     *
-     * @param stdClass $license_data The new license data to store.
-     * @param string   $plugin       The plugin identifier.
-     * @param bool     $force_update Whether to force the update operation.
-     * @return int The result of the update operation.
-     */
-    public function updateLicenseDataForPlugin(stdCLass $license_data, string $plugin, bool $force_update = false): int
-    {
-        if (! isset($license_data->success) || (bool) $license_data->success !== true) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        $licenses = $this->loadOption();
-        // convert objects to array and merge new data with old
-        $licenses[ $plugin ] = (array) $license_data;
-        // then sort by key and convert back to stdCLass
-        ksort($licenses[ $plugin ]);
-        $licenses[ $plugin ] = (object) $licenses[ $plugin ];
-        return $this->updateOption($licenses, $force_update);
-    }
+	/**
+	 * Updates or adds the license data for a specific plugin.
+	 *
+	 * @param stdClass $license_data The new license data to store.
+	 * @param string   $plugin       The plugin identifier.
+	 * @param bool     $force_update Whether to force the update operation.
+	 * @return int The result of the update operation.
+	 */
+	public function updateLicenseDataForPlugin(stdCLass $license_data, string $plugin, bool $force_update = false): int
+	{
+		if (! isset($license_data->success) || (bool) $license_data->success !== true) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		$licenses = $this->loadOption();
+		// convert objects to array and merge new data with old
+		$licenses[ $plugin ] = (array) $license_data;
+		// then sort by key and convert back to stdCLass
+		ksort($licenses[ $plugin ]);
+		$licenses[ $plugin ] = (object) $licenses[ $plugin ];
+		return $this->updateOption($licenses, $force_update);
+	}
 
 
-    /**
-     * Removes the license data for a specific plugin.
-     *
-     * @param string $plugin The plugin identifier.
-     * @return int The result of the remove operation.
-     */
-    public function removeLicenseDataForPlugin(string $plugin): int
-    {
-        $licenses = $this->loadOption();
-        unset($licenses[ $plugin ]);
-        return $this->updateOption($licenses);
-    }
+	/**
+	 * Removes the license data for a specific plugin.
+	 *
+	 * @param string $plugin The plugin identifier.
+	 * @return int The result of the remove operation.
+	 */
+	public function removeLicenseDataForPlugin(string $plugin): int
+	{
+		$licenses = $this->loadOption();
+		unset($licenses[ $plugin ]);
+		return $this->updateOption($licenses);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -57,7 +57,7 @@ 
     public function getLicenseDataForPlugin(string $plugin): stdCLass
     {
         $licenses     = $this->loadOption();
-        $license_data = $licenses[ $plugin ] ?? LicenseKeyData::$no_license;
+        $license_data = $licenses[$plugin] ?? LicenseKeyData::$no_license;
         return (object) $license_data;
     }
 
@@ -72,15 +72,15 @@ 
      */
     public function updateLicenseDataForPlugin(stdCLass $license_data, string $plugin, bool $force_update = false): int
     {
-        if (! isset($license_data->success) || (bool) $license_data->success !== true) {
+        if ( ! isset($license_data->success) || (bool) $license_data->success !== true) {
             return WordPressOption::UPDATE_NONE;
         }
         $licenses = $this->loadOption();
         // convert objects to array and merge new data with old
-        $licenses[ $plugin ] = (array) $license_data;
+        $licenses[$plugin] = (array) $license_data;
         // then sort by key and convert back to stdCLass
-        ksort($licenses[ $plugin ]);
-        $licenses[ $plugin ] = (object) $licenses[ $plugin ];
+        ksort($licenses[$plugin]);
+        $licenses[$plugin] = (object) $licenses[$plugin];
         return $this->updateOption($licenses, $force_update);
     }
 
@@ -94,7 +94,7 @@ 
     public function removeLicenseDataForPlugin(string $plugin): int
     {
         $licenses = $this->loadOption();
-        unset($licenses[ $plugin ]);
+        unset($licenses[$plugin]);
         return $this->updateOption($licenses);
     }
 }

core/services/licensing/PluginLicense.php

Indentation +367 added lines, -367 removed lines

@@ -17,371 +17,371 @@
  */
 class PluginLicense
 {
-    private ?LicenseKeyData $license_key_data = null;
-
-    private ?PluginUpdater $updater = null;
-
-    private string $license_key = '';
-
-    private string $mainfile;
-
-    private string $min_core_version;
-
-    private string $plugin_id;
-
-    private string $plugin_name;
-
-    private string $plugin_slug;
-
-    private string $status = '';
-
-    private string $version;
-
-    private bool $beta;
-
-    private bool $initialized = false;
-
-    private bool $wp_override;
-
-    private static array $slug_prefixes = ['ee-', 'eea-', 'eep-', 'espresso-', 'ee_', 'eea_', 'eep_', 'espresso_'];
-
-
-    public function __construct(
-        string $mainfile,
-        string $plugin_id,
-        string $plugin_name,
-        string $plugin_slug,
-        string $version,
-        bool $beta = false,
-        bool $wp_override = false,
-        string $min_core_version = ''
-    ) {
-        $this->mainfile         = $mainfile;
-        $this->plugin_id        = $plugin_id;
-        $this->plugin_name      = $plugin_name;
-        $this->version          = $version;
-        $this->beta             = $beta;
-        $this->wp_override      = $wp_override;
-        $this->plugin_slug      = $this->removePluginSlugPrefixes($plugin_slug);
-        $this->min_core_version = $min_core_version;
-    }
-
-
-    public function setHooks(): void
-    {
-        // only set hooks ONCE!
-        if ($this->initialized) {
-            return;
-        }
-        add_action('init', [$this, 'loadPluginUpdater']);
-        add_action('admin_init', [$this, 'refreshPluginLicenseData'], 99);
-        add_action(
-            'AHEE__EventEspresso_core_services_licensing_PluginLicenseCollection__loadPluginLicenses',
-            [$this, 'loadPluginLicense']
-        );
-        add_filter(
-            'FHEE__LicenseKeysAdminForm__generate__form_subsections',
-            [$this, 'addLicenseKeyFormSection']
-        );
-        add_filter(
-            'edd_sl_plugin_updater_api_params',
-            [$this, 'addCustomApiParams'],
-            10,
-            2
-        );
-        $this->initialized = true;
-    }
-
-
-    /**
-     * removes unnecessary prefixes from plugin slugs
-     *
-     * @param string $plugin_slug
-     * @return string
-     */
-    private function removePluginSlugPrefixes(string $plugin_slug): string
-    {
-        foreach (self::$slug_prefixes as $slug_prefix) {
-            if (strpos($plugin_slug, $slug_prefix) === 0) {
-                $plugin_slug = str_replace($slug_prefix, '', $plugin_slug);
-            }
-        }
-        return $plugin_slug;
-    }
-
-
-    /**
-     * @return PluginUpdater|null
-     */
-    public function updater(): ?PluginUpdater
-    {
-        return $this->updater;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function itemID(): string
-    {
-        return $this->plugin_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function itemName(): string
-    {
-        return $this->plugin_name;
-    }
-
-
-    private function getLicenseKeyData(): stdClass
-    {
-        if (! $this->license_key_data instanceof LicenseKeyData) {
-            $this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
-        }
-        return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function hasLicenseKey(): bool
-    {
-        return ! empty($this->license_key);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isMissingLicenseKey(): bool
-    {
-        return empty($this->license_key);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function licenseKey(): string
-    {
-        return $this->license_key;
-    }
-
-
-    /**
-     * !!! IMPORTANT !!!
-     * This method only sets the license key for this plugin,
-     * it does not persist the change to the database.
-     * To persist the change, use LicenseKeyData::updateLicenseDataForPlugin(),
-     * or call one of the methods on LicenseManager
-     * which will also send the change to EDD on the server.
-     *
-     * @param string $license_key
-     */
-    public function setLicenseKey(string $license_key): void
-    {
-        $this->license_key = sanitize_text_field($license_key);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function mainfile(): string
-    {
-        return $this->mainfile;
-    }
-
-
-    /**
-     * @return string
-     * @since 5.0.20.p
-     */
-    public function minCoreVersion(): string
-    {
-        return $this->min_core_version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginSlug(): string
-    {
-        return $this->plugin_slug;
-    }
-
-
-    public function status(): string
-    {
-        return $this->status;
-    }
-
-
-    public function setStatus(string $status): void
-    {
-        $this->status = $status;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function version(): string
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBeta(): bool
-    {
-        return $this->beta;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWpOverride(): bool
-    {
-        return $this->wp_override;
-    }
-
-
-    public function loadPluginUpdater()
-    {
-        // To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
-        if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
-            return;
-        }
-
-        $license_data = $this->getLicenseKeyData();
-        $license_key  = $license_data->license_key ?? '';
-        if ($license_key && $this->isMissingLicenseKey()) {
-            $this->setLicenseKey($license_key);
-        }
-
-        $this->updater = new PluginUpdater(
-            LicenseAPI::url(),
-            $this->mainfile(),
-            [
-                'author'      => LicenseAPI::AUTHOR,
-                'beta'        => $this->isBeta(),
-                'item_id'     => $this->itemID(),
-                'item_name'   => $this->itemName(),
-                'license'     => $this->licenseKey(),
-                'version'     => $this->version(),
-                'wp_override' => $this->isWpOverride(),
-            ]
-        );
-    }
-
-
-    public function loadPluginLicense(PluginLicenseCollection $plugin_license_collection)
-    {
-        $plugin_license_collection->add($this, $this->pluginSlug());
-    }
-
-
-    public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
-    {
-        if (is_main_site()) {
-            $license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
-                LicenseKeyFormInput::class,
-                [$this]
-            );
-        }
-        return $license_keys_form_subsections;
-    }
-
-
-    public function addCustomApiParams($api_params, $api_data)
-    {
-        if ($api_data['item_name'] === $this->itemName()) {
-            $api_params['event_espresso_core_version'] = EVENT_ESPRESSO_VERSION;
-            $core_license                              =
-                $this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
-            if (! empty($core_license->license_key)) {
-                $api_params['event_espresso_core_license'] = $core_license->license_key;
-            }
-        }
-        return $api_params;
-    }
-
-
-    /**
-     * updates the license key and status for this plugin
-     * using the license data previously saved in the database
-     *
-     * @return void
-     * @since 5.0.40.p
-     */
-    public function refreshPluginLicenseData()
-    {
-        $license_data = $this->getLicenseKeyData();
-        $update       = ! isset($license_data->license) || $license_data->license === 'none';
-        $license_key  = $license_data->license_key ?? '';
-        if ($this->isMissingLicenseKey()) {
-            if (! $license_key) {
-                $core_license = $this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
-                if ($core_license->license_key && $core_license->license === LicenseStatus::VALID) {
-                    $license_key = $core_license->license_key;
-                    $update      = true;
-                } else {
-                    $network_config = $this->getNetworkConfig();
-                    if (! empty($network_config->core->site_license_key)) {
-                        $license_key = $network_config->core->site_license_key;
-                        $update      = true;
-                    }
-                }
-            }
-            if ($license_key) {
-                $this->setLicenseKey($license_key);
-            }
-        }
-        $license_status = $license_data->license ?? '';
-        if ($license_status && empty($this->status)) {
-            $this->setStatus($license_status);
-        }
-        if ($update && $this->hasLicenseKey()) {
-            $licence_manager = $this->getLicenseManager();
-            $licence_manager->checkLicense(
-                $this->licenseKey(),
-                $this->itemID(),
-                $this->itemName(),
-                $this->pluginSlug(),
-                $this->version(),
-                $this->minCoreVersion(),
-                $this->status()
-            );
-        }
-    }
-
-
-    private function getNetworkConfig(): EE_Network_Config
-    {
-        static $network_config = null;
-        if (! $network_config instanceof EE_Network_Config) {
-            $network_config = LoaderFactory::getShared(EE_Network_Config::class);
-        }
-        return $network_config;
-    }
-
-
-    private function getLicenseManager(): LicenseManager
-    {
-        static $licence_manager = null;
-        if (! $licence_manager instanceof LicenseManager) {
-            $licence_manager = LoaderFactory::getShared(LicenseManager::class);
-        }
-        return $licence_manager;
-    }
+	private ?LicenseKeyData $license_key_data = null;
+
+	private ?PluginUpdater $updater = null;
+
+	private string $license_key = '';
+
+	private string $mainfile;
+
+	private string $min_core_version;
+
+	private string $plugin_id;
+
+	private string $plugin_name;
+
+	private string $plugin_slug;
+
+	private string $status = '';
+
+	private string $version;
+
+	private bool $beta;
+
+	private bool $initialized = false;
+
+	private bool $wp_override;
+
+	private static array $slug_prefixes = ['ee-', 'eea-', 'eep-', 'espresso-', 'ee_', 'eea_', 'eep_', 'espresso_'];
+
+
+	public function __construct(
+		string $mainfile,
+		string $plugin_id,
+		string $plugin_name,
+		string $plugin_slug,
+		string $version,
+		bool $beta = false,
+		bool $wp_override = false,
+		string $min_core_version = ''
+	) {
+		$this->mainfile         = $mainfile;
+		$this->plugin_id        = $plugin_id;
+		$this->plugin_name      = $plugin_name;
+		$this->version          = $version;
+		$this->beta             = $beta;
+		$this->wp_override      = $wp_override;
+		$this->plugin_slug      = $this->removePluginSlugPrefixes($plugin_slug);
+		$this->min_core_version = $min_core_version;
+	}
+
+
+	public function setHooks(): void
+	{
+		// only set hooks ONCE!
+		if ($this->initialized) {
+			return;
+		}
+		add_action('init', [$this, 'loadPluginUpdater']);
+		add_action('admin_init', [$this, 'refreshPluginLicenseData'], 99);
+		add_action(
+			'AHEE__EventEspresso_core_services_licensing_PluginLicenseCollection__loadPluginLicenses',
+			[$this, 'loadPluginLicense']
+		);
+		add_filter(
+			'FHEE__LicenseKeysAdminForm__generate__form_subsections',
+			[$this, 'addLicenseKeyFormSection']
+		);
+		add_filter(
+			'edd_sl_plugin_updater_api_params',
+			[$this, 'addCustomApiParams'],
+			10,
+			2
+		);
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * removes unnecessary prefixes from plugin slugs
+	 *
+	 * @param string $plugin_slug
+	 * @return string
+	 */
+	private function removePluginSlugPrefixes(string $plugin_slug): string
+	{
+		foreach (self::$slug_prefixes as $slug_prefix) {
+			if (strpos($plugin_slug, $slug_prefix) === 0) {
+				$plugin_slug = str_replace($slug_prefix, '', $plugin_slug);
+			}
+		}
+		return $plugin_slug;
+	}
+
+
+	/**
+	 * @return PluginUpdater|null
+	 */
+	public function updater(): ?PluginUpdater
+	{
+		return $this->updater;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function itemID(): string
+	{
+		return $this->plugin_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function itemName(): string
+	{
+		return $this->plugin_name;
+	}
+
+
+	private function getLicenseKeyData(): stdClass
+	{
+		if (! $this->license_key_data instanceof LicenseKeyData) {
+			$this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
+		}
+		return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function hasLicenseKey(): bool
+	{
+		return ! empty($this->license_key);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isMissingLicenseKey(): bool
+	{
+		return empty($this->license_key);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function licenseKey(): string
+	{
+		return $this->license_key;
+	}
+
+
+	/**
+	 * !!! IMPORTANT !!!
+	 * This method only sets the license key for this plugin,
+	 * it does not persist the change to the database.
+	 * To persist the change, use LicenseKeyData::updateLicenseDataForPlugin(),
+	 * or call one of the methods on LicenseManager
+	 * which will also send the change to EDD on the server.
+	 *
+	 * @param string $license_key
+	 */
+	public function setLicenseKey(string $license_key): void
+	{
+		$this->license_key = sanitize_text_field($license_key);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function mainfile(): string
+	{
+		return $this->mainfile;
+	}
+
+
+	/**
+	 * @return string
+	 * @since 5.0.20.p
+	 */
+	public function minCoreVersion(): string
+	{
+		return $this->min_core_version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginSlug(): string
+	{
+		return $this->plugin_slug;
+	}
+
+
+	public function status(): string
+	{
+		return $this->status;
+	}
+
+
+	public function setStatus(string $status): void
+	{
+		$this->status = $status;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function version(): string
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBeta(): bool
+	{
+		return $this->beta;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWpOverride(): bool
+	{
+		return $this->wp_override;
+	}
+
+
+	public function loadPluginUpdater()
+	{
+		// To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
+		if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
+			return;
+		}
+
+		$license_data = $this->getLicenseKeyData();
+		$license_key  = $license_data->license_key ?? '';
+		if ($license_key && $this->isMissingLicenseKey()) {
+			$this->setLicenseKey($license_key);
+		}
+
+		$this->updater = new PluginUpdater(
+			LicenseAPI::url(),
+			$this->mainfile(),
+			[
+				'author'      => LicenseAPI::AUTHOR,
+				'beta'        => $this->isBeta(),
+				'item_id'     => $this->itemID(),
+				'item_name'   => $this->itemName(),
+				'license'     => $this->licenseKey(),
+				'version'     => $this->version(),
+				'wp_override' => $this->isWpOverride(),
+			]
+		);
+	}
+
+
+	public function loadPluginLicense(PluginLicenseCollection $plugin_license_collection)
+	{
+		$plugin_license_collection->add($this, $this->pluginSlug());
+	}
+
+
+	public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
+	{
+		if (is_main_site()) {
+			$license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
+				LicenseKeyFormInput::class,
+				[$this]
+			);
+		}
+		return $license_keys_form_subsections;
+	}
+
+
+	public function addCustomApiParams($api_params, $api_data)
+	{
+		if ($api_data['item_name'] === $this->itemName()) {
+			$api_params['event_espresso_core_version'] = EVENT_ESPRESSO_VERSION;
+			$core_license                              =
+				$this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
+			if (! empty($core_license->license_key)) {
+				$api_params['event_espresso_core_license'] = $core_license->license_key;
+			}
+		}
+		return $api_params;
+	}
+
+
+	/**
+	 * updates the license key and status for this plugin
+	 * using the license data previously saved in the database
+	 *
+	 * @return void
+	 * @since 5.0.40.p
+	 */
+	public function refreshPluginLicenseData()
+	{
+		$license_data = $this->getLicenseKeyData();
+		$update       = ! isset($license_data->license) || $license_data->license === 'none';
+		$license_key  = $license_data->license_key ?? '';
+		if ($this->isMissingLicenseKey()) {
+			if (! $license_key) {
+				$core_license = $this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
+				if ($core_license->license_key && $core_license->license === LicenseStatus::VALID) {
+					$license_key = $core_license->license_key;
+					$update      = true;
+				} else {
+					$network_config = $this->getNetworkConfig();
+					if (! empty($network_config->core->site_license_key)) {
+						$license_key = $network_config->core->site_license_key;
+						$update      = true;
+					}
+				}
+			}
+			if ($license_key) {
+				$this->setLicenseKey($license_key);
+			}
+		}
+		$license_status = $license_data->license ?? '';
+		if ($license_status && empty($this->status)) {
+			$this->setStatus($license_status);
+		}
+		if ($update && $this->hasLicenseKey()) {
+			$licence_manager = $this->getLicenseManager();
+			$licence_manager->checkLicense(
+				$this->licenseKey(),
+				$this->itemID(),
+				$this->itemName(),
+				$this->pluginSlug(),
+				$this->version(),
+				$this->minCoreVersion(),
+				$this->status()
+			);
+		}
+	}
+
+
+	private function getNetworkConfig(): EE_Network_Config
+	{
+		static $network_config = null;
+		if (! $network_config instanceof EE_Network_Config) {
+			$network_config = LoaderFactory::getShared(EE_Network_Config::class);
+		}
+		return $network_config;
+	}
+
+
+	private function getLicenseManager(): LicenseManager
+	{
+		static $licence_manager = null;
+		if (! $licence_manager instanceof LicenseManager) {
+			$licence_manager = LoaderFactory::getShared(LicenseManager::class);
+		}
+		return $licence_manager;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -139,7 +139,7 @@ 
 
     private function getLicenseKeyData(): stdClass
     {
-        if (! $this->license_key_data instanceof LicenseKeyData) {
+        if ( ! $this->license_key_data instanceof LicenseKeyData) {
             $this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
         }
         return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
@@ -259,7 +259,7 @@ 
     public function loadPluginUpdater()
     {
         // To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
-        if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
+        if ( ! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
             return;
         }
 
@@ -294,7 +294,7 @@ 
     public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
     {
         if (is_main_site()) {
-            $license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
+            $license_keys_form_subsections[$this->pluginSlug()] = LoaderFactory::getNew(
                 LicenseKeyFormInput::class,
                 [$this]
             );
@@ -309,7 +309,7 @@ 
             $api_params['event_espresso_core_version'] = EVENT_ESPRESSO_VERSION;
             $core_license                              =
                 $this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
-            if (! empty($core_license->license_key)) {
+            if ( ! empty($core_license->license_key)) {
                 $api_params['event_espresso_core_license'] = $core_license->license_key;
             }
         }
@@ -330,14 +330,14 @@ 
         $update       = ! isset($license_data->license) || $license_data->license === 'none';
         $license_key  = $license_data->license_key ?? '';
         if ($this->isMissingLicenseKey()) {
-            if (! $license_key) {
+            if ( ! $license_key) {
                 $core_license = $this->license_key_data->getLicenseDataForPlugin(Domain::LICENSE_PLUGIN_SLUG);
                 if ($core_license->license_key && $core_license->license === LicenseStatus::VALID) {
                     $license_key = $core_license->license_key;
                     $update      = true;
                 } else {
                     $network_config = $this->getNetworkConfig();
-                    if (! empty($network_config->core->site_license_key)) {
+                    if ( ! empty($network_config->core->site_license_key)) {
                         $license_key = $network_config->core->site_license_key;
                         $update      = true;
                     }
@@ -369,7 +369,7 @@ 
     private function getNetworkConfig(): EE_Network_Config
     {
         static $network_config = null;
-        if (! $network_config instanceof EE_Network_Config) {
+        if ( ! $network_config instanceof EE_Network_Config) {
             $network_config = LoaderFactory::getShared(EE_Network_Config::class);
         }
         return $network_config;
@@ -379,7 +379,7 @@ 
     private function getLicenseManager(): LicenseManager
     {
         static $licence_manager = null;
-        if (! $licence_manager instanceof LicenseManager) {
+        if ( ! $licence_manager instanceof LicenseManager) {
             $licence_manager = LoaderFactory::getShared(LicenseManager::class);
         }
         return $licence_manager;

core/services/licensing/LicenseManager.php

Indentation +159 added lines, -159 removed lines

@@ -6,163 +6,163 @@
 
 class LicenseManager
 {
-    private LicenseAPI $license_api;
-
-    private LicenseKeyData $license_key_data;
-
-    private PluginLicenseCollection $plugin_license_collection;
-
-
-    public function __construct(
-        LicenseAPI $license_api,
-        LicenseKeyData $license_key_data,
-        PluginLicenseCollection $plugin_license_collection
-    ) {
-        $this->license_api               = $license_api;
-        $this->license_key_data          = $license_key_data;
-        $this->plugin_license_collection = $plugin_license_collection;
-    }
-
-
-    public function activateLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = ''
-    ): stdCLass {
-        $license_data = $this->license_api->postRequest(
-            LicenseAPI::ACTION_ACTIVATE,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        return $this->updateLicenseData(
-            $plugin_slug,
-            $license_key,
-            $license_data,
-            $license_data->license ?? '',
-            true
-        );
-    }
-
-
-    public function deactivateLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = ''
-    ): stdCLass {
-        $license_data = $this->license_api->postRequest(
-            LicenseAPI::ACTION_DEACTIVATE,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        $this->license_key_data->removeLicenseDataForPlugin($plugin_slug);
-        return $license_data;
-    }
-
-
-    public function resetLicenseKey(string $plugin_slug): stdCLass
-    {
-        $license_data              = $this->getLicenseData($plugin_slug);
-        $license_data->license_key = '';
-        $this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug, true);
-        return $license_data;
-    }
-
-
-    public function checkLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = '',
-        string $license_status = ''
-    ): stdCLass {
-        $license_data = $this->license_api->postRequest(
-            LicenseAPI::ACTION_CHECK,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        return $this->updateLicenseData(
-            $plugin_slug,
-            $license_key,
-            $license_data,
-            $license_status
-        );
-    }
-
-
-    public function getLicenseData(string $plugin_slug): stdClass
-    {
-        return $this->license_key_data->getLicenseDataForPlugin($plugin_slug);
-    }
-
-
-    public function getVersionInfo(): stdClass
-    {
-        $products = [];
-        foreach ($this->plugin_license_collection as $plugin_license) {
-            if (! $plugin_license instanceof PluginLicense) {
-                continue;
-            }
-            $products[ $plugin_license->pluginSlug() ] = [
-                'item_id' => $plugin_license->itemId(),
-                'license' => $plugin_license->licenseKey(),
-                'url'     => LicenseAPI::url(),
-            ];
-        }
-        return $this->license_api->getProductVersions($products);
-    }
-
-
-    /**
-     * @param string   $plugin_slug
-     * @param string   $license_key
-     * @param stdClass $license_data
-     * @param string   $license_status
-     * @param bool     $force_update    true for license activation requests
-     * @return stdClass
-     * @since 5.0.40.p
-     */
-    private function updateLicenseData(
-        string $plugin_slug,
-        string $license_key,
-        stdClass $license_data,
-        string $license_status = '',
-        bool $force_update = false
-    ): stdClass {
-        if (! isset($license_data->license_key)) {
-            $license_data->license_key = $license_key;
-        }
-        // if the license key or license status has changed, then update the license data
-        $success = $license_data->success ?? false;
-        if (
-            $success
-            && (
-                $force_update
-                || (
-                    (! empty($license_data->license_key) && $license_data->license_key !== $license_key)
-                    || (! empty($license_data->license) && $license_data->license !== $license_status)
-                )
-            )
-        ) {
-            $this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug);
-        }
-
-        return $license_data;
-    }
+	private LicenseAPI $license_api;
+
+	private LicenseKeyData $license_key_data;
+
+	private PluginLicenseCollection $plugin_license_collection;
+
+
+	public function __construct(
+		LicenseAPI $license_api,
+		LicenseKeyData $license_key_data,
+		PluginLicenseCollection $plugin_license_collection
+	) {
+		$this->license_api               = $license_api;
+		$this->license_key_data          = $license_key_data;
+		$this->plugin_license_collection = $plugin_license_collection;
+	}
+
+
+	public function activateLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = ''
+	): stdCLass {
+		$license_data = $this->license_api->postRequest(
+			LicenseAPI::ACTION_ACTIVATE,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		return $this->updateLicenseData(
+			$plugin_slug,
+			$license_key,
+			$license_data,
+			$license_data->license ?? '',
+			true
+		);
+	}
+
+
+	public function deactivateLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = ''
+	): stdCLass {
+		$license_data = $this->license_api->postRequest(
+			LicenseAPI::ACTION_DEACTIVATE,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		$this->license_key_data->removeLicenseDataForPlugin($plugin_slug);
+		return $license_data;
+	}
+
+
+	public function resetLicenseKey(string $plugin_slug): stdCLass
+	{
+		$license_data              = $this->getLicenseData($plugin_slug);
+		$license_data->license_key = '';
+		$this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug, true);
+		return $license_data;
+	}
+
+
+	public function checkLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = '',
+		string $license_status = ''
+	): stdCLass {
+		$license_data = $this->license_api->postRequest(
+			LicenseAPI::ACTION_CHECK,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		return $this->updateLicenseData(
+			$plugin_slug,
+			$license_key,
+			$license_data,
+			$license_status
+		);
+	}
+
+
+	public function getLicenseData(string $plugin_slug): stdClass
+	{
+		return $this->license_key_data->getLicenseDataForPlugin($plugin_slug);
+	}
+
+
+	public function getVersionInfo(): stdClass
+	{
+		$products = [];
+		foreach ($this->plugin_license_collection as $plugin_license) {
+			if (! $plugin_license instanceof PluginLicense) {
+				continue;
+			}
+			$products[ $plugin_license->pluginSlug() ] = [
+				'item_id' => $plugin_license->itemId(),
+				'license' => $plugin_license->licenseKey(),
+				'url'     => LicenseAPI::url(),
+			];
+		}
+		return $this->license_api->getProductVersions($products);
+	}
+
+
+	/**
+	 * @param string   $plugin_slug
+	 * @param string   $license_key
+	 * @param stdClass $license_data
+	 * @param string   $license_status
+	 * @param bool     $force_update    true for license activation requests
+	 * @return stdClass
+	 * @since 5.0.40.p
+	 */
+	private function updateLicenseData(
+		string $plugin_slug,
+		string $license_key,
+		stdClass $license_data,
+		string $license_status = '',
+		bool $force_update = false
+	): stdClass {
+		if (! isset($license_data->license_key)) {
+			$license_data->license_key = $license_key;
+		}
+		// if the license key or license status has changed, then update the license data
+		$success = $license_data->success ?? false;
+		if (
+			$success
+			&& (
+				$force_update
+				|| (
+					(! empty($license_data->license_key) && $license_data->license_key !== $license_key)
+					|| (! empty($license_data->license) && $license_data->license !== $license_status)
+				)
+			)
+		) {
+			$this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug);
+		}
+
+		return $license_data;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -116,10 +116,10 @@ 
     {
         $products = [];
         foreach ($this->plugin_license_collection as $plugin_license) {
-            if (! $plugin_license instanceof PluginLicense) {
+            if ( ! $plugin_license instanceof PluginLicense) {
                 continue;
             }
-            $products[ $plugin_license->pluginSlug() ] = [
+            $products[$plugin_license->pluginSlug()] = [
                 'item_id' => $plugin_license->itemId(),
                 'license' => $plugin_license->licenseKey(),
                 'url'     => LicenseAPI::url(),
@@ -145,7 +145,7 @@ 
         string $license_status = '',
         bool $force_update = false
     ): stdClass {
-        if (! isset($license_data->license_key)) {
+        if ( ! isset($license_data->license_key)) {
             $license_data->license_key = $license_key;
         }
         // if the license key or license status has changed, then update the license data
@@ -155,8 +155,8 @@ 
             && (
                 $force_update
                 || (
-                    (! empty($license_data->license_key) && $license_data->license_key !== $license_key)
-                    || (! empty($license_data->license) && $license_data->license !== $license_status)
+                    ( ! empty($license_data->license_key) && $license_data->license_key !== $license_key)
+                    || ( ! empty($license_data->license) && $license_data->license !== $license_status)
                 )
             )
         ) {

core/services/licensing/AddonLicense.php

Indentation +54 added lines, -54 removed lines

@@ -18,64 +18,64 @@
  */
 class AddonLicense
 {
-    public static function register(string $addon_name, array $license_data)
-    {
-        if (! $addon_name || ! $license_data) {
-            return;
-        }
-        // also bail if the feature flag is not enabled
-        $feature = LoaderFactory::getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
-            return;
-        }
-        $main_file_path = $license_data['main_file_path'] ?? '';
-        $main_file_slug = AddonLicense::derivePluginSlugFromMainFile($main_file_path);
-        // use values from addon IF SET
-        $plugin_slug = $license_data['plugin_slug'] ?? '';
-        $plugin_id   =  $license_data['plugin_id'] ?? 0;
-        $plugin_name =  $license_data['plugin_name'] ?? '';
+	public static function register(string $addon_name, array $license_data)
+	{
+		if (! $addon_name || ! $license_data) {
+			return;
+		}
+		// also bail if the feature flag is not enabled
+		$feature = LoaderFactory::getShared(FeatureFlags::class);
+		if (! $feature->allowed('use_edd_plugin_licensing')) {
+			return;
+		}
+		$main_file_path = $license_data['main_file_path'] ?? '';
+		$main_file_slug = AddonLicense::derivePluginSlugFromMainFile($main_file_path);
+		// use values from addon IF SET
+		$plugin_slug = $license_data['plugin_slug'] ?? '';
+		$plugin_id   =  $license_data['plugin_id'] ?? 0;
+		$plugin_name =  $license_data['plugin_name'] ?? '';
 
-        // if the plugin ID has been set to ZERO, then we are using a pre-EDD plugin,
-        // so use the plugin slug derived from the main file path.
-        // also try to derive the plugin ID and name from the plugin slug.
-        // set the plugin name first else we can't check if plugin id is 0 !!!
-        $plugin_slug = $plugin_id && $plugin_slug ? $plugin_slug : $main_file_slug;
-        $plugin_name = $plugin_id && $plugin_name ? $plugin_name : AddonEddData::getPluginItemName($main_file_slug);
-        $plugin_id   = $plugin_id ?: AddonEddData::getPluginItemID($main_file_slug);
+		// if the plugin ID has been set to ZERO, then we are using a pre-EDD plugin,
+		// so use the plugin slug derived from the main file path.
+		// also try to derive the plugin ID and name from the plugin slug.
+		// set the plugin name first else we can't check if plugin id is 0 !!!
+		$plugin_slug = $plugin_id && $plugin_slug ? $plugin_slug : $main_file_slug;
+		$plugin_name = $plugin_id && $plugin_name ? $plugin_name : AddonEddData::getPluginItemName($main_file_slug);
+		$plugin_id   = $plugin_id ?: AddonEddData::getPluginItemID($main_file_slug);
 
-        // ensure defaults are set
-        $license_data = [
-            'beta'             => false,
-            'main_file_path'   => $license_data['main_file_path'] ?? '',
-            'min_core_version' => $license_data['min_core_version'] ?? '',
-            'plugin_id'        => $plugin_id,
-            'plugin_name'      => $plugin_name,
-            'plugin_slug'      => $plugin_slug,
-            'version'          => $license_data['version'],
-            'wp_override'      => false,
-        ];
+		// ensure defaults are set
+		$license_data = [
+			'beta'             => false,
+			'main_file_path'   => $license_data['main_file_path'] ?? '',
+			'min_core_version' => $license_data['min_core_version'] ?? '',
+			'plugin_id'        => $plugin_id,
+			'plugin_name'      => $plugin_name,
+			'plugin_slug'      => $plugin_slug,
+			'version'          => $license_data['version'],
+			'wp_override'      => false,
+		];
 
-        // Bail if we still don't have a plugin ID.
-        if (empty($license_data['plugin_id'])) {
-            return;
-        }
+		// Bail if we still don't have a plugin ID.
+		if (empty($license_data['plugin_id'])) {
+			return;
+		}
 
-        $addon_license = new PluginLicense(
-            $license_data['main_file_path'],
-            $license_data['plugin_id'],
-            $license_data['plugin_name'],
-            $license_data['plugin_slug'],
-            $license_data['version'],
-            $license_data['beta'],
-            $license_data['wp_override'],
-            $license_data['min_core_version']
-        );
-        $addon_license->setHooks();
-    }
+		$addon_license = new PluginLicense(
+			$license_data['main_file_path'],
+			$license_data['plugin_id'],
+			$license_data['plugin_name'],
+			$license_data['plugin_slug'],
+			$license_data['version'],
+			$license_data['beta'],
+			$license_data['wp_override'],
+			$license_data['min_core_version']
+		);
+		$addon_license->setHooks();
+	}
 
 
-    private static function derivePluginSlugFromMainFile(string $main_file_path): string
-    {
-        return wp_basename($main_file_path, '.php');
-    }
+	private static function derivePluginSlugFromMainFile(string $main_file_path): string
+	{
+		return wp_basename($main_file_path, '.php');
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -20,20 +20,20 @@
 {
     public static function register(string $addon_name, array $license_data)
     {
-        if (! $addon_name || ! $license_data) {
+        if ( ! $addon_name || ! $license_data) {
             return;
         }
         // also bail if the feature flag is not enabled
         $feature = LoaderFactory::getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
+        if ( ! $feature->allowed('use_edd_plugin_licensing')) {
             return;
         }
         $main_file_path = $license_data['main_file_path'] ?? '';
         $main_file_slug = AddonLicense::derivePluginSlugFromMainFile($main_file_path);
         // use values from addon IF SET
         $plugin_slug = $license_data['plugin_slug'] ?? '';
-        $plugin_id   =  $license_data['plugin_id'] ?? 0;
-        $plugin_name =  $license_data['plugin_name'] ?? '';
+        $plugin_id   = $license_data['plugin_id'] ?? 0;
+        $plugin_name = $license_data['plugin_name'] ?? '';
 
         // if the plugin ID has been set to ZERO, then we are using a pre-EDD plugin,
         // so use the plugin slug derived from the main file path.

core/services/routing/Router.php

Indentation +225 added lines, -225 removed lines

@@ -30,249 +30,249 @@
  */
 class Router
 {
-    protected EE_Dependency_Map $dependency_map;
+	protected EE_Dependency_Map $dependency_map;
 
-    protected LoaderInterface $loader;
+	protected LoaderInterface $loader;
 
-    protected RouteHandler $route_handler;
+	protected RouteHandler $route_handler;
 
-    protected string $route_request_type;
+	protected string $route_request_type;
 
-    protected array $routes_loaded;
+	protected array $routes_loaded;
 
 
-    /**
-     * RoutingSwitch constructor.
-     *
-     * @param EE_Dependency_Map $dependency_map
-     * @param LoaderInterface   $loader
-     * @param RouteHandler      $router
-     */
-    public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader, RouteHandler $router)
-    {
-        $this->dependency_map = $dependency_map;
-        $this->loader         = $loader;
-        $this->route_handler  = $router;
-    }
+	/**
+	 * RoutingSwitch constructor.
+	 *
+	 * @param EE_Dependency_Map $dependency_map
+	 * @param LoaderInterface   $loader
+	 * @param RouteHandler      $router
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader, RouteHandler $router)
+	{
+		$this->dependency_map = $dependency_map;
+		$this->loader         = $loader;
+		$this->route_handler  = $router;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function loadPrimaryRoutes()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests',
-            Route::getFullDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests',
-            Route::getFullDependencies()
-        );
-        // now load and prep all primary Routes
-        $this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests');
-        $this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests');
-        $this->route_request_type = $this->route_handler->getRouteRequestType();
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__loadPrimaryRoutes',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function loadPrimaryRoutes()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests',
+			Route::getFullDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests',
+			Route::getFullDependencies()
+		);
+		// now load and prep all primary Routes
+		$this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\admin\ActivationRequests');
+		$this->route_handler->addRoute('EventEspresso\core\domain\entities\routing\handlers\shared\RegularRequests');
+		$this->route_request_type = $this->route_handler->getRouteRequestType();
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__loadPrimaryRoutes',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function registerShortcodesModulesAndWidgets()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__registerShortcodesModulesAndWidgets',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function registerShortcodesModulesAndWidgets()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__registerShortcodesModulesAndWidgets',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
 
-        /** @var LegacyModulesManager $legacy_modules_manager */
-        $legacy_modules_manager = $this->loader->getShared(LegacyModulesManager::class);
-        $legacy_modules_manager->setHooks();
+		/** @var LegacyModulesManager $legacy_modules_manager */
+		$legacy_modules_manager = $this->loader->getShared(LegacyModulesManager::class);
+		$legacy_modules_manager->setHooks();
 
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\frontend\ShortcodeRequests'
-                );
-                /** @var LegacyWidgetsManager $legacy_widgets_manager */
-                $legacy_widgets_manager = $this->loader->getShared(LegacyWidgetsManager::class);
-                $legacy_widgets_manager->setHooks();
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\frontend\ShortcodeRequests'
+				);
+				/** @var LegacyWidgetsManager $legacy_widgets_manager */
+				$legacy_widgets_manager = $this->loader->getShared(LegacyWidgetsManager::class);
+				$legacy_widgets_manager->setHooks();
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function brewEspresso()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__brewEspresso',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\GQLRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\RestApiRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function brewEspresso()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__brewEspresso',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\GQLRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\RestApiRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function loadControllers()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__loadControllers',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        $this->route_handler->addRoute(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute'
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\services\licensing\LicenseKeyActivationRoute'
-                );
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\frontend\FrontendRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\frontend\RegistrationCheckoutRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoLegacyAdmin'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventsAdmin'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventEditor'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\GutenbergEditor'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\NonEspressoAdminAjax'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressProfilePage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPostsPage'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\WordPressHeartbeat'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoBatchJob'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function loadControllers()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__loadControllers',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		$this->route_handler->addRoute(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute'
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\services\licensing\LicenseKeyActivationRoute'
+				);
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\frontend\FrontendRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\frontend\RegistrationCheckoutRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoLegacyAdmin'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventsAdmin'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoEventEditor'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\GutenbergEditor'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\NonEspressoAdminAjax'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressProfilePage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPostsPage'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\WordPressHeartbeat'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\EspressoBatchJob'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function coreLoadedAndReady()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__coreLoadedAndReady',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\AssetRequests'
-                );
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\shared\SessionRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function coreLoadedAndReady()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__coreLoadedAndReady',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\AssetRequests'
+				);
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\shared\SessionRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 
 
-    /**
-     * @throws Exception|Throwable
-     */
-    public function initializeLast()
-    {
-        if (isset($this->routes_loaded[ __FUNCTION__ ])) {
-            return;
-        }
-        do_action(
-            'AHEE__EventEspresso_core_services_routing_Router__initializeLast',
-            $this->route_handler,
-            $this->route_request_type,
-            $this->dependency_map
-        );
-        switch ($this->route_request_type) {
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
-                break;
-            case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
-                $this->route_handler->addRoute(
-                    'EventEspresso\core\domain\entities\routing\handlers\admin\PersonalDataRequests'
-                );
-                break;
-        }
-        $this->routes_loaded[ __FUNCTION__ ] = true;
-    }
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function initializeLast()
+	{
+		if (isset($this->routes_loaded[ __FUNCTION__ ])) {
+			return;
+		}
+		do_action(
+			'AHEE__EventEspresso_core_services_routing_Router__initializeLast',
+			$this->route_handler,
+			$this->route_request_type,
+			$this->dependency_map
+		);
+		switch ($this->route_request_type) {
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION:
+				break;
+			case PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR:
+				$this->route_handler->addRoute(
+					'EventEspresso\core\domain\entities\routing\handlers\admin\PersonalDataRequests'
+				);
+				break;
+		}
+		$this->routes_loaded[ __FUNCTION__ ] = true;
+	}
 }

core/services/payments/PaymentProcessorFees.php

Indentation +158 added lines, -158 removed lines

@@ -28,162 +28,162 @@
  */
 class PaymentProcessorFees
 {
-    public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
-
-    public const  GATEWAY_SQUARE  = 'Square';
-
-    public const  GATEWAY_STRIPE  = 'Stripe';
-
-    private GracePeriod $grace_period;
-
-    private LicenseData $license_data;
-
-    /**
-     * @var float[][] $gateway_fees
-     */
-    private array $gateway_fees = [
-        LicenseStatus::ACTIVE  => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
-        ],
-        LicenseStatus::EXPIRED => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
-        ],
-        LicenseStatus::DECAF   => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
-        ],
-    ];
-
-    private array $partner_gateways = [
-        PaymentProcessorFees::GATEWAY_PAYPAL,
-        PaymentProcessorFees::GATEWAY_SQUARE,
-        PaymentProcessorFees::GATEWAY_STRIPE,
-    ];
-
-
-    /**
-     * @param GracePeriod $grace_period
-     * @param LicenseData $license_data
-     */
-    public function __construct(GracePeriod $grace_period, LicenseData $license_data)
-    {
-        $this->grace_period = $grace_period;
-        $this->license_data = $license_data;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @param string         $payment_method_name
-     * @param float          $amount
-     * @return float
-     * @throws EE_Error|ReflectionException|RuntimeException
-     * @throws Exception
-     */
-    public function applyGatewayPartnerFees(
-        EE_Transaction $transaction,
-        string $payment_method_name,
-        float $amount = 0.00
-    ): float {
-        $processing_fee = $this->forPaymentMethod($payment_method_name);
-        if ($processing_fee <= 0.00) {
-            return $amount;
-        }
-        $grand_total = $transaction->total_line_item(false);
-        if (
-            ! $grand_total instanceof EE_Line_Item
-            || ! $grand_total->is_total()
-            || $grand_total->TXN_ID() !== $transaction->ID()
-        ) {
-            // throw RuntimeException if total_line_item is not a total line item
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Invalid or missing grand total line item for transaction %1$d.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $line_item = EEH_Line_Item::add_percentage_based_item(
-            EEH_Line_Item::get_pre_tax_subtotal($grand_total),
-            esc_html__('Payment Processing Fee', 'event_espresso'),
-            $processing_fee,
-            '',
-            false,
-            sanitize_key(
-                sprintf(
-                    '%1$s-fee-%2$d',
-                    $payment_method_name,
-                    $transaction->ID()
-                )
-            ),
-            true
-        );
-        $line_item->save();
-        return $grand_total->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @return float
-     * @throws Exception|OutOfBoundsException|RuntimeException
-     */
-    public function forPaymentMethod(string $payment_method_name): float
-    {
-        if (! $this->isPartnerGateway($payment_method_name)) {
-            return 0.0;
-        }
-        $license_status = $this->license_data->licenseStatus();
-        $license_expires = $this->license_data->licenseExpiry();
-        // decaf, new activations, or expired licenses are allowed a grace period
-        if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
-            return 0.0;
-        }
-        return $this->getGatewayFee($payment_method_name, $license_status);
-    }
-
-
-    /**
-     * Checks if a gateway is a partner gateway.
-     *
-     * @param string $payment_method_name
-     * @return bool
-     */
-    private function isPartnerGateway(string $payment_method_name): bool
-    {
-        return in_array($payment_method_name, $this->partner_gateways, true);
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @param string $license_status
-     * @return float
-     * @throws OutOfBoundsException
-     */
-    private function getGatewayFee(string $payment_method_name, string $license_status): float
-    {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
-                $payment_method_name,
-                $license_status
-            )
-        );
-    }
+	public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
+
+	public const  GATEWAY_SQUARE  = 'Square';
+
+	public const  GATEWAY_STRIPE  = 'Stripe';
+
+	private GracePeriod $grace_period;
+
+	private LicenseData $license_data;
+
+	/**
+	 * @var float[][] $gateway_fees
+	 */
+	private array $gateway_fees = [
+		LicenseStatus::ACTIVE  => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
+		],
+		LicenseStatus::EXPIRED => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
+		],
+		LicenseStatus::DECAF   => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 3.00,
+		],
+	];
+
+	private array $partner_gateways = [
+		PaymentProcessorFees::GATEWAY_PAYPAL,
+		PaymentProcessorFees::GATEWAY_SQUARE,
+		PaymentProcessorFees::GATEWAY_STRIPE,
+	];
+
+
+	/**
+	 * @param GracePeriod $grace_period
+	 * @param LicenseData $license_data
+	 */
+	public function __construct(GracePeriod $grace_period, LicenseData $license_data)
+	{
+		$this->grace_period = $grace_period;
+		$this->license_data = $license_data;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_method_name
+	 * @param float          $amount
+	 * @return float
+	 * @throws EE_Error|ReflectionException|RuntimeException
+	 * @throws Exception
+	 */
+	public function applyGatewayPartnerFees(
+		EE_Transaction $transaction,
+		string $payment_method_name,
+		float $amount = 0.00
+	): float {
+		$processing_fee = $this->forPaymentMethod($payment_method_name);
+		if ($processing_fee <= 0.00) {
+			return $amount;
+		}
+		$grand_total = $transaction->total_line_item(false);
+		if (
+			! $grand_total instanceof EE_Line_Item
+			|| ! $grand_total->is_total()
+			|| $grand_total->TXN_ID() !== $transaction->ID()
+		) {
+			// throw RuntimeException if total_line_item is not a total line item
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Invalid or missing grand total line item for transaction %1$d.',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$line_item = EEH_Line_Item::add_percentage_based_item(
+			EEH_Line_Item::get_pre_tax_subtotal($grand_total),
+			esc_html__('Payment Processing Fee', 'event_espresso'),
+			$processing_fee,
+			'',
+			false,
+			sanitize_key(
+				sprintf(
+					'%1$s-fee-%2$d',
+					$payment_method_name,
+					$transaction->ID()
+				)
+			),
+			true
+		);
+		$line_item->save();
+		return $grand_total->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @return float
+	 * @throws Exception|OutOfBoundsException|RuntimeException
+	 */
+	public function forPaymentMethod(string $payment_method_name): float
+	{
+		if (! $this->isPartnerGateway($payment_method_name)) {
+			return 0.0;
+		}
+		$license_status = $this->license_data->licenseStatus();
+		$license_expires = $this->license_data->licenseExpiry();
+		// decaf, new activations, or expired licenses are allowed a grace period
+		if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
+			return 0.0;
+		}
+		return $this->getGatewayFee($payment_method_name, $license_status);
+	}
+
+
+	/**
+	 * Checks if a gateway is a partner gateway.
+	 *
+	 * @param string $payment_method_name
+	 * @return bool
+	 */
+	private function isPartnerGateway(string $payment_method_name): bool
+	{
+		return in_array($payment_method_name, $this->partner_gateways, true);
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @param string $license_status
+	 * @return float
+	 * @throws OutOfBoundsException
+	 */
+	private function getGatewayFee(string $payment_method_name, string $license_status): float
+	{
+		if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
+			return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
+				$payment_method_name,
+				$license_status
+			)
+		);
+	}
 }

core/services/request/RequestStackCoreApp.php

Indentation +80 added lines, -80 removed lines

@@ -30,91 +30,91 @@
  */
 class RequestStackCoreApp implements RequestDecoratorInterface, RequestStackCoreAppInterface
 {
-    protected RequestInterface $request;
+	protected RequestInterface $request;
 
-    protected ResponseInterface $response;
+	protected ResponseInterface $response;
 
 
-    /**
-     * handle
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     * @throws InvalidClassException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response): ResponseInterface
-    {
-        $this->request  = $request;
-        $this->response = $response;
-        espresso_load_required('EE_Base', EE_CORE . 'EE_Base.core.php');
-        DeprecationManager::loadDeprecations();
-        // workarounds for PHP < 5.3
-        espresso_load_required('EEH_Class_Tools', EE_HELPERS . 'EEH_Class_Tools.helper.php');
-        do_action(
-            'EE_EventEspresso_core_services_request_RequestStackCoreApp__handle_request__initialize_core_loading'
-        );
-        // legacy action for backwards compatibility
-        do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
-        $this->setupFramework();
-        $capabilities_checker = LoaderFactory::getShared(CapabilitiesChecker::class, [EE_Capabilities::instance()]);
-        LoaderFactory::getShared(PersistentAdminNoticeManager::class, [$capabilities_checker, $request]);
-        // needed
-        LoaderFactory::getShared(EE_Maintenance_Mode::class);
-        // load legacy Cron Tasks and new Cron Manager
-        LoaderFactory::getShared(EE_Cron_Tasks::class);
-        /** @var CronManager $cron_manager */
-        $cron_manager = LoaderFactory::getShared(CronManager::class, [LoaderFactory::getLoader()]);
-        $cron_manager->initialize();
-        LoaderFactory::getShared(EE_System::class);
-        return $this->response;
-    }
+	/**
+	 * handle
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response): ResponseInterface
+	{
+		$this->request  = $request;
+		$this->response = $response;
+		espresso_load_required('EE_Base', EE_CORE . 'EE_Base.core.php');
+		DeprecationManager::loadDeprecations();
+		// workarounds for PHP < 5.3
+		espresso_load_required('EEH_Class_Tools', EE_HELPERS . 'EEH_Class_Tools.helper.php');
+		do_action(
+			'EE_EventEspresso_core_services_request_RequestStackCoreApp__handle_request__initialize_core_loading'
+		);
+		// legacy action for backwards compatibility
+		do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
+		$this->setupFramework();
+		$capabilities_checker = LoaderFactory::getShared(CapabilitiesChecker::class, [EE_Capabilities::instance()]);
+		LoaderFactory::getShared(PersistentAdminNoticeManager::class, [$capabilities_checker, $request]);
+		// needed
+		LoaderFactory::getShared(EE_Maintenance_Mode::class);
+		// load legacy Cron Tasks and new Cron Manager
+		LoaderFactory::getShared(EE_Cron_Tasks::class);
+		/** @var CronManager $cron_manager */
+		$cron_manager = LoaderFactory::getShared(CronManager::class, [LoaderFactory::getLoader()]);
+		$cron_manager->initialize();
+		LoaderFactory::getShared(EE_System::class);
+		return $this->response;
+	}
 
 
-    /**
-     * set framework for the rest of EE to hook into when loading
-     *
-     * @throws EE_Error
-     */
-    private function setupFramework()
-    {
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        add_action('plugins_loaded', ['EE_Bootstrap', 'load_espresso_addons'], 1);
-        add_action('plugins_loaded', ['EE_Bootstrap', 'detect_activations_or_upgrades'], 3);
-        add_action('plugins_loaded', ['EE_Bootstrap', 'load_core_configuration'], 5);
-        add_action('plugins_loaded', ['EE_Bootstrap', 'register_shortcodes_modules_and_widgets'], 7);
-        add_action('plugins_loaded', ['EE_Bootstrap', 'brew_espresso'], 9);
-    }
+	/**
+	 * set framework for the rest of EE to hook into when loading
+	 *
+	 * @throws EE_Error
+	 */
+	private function setupFramework()
+	{
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		add_action('plugins_loaded', ['EE_Bootstrap', 'load_espresso_addons'], 1);
+		add_action('plugins_loaded', ['EE_Bootstrap', 'detect_activations_or_upgrades'], 3);
+		add_action('plugins_loaded', ['EE_Bootstrap', 'load_core_configuration'], 5);
+		add_action('plugins_loaded', ['EE_Bootstrap', 'register_shortcodes_modules_and_widgets'], 7);
+		add_action('plugins_loaded', ['EE_Bootstrap', 'brew_espresso'], 9);
+	}
 
 
-    /**
-     * called after the request stack has been fully processed
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     */
-    public function handleResponse(RequestInterface $request, ResponseInterface $response)
-    {
-        if ($response->pluginDeactivated()) {
-            espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
-        }
-        $request_headers = $response->requestHeaders();
-        if ($request_headers) {
-            foreach ($request_headers as $request_header) {
-                header($request_header);
-            }
-            // headers set AND request terminated? then kill the current request
-            if ($response->requestTerminated()) {
-                exit;
-            }
-        }
-    }
+	/**
+	 * called after the request stack has been fully processed
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 */
+	public function handleResponse(RequestInterface $request, ResponseInterface $response)
+	{
+		if ($response->pluginDeactivated()) {
+			espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
+		}
+		$request_headers = $response->requestHeaders();
+		if ($request_headers) {
+			foreach ($request_headers as $request_header) {
+				header($request_header);
+			}
+			// headers set AND request terminated? then kill the current request
+			if ($response->requestTerminated()) {
+				exit;
+			}
+		}
+	}
 }

core/libraries/rest_api/controllers/model/Read.php

Indentation +1686 added lines, -1686 removed lines

@@ -52,1690 +52,1690 @@
  */
 class Read extends Base
 {
-    protected CalculatedModelFields $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     *
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(CalculatedModelFields $fields_calculator)
-    {
-        parent::__construct();
-        $this->fields_calculator = $fields_calculator;
-    }
-
-
-    /**
-     * @return Read
-     */
-    private static function getReadController(): Read
-    {
-        return LoaderFactory::getLoader()->getNew(Read::class);
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleRequestGetAll(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name
-    ): WP_REST_Response {
-        $controller = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            esc_html__(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version    The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleSchemaRequest(string $version, string $model_name): array
-    {
-        $controller = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return [];
-            }
-            // get the model for this version
-            $model        = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema(
-                $model,
-                LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields')
-            );
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            error_log($e->getMessage());
-            return [];
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     * @throws EE_Error
-     */
-    public function customizeSchemaForRestResponse(EEM_Base $model, array $schema): array
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws RestException  if a default value has a PHP object, which we should never do
-     *                                  (but if we did, let's know about it ASAP, so let the exception bubble up)
-     * @throws EE_Error
-     *
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest(): string
-    {
-        if (
-            isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        return $request->serverParamIsSet('PATH_INFO')
-            ? $request->getServerParam('PATH_INFO')
-            : '/';
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetOne(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name
-    ): WP_REST_Response {
-        $controller = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            esc_html__(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @param string          $related_model_name
-     * @return WP_REST_Response
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name,
-        string $related_model_name
-    ): WP_REST_Response {
-        $controller = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            $main_model = $controller->validateModel($model_name);
-            $controller->validateModel($related_model_name);
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     */
-    public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                ['status' => 403]
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results      = $model->get_all_wpdb_results($query_params);
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                  $primary_model_query_params  query params for finding the item from which
-     *                                                            relations will be based
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request        $request
-     * @return array|null
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws ModelConfigurationException
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams(
-        array $primary_model_query_params,
-        EE_Model_Relation_Base $relation,
-        WP_REST_Request $request
-    ): ?array {
-        $context       = $this->validateContext($request->get_param('caps'));
-        $model         = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = [];
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = [
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        ];
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params          = $primary_model_query_params;
-        $restricted_query_params['caps']  = $context;
-        $restricted_query_params['limit'] = 1;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        $primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        $primary_model_row  = null;
-        if (is_array($primary_model_rows)) {
-            $primary_model_row = reset($primary_model_rows);
-        }
-        if (
-            ! (
-                $primary_model_row
-                && Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    esc_html__(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                ['status' => 403]
-            );
-        }
-
-        $this->checkPassword(
-            $model,
-            $primary_model_row,
-            $restricted_query_params,
-            $request
-        );
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps']                     = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results      = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result     = array_merge($join_model_result, $nice_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param int|string             $id the ID of the thing we are fetching related stuff from
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request        $request
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws ModelConfigurationException
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    public function getEntitiesFromRelation($id, EE_Model_Relation_Base $relation, WP_REST_Request $request): array
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        // can we edit that main item?
-        // if not, show nothing but an error
-        // otherwise, please proceed
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            [
-                [
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ],
-            ],
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function setHeadersFromQueryParams(EEM_Base $model, array $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) === 1) {
-                $limit_parts = [0, $limit_parts[0]];
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base             $model
-     * @param array                $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request|null $rest_request
-     * @param string|null          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     */
-    public function createEntityFromWpdbResult(
-        EEM_Base $model,
-        array $db_row,
-        ?WP_REST_Request $rest_request,
-        string $deprecated = null
-    ): array {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') === null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $current_user_full_access_to_entity = $model->currentUserCan(
-            EEM_Base::caps_read_admin,
-            $model->deduce_fields_n_values_from_cols_n_values($db_row)
-        );
-        $entity_array                       = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array                       = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links']             = $this->getEntityLinks($model, $db_row, $entity_array);
-        // when it's a regular read request for a model with a password and the password wasn't provided
-        // remove the password protected fields
-        $has_protected_fields = false;
-        try {
-            $this->checkPassword(
-                $model,
-                $db_row,
-                $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                ),
-                $rest_request
-            );
-        } catch (RestPasswordRequiredException $e) {
-            if ($model->hasPassword()) {
-                // just remove protected fields
-                $has_protected_fields = true;
-                $entity_array         = Capabilities::filterOutPasswordProtectedFields(
-                    $entity_array,
-                    $model,
-                    $this->getModelVersionInfo()
-                );
-            } else {
-                // that's a problem. None of this should be accessible if no password was provided
-                throw $e;
-            }
-        }
-
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations(
-            $model,
-            $db_row,
-            $rest_request,
-            $has_protected_fields
-        );
-        $entity_array                       = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        // add an empty protected property for now. If it's still around after we remove everything the request didn't
-        // want, we'll populate it then. k?
-        $entity_array['_protected'] = [];
-        // remove any properties the request didn't want. This way _protected won't bother mentioning them
-        $entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
-        $entity_array = $this->includeRequestedModels(
-            $model,
-            $rest_request,
-            $entity_array,
-            $db_row,
-            $has_protected_fields
-        );
-        // if they still wanted the _protected property, add it.
-        if (isset($entity_array['_protected'])) {
-            $entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
-        }
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        if (! $current_user_full_access_to_entity) {
-            $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-                $entity_array,
-                $model,
-                $rest_request->get_param('caps'),
-                $this->getModelVersionInfo()
-            );
-        } else {
-            $result_without_inaccessible_fields = $entity_array;
-        }
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-    /**
-     * Returns an array describing which fields can be protected, and which actually were removed this request
-     *
-     * @param EEM_Base $model
-     * @param array    $results_so_far
-     * @param bool     $protected
-     * @return array results
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
-    {
-        if (! $protected || ! $model->hasPassword()) {
-            return $results_so_far;
-        }
-        $password_field  = $model->getPasswordField();
-        $all_protected   = array_merge(
-            [$password_field->get_name()],
-            $password_field->protectedFields()
-        );
-        $fields_included = array_keys($results_so_far);
-        $fields_included = array_intersect(
-            $all_protected,
-            $fields_included
-        );
-        foreach ($fields_included as $field_name) {
-            $results_so_far['_protected'][] = $field_name;
-        }
-        return $results_so_far;
-    }
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws Exception
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, array $db_row): array
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post     = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname          = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif (
-                $this->isSubclassOfOne(
-                    $field_obj,
-                    $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-                )
-            ) {
-                $result[ $field_name ] = [
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                ];
-            } elseif (
-                $this->isSubclassOfOne(
-                    $field_obj,
-                    $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-                )
-            ) {
-                $result[ $field_name ] = [
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                ];
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ]          = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return array|int
-     * @throws RestException if $value contains a PHP object
-     * @throws EE_Error
-     */
-    protected function prepareFieldObjValueForJson(
-        EE_Model_Field_Base $field_obj,
-        $value,
-        string $format = 'normal'
-    ) {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     * @throws EE_Error
-     */
-    protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row
-     * @param array           $entity_array
-     * @return array the _links item in the entity
-     * @throws EE_Error
-     * @global WP_REST_Server $wp_rest_server
-     */
-    protected function getEntityLinks(EEM_Base $model, array $db_row, array $entity_array): array
-    {
-        // add basic links
-        $links = [];
-        if ($model->has_primary_key_field()) {
-            $links['self'] = [
-                [
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ],
-            ];
-        }
-        $links['collection'] = [
-            [
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ],
-        ];
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part                                                      =
-                    Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
-                    [
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation,
-                    ],
-                ];
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param array           $entity_array
-     * @param array           $db_row
-     * @param boolean         $included_items_protected if the original item is password protected, don't include any
-     *                                                  related models.
-     * @return array the modified entity
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        array $entity_array,
-        array $db_row = [],
-        bool $included_items_protected = false
-    ): array {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    [
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                        'password'  => $rest_request->get_param('password'),
-                    ]
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                if (! $included_items_protected) {
-                    try {
-                        $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                            $primary_model_query_params,
-                            $relation_obj,
-                            $pretend_related_request
-                        );
-                    } catch (RestException $e) {
-                        $related_results = null;
-                    }
-                } else {
-                    // they're protected, hide them.
-                    $related_results              = null;
-                    $entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
-                }
-                if ($related_results instanceof WP_Error || $related_results === null) {
-                    $related_results = $relation_obj instanceof EE_Belongs_To_Relation
-                            ? null
-                            : [];
-                }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * If the user has requested only specific properties (including meta properties like _links or _protected)
-     * remove everything else.
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param                 $entity_array
-     * @return array
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    protected function includeOnlyRequestedProperties(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array
-    ): array {
-
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $array
-     * @return array
-     */
-    private function removeModelNamesFromArray(array $array): array
-    {
-        return array_diff($array, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @param bool            $row_is_protected whether this row is password protected or not
-     * @return stdClass the _calculations item in the entity
-     * @throws RestException if a default value has a PHP object, which should never do (and if we
-     *                                          did, let's know about it ASAP, so let the exception bubble up)
-     * @throws EE_Error
-     */
-    protected function getEntityCalculations(
-        EEM_Base $model,
-        array $wpdb_row,
-        WP_REST_Request $rest_request,
-        bool $row_is_protected = false
-    ): stdClass {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new stdClass();
-        $protected_fields            = [];
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                // it's password protected, so they shouldn't be able to read this. Remove the value
-                $schema = $this->fields_calculator->getJsonSchemaForModel($model);
-                if (
-                    $row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']
-                ) {
-                    $calculated_value   = null;
-                    $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
-                            case 'boolean':
-                                $calculated_value = false;
-                                break;
-                            case 'integer':
-                                $calculated_value = 0;
-                                break;
-                            case 'string':
-                                $calculated_value = '';
-                                break;
-                            case 'array':
-                                $calculated_value = [];
-                                break;
-                            case 'object':
-                                $calculated_value = new stdClass();
-                                break;
-                        }
-                    }
-                } else {
-                    $calculated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        null,
-                        $this->fields_calculator->retrieveCalculatedFieldValue(
-                            $model,
-                            $field_to_calculate,
-                            $wpdb_row,
-                            $rest_request,
-                            $this
-                        ),
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage()
-                );
-            }
-        }
-        $calculated_fields_to_return->_protected = $protected_fields;
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     * @throws EE_Error
-     */
-    public function getVersionedLinkTo(string $link_part_after_version_and_slash): string
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                 $relation_name
-     * @param EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName(string $relation_name, EE_Model_Relation_Base $relation_obj): string
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        }
-        return EEH_Inflector::pluralize_and_lower($relation_name);
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     */
-    public function getEntityFromModel(EEM_Base $model, WP_REST_Request $request): array
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string|null $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext(?string $context): string
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts, true)) {
-            return $context;
-        }
-        return EEM_Base::caps_read;
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param string $default_where_conditions
-     * @return string
-     */
-    public function validateDefaultQueryParams(string $default_where_conditions): string
-    {
-        $valid_default_where_conditions_for_api_calls = [
-            EE_Default_Where_Conditions::ALL,
-            EE_Default_Where_Conditions::MINIMUM_ALL,
-            EE_Default_Where_Conditions::MINIMUM_OTHERS,
-        ];
-        if (! $default_where_conditions) {
-            $default_where_conditions = EE_Default_Where_Conditions::ALL;
-        }
-        if (
-            in_array(
-                $default_where_conditions,
-                $valid_default_where_conditions_for_api_calls,
-                true
-            )
-        ) {
-            return $default_where_conditions;
-        }
-        return EE_Default_Where_Conditions::ALL;
-    }
-
-
-    /**
-     * Translates API filter get parameter into model query params @param EEM_Base $model
-     *
-     * @param array $query_params
-     * @return array model query params (@see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
-     *               or FALSE to indicate that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     * @throws DomainException
-     * @throws ReflectionException
-     * @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
-     *               Note: right now the query parameter keys for fields (and related fields) can be left as-is, but
-     *               it's quite possible this will change someday. Also, this method's contents might be candidate for
-     *               moving to Model_Data_Translator
-     *
-     */
-    public function createModelQueryParams(EEM_Base $model, array $query_params): array
-    {
-        $model_query_params = [];
-        if (isset($query_params['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order_by'])) {
-            $order_by = $query_params['order_by'];
-        } elseif (isset($query_params['orderby'])) {
-            $order_by = $query_params['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_params['group_by'])) {
-            $group_by = $query_params['group_by'];
-        } elseif (isset($query_params['groupby'])) {
-            $group_by = $query_params['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_params['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order'])) {
-            $model_query_params['order'] = $query_params['order'];
-        }
-        if (isset($query_params['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_params['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
-                $limit_array = explode(',', (string) $query_params['limit']);
-            } else {
-                $limit_array = $query_params['limit'];
-            }
-            $sanitized_limit = [];
-            foreach ($limit_array as $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_params['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_params['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_params['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_params['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_params['default_where_conditions']
-            );
-        }
-        // if this is a model protected by a password on another model, exclude the password protected
-        // entities by default. But if they passed in a password, try to show them all. If the password is wrong,
-        // though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
-        if (
-            $model_query_params['caps'] === EEM_Base::caps_read
-            && empty($query_params['password'])
-            && ! $model->hasPassword()
-            && $model->restrictedByRelatedModelPassword()
-        ) {
-            $model_query_params['exclude_protected'] = true;
-        }
-
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     * @deprecated
-     */
-    public function prepareRestQueryParamsKeyForModels(EEM_Base $model, array $query_params): array
-    {
-        $model_ready_query_params = [];
-        foreach ($query_params as $key => $value) {
-            $model_ready_query_params[ $key ] = is_array($value)
-                ? $this->prepareRestQueryParamsKeyForModels($model, $value)
-                : $value;
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @param $model
-     * @param $query_params
-     * @return array
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params): array
-    {
-        $model_ready_query_params = [];
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, string $prefix): array
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = [];
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents    = array_filter($exploded_contents);
-        $contents_with_prefix = [];
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @param string      $include_string @see Read:handle_request_get_all
-     * @param string|null $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                                    the fields for that model, with the model's name removed from each.
-     *                                    If $include_string was blank or '*' returns an empty array
-     * @throws EE_Error
-     * @throws EE_Error
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     *                                    Deprecated because its return values were really quite confusing- sometimes
-     *                                    it
-     *                                    returned an empty array (when the include string was blank or '*') or
-     *                                    sometimes it returned array('*') (when you provided a model and a model of
-     *                                    that kind was found). Parses the $include_string so we fetch all the field
-     *                                    names relating to THIS model
-     *                                    (ie have NO period in them), or for the provided model (ie start with the
-     *                                    model name and then a period).
-     */
-    public function extractIncludesForThisModel(string $include_string, string $model_name = null): array
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return [];
-        }
-        $includes                    = explode(',', $include_string);
-        $extracted_fields_to_include = [];
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include === $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (
-                    strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null): array
-    {
-        $query_params = [[$model->primary_key_name() => $request->get_param('id')], 'limit' => 1];
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params         = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                reset($model_rows),
-                $request
-            );
-        }
-        // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-        $lowercase_model_name = strtolower($model->get_this_model_name());
-        if ($model->exists($query_params)) {
-            // you got shafted- it existed but we didn't want to tell you!
-            throw new RestException(
-                'rest_user_cannot_' . $context,
-                sprintf(
-                    __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                    $context,
-                    $lowercase_model_name,
-                    Capabilities::getMissingPermissionsString(
-                        $model,
-                        $context
-                    )
-                ),
-                ['status' => 403]
-            );
-        }
-        // it's not you. It just doesn't exist
-        throw new RestException(
-            sprintf('rest_%s_invalid_id', $lowercase_model_name),
-            sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-            ['status' => 404]
-        );
-    }
-
-
-    /**
-     * Checks that if this content requires a password to be read, that it's been provided and is correct.
-     *
-     * @param EEM_Base        $model
-     * @param array           $model_row
-     * @param array           $query_params Adds 'default_where_conditions' => 'minimum'
-     *                                      to ensure we don't confuse trashed with password protected.
-     * @param WP_REST_Request $request
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestPasswordRequiredException
-     * @throws RestPasswordIncorrectException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @since 4.9.74.p
-     */
-    protected function checkPassword(EEM_Base $model, array $model_row, array $query_params, WP_REST_Request $request)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        // stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
-        // or you don't.
-        $request_caps = $request->get_param('caps');
-        if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
-            return;
-        }
-        // if this entity requires a password, they better give it and it better be right!
-        if (
-            $model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
-        ) {
-            if (empty($request['password'])) {
-                throw new RestPasswordRequiredException();
-            }
-            if (
-                ! hash_equals(
-                    $model_row[ $model->getPasswordField()->get_qualified_column() ],
-                    $request['password']
-                )
-            ) {
-                throw new RestPasswordIncorrectException();
-            }
-        } elseif (
-            // wait! maybe this content is password protected
-            $model->restrictedByRelatedModelPassword()
-            && $request->get_param('caps') === EEM_Base::caps_read
-        ) {
-            $password_supplied = $request->get_param('password');
-            if (empty($password_supplied)) {
-                $query_params['exclude_protected'] = true;
-                if (! $model->exists($query_params)) {
-                    throw new RestPasswordRequiredException();
-                }
-            } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (! $model->exists($query_params)) {
-                    throw new RestPasswordIncorrectException();
-                }
-            }
-        }
-    }
+	protected CalculatedModelFields $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 *
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * @return Read
+	 */
+	private static function getReadController(): Read
+	{
+		return LoaderFactory::getLoader()->getNew(Read::class);
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleRequestGetAll(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name
+	): WP_REST_Response {
+		$controller = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							esc_html__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version    The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleSchemaRequest(string $version, string $model_name): array
+	{
+		$controller = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return [];
+			}
+			// get the model for this version
+			$model        = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema(
+				$model,
+				LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields')
+			);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			error_log($e->getMessage());
+			return [];
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 * @throws EE_Error
+	 */
+	public function customizeSchemaForRestResponse(EEM_Base $model, array $schema): array
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws RestException  if a default value has a PHP object, which we should never do
+	 *                                  (but if we did, let's know about it ASAP, so let the exception bubble up)
+	 * @throws EE_Error
+	 *
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest(): string
+	{
+		if (
+			isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		return $request->serverParamIsSet('PATH_INFO')
+			? $request->getServerParam('PATH_INFO')
+			: '/';
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetOne(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name
+	): WP_REST_Response {
+		$controller = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							esc_html__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @param string          $related_model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name,
+		string $related_model_name
+	): WP_REST_Response {
+		$controller = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			$main_model = $controller->validateModel($model_name);
+			$controller->validateModel($related_model_name);
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 */
+	public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				['status' => 403]
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results      = $model->get_all_wpdb_results($query_params);
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                  $primary_model_query_params  query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request        $request
+	 * @return array|null
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws ModelConfigurationException
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams(
+		array $primary_model_query_params,
+		EE_Model_Relation_Base $relation,
+		WP_REST_Request $request
+	): ?array {
+		$context       = $this->validateContext($request->get_param('caps'));
+		$model         = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = [];
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = [
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		];
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params          = $primary_model_query_params;
+		$restricted_query_params['caps']  = $context;
+		$restricted_query_params['limit'] = 1;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		$primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		$primary_model_row  = null;
+		if (is_array($primary_model_rows)) {
+			$primary_model_row = reset($primary_model_rows);
+		}
+		if (
+			! (
+				$primary_model_row
+				&& Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					esc_html__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				['status' => 403]
+			);
+		}
+
+		$this->checkPassword(
+			$model,
+			$primary_model_row,
+			$restricted_query_params,
+			$request
+		);
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps']                     = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results      = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result     = array_merge($join_model_result, $nice_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param int|string             $id the ID of the thing we are fetching related stuff from
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request        $request
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws ModelConfigurationException
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	public function getEntitiesFromRelation($id, EE_Model_Relation_Base $relation, WP_REST_Request $request): array
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		// can we edit that main item?
+		// if not, show nothing but an error
+		// otherwise, please proceed
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			[
+				[
+					$relation->get_this_model()->primary_key_name() => $id,
+				],
+			],
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function setHeadersFromQueryParams(EEM_Base $model, array $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) === 1) {
+				$limit_parts = [0, $limit_parts[0]];
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base             $model
+	 * @param array                $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request|null $rest_request
+	 * @param string|null          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 */
+	public function createEntityFromWpdbResult(
+		EEM_Base $model,
+		array $db_row,
+		?WP_REST_Request $rest_request,
+		string $deprecated = null
+	): array {
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') === null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$current_user_full_access_to_entity = $model->currentUserCan(
+			EEM_Base::caps_read_admin,
+			$model->deduce_fields_n_values_from_cols_n_values($db_row)
+		);
+		$entity_array                       = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array                       = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links']             = $this->getEntityLinks($model, $db_row, $entity_array);
+		// when it's a regular read request for a model with a password and the password wasn't provided
+		// remove the password protected fields
+		$has_protected_fields = false;
+		try {
+			$this->checkPassword(
+				$model,
+				$db_row,
+				$model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				),
+				$rest_request
+			);
+		} catch (RestPasswordRequiredException $e) {
+			if ($model->hasPassword()) {
+				// just remove protected fields
+				$has_protected_fields = true;
+				$entity_array         = Capabilities::filterOutPasswordProtectedFields(
+					$entity_array,
+					$model,
+					$this->getModelVersionInfo()
+				);
+			} else {
+				// that's a problem. None of this should be accessible if no password was provided
+				throw $e;
+			}
+		}
+
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations(
+			$model,
+			$db_row,
+			$rest_request,
+			$has_protected_fields
+		);
+		$entity_array                       = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		// add an empty protected property for now. If it's still around after we remove everything the request didn't
+		// want, we'll populate it then. k?
+		$entity_array['_protected'] = [];
+		// remove any properties the request didn't want. This way _protected won't bother mentioning them
+		$entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
+		$entity_array = $this->includeRequestedModels(
+			$model,
+			$rest_request,
+			$entity_array,
+			$db_row,
+			$has_protected_fields
+		);
+		// if they still wanted the _protected property, add it.
+		if (isset($entity_array['_protected'])) {
+			$entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
+		}
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		if (! $current_user_full_access_to_entity) {
+			$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+				$entity_array,
+				$model,
+				$rest_request->get_param('caps'),
+				$this->getModelVersionInfo()
+			);
+		} else {
+			$result_without_inaccessible_fields = $entity_array;
+		}
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+	/**
+	 * Returns an array describing which fields can be protected, and which actually were removed this request
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $results_so_far
+	 * @param bool     $protected
+	 * @return array results
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
+	{
+		if (! $protected || ! $model->hasPassword()) {
+			return $results_so_far;
+		}
+		$password_field  = $model->getPasswordField();
+		$all_protected   = array_merge(
+			[$password_field->get_name()],
+			$password_field->protectedFields()
+		);
+		$fields_included = array_keys($results_so_far);
+		$fields_included = array_intersect(
+			$all_protected,
+			$fields_included
+		);
+		foreach ($fields_included as $field_name) {
+			$results_so_far['_protected'][] = $field_name;
+		}
+		return $results_so_far;
+	}
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws Exception
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, array $db_row): array
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post     = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname          = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif (
+				$this->isSubclassOfOne(
+					$field_obj,
+					$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+				)
+			) {
+				$result[ $field_name ] = [
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				];
+			} elseif (
+				$this->isSubclassOfOne(
+					$field_obj,
+					$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+				)
+			) {
+				$result[ $field_name ] = [
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				];
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ]          = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return array|int
+	 * @throws RestException if $value contains a PHP object
+	 * @throws EE_Error
+	 */
+	protected function prepareFieldObjValueForJson(
+		EE_Model_Field_Base $field_obj,
+		$value,
+		string $format = 'normal'
+	) {
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 * @throws EE_Error
+	 */
+	protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row
+	 * @param array           $entity_array
+	 * @return array the _links item in the entity
+	 * @throws EE_Error
+	 * @global WP_REST_Server $wp_rest_server
+	 */
+	protected function getEntityLinks(EEM_Base $model, array $db_row, array $entity_array): array
+	{
+		// add basic links
+		$links = [];
+		if ($model->has_primary_key_field()) {
+			$links['self'] = [
+				[
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				],
+			];
+		}
+		$links['collection'] = [
+			[
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			],
+		];
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part                                                      =
+					Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
+					[
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation,
+					],
+				];
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array           $entity_array
+	 * @param array           $db_row
+	 * @param boolean         $included_items_protected if the original item is password protected, don't include any
+	 *                                                  related models.
+	 * @return array the modified entity
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		array $entity_array,
+		array $db_row = [],
+		bool $included_items_protected = false
+	): array {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					[
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+						'password'  => $rest_request->get_param('password'),
+					]
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				if (! $included_items_protected) {
+					try {
+						$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+							$primary_model_query_params,
+							$relation_obj,
+							$pretend_related_request
+						);
+					} catch (RestException $e) {
+						$related_results = null;
+					}
+				} else {
+					// they're protected, hide them.
+					$related_results              = null;
+					$entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
+				}
+				if ($related_results instanceof WP_Error || $related_results === null) {
+					$related_results = $relation_obj instanceof EE_Belongs_To_Relation
+							? null
+							: [];
+				}
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * If the user has requested only specific properties (including meta properties like _links or _protected)
+	 * remove everything else.
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param                 $entity_array
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	protected function includeOnlyRequestedProperties(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array
+	): array {
+
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $array
+	 * @return array
+	 */
+	private function removeModelNamesFromArray(array $array): array
+	{
+		return array_diff($array, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @param bool            $row_is_protected whether this row is password protected or not
+	 * @return stdClass the _calculations item in the entity
+	 * @throws RestException if a default value has a PHP object, which should never do (and if we
+	 *                                          did, let's know about it ASAP, so let the exception bubble up)
+	 * @throws EE_Error
+	 */
+	protected function getEntityCalculations(
+		EEM_Base $model,
+		array $wpdb_row,
+		WP_REST_Request $rest_request,
+		bool $row_is_protected = false
+	): stdClass {
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new stdClass();
+		$protected_fields            = [];
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				// it's password protected, so they shouldn't be able to read this. Remove the value
+				$schema = $this->fields_calculator->getJsonSchemaForModel($model);
+				if (
+					$row_is_protected
+					&& isset($schema['properties'][ $field_to_calculate ]['protected'])
+					&& $schema['properties'][ $field_to_calculate ]['protected']
+				) {
+					$calculated_value   = null;
+					$protected_fields[] = $field_to_calculate;
+					if ($schema['properties'][ $field_to_calculate ]['type']) {
+						switch ($schema['properties'][ $field_to_calculate ]['type']) {
+							case 'boolean':
+								$calculated_value = false;
+								break;
+							case 'integer':
+								$calculated_value = 0;
+								break;
+							case 'string':
+								$calculated_value = '';
+								break;
+							case 'array':
+								$calculated_value = [];
+								break;
+							case 'object':
+								$calculated_value = new stdClass();
+								break;
+						}
+					}
+				} else {
+					$calculated_value = ModelDataTranslator::prepareFieldValueForJson(
+						null,
+						$this->fields_calculator->retrieveCalculatedFieldValue(
+							$model,
+							$field_to_calculate,
+							$wpdb_row,
+							$rest_request,
+							$this
+						),
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage()
+				);
+			}
+		}
+		$calculated_fields_to_return->_protected = $protected_fields;
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 * @throws EE_Error
+	 */
+	public function getVersionedLinkTo(string $link_part_after_version_and_slash): string
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                 $relation_name
+	 * @param EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName(string $relation_name, EE_Model_Relation_Base $relation_obj): string
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		}
+		return EEH_Inflector::pluralize_and_lower($relation_name);
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 */
+	public function getEntityFromModel(EEM_Base $model, WP_REST_Request $request): array
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string|null $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext(?string $context): string
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts, true)) {
+			return $context;
+		}
+		return EEM_Base::caps_read;
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param string $default_where_conditions
+	 * @return string
+	 */
+	public function validateDefaultQueryParams(string $default_where_conditions): string
+	{
+		$valid_default_where_conditions_for_api_calls = [
+			EE_Default_Where_Conditions::ALL,
+			EE_Default_Where_Conditions::MINIMUM_ALL,
+			EE_Default_Where_Conditions::MINIMUM_OTHERS,
+		];
+		if (! $default_where_conditions) {
+			$default_where_conditions = EE_Default_Where_Conditions::ALL;
+		}
+		if (
+			in_array(
+				$default_where_conditions,
+				$valid_default_where_conditions_for_api_calls,
+				true
+			)
+		) {
+			return $default_where_conditions;
+		}
+		return EE_Default_Where_Conditions::ALL;
+	}
+
+
+	/**
+	 * Translates API filter get parameter into model query params @param EEM_Base $model
+	 *
+	 * @param array $query_params
+	 * @return array model query params (@see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
+	 *               or FALSE to indicate that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 * @throws DomainException
+	 * @throws ReflectionException
+	 * @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
+	 *               Note: right now the query parameter keys for fields (and related fields) can be left as-is, but
+	 *               it's quite possible this will change someday. Also, this method's contents might be candidate for
+	 *               moving to Model_Data_Translator
+	 *
+	 */
+	public function createModelQueryParams(EEM_Base $model, array $query_params): array
+	{
+		$model_query_params = [];
+		if (isset($query_params['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order_by'])) {
+			$order_by = $query_params['order_by'];
+		} elseif (isset($query_params['orderby'])) {
+			$order_by = $query_params['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_params['group_by'])) {
+			$group_by = $query_params['group_by'];
+		} elseif (isset($query_params['groupby'])) {
+			$group_by = $query_params['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_params['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order'])) {
+			$model_query_params['order'] = $query_params['order'];
+		}
+		if (isset($query_params['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_params['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_params['limit'])) {
+				$limit_array = explode(',', (string) $query_params['limit']);
+			} else {
+				$limit_array = $query_params['limit'];
+			}
+			$sanitized_limit = [];
+			foreach ($limit_array as $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_params['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_params['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_params['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_params['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_params['default_where_conditions']
+			);
+		}
+		// if this is a model protected by a password on another model, exclude the password protected
+		// entities by default. But if they passed in a password, try to show them all. If the password is wrong,
+		// though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
+		if (
+			$model_query_params['caps'] === EEM_Base::caps_read
+			&& empty($query_params['password'])
+			&& ! $model->hasPassword()
+			&& $model->restrictedByRelatedModelPassword()
+		) {
+			$model_query_params['exclude_protected'] = true;
+		}
+
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 * @deprecated
+	 */
+	public function prepareRestQueryParamsKeyForModels(EEM_Base $model, array $query_params): array
+	{
+		$model_ready_query_params = [];
+		foreach ($query_params as $key => $value) {
+			$model_ready_query_params[ $key ] = is_array($value)
+				? $this->prepareRestQueryParamsKeyForModels($model, $value)
+				: $value;
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params): array
+	{
+		$model_ready_query_params = [];
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, string $prefix): array
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = [];
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents    = array_filter($exploded_contents);
+		$contents_with_prefix = [];
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @param string      $include_string @see Read:handle_request_get_all
+	 * @param string|null $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                                    the fields for that model, with the model's name removed from each.
+	 *                                    If $include_string was blank or '*' returns an empty array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 *                                    Deprecated because its return values were really quite confusing- sometimes
+	 *                                    it
+	 *                                    returned an empty array (when the include string was blank or '*') or
+	 *                                    sometimes it returned array('*') (when you provided a model and a model of
+	 *                                    that kind was found). Parses the $include_string so we fetch all the field
+	 *                                    names relating to THIS model
+	 *                                    (ie have NO period in them), or for the provided model (ie start with the
+	 *                                    model name and then a period).
+	 */
+	public function extractIncludesForThisModel(string $include_string, string $model_name = null): array
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return [];
+		}
+		$includes                    = explode(',', $include_string);
+		$extracted_fields_to_include = [];
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include === $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (
+					strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null): array
+	{
+		$query_params = [[$model->primary_key_name() => $request->get_param('id')], 'limit' => 1];
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params         = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				reset($model_rows),
+				$request
+			);
+		}
+		// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+		$lowercase_model_name = strtolower($model->get_this_model_name());
+		if ($model->exists($query_params)) {
+			// you got shafted- it existed but we didn't want to tell you!
+			throw new RestException(
+				'rest_user_cannot_' . $context,
+				sprintf(
+					__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+					$context,
+					$lowercase_model_name,
+					Capabilities::getMissingPermissionsString(
+						$model,
+						$context
+					)
+				),
+				['status' => 403]
+			);
+		}
+		// it's not you. It just doesn't exist
+		throw new RestException(
+			sprintf('rest_%s_invalid_id', $lowercase_model_name),
+			sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+			['status' => 404]
+		);
+	}
+
+
+	/**
+	 * Checks that if this content requires a password to be read, that it's been provided and is correct.
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $model_row
+	 * @param array           $query_params Adds 'default_where_conditions' => 'minimum'
+	 *                                      to ensure we don't confuse trashed with password protected.
+	 * @param WP_REST_Request $request
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestPasswordRequiredException
+	 * @throws RestPasswordIncorrectException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @since 4.9.74.p
+	 */
+	protected function checkPassword(EEM_Base $model, array $model_row, array $query_params, WP_REST_Request $request)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		// stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
+		// or you don't.
+		$request_caps = $request->get_param('caps');
+		if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
+			return;
+		}
+		// if this entity requires a password, they better give it and it better be right!
+		if (
+			$model->hasPassword()
+			&& $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
+		) {
+			if (empty($request['password'])) {
+				throw new RestPasswordRequiredException();
+			}
+			if (
+				! hash_equals(
+					$model_row[ $model->getPasswordField()->get_qualified_column() ],
+					$request['password']
+				)
+			) {
+				throw new RestPasswordIncorrectException();
+			}
+		} elseif (
+			// wait! maybe this content is password protected
+			$model->restrictedByRelatedModelPassword()
+			&& $request->get_param('caps') === EEM_Base::caps_read
+		) {
+			$password_supplied = $request->get_param('password');
+			if (empty($password_supplied)) {
+				$query_params['exclude_protected'] = true;
+				if (! $model->exists($query_params)) {
+					throw new RestPasswordRequiredException();
+				}
+			} else {
+				$query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
+				if (! $model->exists($query_params)) {
+					throw new RestPasswordIncorrectException();
+				}
+			}
+		}
+	}
 }

Spacing +65 added lines, -65 removed lines

@@ -95,7 +95,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -136,7 +136,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return [];
             }
             // get the model for this version
@@ -200,11 +200,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -213,9 +213,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -237,9 +237,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -289,7 +289,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -373,7 +373,7 @@ 
     public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -385,7 +385,7 @@ 
                 ['status' => 403]
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -433,7 +433,7 @@ 
         $context       = $this->validateContext($request->get_param('caps'));
         $model         = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = [];
         }
         // check if they can access the 1st model object
@@ -497,13 +497,13 @@ 
         );
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps']                     = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -523,7 +523,7 @@ 
                     $result,
                     $request
                 );
-                $joined_result     = array_merge($join_model_result, $nice_result);
+                $joined_result = array_merge($join_model_result, $nice_result);
                 // but keep the meta stuff from the main model
                 if (isset($nice_result['meta'])) {
                     $joined_result['meta'] = $nice_result['meta'];
@@ -563,7 +563,7 @@ 
      */
     public function getEntitiesFromRelation($id, EE_Model_Relation_Base $relation, WP_REST_Request $request): array
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -610,7 +610,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -658,7 +658,7 @@ 
         ?WP_REST_Request $rest_request,
         string $deprecated = null
     ): array {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -712,7 +712,7 @@ 
             $rest_request,
             $has_protected_fields
         );
-        $entity_array                       = apply_filters(
+        $entity_array = apply_filters(
             'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
             $entity_array,
             $model,
@@ -744,7 +744,7 @@ 
             $rest_request,
             $this
         );
-        if (! $current_user_full_access_to_entity) {
+        if ( ! $current_user_full_access_to_entity) {
             $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
                 $entity_array,
                 $model,
@@ -779,7 +779,7 @@ 
      */
     protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
     {
-        if (! $protected || ! $model->hasPassword()) {
+        if ( ! $protected || ! $model->hasPassword()) {
             return $results_so_far;
         }
         $password_field  = $model->getPasswordField();
@@ -829,8 +829,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post     = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof WP_Post) {
+            $post     = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -840,7 +840,7 @@ 
                     )
                 );
             }
-            $model_object_classname          = 'EE_' . $model->get_this_model_name();
+            $model_object_classname          = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -851,14 +851,14 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif (
                 $this->isSubclassOfOne(
                     $field_obj,
                     $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
                 )
             ) {
-                $result[ $field_name ] = [
+                $result[$field_name] = [
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 ];
@@ -868,7 +868,7 @@ 
                     $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
                 )
             ) {
-                $result[ $field_name ] = [
+                $result[$field_name] = [
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 ];
@@ -899,10 +899,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ]          = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name]          = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -959,7 +959,7 @@ 
     protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -985,7 +985,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ],
             ];
@@ -1002,12 +1002,12 @@ 
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part                                                      =
                     Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = [
                     [
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -1047,12 +1047,12 @@ 
         bool $included_items_protected = false
     ): array {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
         foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
+            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
                 $rest_request->get_param('include'),
                 $relation_name
             );
@@ -1080,7 +1080,7 @@ 
                         $model->deduce_fields_n_values_from_cols_n_values($db_row)
                     )
                 );
-                if (! $included_items_protected) {
+                if ( ! $included_items_protected) {
                     try {
                         $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
                             $primary_model_query_params,
@@ -1100,7 +1100,7 @@ 
                             ? null
                             : [];
                 }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results;
             }
         }
         return $entity_array;
@@ -1127,7 +1127,7 @@ 
         $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
+        if ( ! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
             if ($model->has_primary_key_field()) {
                 // always include the primary key. ya just gotta know that at least
                 $includes_for_this_model[] = $model->primary_key_name();
@@ -1185,13 +1185,13 @@ 
                 $schema = $this->fields_calculator->getJsonSchemaForModel($model);
                 if (
                     $row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']
+                    && isset($schema['properties'][$field_to_calculate]['protected'])
+                    && $schema['properties'][$field_to_calculate]['protected']
                 ) {
                     $calculated_value   = null;
                     $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
+                    if ($schema['properties'][$field_to_calculate]['type']) {
+                        switch ($schema['properties'][$field_to_calculate]['type']) {
                             case 'boolean':
                                 $calculated_value = false;
                                 break;
@@ -1311,7 +1311,7 @@ 
      */
     public function validateContext(?string $context): string
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1335,7 +1335,7 @@ 
             EE_Default_Where_Conditions::MINIMUM_ALL,
             EE_Default_Where_Conditions::MINIMUM_OTHERS,
         ];
-        if (! $default_where_conditions) {
+        if ( ! $default_where_conditions) {
             $default_where_conditions = EE_Default_Where_Conditions::ALL;
         }
         if (
@@ -1427,14 +1427,14 @@ 
         }
         if (isset($query_params['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
+            if ( ! is_array($query_params['limit'])) {
                 $limit_array = explode(',', (string) $query_params['limit']);
             } else {
                 $limit_array = $query_params['limit'];
             }
             $sanitized_limit = [];
             foreach ($limit_array as $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1491,7 +1491,7 @@ 
     {
         $model_ready_query_params = [];
         foreach ($query_params as $key => $value) {
-            $model_ready_query_params[ $key ] = is_array($value)
+            $model_ready_query_params[$key] = is_array($value)
                 ? $this->prepareRestQueryParamsKeyForModels($model, $value)
                 : $value;
         }
@@ -1510,9 +1510,9 @@ 
         $model_ready_query_params = [];
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1544,17 +1544,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1597,9 +1597,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name         = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include === $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1642,7 +1642,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 reset($model_rows),
@@ -1654,7 +1654,7 @@ 
         if ($model->exists($query_params)) {
             // you got shafted- it existed but we didn't want to tell you!
             throw new RestException(
-                'rest_user_cannot_' . $context,
+                'rest_user_cannot_'.$context,
                 sprintf(
                     __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                     $context,
@@ -1706,14 +1706,14 @@ 
         // if this entity requires a password, they better give it and it better be right!
         if (
             $model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
+            && $model_row[$model->getPasswordField()->get_qualified_column()] !== ''
         ) {
             if (empty($request['password'])) {
                 throw new RestPasswordRequiredException();
             }
             if (
                 ! hash_equals(
-                    $model_row[ $model->getPasswordField()->get_qualified_column() ],
+                    $model_row[$model->getPasswordField()->get_qualified_column()],
                     $request['password']
                 )
             ) {
@@ -1727,12 +1727,12 @@ 
             $password_supplied = $request->get_param('password');
             if (empty($password_supplied)) {
                 $query_params['exclude_protected'] = true;
-                if (! $model->exists($query_params)) {
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordRequiredException();
                 }
             } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (! $model->exists($query_params)) {
+                $query_params[0][$model->modelChainAndPassword()] = $password_supplied;
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordIncorrectException();
                 }
             }

core/libraries/rest_api/calculations/Registration.php

Indentation +94 added lines, -94 removed lines

@@ -25,104 +25,104 @@
  */
 class Registration extends RegistrationCalculationBase
 {
-    protected EEM_Registration $registration_model;
+	protected EEM_Registration $registration_model;
 
-    /**
-     * Registration constructor.
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(EEM_Registration $registration_model)
-    {
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * Registration constructor.
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(EEM_Registration $registration_model)
+	{
+		$this->registration_model = $registration_model;
+	}
 
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array                      $wpdb_row
-     * @param WP_REST_Request            $request
-     * @param RegistrationControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function datetimeCheckinStati($wpdb_row, $request, $controller): array
-    {
-        $registration = is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])
-            ? $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID'])
-            : null;
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array                      $wpdb_row
+	 * @param WP_REST_Request            $request
+	 * @param RegistrationControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function datetimeCheckinStati($wpdb_row, $request, $controller): array
+	{
+		$registration = is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])
+			? $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID'])
+			: null;
 
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = EEM_Datetime::instance()->get_col(
-            [
-                [
-                    'Ticket.TKT_ID' => $registration->ticket_ID(),
-                ],
-                'default_where_conditions' => EE_Default_Where_Conditions::MINIMUM_ALL,
-            ]
-        );
-        $checkin_stati = [];
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $registration->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case EE_Checkin::status_checked_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case EE_Checkin::status_checked_in:
-                    $status_pretty = 'IN';
-                    break;
-                case EE_Checkin::status_checked_never:
-                default:
-                    $status_pretty = 'NEVER';
-            }
-            $checkin_stati[ $datetime_id ] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = EEM_Datetime::instance()->get_col(
+			[
+				[
+					'Ticket.TKT_ID' => $registration->ticket_ID(),
+				],
+				'default_where_conditions' => EE_Default_Where_Conditions::MINIMUM_ALL,
+			]
+		);
+		$checkin_stati = [];
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $registration->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case EE_Checkin::status_checked_out:
+					$status_pretty = 'OUT';
+					break;
+				case EE_Checkin::status_checked_in:
+					$status_pretty = 'IN';
+					break;
+				case EE_Checkin::status_checked_never:
+				default:
+					$status_pretty = 'NEVER';
+			}
+			$checkin_stati[ $datetime_id ] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'datetime_checkin_stati' => array(
-                'description' => esc_html__(
-                    'Returns the checkin status for each datetime this registration has access to.',
-                    'event_espresso'
-                ),
-                'type' => 'object',
-                'properties' => array(),
-                'additionalProperties' => array(
-                    'description' => esc_html__(
-                        'Keys are date-time ids and values are the check-in status',
-                        'event_espresso'
-                    ),
-                    'type' => 'string'
-                ),
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'datetime_checkin_stati' => array(
+				'description' => esc_html__(
+					'Returns the checkin status for each datetime this registration has access to.',
+					'event_espresso'
+				),
+				'type' => 'object',
+				'properties' => array(),
+				'additionalProperties' => array(
+					'description' => esc_html__(
+						'Keys are date-time ids and values are the check-in status',
+						'event_espresso'
+					),
+					'type' => 'string'
+				),
+			),
+		);
+	}
 }