eventespresso / event-espresso-core

core/interfaces/EEI_Transaction.interface.php

Indentation +41 added lines, -41 removed lines

@@ -6,63 +6,63 @@
 interface EEI_Transaction extends EEI_Base
 {
 
-    /**
-     * @return EEI_Payment
-     */
-    public function last_payment();
+	/**
+	 * @return EEI_Payment
+	 */
+	public function last_payment();
 
 
 
-    /**
-     * Gets the total that should eb paid for this transaction
-     *
-     * @return float
-     */
-    public function total();
+	/**
+	 * Gets the total that should eb paid for this transaction
+	 *
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Get the line item that represents the total for the transaction
-     *
-     * @return EE_Line_Item
-     */
-    public function total_line_item();
+	/**
+	 * Get the line item that represents the total for the transaction
+	 *
+	 * @return EE_Line_Item
+	 */
+	public function total_line_item();
 
 
 
-    /**
-     * Gets the primary registration for this transaction
-     *
-     * @return EEI_Registration
-     */
-    public function primary_registration();
+	/**
+	 * Gets the primary registration for this transaction
+	 *
+	 * @return EEI_Registration
+	 */
+	public function primary_registration();
 
 
 
-    /**
-     * Returns the balance due on the transaction
-     *
-     * @return float
-     */
-    public function remaining();
+	/**
+	 * Returns the balance due on the transaction
+	 *
+	 * @return float
+	 */
+	public function remaining();
 
 
 
-    /**
-     *        get Total Amount Paid to Date
-     *
-     * @access        public
-     * @return float
-     */
-    public function paid();
+	/**
+	 *        get Total Amount Paid to Date
+	 *
+	 * @access        public
+	 * @return float
+	 */
+	public function paid();
 
 
 
-    /**
-     * Retrieves all the pending payments on this transaction
-     *
-     * @return EEI_Payment[]
-     */
-    public function pending_payments();
+	/**
+	 * Retrieves all the pending payments on this transaction
+	 *
+	 * @return EEI_Payment[]
+	 */
+	public function pending_payments();
 }

core/interfaces/line_items/EE_Line_Item_Filter.interface.php

Indentation +7 added lines, -7 removed lines

@@ -15,11 +15,11 @@
  */
 interface EE_Line_Item_Filter
 {
-    /**
-     * process
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     */
-    public function process(EE_Line_Item $line_item): ?EE_Line_Item;
+	/**
+	 * process
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 */
+	public function process(EE_Line_Item $line_item): ?EE_Line_Item;
 }

core/interfaces/line_items/EEI_Line_Item.interface.php

Indentation +169 added lines, -169 removed lines

@@ -11,231 +11,231 @@
 interface EEI_Line_Item
 {
 
-    /**
-     * generic setter
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false);
+	/**
+	 * generic setter
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false);
 
 
 
-    /**
-     * @return string
-     */
-    public function name();
+	/**
+	 * @return string
+	 */
+	public function name();
 
 
 
-    /**
-     * @return string
-     */
-    public function desc();
+	/**
+	 * @return string
+	 */
+	public function desc();
 
 
 
-    /**
-     * The unit price for the items of this line item
-     * @return float
-     */
-    public function unit_price();
+	/**
+	 * The unit price for the items of this line item
+	 * @return float
+	 */
+	public function unit_price();
 
 
 
-    /**
-     * Returns the number of items in this line item
-     * @return int
-     */
-    public function quantity();
+	/**
+	 * Returns the number of items in this line item
+	 * @return int
+	 */
+	public function quantity();
 
 
 
-    /**
-     * Sets quantity
-     * @param int $quantity
-     */
-    public function set_quantity($quantity);
+	/**
+	 * Sets quantity
+	 * @param int $quantity
+	 */
+	public function set_quantity($quantity);
 
 
 
-    /**
-     * Returns the total amount due for this line item
-     * (usually quantity x unit_price)
-     * @return float
-     */
-    public function total();
+	/**
+	 * Returns the total amount due for this line item
+	 * (usually quantity x unit_price)
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Gets all teh children line items of type 'line-item'
-     * @return EE_Line_Item[]
-     */
-    public function get_items();
+	/**
+	 * Gets all teh children line items of type 'line-item'
+	 * @return EE_Line_Item[]
+	 */
+	public function get_items();
 
 
 
-    /**
-     * Gets the total for all the items purchased only
-     * @return float
-     */
-    public function get_items_total();
+	/**
+	 * Gets the total for all the items purchased only
+	 * @return float
+	 */
+	public function get_items_total();
 
 
 
-    /**
-     * Gets all the children line items of type 'tax'
-     * @return EE_Line_Item[]
-     */
-    public function tax_descendants();
+	/**
+	 * Gets all the children line items of type 'tax'
+	 * @return EE_Line_Item[]
+	 */
+	public function tax_descendants();
 
 
 
-    /**
-     * Gets the total amount of the tax sub-line items
-     * @return float
-     */
-    public function get_total_tax();
+	/**
+	 * Gets the total amount of the tax sub-line items
+	 * @return float
+	 */
+	public function get_total_tax();
 
 
 
-    /**
-     * Returns the name of the event the ticket is for
-     * @return string
-     */
-    public function ticket_event_name();
+	/**
+	 * Returns the name of the event the ticket is for
+	 * @return string
+	 */
+	public function ticket_event_name();
 
 
 
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null);
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null);
 
 
 
