eventespresso / event-espresso-core

core/services/assets/AssetManager.php

Indentation +323 added lines, -323 removed lines

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

core/services/helpers/DebugDisplay.php

Indentation +26 added lines, -26 removed lines

@@ -4,34 +4,34 @@
 
 trait DebugDisplay
 {
-    /**
-     * used for controlling how much data is displayed when debugging
-     * threshold is set to 0 by default, but can be set to 1, 2, 3, or 4
-     * where higher numbers display more data
-     *
-     * @var int
-     */
-    private int $threshold = 0;
+	/**
+	 * used for controlling how much data is displayed when debugging
+	 * threshold is set to 0 by default, but can be set to 1, 2, 3, or 4
+	 * where higher numbers display more data
+	 *
+	 * @var int
+	 */
+	private int $threshold = 0;
 
-    private array $levels = [
-        0 => 'none',
-        1 => 'low',
-        2 => 'medium',
-        3 => 'high',
-        4 => 'all'
-    ];
+	private array $levels = [
+		0 => 'none',
+		1 => 'low',
+		2 => 'medium',
+		3 => 'high',
+		4 => 'all'
+	];
 
 
-    public function initializeDebugDisplay(int $threshold = 0, ?array $levels = null)
-    {
-        $this->threshold = defined('WP_DEBUG') && WP_DEBUG ? $threshold: 0;
-        $this->levels = $levels ?: $this->levels;
-    }
+	public function initializeDebugDisplay(int $threshold = 0, ?array $levels = null)
+	{
+		$this->threshold = defined('WP_DEBUG') && WP_DEBUG ? $threshold: 0;
+		$this->levels = $levels ?: $this->levels;
+	}
 
-    public function debugLog(string $text, int $level = 1)
-    {
-        if ($this->threshold && $this->threshold >= $level) {
-            error_log($text);
-        }
-    }
+	public function debugLog(string $text, int $level = 1)
+	{
+		if ($this->threshold && $this->threshold >= $level) {
+			error_log($text);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 
     public function initializeDebugDisplay(int $threshold = 0, ?array $levels = null)
     {
-        $this->threshold = defined('WP_DEBUG') && WP_DEBUG ? $threshold: 0;
+        $this->threshold = defined('WP_DEBUG') && WP_DEBUG ? $threshold : 0;
         $this->levels = $levels ?: $this->levels;
     }
 

core/services/database/TableManager.php

Indentation +239 added lines, -239 removed lines

@@ -16,264 +16,264 @@
  */
 class TableManager extends EE_Base
 {
-    private ?TableAnalysis $table_analysis;
+	private ?TableAnalysis $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function getTableAnalysis(): ?TableAnalysis
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function getTableAnalysis(): ?TableAnalysis
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     * @throws EE_Error
-     */
-    public function addColumn(string $table_name, string $column_name, string $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns         = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 * @throws EE_Error
+	 */
+	public function addColumn(string $table_name, string $column_name, string $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns         = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return array
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function getTableColumns(string $table_name): array
-    {
-        global $wpdb;
-        $table_name  = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = [];
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return array
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function getTableColumns(string $table_name): array
+	{
+		global $wpdb;
+		$table_name  = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = [];
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return bool|int
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function dropTable(string $table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS $table_name");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function dropTable(string $table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS $table_name");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @param string[] $table_names
-     * @return array of table names which we deleted
-     * @throws EE_Error
-     * @global WPDB    $wpdb
-     */
-    public function dropTables(array $table_names): array
-    {
-        $tables_to_delete = [];
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @param string[] $table_names
+	 * @return array of table names which we deleted
+	 * @throws EE_Error
+	 * @global WPDB    $wpdb
+	 */
+	public function dropTables(array $table_names): array
+	{
+		$tables_to_delete = [];
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool|int the number of indexes dropped. False if there was a datbase error
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function dropIndex(string $table_name, string $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name         = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM $table_name WHERE key_name = '$index_name'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE $table_name DROP INDEX $index_name");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool|int the number of indexes dropped. False if there was a datbase error
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function dropIndex(string $table_name, string $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name         = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM $table_name WHERE key_name = '$index_name'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name // using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE $table_name DROP INDEX $index_name");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws EE_Error
-     */
-    public function createTable(string $table_name, string $create_sql, string $engine = 'InnoDB')
-    {
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine " . $wpdb->get_charset_collate();
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function createTable(string $table_name, string $create_sql, string $engine = 'InnoDB')
+	{
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine " . $wpdb->get_charset_collate();
 
-            // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            // happened. And then we can choose to tell the end user
-            $old_show_errors_policy       = $wpdb->show_errors();
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
+			// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			// happened. And then we can choose to tell the end user
+			$old_show_errors_policy       = $wpdb->show_errors();
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
 
-            if (! function_exists('dbDelta')) {
-                require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-            }
+			if (! function_exists('dbDelta')) {
+				require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+			}
 
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
-                throw new EE_Error($output);
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if (! empty($output)) {
+				throw new EE_Error($output);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string     $column_name        if none is provided, we assume the column name matches the index
-     *                                       (often true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws /EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        string $table_name,
-        string $index_name,
-        string $column_name = '',
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === '') {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if (
-                $column_name === $index_entry->Column_name
-                && (string)$desired_index_size !== $index_entry->Sub_part
-            ) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string     $column_name        if none is provided, we assume the column name matches the index
+	 *                                       (often true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws /EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		string $table_name,
+		string $index_name,
+		string $column_name = '',
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === '') {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if (
+				$column_name === $index_entry->Column_name
+				&& (string)$desired_index_size !== $index_entry->Sub_part
+			) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }

core/services/request/RequestStackCoreApp.php

Indentation +76 added lines, -76 removed lines

@@ -29,87 +29,87 @@
  */
 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);
-        LoaderFactory::getShared(EE_Cron_Tasks::class);
-        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);
+		LoaderFactory::getShared(EE_Cron_Tasks::class);
+		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/EE_Cart.core.php

Indentation +408 added lines, -408 removed lines

@@ -16,412 +16,412 @@
  */
 class EE_Cart implements ResettableInterface
 {
-    /**
-     * instance of the EE_Cart object
-     *
-     * @access    private
-     * @var EE_Cart $_instance
-     */
-    private static $_instance;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @access    protected
-     * @var EE_Session $_session
-     */
-    protected $_session;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * @var EE_Line_Item
-     */
-    private $_grand_total;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     */
-    private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-    /**
-     * @return EE_Session
-     */
-    public function session()
-    {
-        if (! $this->_session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->_session;
-    }
-
-
-    /**
-     * @param EE_Session $session
-     */
-    public function set_session(EE_Session $session = null)
-    {
-        $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->_grand_total = $line_item;
-    }
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param EE_Session     $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _create_grand_total()
-    {
-        $this->_grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->_grand_total;
-    }
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @access public
-     * @return EE_Line_Item[]
-     */
-    public function get_tickets()
-    {
-        if ($this->_grand_total === null) {
-            return array();
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
-    }
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function all_ticket_quantity_count()
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->get('LIN_quantity');
-        }
-        return $count;
-    }
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_taxes()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_grand_total()
-    {
-        return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
-    }
-
-
-    /**
-     * @process items for adding to cart
-     * @access  public
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty, false);
-        return $this->save_cart();
-    }
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_cart_total_before_tax()
-    {
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_applied_taxes()
-    {
-        return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_cart_grand_total()
-    {
-        EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculate_all_cart_totals()
-    {
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        $this->_grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->_grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @access public
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_items($line_item_codes = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function empty_cart()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_grand_total = $this->_create_grand_total();
-        return $this->save_cart(true);
-    }
-
-
-    /**
-     * @remove ALL items from cart and delete total as well
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cart()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-            if ($deleted) {
-                $deleted += $this->_grand_total->delete();
-                $this->_grand_total = null;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @save   cart to session
-     * @access public
-     * @param bool $apply_taxes
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save_cart($apply_taxes = true)
-    {
-        if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-            // make sure we don't cache the transaction because it can get stale
-            if (
-                $this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->_grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->_grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        }
-        return false;
-    }
-
-
-    public function __wakeup()
-    {
-        if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
-            $this->_grand_total = $this->_grand_total->ID();
-        }
-        return array('_grand_total');
-    }
+	/**
+	 * instance of the EE_Cart object
+	 *
+	 * @access    private
+	 * @var EE_Cart $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @access    protected
+	 * @var EE_Session $_session
+	 */
+	protected $_session;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * @var EE_Line_Item
+	 */
+	private $_grand_total;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if (! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if (! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 */
+	private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * @return EE_Session
+	 */
+	public function session()
+	{
+		if (! $this->_session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->_session;
+	}
+
+
+	/**
+	 * @param EE_Session $session
+	 */
+	public function set_session(EE_Session $session = null)
+	{
+		$this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->_grand_total = $line_item;
+	}
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param EE_Session     $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _create_grand_total()
+	{
+		$this->_grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->_grand_total;
+	}
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @access public
+	 * @return EE_Line_Item[]
+	 */
+	public function get_tickets()
+	{
+		if ($this->_grand_total === null) {
+			return array();
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
+	}
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function all_ticket_quantity_count()
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->get('LIN_quantity');
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_taxes()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_grand_total()
+	{
+		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
+	}
+
+
+	/**
+	 * @process items for adding to cart
+	 * @access  public
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty, false);
+		return $this->save_cart();
+	}
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_cart_total_before_tax()
+	{
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_applied_taxes()
+	{
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_cart_grand_total()
+	{
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculate_all_cart_totals()
+	{
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->_grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @access public
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_items($line_item_codes = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function empty_cart()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_grand_total = $this->_create_grand_total();
+		return $this->save_cart(true);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and delete total as well
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cart()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+			if ($deleted) {
+				$deleted += $this->_grand_total->delete();
+				$this->_grand_total = null;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @save   cart to session
+	 * @access public
+	 * @param bool $apply_taxes
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save_cart($apply_taxes = true)
+	{
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+			// make sure we don't cache the transaction because it can get stale
+			if (
+				$this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->_grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		}
+		return false;
+	}
+
+
+	public function __wakeup()
+	{
+		if (! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
+			$this->_grand_total = $this->_grand_total->ID();
+		}
+		return array('_grand_total');
+	}
 }

core/db_models/EEM_Line_Item.model.php

Indentation +625 added lines, -625 removed lines

@@ -27,632 +27,632 @@
  */
 class EEM_Line_Item extends EEM_Base
 {
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of the grand total. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_sub_tax = 'sub-tax';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order.
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // various line item object types
-    const OBJ_TYPE_EVENT       = 'Event';
-
-    const OBJ_TYPE_PRICE       = 'Price';
-
-    const OBJ_TYPE_PROMOTION   = 'Promotion';
-
-    const OBJ_TYPE_TICKET      = 'Ticket';
-
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
-
-    /**
-     * @var EEM_Line_Item $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              Default is NULL
-     *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item   = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables                 = [
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
-        ];
-        $line_items_can_be_for         = apply_filters(
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
-            ['Ticket', 'Price', 'Event']
-        );
-        $this->_fields                 = [
-            'Line_Item' => [
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
-                    'LIN_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'LIN_code'       => new EE_Slug_Field(
-                    'LIN_code',
-                    esc_html__('Code for index into Cart', 'event_espresso'),
-                    true
-                ),
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Transaction'
-                ),
-                'LIN_name'       => new EE_Full_HTML_Field(
-                    'LIN_name',
-                    esc_html__('Line Item Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'LIN_desc'       => new EE_Full_HTML_Field(
-                    'LIN_desc',
-                    esc_html__('Line Item Description', 'event_espresso'),
-                    true
-                ),
-                'LIN_unit_price' => new EE_Money_Field(
-                    'LIN_unit_price',
-                    esc_html__('Unit Price', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_percent'    => new EE_Float_Field(
-                    'LIN_percent',
-                    esc_html__('Percent', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_is_taxable' => new EE_Boolean_Field(
-                    'LIN_is_taxable',
-                    esc_html__('Taxable', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'LIN_order'      => new EE_Integer_Field(
-                    'LIN_order',
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_total'      => new EE_Money_Field(
-                    'LIN_total',
-                    esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_pretax'     => new EE_Money_Field(
-                    'LIN_pretax',
-                    esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_quantity'   => new EE_Integer_Field(
-                    'LIN_quantity',
-                    esc_html__('Quantity', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_parent'     => new EE_Integer_Field(
-                    'LIN_parent',
-                    esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
-                    true,
-                    null
-                ),
-                'LIN_type'       => new EE_Enum_Text_Field(
-                    'LIN_type',
-                    esc_html__('Type', 'event_espresso'),
-                    false,
-                    'line-item',
-                    [
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
-                        self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
-                    ]
-                ),
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'LIN_timestamp'  => new EE_Datetime_Field(
-                    'LIN_timestamp',
-                    esc_html__('When the line item was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
-            'Price'       => new EE_Belongs_To_Any_Relation(),
-            'Event'       => new EE_Belongs_To_Any_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     *
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => $line_item_type,
-                    'TXN_ID'   => $transaction,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     *
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => self::type_line_item,
-                    'TXN_ID'   => $transaction,
-                    'OR'       => [
-                        'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
-                        'OBJ_type*null'      => ['IS_NULL'],
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
-     * deleting and joining tables like this.
-     *
-     * @return int count of how many deleted
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query               = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of the grand total. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_sub_tax = 'sub-tax';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order.
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// various line item object types
+	const OBJ_TYPE_EVENT       = 'Event';
+
+	const OBJ_TYPE_PRICE       = 'Price';
+
+	const OBJ_TYPE_PROMOTION   = 'Promotion';
+
+	const OBJ_TYPE_TICKET      = 'Ticket';
+
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
+
+	/**
+	 * @var EEM_Line_Item $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                              (and any incoming timezone data that gets saved).
+	 *                              Note this just sends the timezone info to the date time model field objects.
+	 *                              Default is NULL
+	 *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item   = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables                 = [
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
+		];
+		$line_items_can_be_for         = apply_filters(
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
+			['Ticket', 'Price', 'Event']
+		);
+		$this->_fields                 = [
+			'Line_Item' => [
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
+					'LIN_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'LIN_code'       => new EE_Slug_Field(
+					'LIN_code',
+					esc_html__('Code for index into Cart', 'event_espresso'),
+					true
+				),
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					true,
+					null,
+					'Transaction'
+				),
+				'LIN_name'       => new EE_Full_HTML_Field(
+					'LIN_name',
+					esc_html__('Line Item Name', 'event_espresso'),
+					false,
+					''
+				),
+				'LIN_desc'       => new EE_Full_HTML_Field(
+					'LIN_desc',
+					esc_html__('Line Item Description', 'event_espresso'),
+					true
+				),
+				'LIN_unit_price' => new EE_Money_Field(
+					'LIN_unit_price',
+					esc_html__('Unit Price', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_percent'    => new EE_Float_Field(
+					'LIN_percent',
+					esc_html__('Percent', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_is_taxable' => new EE_Boolean_Field(
+					'LIN_is_taxable',
+					esc_html__('Taxable', 'event_espresso'),
+					false,
+					false
+				),
+				'LIN_order'      => new EE_Integer_Field(
+					'LIN_order',
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_total'      => new EE_Money_Field(
+					'LIN_total',
+					esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_pretax'     => new EE_Money_Field(
+					'LIN_pretax',
+					esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_quantity'   => new EE_Integer_Field(
+					'LIN_quantity',
+					esc_html__('Quantity', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_parent'     => new EE_Integer_Field(
+					'LIN_parent',
+					esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
+					true,
+					null
+				),
+				'LIN_type'       => new EE_Enum_Text_Field(
+					'LIN_type',
+					esc_html__('Type', 'event_espresso'),
+					false,
+					'line-item',
+					[
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
+						self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
+						self::type_total         => esc_html__('Total', 'event_espresso'),
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
+					]
+				),
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__('ID of Item purchased.', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'LIN_timestamp'  => new EE_Datetime_Field(
+					'LIN_timestamp',
+					esc_html__('When the line item was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
+			'Price'       => new EE_Belongs_To_Any_Relation(),
+			'Event'       => new EE_Belongs_To_Any_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 *
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => $line_item_type,
+					'TXN_ID'   => $transaction,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => self::type_line_item,
+					'TXN_ID'   => $transaction,
+					'OR'       => [
+						'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
+						'OBJ_type*null'      => ['IS_NULL'],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
+	 * deleting and joining tables like this.
+	 *
+	 * @return int count of how many deleted
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query               = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int           $TXN_ID
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $TXN_ID,
-                    'OBJ_type' => str_replace('EE_', '', get_class($object)),
-                    'OBJ_ID'   => $object->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int    $TXN_ID
-     * @param string $OBJ_type
-     * @param array  $OBJ_IDs
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_object_line_items_for_transaction(
-        $TXN_ID,
-        $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
-        $OBJ_IDs = []
-    ) {
-        $query_params = [
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
-        ];
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all([$query_params]);
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $transaction->ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                    'OBJ_ID'   => $TKT_ID,
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 1.0.0
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                    'OBJ_ID'     => $promotion->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since   1.0.0
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     *
-     * @param EE_Registration $registration
-     * @param array           $original_query_params any extra query params you'd like to be merged with
-     * @return array @see
-     *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function line_item_for_registration_query_params(
-        EE_Registration $registration,
-        $original_query_params = []
-    ) {
-        return array_replace_recursive(
-            $original_query_params,
-            [
-                [
-                    'OBJ_ID'   => $registration->ticket_ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'TXN_ID'   => $registration->transaction_ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = [
-            'TXN_ID'   => 0,
-            'LIN_type' => 'total',
-        ];
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan              = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = [
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            ];
-        }
-        return $this->get_all([$where_params]);
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp        = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => ['<=', $timestamp],
-                ],
-            ]
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int           $TXN_ID
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $TXN_ID,
+					'OBJ_type' => str_replace('EE_', '', get_class($object)),
+					'OBJ_ID'   => $object->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int    $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array  $OBJ_IDs
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_object_line_items_for_transaction(
+		$TXN_ID,
+		$OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
+		$OBJ_IDs = []
+	) {
+		$query_params = [
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
+		];
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all([$query_params]);
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $transaction->ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+					'OBJ_ID'   => $TKT_ID,
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 1.0.0
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+					'OBJ_ID'     => $promotion->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since   1.0.0
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
+	 * @return array @see
+	 *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function line_item_for_registration_query_params(
+		EE_Registration $registration,
+		$original_query_params = []
+	) {
+		return array_replace_recursive(
+			$original_query_params,
+			[
+				[
+					'OBJ_ID'   => $registration->ticket_ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'TXN_ID'   => $registration->transaction_ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = [
+			'TXN_ID'   => 0,
+			'LIN_type' => 'total',
+		];
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan              = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = [
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			];
+		}
+		return $this->get_all([$where_params]);
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp        = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => ['<=', $timestamp],
+				],
+			]
+		);
+	}
 }

core/db_models/relations/EE_Belongs_To_Relation.php

Indentation +143 added lines, -143 removed lines

@@ -11,157 +11,157 @@
  */
 class EE_Belongs_To_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Object representing the relationship between two models. Belongs_To means that THIS model has the foreign key
-     * to the other model. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool   $block_deletes                                 For Belongs_To relations, this is set to FALSE by
-     *                                                              default. if there are related models across this
-     *                                                              relation, block (prevent and add an error) the
-     *                                                              deletion of this model
-     * @param string $related_model_objects_deletion_error_message  a customized error message on blocking deletes
-     *                                                              instead of the default
-     */
-    public function __construct(bool $block_deletes = false, string $related_model_objects_deletion_error_message = '')
-    {
-        parent::__construct($block_deletes, $related_model_objects_deletion_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Belongs_To means that THIS model has the foreign key
+	 * to the other model. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool   $block_deletes                                 For Belongs_To relations, this is set to FALSE by
+	 *                                                              default. if there are related models across this
+	 *                                                              relation, block (prevent and add an error) the
+	 *                                                              deletion of this model
+	 * @param string $related_model_objects_deletion_error_message  a customized error message on blocking deletes
+	 *                                                              instead of the default
+	 */
+	public function __construct(bool $block_deletes = false, string $related_model_objects_deletion_error_message = '')
+	{
+		parent::__construct($block_deletes, $related_model_objects_deletion_error_message);
+	}
 
 
-    /**
-     * get_join_statement
-     *
-     * @param string $model_relation_chain
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_statement(string $model_relation_chain): string
-    {
-        // create the sql string like
-        $this_table_fk_field  =
-            $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
-        $this_table_alias     = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model()->get_this_model_name()
-            ) . $this_table_fk_field->get_table_alias();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
-        return $this->_left_join(
-                $other_table,
-                $other_table_alias,
-                $other_table_pk_field->get_table_column(),
-                $this_table_alias,
-                $this_table_fk_field->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-    }
+	/**
+	 * get_join_statement
+	 *
+	 * @param string $model_relation_chain
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_statement(string $model_relation_chain): string
+	{
+		// create the sql string like
+		$this_table_fk_field  =
+			$this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
+		$this_table_alias     = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model()->get_this_model_name()
+			) . $this_table_fk_field->get_table_alias();
+		$other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_other_model()->get_this_model_name()
+			) . $other_table_pk_field->get_table_alias();
+		$other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+		return $this->_left_join(
+				$other_table,
+				$other_table_alias,
+				$other_table_pk_field->get_table_column(),
+				$this_table_alias,
+				$this_table_fk_field->get_table_column()
+			) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+	}
 
 
-    /**
-     * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // find the field on the other model which is a foreign key to this model
-        $fk_on_this_model =
-            $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        if ($this_model_obj->get($fk_on_this_model->get_name()) != $other_model_obj->ID()) {
-            // set that field on the other model to this model's ID
-            $this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
-            $this_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+	/**
+	 * Sets this model object's foreign key to the other model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// find the field on the other model which is a foreign key to this model
+		$fk_on_this_model =
+			$this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		if ($this_model_obj->get($fk_on_this_model->get_name()) != $other_model_obj->ID()) {
+			// set that field on the other model to this model's ID
+			$this_model_obj->set($fk_on_this_model->get_name(), $other_model_obj->ID());
+			$this_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the this model object's foreign key to its default, instead of pointing to the other model object
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
-        // find the field on the other model which is a foreign key to this model
-        $fk_on_this_model = $this->get_this_model()->get_foreign_key_to(
-            $this->get_other_model()->get_this_model_name()
-        );
-        // set that field on the other model to this model's ID
-        $this_model_obj->set($fk_on_this_model->get_name(), null, true);
-        $this_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the this model object's foreign key to its default, instead of pointing to the other model object
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id);
+		// find the field on the other model which is a foreign key to this model
+		$fk_on_this_model = $this->get_this_model()->get_foreign_key_to(
+			$this->get_other_model()->get_this_model_name()
+		);
+		// set that field on the other model to this model's ID
+		$this_model_obj->set($fk_on_this_model->get_name(), null, true);
+		$this_model_obj->save();
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Overrides parent so that we don't NEED to save the $model_object before getting the related objects.
-     *
-     * @param EE_Base_Class $model_object_or_id
-     * @param array|null    $query_params
-     * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws Exception
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        ?array $query_params = [],
-        bool $values_already_prepared_by_model_object = false
-    ): array {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__(
-                    'The argument $values_already_prepared_by_model_object is no longer used.',
-                    'event_espresso'
-                ),
-                '4.8.1'
-            );
-        }
-        // get column on this model object which is a foreign key to the other model
-        $fk_field_obj = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        // get its value
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_obj = $model_object_or_id;
-        } else {
-            $model_obj = $this->get_this_model()->ensure_is_obj($model_object_or_id);
-        }
-        $ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
-        // if PK ID is empty, there is nothing to match to
-        if(empty($ID_value_on_other_model)) {
-            return [];
-        }
-        // get all where their PK matches that value
-        $query_params[0][ $this->get_other_model()->get_primary_key_field()->get_name() ] = $ID_value_on_other_model;
-        $query_params                                                                     =
-            $this->_disable_default_where_conditions_on_query_param($query_params);
+	/**
+	 * Overrides parent so that we don't NEED to save the $model_object before getting the related objects.
+	 *
+	 * @param EE_Base_Class $model_object_or_id
+	 * @param array|null    $query_params
+	 * @param boolean       $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		?array $query_params = [],
+		bool $values_already_prepared_by_model_object = false
+	): array {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__(
+					'The argument $values_already_prepared_by_model_object is no longer used.',
+					'event_espresso'
+				),
+				'4.8.1'
+			);
+		}
+		// get column on this model object which is a foreign key to the other model
+		$fk_field_obj = $this->get_this_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		// get its value
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_obj = $model_object_or_id;
+		} else {
+			$model_obj = $this->get_this_model()->ensure_is_obj($model_object_or_id);
+		}
+		$ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
+		// if PK ID is empty, there is nothing to match to
+		if(empty($ID_value_on_other_model)) {
+			return [];
+		}
+		// get all where their PK matches that value
+		$query_params[0][ $this->get_other_model()->get_primary_key_field()->get_name() ] = $ID_value_on_other_model;
+		$query_params                                                                     =
+			$this->_disable_default_where_conditions_on_query_param($query_params);
 //      echo '$query_params';
 //      var_dump($query_params);
-        return $this->get_other_model()->get_all($query_params);
-    }
+		return $this->get_other_model()->get_all($query_params);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -46,19 +46,19 @@ 
         $this_table_alias     = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_fk_field->get_table_alias();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_fk_field->get_table_alias();
+        $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+            ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
         return $this->_left_join(
                 $other_table,
                 $other_table_alias,
                 $other_table_pk_field->get_table_column(),
                 $this_table_alias,
                 $this_table_fk_field->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+            ).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 
 
@@ -153,11 +153,11 @@ 
         }
         $ID_value_on_other_model = $model_obj->get($fk_field_obj->get_name());
         // if PK ID is empty, there is nothing to match to
-        if(empty($ID_value_on_other_model)) {
+        if (empty($ID_value_on_other_model)) {
             return [];
         }
         // get all where their PK matches that value
-        $query_params[0][ $this->get_other_model()->get_primary_key_field()->get_name() ] = $ID_value_on_other_model;
+        $query_params[0][$this->get_other_model()->get_primary_key_field()->get_name()] = $ID_value_on_other_model;
         $query_params                                                                     =
             $this->_disable_default_where_conditions_on_query_param($query_params);
 //      echo '$query_params';

core/db_models/helpers/EE_Table_Base.php

Indentation +147 added lines, -147 removed lines

@@ -6,151 +6,151 @@
  */
 abstract class EE_Table_Base
 {
-    /**
-     * This holds the table_name without the table prefix.
-     *
-     * @var string
-     */
-    public string $_table_name;
-
-
-    /**
-     * This holds what is used as the alias for the table in queries.
-     *
-     * @var string
-     */
-    public string $_table_alias;
-
-
-    /**
-     * Table's private key column
-     *
-     * @var string|null
-     */
-    protected ?string $_pk_column = null;
-
-
-    /**
-     * Whether this table is a global table (in multisite) or specific to site.
-     *
-     * @var bool|null
-     */
-    protected ?bool $_global;
-
-
-    /**
-     * @param string      $table_name with or without wpdb prefix
-     * @param string|null $pk_column
-     * @param boolean     $global     whether the table is "global" as in there is only 1 table on an entire multisite
-     *                                install, or whether each site on a multisite installation has a copy of this table
-     * @global wpdb       $wpdb
-     */
-    public function __construct(string $table_name, ?string $pk_column, bool $global = false)
-    {
-        $this->_global = $global;
-        $prefix        = $this->get_table_prefix();
-        // if they added the prefix, let's remove it because we delay adding the prefix until right when it's needed.
-        if (strpos($table_name, $prefix) === 0) {
-            $table_name = substr_replace($table_name, '', 0, strlen($prefix));
-        }
-        $this->_table_name = $table_name;
-        $this->_pk_column  = $pk_column;
-    }
-
-
-    /**
-     * This returns the table prefix for the current model state.
-     *
-     * @return string
-     * @global wpdb $wpdb
-     */
-    public function get_table_prefix()
-    {
-        global $wpdb;
-        if ($this->_global) {
-            return $wpdb->base_prefix;
-        }
-        return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
-    }
-
-
-    /**
-     * Used to set the table_alias property
-     *
-     * @param string $table_alias
-     */
-    public function _construct_finalize_with_alias(string $table_alias)
-    {
-        $this->_table_alias = $table_alias;
-    }
-
-
-    /**
-     * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
-     *
-     * @return string
-     */
-    public function get_table_name()
-    {
-        return $this->get_table_prefix() . $this->_table_name;
-    }
-
-
-    /**
-     * Provides what is currently set as the alias for the table to be used in queries.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_table_alias()
-    {
-        if (! $this->_table_alias) {
-            throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
-        }
-        return $this->_table_alias;
-    }
-
-
-    /**
-     * @return string name of column of PK
-     */
-    public function get_pk_column()
-    {
-        return $this->_pk_column;
-    }
-
-
-    /**
-     * returns a string with the table alias, a period, and the private key's column.
-     *
-     * @return string
-     */
-    public function get_fully_qualified_pk_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
-    }
-
-
-    /**
-     * returns the special sql for a inner select with a limit.
-     *
-     * @return string    SQL select
-     */
-    public function get_select_join_limit($limit)
-    {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
-    }
-
-
-    /**
-     * Returns whether or not htis is a global table (ie, on multisite there's
-     * only one of these tables, on the main blog)
-     *
-     * @return boolean
-     */
-    public function is_global()
-    {
-        return $this->_global;
-    }
+	/**
+	 * This holds the table_name without the table prefix.
+	 *
+	 * @var string
+	 */
+	public string $_table_name;
+
+
+	/**
+	 * This holds what is used as the alias for the table in queries.
+	 *
+	 * @var string
+	 */
+	public string $_table_alias;
+
+
+	/**
+	 * Table's private key column
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_pk_column = null;
+
+
+	/**
+	 * Whether this table is a global table (in multisite) or specific to site.
+	 *
+	 * @var bool|null
+	 */
+	protected ?bool $_global;
+
+
+	/**
+	 * @param string      $table_name with or without wpdb prefix
+	 * @param string|null $pk_column
+	 * @param boolean     $global     whether the table is "global" as in there is only 1 table on an entire multisite
+	 *                                install, or whether each site on a multisite installation has a copy of this table
+	 * @global wpdb       $wpdb
+	 */
+	public function __construct(string $table_name, ?string $pk_column, bool $global = false)
+	{
+		$this->_global = $global;
+		$prefix        = $this->get_table_prefix();
+		// if they added the prefix, let's remove it because we delay adding the prefix until right when it's needed.
+		if (strpos($table_name, $prefix) === 0) {
+			$table_name = substr_replace($table_name, '', 0, strlen($prefix));
+		}
+		$this->_table_name = $table_name;
+		$this->_pk_column  = $pk_column;
+	}
+
+
+	/**
+	 * This returns the table prefix for the current model state.
+	 *
+	 * @return string
+	 * @global wpdb $wpdb
+	 */
+	public function get_table_prefix()
+	{
+		global $wpdb;
+		if ($this->_global) {
+			return $wpdb->base_prefix;
+		}
+		return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
+	}
+
+
+	/**
+	 * Used to set the table_alias property
+	 *
+	 * @param string $table_alias
+	 */
+	public function _construct_finalize_with_alias(string $table_alias)
+	{
+		$this->_table_alias = $table_alias;
+	}
+
+
+	/**
+	 * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
+	 *
+	 * @return string
+	 */
+	public function get_table_name()
+	{
+		return $this->get_table_prefix() . $this->_table_name;
+	}
+
+
+	/**
+	 * Provides what is currently set as the alias for the table to be used in queries.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_table_alias()
+	{
+		if (! $this->_table_alias) {
+			throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
+		}
+		return $this->_table_alias;
+	}
+
+
+	/**
+	 * @return string name of column of PK
+	 */
+	public function get_pk_column()
+	{
+		return $this->_pk_column;
+	}
+
+
+	/**
+	 * returns a string with the table alias, a period, and the private key's column.
+	 *
+	 * @return string
+	 */
+	public function get_fully_qualified_pk_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_pk_column();
+	}
+
+
+	/**
+	 * returns the special sql for a inner select with a limit.
+	 *
+	 * @return string    SQL select
+	 */
+	public function get_select_join_limit($limit)
+	{
+		$limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
+		return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+	}
+
+
+	/**
+	 * Returns whether or not htis is a global table (ie, on multisite there's
+	 * only one of these tables, on the main blog)
+	 *
+	 * @return boolean
+	 */
+	public function is_global()
+	{
+		return $this->_global;
+	}
 }

core/db_models/helpers/EE_Secondary_Table.php

Indentation +153 added lines, -153 removed lines

@@ -9,157 +9,157 @@
 class EE_Secondary_Table extends EE_Table_Base
 {
 
-    protected ?string $_extra_join_conditions;
-
-    protected ?string $_fk_on_table;
-
-    protected ?EE_Table_Base $_table_to_join_with = null;
-
-
-    /**
-     * @param string      $table_name            with or without wpdb prefix
-     * @param string      $pk_column             name of primary key column on THIS table
-     * @param string|null $fk_column             the name of the COLUMN that is a foreign key to the primary table's
-     *                                           primary key
-     * @param string|null $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
-     * @param boolean     $global                whether the table is "global" as in there is only 1 table on an entire
-     *                                           multisite install, or whether each site on a multisite installation ha
-     *                                           a copy of this table
-     * @global WPDB       $wpdb
-     */
-    public function __construct(
-        string $table_name,
-        string $pk_column,
-        ?string $fk_column = null,
-        ?string $extra_join_conditions = null,
-        bool $global = false
-    ) {
-        $this->_fk_on_table           = $fk_column;
-        $this->_extra_join_conditions = $extra_join_conditions;
-        parent::__construct($table_name, $pk_column, $global);
-    }
-
-
-    public function get_fk_on_table(): ?string
-    {
-        return $this->_fk_on_table;
-    }
-
-
-    public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
-    {
-        $this->_table_to_join_with = $table;
-    }
-
-
-    /**
-     * @return string of sql like "Event.post_type = 'event'", which gets added to
-     * the end of the join statement with the primary table
-     */
-    public function get_extra_join_conditions(): ?string
-    {
-        return $this->_extra_join_conditions;
-    }
-
-
-    /**
-     * @return EE_Table_Base|null
-     */
-    public function get_table_to_join_with(): ?EE_Table_Base
-    {
-        return $this->_table_to_join_with;
-    }
-
-
-    /**
-     * creates join statement FROM primary table
-     * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
-     *
-     * @param string $primary_table_alias_with_model_chain_prefix allows us to set special conditions on the
-     *                                                            $table_name portion of the join query
-     *                                                            (i.e. doing a sub-query)
-     * @return string of SQL
-     * @throws EE_Error
-     */
-    public function get_join_sql($primary_table_alias_with_model_chain_prefix)
-    {
-        $table_name            = $this->get_table_name();
-        $secondary_table_alias =
-            EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
-                $primary_table_alias_with_model_chain_prefix
-            ) . $this->get_table_alias();
-        $other_table_pk        = $this->get_table_to_join_with()->get_pk_column();
-        $fk                    = $this->get_fk_on_table();
-        $join_sql              =
-            " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql .= "AND " . $this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
-
-
-    /**
-     * Produces join SQL like get_join_sql, except instead of joining the primary table to the
-     * secondary table, does the inverse: joins the secondary table to the primary one. Eg, instead of
-     * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
-     * " LEFT JOIN primary_table AS Primary ON ...".
-     * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
-    {
-        $primary_table_name  = $this->get_table_to_join_with()->get_table_name();
-        $primary_table_alias =
-            EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
-                $secondary_table_alias_with_model_chain_prefix
-            ) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk    = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
-        $fk                  = $this->get_fk_on_table();
-        $join_sql            =
-            " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
-        if ($this->get_extra_join_conditions()) {
-            $join_sql .= "AND " . $this->get_extra_join_conditions();
-        }
-        return $join_sql;
-    }
-
-
-    /**
-     * This prepares the join on the other table using a select with a internal limit.
-     *
-     * @param array|string $limit limit
-     * @return string             SQL to return
-     * @throws EE_Error
-     */
-    public function get_select_join_limit_join($limit)
-    {
-        // first get the select
-        $select   = $this->get_select_join_limit($limit);
-        return $this->get_join_sql($select);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function get_fully_qualified_fk_column()
-    {
-        $table_alias = $this->get_table_alias();
-        $fk          = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function get_fully_qualified_pk_on_fk_table()
-    {
-        $table_alias = $this->get_table_to_join_with()->get_table_alias();
-        $pk          = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
-    }
+	protected ?string $_extra_join_conditions;
+
+	protected ?string $_fk_on_table;
+
+	protected ?EE_Table_Base $_table_to_join_with = null;
+
+
+	/**
+	 * @param string      $table_name            with or without wpdb prefix
+	 * @param string      $pk_column             name of primary key column on THIS table
+	 * @param string|null $fk_column             the name of the COLUMN that is a foreign key to the primary table's
+	 *                                           primary key
+	 * @param string|null $extra_join_conditions string for additional SQL to add onto the join statement's ON condition
+	 * @param boolean     $global                whether the table is "global" as in there is only 1 table on an entire
+	 *                                           multisite install, or whether each site on a multisite installation ha
+	 *                                           a copy of this table
+	 * @global WPDB       $wpdb
+	 */
+	public function __construct(
+		string $table_name,
+		string $pk_column,
+		?string $fk_column = null,
+		?string $extra_join_conditions = null,
+		bool $global = false
+	) {
+		$this->_fk_on_table           = $fk_column;
+		$this->_extra_join_conditions = $extra_join_conditions;
+		parent::__construct($table_name, $pk_column, $global);
+	}
+
+
+	public function get_fk_on_table(): ?string
+	{
+		return $this->_fk_on_table;
+	}
+
+
+	public function _construct_finalize_set_table_to_join_with(EE_Table_Base $table)
+	{
+		$this->_table_to_join_with = $table;
+	}
+
+
+	/**
+	 * @return string of sql like "Event.post_type = 'event'", which gets added to
+	 * the end of the join statement with the primary table
+	 */
+	public function get_extra_join_conditions(): ?string
+	{
+		return $this->_extra_join_conditions;
+	}
+
+
+	/**
+	 * @return EE_Table_Base|null
+	 */
+	public function get_table_to_join_with(): ?EE_Table_Base
+	{
+		return $this->_table_to_join_with;
+	}
+
+
+	/**
+	 * creates join statement FROM primary table
+	 * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
+	 *
+	 * @param string $primary_table_alias_with_model_chain_prefix allows us to set special conditions on the
+	 *                                                            $table_name portion of the join query
+	 *                                                            (i.e. doing a sub-query)
+	 * @return string of SQL
+	 * @throws EE_Error
+	 */
+	public function get_join_sql($primary_table_alias_with_model_chain_prefix)
+	{
+		$table_name            = $this->get_table_name();
+		$secondary_table_alias =
+			EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
+				$primary_table_alias_with_model_chain_prefix
+			) . $this->get_table_alias();
+		$other_table_pk        = $this->get_table_to_join_with()->get_pk_column();
+		$fk                    = $this->get_fk_on_table();
+		$join_sql              =
+			" LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND " . $this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
+
+
+	/**
+	 * Produces join SQL like get_join_sql, except instead of joining the primary table to the
+	 * secondary table, does the inverse: joins the secondary table to the primary one. Eg, instead of
+	 * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
+	 * " LEFT JOIN primary_table AS Primary ON ...".
+	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix)
+	{
+		$primary_table_name  = $this->get_table_to_join_with()->get_table_name();
+		$primary_table_alias =
+			EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
+				$secondary_table_alias_with_model_chain_prefix
+			) . $this->get_table_to_join_with()->get_table_alias();
+		$primary_table_pk    = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+		$fk                  = $this->get_fk_on_table();
+		$join_sql            =
+			" LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND " . $this->get_extra_join_conditions();
+		}
+		return $join_sql;
+	}
+
+
+	/**
+	 * This prepares the join on the other table using a select with a internal limit.
+	 *
+	 * @param array|string $limit limit
+	 * @return string             SQL to return
+	 * @throws EE_Error
+	 */
+	public function get_select_join_limit_join($limit)
+	{
+		// first get the select
+		$select   = $this->get_select_join_limit($limit);
+		return $this->get_join_sql($select);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function get_fully_qualified_fk_column()
+	{
+		$table_alias = $this->get_table_alias();
+		$fk          = $this->get_fk_on_table();
+		return $table_alias . '.' . $fk;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function get_fully_qualified_pk_on_fk_table()
+	{
+		$table_alias = $this->get_table_to_join_with()->get_table_alias();
+		$pk          = $this->get_table_to_join_with()->get_pk_column();
+		return $table_alias . '.' . $pk;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -87,13 +87,13 @@ 
         $secondary_table_alias =
             EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
                 $primary_table_alias_with_model_chain_prefix
-            ) . $this->get_table_alias();
+            ).$this->get_table_alias();
         $other_table_pk        = $this->get_table_to_join_with()->get_pk_column();
         $fk                    = $this->get_fk_on_table();
         $join_sql              =
             " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql .= "AND " . $this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -115,13 +115,13 @@ 
         $primary_table_alias =
             EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix(
                 $secondary_table_alias_with_model_chain_prefix
-            ) . $this->get_table_to_join_with()->get_table_alias();
-        $primary_table_pk    = $this->get_table_to_join_with()->get_pk_column();// $this->get_pk_column();
+            ).$this->get_table_to_join_with()->get_table_alias();
+        $primary_table_pk    = $this->get_table_to_join_with()->get_pk_column(); // $this->get_pk_column();
         $fk                  = $this->get_fk_on_table();
         $join_sql            =
             " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
         if ($this->get_extra_join_conditions()) {
-            $join_sql .= "AND " . $this->get_extra_join_conditions();
+            $join_sql .= "AND ".$this->get_extra_join_conditions();
         }
         return $join_sql;
     }
@@ -137,7 +137,7 @@ 
     public function get_select_join_limit_join($limit)
     {
         // first get the select
-        $select   = $this->get_select_join_limit($limit);
+        $select = $this->get_select_join_limit($limit);
         return $this->get_join_sql($select);
     }
 
@@ -149,7 +149,7 @@ 
     {
         $table_alias = $this->get_table_alias();
         $fk          = $this->get_fk_on_table();
-        return $table_alias . '.' . $fk;
+        return $table_alias.'.'.$fk;
     }
 
 
@@ -160,6 +160,6 @@ 
     {
         $table_alias = $this->get_table_to_join_with()->get_table_alias();
         $pk          = $this->get_table_to_join_with()->get_pk_column();
-        return $table_alias . '.' . $pk;
+        return $table_alias.'.'.$pk;
     }
 }