-    /**
-     * Indicates whether or not taxes should apply to this line item
-     * @return boolean
-     */
-    public function is_taxable();
+	/**
+	 * Indicates whether or not taxes should apply to this line item
+	 * @return boolean
+	 */
+	public function is_taxable();
 
 
 
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     * @return EE_Line_Item[]
-     */
-    public function children();
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 * @return EE_Line_Item[]
+	 */
+	public function children();
 
 
 
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     * @param EE_Line_Item $line_item
-     * @param bool         $set_order
-     * @return bool true for success, false for fail
-     */
-    public function add_child_line_item(EE_Line_Item $line_item, $set_order = true);
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 * @param EE_Line_Item $line_item
+	 * @param bool         $set_order
+	 * @return bool true for success, false for fail
+	 */
+	public function add_child_line_item(EE_Line_Item $line_item, $set_order = true);
 
 
 
-    /**
-     * Gets the line item type
-     * @return string
-     */
-    public function type();
+	/**
+	 * Gets the line item type
+	 * @return string
+	 */
+	public function type();
 
 
 
-    /**
-     * Gets item_id
-     * @return string
-     */
-    public function OBJ_ID();
+	/**
+	 * Gets item_id
+	 * @return string
+	 */
+	public function OBJ_ID();
 
 
 
-    /**
-     * Gets the related item type ( like: Ticket or Event )
-     * @return string
-     */
-    public function OBJ_type();
+	/**
+	 * Gets the related item type ( like: Ticket or Event )
+	 * @return string
+	 */
+	public function OBJ_type();
 
 
 
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total
-     * @return float
-     */
-    public function recalculate_total_including_taxes();
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total
+	 * @return float
+	 */
+	public function recalculate_total_including_taxes();
 
-    /**
-     * Checks if this item is a percentage modifier or not
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_percent();
-
-    /**
-     * Gets percent (between 100-.001)
-     * @return float
-     */
-    public function percent();
-
-    /**
-     * Sets total
-     * @param float $total
-     * @return boolean
-     */
-    public function set_total($total);
-
-    /**
-     * Sets unit_price
-     * @param float $unit_price
-     * @return boolean
-     */
-    public function set_unit_price($unit_price);
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
-     * @param string $code
-     * @param bool $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true);
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist);
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_percent();
+
+	/**
+	 * Gets percent (between 100-.001)
+	 * @return float
+	 */
+	public function percent();
+
+	/**
+	 * Sets total
+	 * @param float $total
+	 * @return boolean
+	 */
+	public function set_total($total);
+
+	/**
+	 * Sets unit_price
+	 * @param float $unit_price
+	 * @return boolean
+	 */
+	public function set_unit_price($unit_price);
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
+	 * @param string $code
+	 * @param bool $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true);
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist);
 }

core/db_models/EEM_Price.model.php

Indentation +338 added lines, -338 removed lines

@@ -13,369 +13,369 @@
 class EEM_Price extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Price object
-    protected static $_instance;
+	// private instance of the EEM_Price object
+	protected static $_instance;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param string $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)
-     */
-    protected function __construct($timezone)
-    {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->singular_item = __('Price', 'event_espresso');
-        $this->plural_item   = __('Prices', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param string $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)
+	 */
+	protected function __construct($timezone)
+	{
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->singular_item = __('Price', 'event_espresso');
+		$this->plural_item   = __('Prices', 'event_espresso');
 
-        $this->_tables          = [
-            'Price' => new EE_Primary_Table('esp_price', 'PRC_ID'),
-        ];
-        $this->_fields          = [
-            'Price' => [
-                'PRC_ID'         => new EE_Primary_Key_Int_Field(
-                    'PRC_ID',
-                    'Price ID'
-                ),
-                'PRT_ID'         => new EE_Foreign_Key_Int_Field(
-                    'PRT_ID',
-                    esc_html__('Price type Id', 'event_espresso'),
-                    false,
-                    null,
-                    'Price_Type'
-                ),
-                'PRC_amount'     => new EE_Money_Field(
-                    'PRC_amount',
-                    esc_html__('Price Amount', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PRC_name'       => new EE_Plain_Text_Field(
-                    'PRC_name',
-                    esc_html__('Name of Price', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PRC_desc'       => new EE_Post_Content_Field(
-                    'PRC_desc',
-                    esc_html__('Price Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PRC_is_default' => new EE_Boolean_Field(
-                    'PRC_is_default',
-                    esc_html__('Flag indicating whether price is a default price', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRC_overrides'  => new EE_Integer_Field(
-                    'PRC_overrides',
-                    esc_html__(
-                        'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'PRC_order'      => new EE_Integer_Field(
-                    'PRC_order',
-                    esc_html__(
-                        'Order of Application of Price (lower numbers apply first?)',
-                        'event_espresso'
-                    ),
-                    false,
-                    1
-                ),
-                'PRC_deleted'    => new EE_Trashed_Flag_Field(
-                    'PRC_deleted',
-                    esc_html__('Flag Indicating if this has been deleted or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PRC_parent'     => new EE_Integer_Field(
-                    'PRC_parent',
-                    esc_html__('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'PRC_wp_user'    => new EE_WP_User_Field(
-                    'PRC_wp_user',
-                    esc_html__('Price Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Ticket'     => new EE_HABTM_Relation('Ticket_Price'),
-            'Price_Type' => new EE_Belongs_To_Relation(),
-            'WP_User'    => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
-            new EE_Restriction_Generator_Default_Public(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Default_Protected(
-                'PRC_is_default',
-                'Ticket.Datetime.Event'
-            );
-        parent::__construct($timezone);
-    }
+		$this->_tables          = [
+			'Price' => new EE_Primary_Table('esp_price', 'PRC_ID'),
+		];
+		$this->_fields          = [
+			'Price' => [
+				'PRC_ID'         => new EE_Primary_Key_Int_Field(
+					'PRC_ID',
+					'Price ID'
+				),
+				'PRT_ID'         => new EE_Foreign_Key_Int_Field(
+					'PRT_ID',
+					esc_html__('Price type Id', 'event_espresso'),
+					false,
+					null,
+					'Price_Type'
+				),
+				'PRC_amount'     => new EE_Money_Field(
+					'PRC_amount',
+					esc_html__('Price Amount', 'event_espresso'),
+					false,
+					0
+				),
+				'PRC_name'       => new EE_Plain_Text_Field(
+					'PRC_name',
+					esc_html__('Name of Price', 'event_espresso'),
+					false,
+					''
+				),
+				'PRC_desc'       => new EE_Post_Content_Field(
+					'PRC_desc',
+					esc_html__('Price Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PRC_is_default' => new EE_Boolean_Field(
+					'PRC_is_default',
+					esc_html__('Flag indicating whether price is a default price', 'event_espresso'),
+					false,
+					false
+				),
+				'PRC_overrides'  => new EE_Integer_Field(
+					'PRC_overrides',
+					esc_html__(
+						'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'PRC_order'      => new EE_Integer_Field(
+					'PRC_order',
+					esc_html__(
+						'Order of Application of Price (lower numbers apply first?)',
+						'event_espresso'
+					),
+					false,
+					1
+				),
+				'PRC_deleted'    => new EE_Trashed_Flag_Field(
+					'PRC_deleted',
+					esc_html__('Flag Indicating if this has been deleted or not', 'event_espresso'),
+					false,
+					false
+				),
+				'PRC_parent'     => new EE_Integer_Field(
+					'PRC_parent',
+					esc_html__('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'PRC_wp_user'    => new EE_WP_User_Field(
+					'PRC_wp_user',
+					esc_html__('Price Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Ticket'     => new EE_HABTM_Relation('Ticket_Price'),
+			'Price_Type' => new EE_Belongs_To_Relation(),
+			'WP_User'    => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+			new EE_Restriction_Generator_Default_Public(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Default_Protected(
+				'PRC_is_default',
+				'Ticket.Datetime.Event'
+			);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * instantiate a new price object with blank/empty properties
-     *
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_new_price()
-    {
-        return $this->create_default_object();
-    }
+	/**
+	 * instantiate a new price object with blank/empty properties
+	 *
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_new_price()
+	{
+		return $this->create_default_object();
+	}
 
 
-    /**
-     * retrieve  ALL prices from db
-     *
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_prices()
-    {
-        // retrieve all prices
-        return $this->get_all(['order_by' => ['PRC_amount' => 'ASC']]);
-    }
+	/**
+	 * retrieve  ALL prices from db
+	 *
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_prices()
+	{
+		// retrieve all prices
+		return $this->get_all(['order_by' => ['PRC_amount' => 'ASC']]);
+	}
 
 
-    /**
-     * retrieve all active prices for a particular event
-     *
-     * @param int $EVT_ID
-     * @return array on success
-     * @throws EE_Error
-     */
-    public function get_all_event_prices($EVT_ID = 0)
-    {
-        return $this->get_all(
-            [
-                [
-                    'EVT_ID'            => $EVT_ID,
-                    'Price_Type.PBT_ID' => ['!=', EEM_Price_Type::base_type_tax],
-                ],
-                'order_by' => $this->_order_by_array_for_get_all_method(),
-            ]
-        );
-    }
+	/**
+	 * retrieve all active prices for a particular event
+	 *
+	 * @param int $EVT_ID
+	 * @return array on success
+	 * @throws EE_Error
+	 */
+	public function get_all_event_prices($EVT_ID = 0)
+	{
+		return $this->get_all(
+			[
+				[
+					'EVT_ID'            => $EVT_ID,
+					'Price_Type.PBT_ID' => ['!=', EEM_Price_Type::base_type_tax],
+				],
+				'order_by' => $this->_order_by_array_for_get_all_method(),
+			]
+		);
+	}
 
 
-    /**
-     * retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
-     *
-     * @param boolean $count return count
-     * @param bool    $include_taxes
-     * @return bool|EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_default_prices($count = false, $include_taxes = false)
-    {
-        $_where = [
-            'PRC_deleted'    => 0,
-            'PRC_is_default' => 1,
-        ];
-        if (! $include_taxes) {
-            $_where['Price_Type.PBT_ID'] = ['!=', 4];
-        }
-        $_query_params = [
-            $_where,
-            'order_by' => $this->_order_by_array_for_get_all_method(),
-        ];
-        return $count ? $this->count([$_where]) : $this->get_all($_query_params);
-    }
+	/**
+	 * retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
+	 *
+	 * @param boolean $count return count
+	 * @param bool    $include_taxes
+	 * @return bool|EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_default_prices($count = false, $include_taxes = false)
+	{
+		$_where = [
+			'PRC_deleted'    => 0,
+			'PRC_is_default' => 1,
+		];
+		if (! $include_taxes) {
+			$_where['Price_Type.PBT_ID'] = ['!=', 4];
+		}
+		$_query_params = [
+			$_where,
+			'order_by' => $this->_order_by_array_for_get_all_method(),
+		];
+		return $count ? $this->count([$_where]) : $this->get_all($_query_params);
+	}
 
 
-    /**
-     * retrieve all active global prices that are taxes
-     *
-     * @return bool|EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    public function getAllDefaultTaxes()
-    {
-        return $this->get_all(
-            [
-                [
-                    'PRC_deleted'    => 0,
-                    'PRC_is_default' => 1,
-                    'Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax
-                ],
-                'order_by' => [
-                    'Price_Type.PRT_order' => 'ASC',
-                    'PRC_order' => 'ASC'
-                ],
-            ]
-        );
-    }
+	/**
+	 * retrieve all active global prices that are taxes
+	 *
+	 * @return bool|EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	public function getAllDefaultTaxes()
+	{
+		return $this->get_all(
+			[
+				[
+					'PRC_deleted'    => 0,
+					'PRC_is_default' => 1,
+					'Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax
+				],
+				'order_by' => [
+					'Price_Type.PRT_order' => 'ASC',
+					'PRC_order' => 'ASC'
+				],
+			]
+		);
+	}
 
 
-    /**
-     * retrieve all prices that are taxes
-     *
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_prices_that_are_taxes()
-    {
-        $taxes     = [];
-        $all_taxes = $this->get_all(
-            [
-                ['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax, 'PRC_is_default' => 1],
-                'order_by' => ['Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC'],
-            ]
-        );
-        foreach ($all_taxes as $tax) {
-            if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
-            }
-        }
-        return $taxes;
-    }
+	/**
+	 * retrieve all prices that are taxes
+	 *
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_prices_that_are_taxes()
+	{
+		$taxes     = [];
+		$all_taxes = $this->get_all(
+			[
+				['Price_Type.PBT_ID' => EEM_Price_Type::base_type_tax, 'PRC_is_default' => 1],
+				'order_by' => ['Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC'],
+			]
+		);
+		foreach ($all_taxes as $tax) {
+			if ($tax instanceof EE_Price) {
+				$taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+			}
+		}
+		return $taxes;
+	}
 
 
-    /**
-     * retrieve all prices for an ticket plus default global prices, but not taxes
-     *
-     * @param int $TKT_ID the id of the event.  If not included then we assume that this is a new ticket.
-     * @return EE_Base_Class[]|EE_PRice[]|boolean
-     * @throws EE_Error
-     */
-    public function get_all_ticket_prices_for_admin($TKT_ID = 0)
-    {
-        $array_of_price_objects = [];
-        if (empty($TKT_ID)) {
-            // if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
-            // return that list
-            $default_prices = $this->get_all_default_prices();
+	/**
+	 * retrieve all prices for an ticket plus default global prices, but not taxes
+	 *
+	 * @param int $TKT_ID the id of the event.  If not included then we assume that this is a new ticket.
+	 * @return EE_Base_Class[]|EE_PRice[]|boolean
+	 * @throws EE_Error
+	 */
+	public function get_all_ticket_prices_for_admin($TKT_ID = 0)
+	{
+		$array_of_price_objects = [];
+		if (empty($TKT_ID)) {
+			// if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
+			// return that list
+			$default_prices = $this->get_all_default_prices();
 
-            if ($default_prices) {
-                foreach ($default_prices as $price) {
-                    if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
-                    }
-                }
-                return $array_of_price_objects;
-            }
-            return [];
-        }
-        $ticket_prices = $this->get_all(
-            [
-                [
-                    'TKT_ID'      => $TKT_ID,
-                    'PRC_deleted' => 0,
-                ],
-                'order_by' => ['PRC_order' => 'ASC'],
-            ]
-        );
+			if ($default_prices) {
+				foreach ($default_prices as $price) {
+					if ($price instanceof EE_Price) {
+						$array_of_price_objects[ $price->type() ][] = $price;
+					}
+				}
+				return $array_of_price_objects;
+			}
+			return [];
+		}
+		$ticket_prices = $this->get_all(
+			[
+				[
+					'TKT_ID'      => $TKT_ID,
+					'PRC_deleted' => 0,
+				],
+				'order_by' => ['PRC_order' => 'ASC'],
+			]
+		);
 
-        if (! empty($ticket_prices)) {
-            foreach ($ticket_prices as $price) {
-                if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
-                }
-            }
-            return $array_of_price_objects;
-        }
-        return false;
-    }
+		if (! empty($ticket_prices)) {
+			foreach ($ticket_prices as $price) {
+				if ($price instanceof EE_Price) {
+					$array_of_price_objects[ $price->type() ][] = $price;
+				}
+			}
+			return $array_of_price_objects;
+		}
+		return false;
+	}
 
 
-    /**
-     * _sort_event_prices_by_type
-     *
-     * @param EE_Price $price_a
-     * @param EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->type_obj()->order() === $price_b->type_obj()->order()) {
-            return $this->_sort_event_prices_by_order($price_a, $price_b);
-        }
-        return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
-    }
+	/**
+	 * _sort_event_prices_by_type
+	 *
+	 * @param EE_Price $price_a
+	 * @param EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->type_obj()->order() === $price_b->type_obj()->order()) {
+			return $this->_sort_event_prices_by_order($price_a, $price_b);
+		}
+		return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
+	}
 
 
-    /**
-     *        _sort_event_prices_by_order
-     *
-     * @param EE_Price $price_a
-     * @param EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->order() === $price_b->order()) {
-            return 0;
-        }
-        return $price_a->order() < $price_b->order() ? -1 : 1;
-    }
+	/**
+	 *        _sort_event_prices_by_order
+	 *
+	 * @param EE_Price $price_a
+	 * @param EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->order() === $price_b->order()) {
+			return 0;
+		}
+		return $price_a->order() < $price_b->order() ? -1 : 1;
+	}
 
 
-    /**
-     * get all prices of a specific type
-     *
-     * @param int $type - PRT_ID
-     * @return EE_Base_Class[]|EE_PRice[]
-     * @throws EE_Error
-     */
-    public function get_all_prices_that_are_type($type = 0)
-    {
-        return $this->get_all(
-            [
-                [
-                    'PRT_ID' => $type,
-                ],
-                'order_by' => $this->_order_by_array_for_get_all_method(),
-            ]
-        );
-    }
+	/**
+	 * get all prices of a specific type
+	 *
+	 * @param int $type - PRT_ID
+	 * @return EE_Base_Class[]|EE_PRice[]
+	 * @throws EE_Error
+	 */
+	public function get_all_prices_that_are_type($type = 0)
+	{
+		return $this->get_all(
+			[
+				[
+					'PRT_ID' => $type,
+				],
+				'order_by' => $this->_order_by_array_for_get_all_method(),
+			]
+		);
+	}
 
 
-    /**
-     * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
-     * Of course you don't have to use it, but this is the order we usually want to sort prices by
-     *
-     * @return array which can be used like so: $this->get_all(array(array(...where
-     *               stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
-     */
-    public function _order_by_array_for_get_all_method()
-    {
-        return [
-            'PRC_order'            => 'ASC',
-            'Price_Type.PRT_order' => 'ASC',
-            'PRC_ID'               => 'ASC',
-        ];
-    }
+	/**
+	 * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
+	 * Of course you don't have to use it, but this is the order we usually want to sort prices by
+	 *
+	 * @return array which can be used like so: $this->get_all(array(array(...where
+	 *               stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
+	 */
+	public function _order_by_array_for_get_all_method()
+	{
+		return [
+			'PRC_order'            => 'ASC',
+			'Price_Type.PRT_order' => 'ASC',
+			'PRC_ID'               => 'ASC',
+		];
+	}
 }

core/db_models/EEM_Line_Item.model.php

Indentation +609 added lines, -609 removed lines

@@ -28,616 +28,616 @@
 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. 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
-     *
-     * @Constructor
-     * @param string $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 InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables = array(
-            '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',
-            array('Ticket', 'Price', 'Event')
-        );
-        $this->_fields = array(
-            'Line_Item' => array(
-                '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'),
-                    true,
-                    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',
-                    array(
-                        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 = array(
-            '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(array(
-            array(
-                '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(array(
-            array(
-                'LIN_type' => self::type_line_item,
-                'TXN_ID'   => $transaction,
-                'OR'       => array(
-                    'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
-                    'OBJ_type*null'      => array('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. 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
+	 *
+	 * @Constructor
+	 * @param string $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 InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables = array(
+			'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',
+			array('Ticket', 'Price', 'Event')
+		);
+		$this->_fields = array(
+			'Line_Item' => array(
+				'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'),
+					true,
+					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',
+					array(
+						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 = array(
+			'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(array(
+			array(
+				'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(array(
+			array(
+				'LIN_type' => self::type_line_item,
+				'TXN_ID'   => $transaction,
+				'OR'       => array(
+					'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
+					'OBJ_type*null'      => array('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(array(
-            array(
-                '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 = array()
-    ) {
-        $query_params = array(
-            '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']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
-        );
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all(array($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(array(
-            array(
-                '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(array(
-            array(
-                '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
-     *
-     * @since 1.0.0
-     * @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
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(array(
-            array(
-                '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
-     *
-     * @since   1.0.0
-     * @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
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(array(
-            array(
-                '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 = array()
-    ) {
-        return array_replace_recursive($original_query_params, array(
-            array(
-                '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 = array(
-            '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'] = array(
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            );
-        }
-        return $this->get_all(array($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(
-            array(
-                array(
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => array('<=', $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(array(
+			array(
+				'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 = array()
+	) {
+		$query_params = array(
+			'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']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
+		);
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all(array($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(array(
+			array(
+				'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(array(
+			array(
+				'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
+	 *
+	 * @since 1.0.0
+	 * @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
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(array(
+			array(
+				'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
+	 *
+	 * @since   1.0.0
+	 * @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
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(array(
+			array(
+				'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 = array()
+	) {
+		return array_replace_recursive($original_query_params, array(
+			array(
+				'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 = array(
+			'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'] = array(
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			);
+		}
+		return $this->get_all(array($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(
+			array(
+				array(
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => array('<=', $timestamp),
+				),
+			)
+		);
+	}
 }

core/db_models/fields/EE_Float_Field.php

Indentation +62 added lines, -62 removed lines

@@ -7,77 +7,77 @@
 class EE_Float_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param float|string $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param float|string $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        // remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(
-                array(" ", EE_Config::instance()->currency->thsnds),
-                "",
-                $value_inputted_for_field_on_model_object
-            );
+		// remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(
+				array(" ", EE_Config::instance()->currency->thsnds),
+				"",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(
-                EE_Config::instance()->currency->dec_mrk,
-                ".",
-                $value_inputted_for_field_on_model_object
-            );
+			$value_inputted_for_field_on_model_object = str_replace(
+				EE_Config::instance()->currency->dec_mrk,
+				".",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace(
-                "/[^0-9,.]/",
-                "",
-                $value_inputted_for_field_on_model_object
-            );
-        }
+			$value_inputted_for_field_on_model_object = preg_replace(
+				"/[^0-9,.]/",
+				"",
+				$value_inputted_for_field_on_model_object
+			);
+		}
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format(
-            $value_on_field_to_be_outputted,
-            $EE->CFG->currency->dec_plc,
-            $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds
-        );
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format(
+			$value_on_field_to_be_outputted,
+			$EE->CFG->currency->dec_plc,
+			$EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds
+		);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //      echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }

core/domain/entities/tickets/TicketPriceModifiers.php

Indentation +230 added lines, -230 removed lines

@@ -20,234 +20,234 @@
  */
 class TicketPriceModifiers
 {
-    /**
-     * @var EE_Ticket
-     */
-    private $ticket;
-
-
-    /**
-     * @var EE_Price[]
-     */
-    private $ticket_prices;
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Ticket $ticket)
-    {
-        $this->ticket = $ticket;
-        // run a query to retrieve ALL of this ticket's related prices before doing anything else
-        $this->ticket_prices = $this->ticket->prices();
-    }
-
-
-    /**
-     * @param callable  $filter
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function filterModifiersForTicket(callable $filter): array
-    {
-        $ticket_modifiers = $this->ticket->get_all_from_cache('Price');
-        if (empty($ticket_modifiers)) {
-            $ticket_modifiers = $this->ticket_prices;
-        }
-        return array_filter($ticket_modifiers, $filter);
-    }
-
-
-    /**
-     * retrieve all price modifiers for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllModifiersForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'allModifiersFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket to retrieve all price modifiers for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function allModifiersFilter(EE_Price $price_modifier): bool
-    {
-        return ! $price_modifier->is_base_price();
-    }
-
-
-    /**
-     * retrieve all discounts for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllDiscountModifiersForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'discountModifierFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket to retrieve all discounts for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function discountModifierFilter(EE_Price $price_modifier): bool
-    {
-        return $price_modifier->is_discount();
-    }
-
-
-    /**
-     * retrieve all surcharges for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllSurchargeModifiersForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'surchargeModifierFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket to retrieve all surcharges for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function surchargeModifierFilter(EE_Price $price_modifier): bool
-    {
-        return $price_modifier->is_surcharge();
-    }
-
-
-    /**
-     * retrieve all discounts AND surcharges for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllDiscountAndSurchargeModifiersForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'discountAndSurchargeModifierFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket to retrieve all discounts AND surcharges for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function discountAndSurchargeModifierFilter(EE_Price $price_modifier): bool
-    {
-        return $price_modifier->is_discount() || $price_modifier->is_surcharge();
-    }
-
-
-    /**
-     * retrieve all taxes for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllTaxesForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'taxModifierFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket to retrieve all taxes for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function taxModifierFilter(EE_Price $price_modifier): bool
-    {
-        return $price_modifier->is_tax();
-    }
-
-
-    /**
-     * retrieve ALL PRICES that are NOT taxes for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllNonTaxPricesForTicket(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'nonTaxPriceFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket() with a ticket
-     * to retrieve ALL PRICES that are NOT taxes for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function nonTaxPriceFilter(EE_Price $price_modifier): bool
-    {
-        return ! $price_modifier->is_base_price() && ! $price_modifier->is_tax();
-    }
-
-
-    /**
-     * retrieve the base price for the this ticket
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getBasePrice(): array
-    {
-        return $this->filterModifiersForTicket([$this, 'basePriceFilter']);
-    }
-
-
-    /**
-     * pass to filterModifiersForTicket()
-     * to retrieve the base price for the this ticket
-     *
-     * @param EE_Price $price_modifier
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function basePriceFilter(EE_Price $price_modifier): bool
-    {
-        return $price_modifier->is_base_price();
-    }
+	/**
+	 * @var EE_Ticket
+	 */
+	private $ticket;
+
+
+	/**
+	 * @var EE_Price[]
+	 */
+	private $ticket_prices;
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Ticket $ticket)
+	{
+		$this->ticket = $ticket;
+		// run a query to retrieve ALL of this ticket's related prices before doing anything else
+		$this->ticket_prices = $this->ticket->prices();
+	}
+
+
+	/**
+	 * @param callable  $filter
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function filterModifiersForTicket(callable $filter): array
+	{
+		$ticket_modifiers = $this->ticket->get_all_from_cache('Price');
+		if (empty($ticket_modifiers)) {
+			$ticket_modifiers = $this->ticket_prices;
+		}
+		return array_filter($ticket_modifiers, $filter);
+	}
+
+
+	/**
+	 * retrieve all price modifiers for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllModifiersForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'allModifiersFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket to retrieve all price modifiers for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function allModifiersFilter(EE_Price $price_modifier): bool
+	{
+		return ! $price_modifier->is_base_price();
+	}
+
+
+	/**
+	 * retrieve all discounts for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllDiscountModifiersForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'discountModifierFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket to retrieve all discounts for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function discountModifierFilter(EE_Price $price_modifier): bool
+	{
+		return $price_modifier->is_discount();
+	}
+
+
+	/**
+	 * retrieve all surcharges for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllSurchargeModifiersForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'surchargeModifierFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket to retrieve all surcharges for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function surchargeModifierFilter(EE_Price $price_modifier): bool
+	{
+		return $price_modifier->is_surcharge();
+	}
+
+
+	/**
+	 * retrieve all discounts AND surcharges for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllDiscountAndSurchargeModifiersForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'discountAndSurchargeModifierFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket to retrieve all discounts AND surcharges for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function discountAndSurchargeModifierFilter(EE_Price $price_modifier): bool
+	{
+		return $price_modifier->is_discount() || $price_modifier->is_surcharge();
+	}
+
+
+	/**
+	 * retrieve all taxes for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllTaxesForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'taxModifierFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket to retrieve all taxes for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function taxModifierFilter(EE_Price $price_modifier): bool
+	{
+		return $price_modifier->is_tax();
+	}
+
+
+	/**
+	 * retrieve ALL PRICES that are NOT taxes for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllNonTaxPricesForTicket(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'nonTaxPriceFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket() with a ticket
+	 * to retrieve ALL PRICES that are NOT taxes for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function nonTaxPriceFilter(EE_Price $price_modifier): bool
+	{
+		return ! $price_modifier->is_base_price() && ! $price_modifier->is_tax();
+	}
+
+
+	/**
+	 * retrieve the base price for the this ticket
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getBasePrice(): array
+	{
+		return $this->filterModifiersForTicket([$this, 'basePriceFilter']);
+	}
+
+
+	/**
+	 * pass to filterModifiersForTicket()
+	 * to retrieve the base price for the this ticket
+	 *
+	 * @param EE_Price $price_modifier
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function basePriceFilter(EE_Price $price_modifier): bool
+	{
+		return $price_modifier->is_base_price();
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Base.class.php

Indentation +10 added lines, -10 removed lines

@@ -16,14 +16,14 @@
 {
 
 
-    /**
-     * process
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     */
-    public function process(EE_Line_Item $line_item): ?EE_Line_Item
-    {
-        return $line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 */
+	public function process(EE_Line_Item $line_item): ?EE_Line_Item
+	{
+		return $line_item;
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Processor.class.php

Indentation +82 added lines, -82 removed lines

@@ -36,95 +36,95 @@
 class EE_Line_Item_Filter_Processor
 {
 
-    /**
-     * @type EE_Line_Item_Filter_Collection $line_item_filters
-     */
-    protected $line_item_filters;
+	/**
+	 * @type EE_Line_Item_Filter_Collection $line_item_filters
+	 */
+	protected $line_item_filters;
 
-    /**
-     * @type EE_Line_Item $grand_total_line_item
-     */
-    protected $grand_total_line_item;
+	/**
+	 * @type EE_Line_Item $grand_total_line_item
+	 */
+	protected $grand_total_line_item;
 
 
-    /**
-     * EE_Line_Item_Filter_Processor constructor.
-     *
-     * @param EE_Line_Item_Filter_Collection $line_item_filters
-     * @param EE_Line_Item                   $grand_total_line_item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EE_Line_Item $grand_total_line_item)
-    {
-        $this->line_item_filters = $line_item_filters;
-        if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
-            throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
-        }
-        $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
-    }
+	/**
+	 * EE_Line_Item_Filter_Processor constructor.
+	 *
+	 * @param EE_Line_Item_Filter_Collection $line_item_filters
+	 * @param EE_Line_Item                   $grand_total_line_item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EE_Line_Item $grand_total_line_item)
+	{
+		$this->line_item_filters = $line_item_filters;
+		if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
+			throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
+		}
+		$this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
+	}
 
 
-    /**
-     * clone_and_reset_line_item_tree
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function clone_and_reset_line_item_tree(EE_Line_Item $line_item): EE_Line_Item
-    {
-        $cloned_line_item = $this->clone_and_reset_line_item($line_item);
-        foreach ($line_item->children() as $child_line_item) {
-            $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
-        }
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item_tree
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function clone_and_reset_line_item_tree(EE_Line_Item $line_item): EE_Line_Item
+	{
+		$cloned_line_item = $this->clone_and_reset_line_item($line_item);
+		foreach ($line_item->children() as $child_line_item) {
+			$cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
+		}
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * clone_and_reset_line_item
-     *
-     * clones the incoming object
-     * resets any fields that represent database primary keys
-     * resets total
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function clone_and_reset_line_item(EE_Line_Item $line_item): EE_Line_Item
-    {
-        // we don't actually want to work with the original line item, so clone it
-        $cloned_line_item = clone $line_item;
-        $cloned_line_item->set('LIN_ID', null);
-        $cloned_line_item->set('LIN_parent', null);
-        $cloned_line_item->clear_related_line_item_cache();
-        foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
-            $cloned_line_item->clear_cache($relation_name, null, true);
-        }
-        $cloned_line_item->set_allow_persist(false);
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item
+	 *
+	 * clones the incoming object
+	 * resets any fields that represent database primary keys
+	 * resets total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function clone_and_reset_line_item(EE_Line_Item $line_item): EE_Line_Item
+	{
+		// we don't actually want to work with the original line item, so clone it
+		$cloned_line_item = clone $line_item;
+		$cloned_line_item->set('LIN_ID', null);
+		$cloned_line_item->set('LIN_parent', null);
+		$cloned_line_item->clear_related_line_item_cache();
+		foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
+			$cloned_line_item->clear_cache($relation_name, null, true);
+		}
+		$cloned_line_item->set_allow_persist(false);
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * process
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function process(): ?EE_Line_Item
-    {
-        $this->line_item_filters->rewind();
-        while ($this->line_item_filters->valid()) {
-            $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
-            $this->line_item_filters->next();
-        }
-        $this->grand_total_line_item->recalculate_total_including_taxes();
-        return $this->grand_total_line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function process(): ?EE_Line_Item
+	{
+		$this->line_item_filters->rewind();
+		while ($this->line_item_filters->valid()) {
+			$this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
+			$this->line_item_filters->next();
+		}
+		$this->grand_total_line_item->recalculate_total_including_taxes();
+		return $this->grand_total_line_item;
+	}
 }