eventespresso / event-espresso-core

core/domain/entities/editor/EditorBlockCollection.php

Indentation +47 added lines, -47 removed lines

@@ -20,55 +20,55 @@
 class EditorBlockCollection extends Collection
 {
 
-    /**
-     * Collection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\entities\editor\EditorBlockInterface');
-    }
+	/**
+	 * Collection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\entities\editor\EditorBlockInterface');
+	}
 
 
-    /**
-     * unRegisterBlock
-     * finds block in the Collection based on the identifier that was set using addObject()
-     * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
-     *
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function unRegisterBlock($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object->unRegisterBlock();
-            }
-            $this->next();
-        }
-        return false;
-    }
+	/**
+	 * unRegisterBlock
+	 * finds block in the Collection based on the identifier that was set using addObject()
+	 * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
+	 *
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function unRegisterBlock($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object->unRegisterBlock();
+			}
+			$this->next();
+		}
+		return false;
+	}
 
 
-    /**
-     * unRegisterAllBlocks
-     * calls unRegisterBlock() on all blocks in Collection.
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
-     *
-     * @return void
-     */
-    public function unRegisterAllBlocks()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $this->current()->unRegisterBlock();
-            $this->next();
-        }
-        $this->rewind();
-    }
+	/**
+	 * unRegisterAllBlocks
+	 * calls unRegisterBlock() on all blocks in Collection.
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
+	 *
+	 * @return void
+	 */
+	public function unRegisterAllBlocks()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$this->current()->unRegisterBlock();
+			$this->next();
+		}
+		$this->rewind();
+	}
 }

core/domain/entities/editor/EditorBlockInterface.php

Indentation +68 added lines, -68 removed lines

@@ -25,72 +25,72 @@
 interface EditorBlockInterface
 {
 
-    /**
-     * Perform any early setup required by the block
-     * including setting the block type and supported post types
-     *
-     * @return void
-     */
-    public function initialize();
-
-
-    /**
-     * @return string
-     */
-    public function editorBlockType();
-
-
-    /**
-     * Registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function registerBlock();
-
-
-    /**
-     * Un-registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function unRegisterBlock();
-
-
-    /**
-     * returns true if the block type applies for the supplied post type
-     * and should be added to that post type's editor
-     *
-     * @param string $post_type
-     * @return boolean
-     */
-    public function appliesToPostType($post_type);
-
-
-    /**
-     * @return array
-     */
-    public function getEditorContainer();
-
-
-    /**
-     * @return  void
-     */
-    public function registerScripts();
-
-
-    /**
-     * @return void
-     */
-    public function registerStyles();
-
-
-    /**
-     * returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function renderBlock(array $attributes = array());
+	/**
+	 * Perform any early setup required by the block
+	 * including setting the block type and supported post types
+	 *
+	 * @return void
+	 */
+	public function initialize();
+
+
+	/**
+	 * @return string
+	 */
+	public function editorBlockType();
+
+
+	/**
+	 * Registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function registerBlock();
+
+
+	/**
+	 * Un-registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function unRegisterBlock();
+
+
+	/**
+	 * returns true if the block type applies for the supplied post type
+	 * and should be added to that post type's editor
+	 *
+	 * @param string $post_type
+	 * @return boolean
+	 */
+	public function appliesToPostType($post_type);
+
+
+	/**
+	 * @return array
+	 */
+	public function getEditorContainer();
+
+
+	/**
+	 * @return  void
+	 */
+	public function registerScripts();
+
+
+	/**
+	 * @return void
+	 */
+	public function registerStyles();
+
+
+	/**
+	 * returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function renderBlock(array $attributes = array());
 }

core/services/editor/EditorBlockRegistrationManager.php

Spacing +4 added lines, -4 removed lines

@@ -143,7 +143,7 @@ 
             foreach ($this->blocks as $block) {
                 // perform any setup required for the block
                 $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
+                if ( ! $block_type instanceof WP_Block_Type) {
                     throw new InvalidEntityException($block_type, 'WP_Block_Type');
                 }
                 add_action('enqueue_block_assets', array($block, 'registerStyles'));
@@ -178,9 +178,9 @@ 
             $this->assets_registry->getAssetUrl(Registry::ASSET_NAMESPACE, 'core-blocks', Registry::ASSET_TYPE_JS),
             array(
                 'eejs-core',
-                'wp-blocks',    // Provides useful functions and components for extending the editor
-                'wp-i18n',      // Provides localization functions
-                'wp-element',   // Provides React.Component
+                'wp-blocks', // Provides useful functions and components for extending the editor
+                'wp-i18n', // Provides localization functions
+                'wp-element', // Provides React.Component
                 'wp-components' // Provides many prebuilt components and controls
             ),
             null,

Indentation +149 added lines, -149 removed lines

@@ -34,153 +34,153 @@
 class EditorBlockRegistrationManager extends EditorBlockManager
 {
 
-    /**
-     *  Returns the name of a hookpoint to be used to call initialize()
-     *
-     * @return string
-     */
-    public function initHook()
-    {
-        return 'AHEE__EE_System__set_hooks_for_core';
-    }
-
-
-    /**
-     * Perform any early setup required for block editors to functions
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function initialize()
-    {
-        $this->loadEditorBlocks();
-        add_action('AHEE__EE_System__initialize', array($this, 'registerEditorBlocks'));
-    }
-
-
-    /**
-     * @return CollectionInterface|EditorBlockInterface[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFilePathException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    protected function populateEditorBlockCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-                // collection name
-                'shortcodes',
-                // collection interface
-                'EventEspresso\core\domain\entities\editor\EditorBlockInterface',
-                // FQCNs for classes to add (all classes within each namespace will be loaded)
-                apply_filters(
-                    'FHEE__EventEspresso_core_services_editor_EditorBlockManager__populateEditorBlockCollection__collection_FQCNs',
-                    array()
-                    // array(
-                    //     'EventEspresso\core\domain\entities\editor\blocks\common',
-                    //     'EventEspresso\core\domain\entities\editor\blocks\editor',
-                    //     'EventEspresso\core\domain\entities\editor\blocks\shortcodes',
-                    //     'EventEspresso\core\domain\entities\editor\blocks\widgets',
-                    // )
-                ),
-                // filepaths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            ),
-            $this->blocks
-        );
-        return $loader->getCollection();
-    }
-
-
-    /**
-     * populates the EditorBlockCollection and calls initialize() on all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function loadEditorBlocks()
-    {
-        try {
-            $this->populateEditorBlockCollection();
-            // cycle thru block loaders and initialize each loader
-            foreach ($this->blocks as $block) {
-                $block->initialize();
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * calls registerBlock() and load assets for all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function registerEditorBlocks()
-    {
-        try {
-            // register primary assets
-            add_action('enqueue_block_assets', array($this, 'registerStyles'));
-            add_action('enqueue_block_assets', array($this, 'registerScripts'));
-            // cycle thru block loader folders
-            foreach ($this->blocks as $block) {
-                // perform any setup required for the block
-                $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
-                    throw new InvalidEntityException($block_type, 'WP_Block_Type');
-                }
-                add_action('enqueue_block_assets', array($block, 'registerStyles'));
-                add_action('enqueue_block_assets', array($block, 'registerScripts'));
-                do_action(
-                    'FHEE__EventEspresso_core_services_editor_EditorBlockManager__registerEditorBlocks__block_type_registered',
-                    $block,
-                    $block_type
-                );
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    public function registerStyles()
-    {
-        // wp_register_style(
-        //     'ee-block-styles',
-        //     $this->domain->distributionAssetsUrl() . 'style.css',
-        //     array(),
-        //     filemtime($this->domain->distributionAssetsPath() . 'style.css')
-        // );
-    }
-
-
-    public function registerScripts()
-    {
-        wp_register_script(
-            'ee-core-blocks',
-            $this->assets_registry->getAssetUrl(Registry::ASSET_NAMESPACE, 'core-blocks', Registry::ASSET_TYPE_JS),
-            array(
-                'eejs-core',
-                'wp-blocks',    // Provides useful functions and components for extending the editor
-                'wp-i18n',      // Provides localization functions
-                'wp-element',   // Provides React.Component
-                'wp-components' // Provides many prebuilt components and controls
-            ),
-            null,
-            true
-        );
-    }
+	/**
+	 *  Returns the name of a hookpoint to be used to call initialize()
+	 *
+	 * @return string
+	 */
+	public function initHook()
+	{
+		return 'AHEE__EE_System__set_hooks_for_core';
+	}
+
+
+	/**
+	 * Perform any early setup required for block editors to functions
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize()
+	{
+		$this->loadEditorBlocks();
+		add_action('AHEE__EE_System__initialize', array($this, 'registerEditorBlocks'));
+	}
+
+
+	/**
+	 * @return CollectionInterface|EditorBlockInterface[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function populateEditorBlockCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+				// collection name
+				'shortcodes',
+				// collection interface
+				'EventEspresso\core\domain\entities\editor\EditorBlockInterface',
+				// FQCNs for classes to add (all classes within each namespace will be loaded)
+				apply_filters(
+					'FHEE__EventEspresso_core_services_editor_EditorBlockManager__populateEditorBlockCollection__collection_FQCNs',
+					array()
+					// array(
+					//     'EventEspresso\core\domain\entities\editor\blocks\common',
+					//     'EventEspresso\core\domain\entities\editor\blocks\editor',
+					//     'EventEspresso\core\domain\entities\editor\blocks\shortcodes',
+					//     'EventEspresso\core\domain\entities\editor\blocks\widgets',
+					// )
+				),
+				// filepaths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			),
+			$this->blocks
+		);
+		return $loader->getCollection();
+	}
+
+
+	/**
+	 * populates the EditorBlockCollection and calls initialize() on all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function loadEditorBlocks()
+	{
+		try {
+			$this->populateEditorBlockCollection();
+			// cycle thru block loaders and initialize each loader
+			foreach ($this->blocks as $block) {
+				$block->initialize();
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * calls registerBlock() and load assets for all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function registerEditorBlocks()
+	{
+		try {
+			// register primary assets
+			add_action('enqueue_block_assets', array($this, 'registerStyles'));
+			add_action('enqueue_block_assets', array($this, 'registerScripts'));
+			// cycle thru block loader folders
+			foreach ($this->blocks as $block) {
+				// perform any setup required for the block
+				$block_type = $block->registerBlock();
+				if (! $block_type instanceof WP_Block_Type) {
+					throw new InvalidEntityException($block_type, 'WP_Block_Type');
+				}
+				add_action('enqueue_block_assets', array($block, 'registerStyles'));
+				add_action('enqueue_block_assets', array($block, 'registerScripts'));
+				do_action(
+					'FHEE__EventEspresso_core_services_editor_EditorBlockManager__registerEditorBlocks__block_type_registered',
+					$block,
+					$block_type
+				);
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	public function registerStyles()
+	{
+		// wp_register_style(
+		//     'ee-block-styles',
+		//     $this->domain->distributionAssetsUrl() . 'style.css',
+		//     array(),
+		//     filemtime($this->domain->distributionAssetsPath() . 'style.css')
+		// );
+	}
+
+
+	public function registerScripts()
+	{
+		wp_register_script(
+			'ee-core-blocks',
+			$this->assets_registry->getAssetUrl(Registry::ASSET_NAMESPACE, 'core-blocks', Registry::ASSET_TYPE_JS),
+			array(
+				'eejs-core',
+				'wp-blocks',    // Provides useful functions and components for extending the editor
+				'wp-i18n',      // Provides localization functions
+				'wp-element',   // Provides React.Component
+				'wp-components' // Provides many prebuilt components and controls
+			),
+			null,
+			true
+		);
+	}
 }

core/db_models/EEM_Line_Item.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -429,7 +429,7 @@
      * 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
+     * @param boolean $expired
      * @return EE_Base_Class[]|EE_Line_Item[]
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException

Indentation +438 added lines, -438 removed lines

@@ -32,445 +32,445 @@
 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';
-
-    /**
-     * 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 mount.
-     */
-    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';
-
-    // private instance of the EEM_Line_Item object
-    protected static $_instance = null;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     * @Constructor
-     * @access protected
-     * @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)
-     * @return \EEM_Line_Item
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Line Item', 'event_espresso');
-        $this->plural_item = __('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', __("ID", "event_espresso")),
-                'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), true),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), true, null, 'Transaction'),
-                'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), false, ''),
-                'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), true),
-                'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), false, 0),
-                'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), false, 0),
-                'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), false, false),
-                'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), false, 1),
-                'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), false, 0),
-                'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), true, 1),
-                'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), true, null),
-                'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), false, 'line-item', array(
-                        self::type_line_item => __("Line Item", "event_espresso"),
-                        self::type_sub_line_item => __("Sub-Item", "event_espresso"),
-                        self::type_sub_total => __("Subtotal", "event_espresso"),
-                        self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
-                        self::type_tax => __("Tax", "event_espresso"),
-                        self::type_total => __("Total", "event_espresso"),
-                        self::type_cancellation => __('Cancellation', 'event_espresso')
-                    )),
-                'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), true, null, $line_items_can_be_for),
-                'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), true, null, $line_items_can_be_for),
-                'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('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_Line_Item[]
-     */
-    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_Line_Item[]
-     */
-    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('!=', '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
-     * @return int count of how many deleted
-     */
-    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';
+
+	/**
+	 * 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 mount.
+	 */
+	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';
+
+	// private instance of the EEM_Line_Item object
+	protected static $_instance = null;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 * @Constructor
+	 * @access protected
+	 * @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)
+	 * @return \EEM_Line_Item
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('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', __("ID", "event_espresso")),
+				'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), true),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), true, null, 'Transaction'),
+				'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), false, ''),
+				'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), true),
+				'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), false, 0),
+				'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), false, 0),
+				'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), false, false),
+				'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), false, 1),
+				'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), false, 0),
+				'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), true, 1),
+				'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), true, null),
+				'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), false, 'line-item', array(
+						self::type_line_item => __("Line Item", "event_espresso"),
+						self::type_sub_line_item => __("Sub-Item", "event_espresso"),
+						self::type_sub_total => __("Subtotal", "event_espresso"),
+						self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
+						self::type_tax => __("Tax", "event_espresso"),
+						self::type_total => __("Total", "event_espresso"),
+						self::type_cancellation => __('Cancellation', 'event_espresso')
+					)),
+				'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), true, null, $line_items_can_be_for),
+				'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), true, null, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('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_Line_Item[]
+	 */
+	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_Line_Item[]
+	 */
+	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('!=', '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
+	 * @return int count of how many deleted
+	 */
+	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_Line_Item[]
-     */
-    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_Line_Item[]
-     */
-    public function get_object_line_items_for_transaction($TXN_ID, $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_Line_Item[]
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID' => $transaction->ID(),
-                'OBJ_type' => 'Ticket',
-            )
-        ));
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return \EE_Line_Item
-     */
-    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' => '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_Line_Item
-     */
-    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' => '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_Line_Item[]
-     */
-    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' => '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_Line_ITem
-     */
-    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 like EEM_Base::get_all()'s $query_params
-     */
-    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' => '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 InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @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'      => '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_Line_Item[]
+	 */
+	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_Line_Item[]
+	 */
+	public function get_object_line_items_for_transaction($TXN_ID, $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_Line_Item[]
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID' => $transaction->ID(),
+				'OBJ_type' => 'Ticket',
+			)
+		));
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return \EE_Line_Item
+	 */
+	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' => '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_Line_Item
+	 */
+	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' => '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_Line_Item[]
+	 */
+	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' => '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_Line_ITem
+	 */
+	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 like EEM_Base::get_all()'s $query_params
+	 */
+	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' => '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 InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @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'      => 'Ticket',
+					'LIN_timestamp' => array('<=', $timestamp),
+				)
+			)
+		);
+	}
 }

core/domain/services/admin/ExitModal.php

Indentation +82 added lines, -82 removed lines

@@ -19,94 +19,94 @@
 class ExitModal
 {
 
-    /**
-     * @var Registry
-     */
-    private $assets_registry;
+	/**
+	 * @var Registry
+	 */
+	private $assets_registry;
 
-    /**
-     * ExitModal constructor.
-     *
-     * @param Registry $assets_registry
-     */
-    public function __construct(Registry $assets_registry)
-    {
-        $this->assets_registry = $assets_registry;
-        add_action('in_admin_footer', array($this, 'modalContainer'));
-        add_action('admin_enqueue_scripts', array($this, 'enqueues'));
-    }
+	/**
+	 * ExitModal constructor.
+	 *
+	 * @param Registry $assets_registry
+	 */
+	public function __construct(Registry $assets_registry)
+	{
+		$this->assets_registry = $assets_registry;
+		add_action('in_admin_footer', array($this, 'modalContainer'));
+		add_action('admin_enqueue_scripts', array($this, 'enqueues'));
+	}
 
 
-    /**
-     * Callback on in_admin_footer that is used to output the exit modal container.
-     */
-    public function modalContainer()
-    {
-        echo '<div id="ee-exit-survey-modal"></div>';
-    }
+	/**
+	 * Callback on in_admin_footer that is used to output the exit modal container.
+	 */
+	public function modalContainer()
+	{
+		echo '<div id="ee-exit-survey-modal"></div>';
+	}
 
 
-    /**
-     * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal.
-     *
-     * @throws InvalidArgumentException
-     */
-    public function enqueues()
-    {
-        $current_user = new WP_User(get_current_user_id());
-        $this->assets_registry->addData(
-            'exitModali18n',
-            array(
-                'introText' => htmlspecialchars(
-                    __(
-                        'Do you have a moment to share why you are deactivating Event Espresso?',
-                        'event_espresso'
-                    ),
-                    ENT_NOQUOTES
-                ),
-                'doSurveyButtonText' => htmlspecialchars(
-                    __(
-                        'Sure I\'ll help',
-                        'event_espresso'
-                    ),
-                    ENT_NOQUOTES
-                ),
-                'skipButtonText' => htmlspecialchars(
-                    __(
-                        'Skip',
-                        'event_espresso'
-                    ),
-                    ENT_NOQUOTES
-                )
-            )
-        );
-        $this->assets_registry->addData(
-            'exitModalInfo',
-            array(
-                'firstname' => htmlspecialchars($current_user->user_firstname),
-                'emailaddress' => htmlspecialchars($current_user->user_email),
-                'website' => htmlspecialchars(site_url()),
-                'isModalActive' => $this->isModalActive()
-            )
-        );
+	/**
+	 * Callback for `admin_enqueue_scripts` to take care of enqueueing scripts and styles specific to the modal.
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public function enqueues()
+	{
+		$current_user = new WP_User(get_current_user_id());
+		$this->assets_registry->addData(
+			'exitModali18n',
+			array(
+				'introText' => htmlspecialchars(
+					__(
+						'Do you have a moment to share why you are deactivating Event Espresso?',
+						'event_espresso'
+					),
+					ENT_NOQUOTES
+				),
+				'doSurveyButtonText' => htmlspecialchars(
+					__(
+						'Sure I\'ll help',
+						'event_espresso'
+					),
+					ENT_NOQUOTES
+				),
+				'skipButtonText' => htmlspecialchars(
+					__(
+						'Skip',
+						'event_espresso'
+					),
+					ENT_NOQUOTES
+				)
+			)
+		);
+		$this->assets_registry->addData(
+			'exitModalInfo',
+			array(
+				'firstname' => htmlspecialchars($current_user->user_firstname),
+				'emailaddress' => htmlspecialchars($current_user->user_email),
+				'website' => htmlspecialchars(site_url()),
+				'isModalActive' => $this->isModalActive()
+			)
+		);
 
-        wp_enqueue_script('ee-wp-plugins-page');
-        wp_enqueue_style('ee-wp-plugins-page');
-    }
+		wp_enqueue_script('ee-wp-plugins-page');
+		wp_enqueue_style('ee-wp-plugins-page');
+	}
 
 
-    /**
-     * Exposes a filter switch for turning off the enqueueing of the modal script.
-     * @return bool
-     */
-    private function isModalActive()
-    {
-        return filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive',
-                true
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * Exposes a filter switch for turning off the enqueueing of the modal script.
+	 * @return bool
+	 */
+	private function isModalActive()
+	{
+		return filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_domain_services_admin_ExitModal__isModalActive',
+				true
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/DomainInterface.php

Indentation +44 added lines, -44 removed lines

@@ -16,67 +16,67 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function sourceAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function sourceAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function sourceAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function sourceAssetsUrl();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 
-    /**
-     * @return string
-     */
-    public function assetNamespace();
+	/**
+	 * @return string
+	 */
+	public function assetNamespace();
 
 }

core/services/collections/CollectionLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 
     /**
      * @param        $entity
-     * @param  mixed $identifier
+     * @param  string $identifier
      * @return string
      * @throws InvalidEntityException
      */

Spacing +8 added lines, -8 removed lines

@@ -84,7 +84,7 @@ 
         LocatorInterface $file_locator = null
     ) {
         $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection($this->collection_details->getCollectionInterface());
         }
         $this->collection = $collection;
@@ -111,7 +111,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -143,10 +143,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once $filepath;
@@ -154,7 +154,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         return $this->addEntityToCollection(new $class_name(), $file_name);
@@ -224,7 +224,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -288,10 +288,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         return $this->addEntityToCollection(

Indentation +249 added lines, -249 removed lines

@@ -27,276 +27,276 @@
 class CollectionLoader
 {
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was NOT ADDED to the collection
-     */
-    const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was NOT ADDED to the collection
+	 */
+	const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was SUCCESSFULLY ADDED to the collection
-     */
-    const ENTITY_ADDED = 'entity-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was SUCCESSFULLY ADDED to the collection
+	 */
+	const ENTITY_ADDED = 'entity-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was ALREADY ADDED to the collection,
-     * and therefore could not be added again.
-     */
-    const ENTITY_EXISTS = 'entity-already-in-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was ALREADY ADDED to the collection,
+	 * and therefore could not be added again.
+	 */
+	const ENTITY_EXISTS = 'entity-already-in-collection';
 
 
-    /**
-     * @var CollectionDetailsInterface $collection_details
-     */
-    protected $collection_details;
+	/**
+	 * @var CollectionDetailsInterface $collection_details
+	 */
+	protected $collection_details;
 
-    /**
-     * @var CollectionInterface $collection
-     */
-    protected $collection;
+	/**
+	 * @var CollectionInterface $collection
+	 */
+	protected $collection;
 
-    /**
-     * @var FileLocator $file_locator
-     */
-    protected $file_locator;
+	/**
+	 * @var FileLocator $file_locator
+	 */
+	protected $file_locator;
 
 
-    /**
-     * CollectionLoader constructor.
-     *
-     * @param CollectionDetailsInterface $collection_details
-     * @param CollectionInterface        $collection
-     * @param LocatorInterface           $file_locator
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        CollectionDetailsInterface $collection_details,
-        CollectionInterface $collection = null,
-        LocatorInterface $file_locator = null
-    ) {
-        $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection($this->collection_details->getCollectionInterface());
-        }
-        $this->collection = $collection;
-        $this->file_locator = $file_locator;
-        $this->loadAllFromFilepaths();
-        $this->loadFromFQCNs();
-    }
+	/**
+	 * CollectionLoader constructor.
+	 *
+	 * @param CollectionDetailsInterface $collection_details
+	 * @param CollectionInterface        $collection
+	 * @param LocatorInterface           $file_locator
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		CollectionDetailsInterface $collection_details,
+		CollectionInterface $collection = null,
+		LocatorInterface $file_locator = null
+	) {
+		$this->collection_details = $collection_details;
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection($this->collection_details->getCollectionInterface());
+		}
+		$this->collection = $collection;
+		$this->file_locator = $file_locator;
+		$this->loadAllFromFilepaths();
+		$this->loadFromFQCNs();
+	}
 
 
-    /**
-     * @return CollectionInterface
-     */
-    public function getCollection()
-    {
-        return $this->collection;
-    }
+	/**
+	 * @return CollectionInterface
+	 */
+	public function getCollection()
+	{
+		return $this->collection;
+	}
 
 
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadAllFromFilepaths()
-    {
-        if (! $this->file_locator instanceof FileLocator) {
-            $this->file_locator = new FileLocator();
-        }
-        $this->file_locator->setFileMask($this->collection_details->getFileMask());
-        // find all of the files that match the file mask in the specified folder
-        $this->file_locator->locate($this->collection_details->getCollectionPaths());
-        // filter the results
-        $filepaths = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
-            $this->file_locator->getFilePaths(),
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ($filepaths as $filepath) {
-            $this->loadClassFromFilepath($filepath);
-        }
-    }
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadAllFromFilepaths()
+	{
+		if (! $this->file_locator instanceof FileLocator) {
+			$this->file_locator = new FileLocator();
+		}
+		$this->file_locator->setFileMask($this->collection_details->getFileMask());
+		// find all of the files that match the file mask in the specified folder
+		$this->file_locator->locate($this->collection_details->getCollectionPaths());
+		// filter the results
+		$filepaths = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
+			$this->file_locator->getFilePaths(),
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ($filepaths as $filepath) {
+			$this->loadClassFromFilepath($filepath);
+		}
+	}
 
 
-    /**
-     * @param  string $filepath
-     * @return string
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFilepath($filepath)
-    {
-        if (! is_string($filepath)) {
-            throw new InvalidDataTypeException('$filepath', $filepath, 'string');
-        }
-        if (! is_readable($filepath)) {
-            throw new InvalidFilePathException($filepath);
-        }
-        require_once $filepath;
-        // extract filename from path
-        $file_name = basename($filepath);
-        // now remove any file extensions
-        $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
-            throw new InvalidClassException($class_name);
-        }
-        return $this->addEntityToCollection(new $class_name(), $file_name);
-    }
+	/**
+	 * @param  string $filepath
+	 * @return string
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFilepath($filepath)
+	{
+		if (! is_string($filepath)) {
+			throw new InvalidDataTypeException('$filepath', $filepath, 'string');
+		}
+		if (! is_readable($filepath)) {
+			throw new InvalidFilePathException($filepath);
+		}
+		require_once $filepath;
+		// extract filename from path
+		$file_name = basename($filepath);
+		// now remove any file extensions
+		$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
+		if (! class_exists($class_name)) {
+			throw new InvalidClassException($class_name);
+		}
+		return $this->addEntityToCollection(new $class_name(), $file_name);
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function addEntityToCollection($entity, $identifier)
-    {
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity',
-            $entity,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $identifier = $this->setIdentifier($entity, $identifier);
-        if ($this->collection->has($identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_EXISTS;
-        }
-        if ($this->collection->add($entity, $identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_ADDED;
-        }
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
-    }
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function addEntityToCollection($entity, $identifier)
+	{
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity',
+			$entity,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$identifier = $this->setIdentifier($entity, $identifier);
+		if ($this->collection->has($identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_EXISTS;
+		}
+		if ($this->collection->add($entity, $identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_ADDED;
+		}
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function setIdentifier($entity, $identifier)
-    {
-        switch ($this->collection_details->identifierType()) {
-            // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH:
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME:
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD:
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function setIdentifier($entity, $identifier)
+	{
+		switch ($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH:
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME:
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD:
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if (! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-        }
-        return apply_filters(
-            'FHEE__CollectionLoader__addEntityToCollection__identifier',
-            $identifier,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-    }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+		}
+		return apply_filters(
+			'FHEE__CollectionLoader__addEntityToCollection__identifier',
+			$identifier,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadFromFQCNs()
-    {
-        $FQCNs = $this->collection_details->getCollectionFQCNs();
-        $FQCNs = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
-            $FQCNs,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        foreach ($FQCNs as $FQCN) {
-            $this->loadClassFromFQCN($FQCN);
-        }
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadFromFQCNs()
+	{
+		$FQCNs = $this->collection_details->getCollectionFQCNs();
+		$FQCNs = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
+			$FQCNs,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		foreach ($FQCNs as $FQCN) {
+			$this->loadClassFromFQCN($FQCN);
+		}
+	}
 
 
-    /**
-     * @param  string $FQCN Fully Qualified Class Name
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFQCN($FQCN)
-    {
-        if (! is_string($FQCN)) {
-            throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
-        }
-        if (! class_exists($FQCN)) {
-            throw new InvalidClassException($FQCN);
-        }
-        return $this->addEntityToCollection(
-            EE_Registry::instance()->create($FQCN),
-            $FQCN
-        );
-    }
+	/**
+	 * @param  string $FQCN Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFQCN($FQCN)
+	{
+		if (! is_string($FQCN)) {
+			throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
+		}
+		if (! class_exists($FQCN)) {
+			throw new InvalidClassException($FQCN);
+		}
+		return $this->addEntityToCollection(
+			EE_Registry::instance()->create($FQCN),
+			$FQCN
+		);
+	}
 }

core/exceptions/InvalidEntityException.php

Indentation +26 added lines, -26 removed lines

@@ -16,30 +16,30 @@
 class InvalidEntityException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidEntityException constructor.
-     *
-     * @param mixed     $actual   the actual object (or thing) we got
-     * @param string    $expected classname of the entity we wanted
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                var_export($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidEntityException constructor.
+	 *
+	 * @param mixed     $actual   the actual object (or thing) we got
+	 * @param string    $expected classname of the entity we wanted
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				var_export($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/domain/entities/editor/EditorBlock.php

Indentation +242 added lines, -242 removed lines

@@ -23,246 +23,246 @@
 abstract class EditorBlock implements EditorBlockInterface
 {
 
-    const NS = 'event-espresso/';
-
-    /**
-     * @var DomainInterface $domain
-     */
-    protected $domain;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-
-    /**
-     * @var Registry
-     */
-    protected $assets_registry;
-
-    /**
-     * @var string $editor_block_type
-     */
-    private $editor_block_type;
-
-    /**
-     * @var WP_Block_Type $wp_block_type
-     */
-    private $wp_block_type;
-
-    /**
-     * @var array $supported_post_types
-     */
-    private $supported_post_types;
-
-    /**
-     * @var array $attributes
-     */
-    private $attributes;
-
-    /**
-     * If set to true, then the block will render its content client side
-     * If false, then the block will render its content server side using the renderBlock() method
-     *
-     * @var bool $dynamic
-     */
-    private $dynamic = false;
-
-
-    /**
-     * EditorBlockLoader constructor.
-     *
-     * @param DomainInterface $domain
-     * @param LoaderInterface $loader
-     * @param Registry        $assets_registry
-     */
-    public function __construct(
-        DomainInterface $domain,
-        LoaderInterface $loader,
-        Registry $assets_registry
-    ) {
-        $this->domain = $domain;
-        $this->loader = $loader;
-        $this->assets_registry = $assets_registry;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function editorBlockType()
-    {
-        return $this->editor_block_type;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function namespacedEditorBlockType()
-    {
-        return EditorBlock::NS . $this->editor_block_type;
-    }
-
-
-    /**
-     * @param string $editor_block_type
-     */
-    protected function setEditorBlockType($editor_block_type)
-    {
-        $this->editor_block_type = $editor_block_type;
-    }
-
-
-    /**
-     * @param WP_Block_Type $wp_block_type
-     */
-    protected function setWpBlockType($wp_block_type)
-    {
-        $this->wp_block_type = $wp_block_type;
-    }
-
-
-    /**
-     * @param array $supported_post_types
-     */
-    protected function setSupportedPostTypes(array $supported_post_types)
-    {
-        $this->supported_post_types = $supported_post_types;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function attributes()
-    {
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param array $attributes
-     */
-    public function setAttributes(array $attributes)
-    {
-        $this->attributes = $attributes;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isDynamic()
-    {
-        return $this->dynamic;
-    }
-
-
-    /**
-     * @param bool $dynamic
-     */
-    public function setDynamic($dynamic = true)
-    {
-        $this->dynamic = filter_var($dynamic, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function registerBlock()
-    {
-        $context ='core';
-        // todo add route detection (ie inject route) and change context based on route
-        $args          = array(
-            'attributes'      => $this->attributes(),
-            'editor_script'   => "ee-{$context}-blocks",
-            'editor_style'    => "ee-{$context}-blocks",
-            'script'          => "ee-{$context}-blocks",
-            'style'           => "ee-{$context}-blocks",
-        );
-        if (! $this->isDynamic()) {
-            $args['render_callback'] = $this->renderBlock();
-        }
-        $wp_block_type = register_block_type(
-            new WP_Block_Type(
-                $this->namespacedEditorBlockType(),
-                $args
-            )
-        );
-        $this->setWpBlockType($wp_block_type);
-        return $wp_block_type;
-    }
-
-
-    /**
-     * @return WP_Block_Type|false The registered block type on success, or false on failure.
-     */
-    public function unRegisterBlock()
-    {
-        return unregister_block_type($this->namespacedEditorBlockType());
-    }
-
-
-    /**
-     * returns true if the block type applies for the supplied post type
-     * and should be added to that post type's editor
-     *
-     * @param string $post_type
-     * @return boolean
-     */
-    public function appliesToPostType($post_type)
-    {
-        return in_array($post_type, $this->supported_post_types, true);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getEditorContainer()
-    {
-        return array(
-            $this->namespacedEditorBlockType(),
-            array()
-        );
-    }
-
-
-    /**
-     * @return  void
-     */
-    public function registerScripts()
-    {
-        // wp_register_script(
-        //     'core-blocks',
-        //     $this->domain->distributionAssetsUrl() . 'ee-core-blocks.dist.js',
-        //     array(
-        //         'wp-blocks',    // Provides useful functions and components for extending the editor
-        //         'wp-i18n',      // Provides localization functions
-        //         'wp-element',   // Provides React.Component
-        //         'wp-components' // Provides many prebuilt components and controls
-        //     ),
-        //     filemtime($this->domain->distributionAssetsPath() . 'ee-core-blocks.dist.js')
-        // );
-    }
-
-
-    /**
-     * @return void
-     */
-    public function registerStyles()
-    {
-        // wp_register_style(
-        //     'ee-block-styles',
-        //     $this->domain->distributionAssetsUrl() . 'style.css',
-        //     array(),
-        //     filemtime($this->domain->distributionAssetsPath() . 'style.css')
-        // );
-    }
+	const NS = 'event-espresso/';
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	protected $domain;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+
+	/**
+	 * @var Registry
+	 */
+	protected $assets_registry;
+
+	/**
+	 * @var string $editor_block_type
+	 */
+	private $editor_block_type;
+
+	/**
+	 * @var WP_Block_Type $wp_block_type
+	 */
+	private $wp_block_type;
+
+	/**
+	 * @var array $supported_post_types
+	 */
+	private $supported_post_types;
+
+	/**
+	 * @var array $attributes
+	 */
+	private $attributes;
+
+	/**
+	 * If set to true, then the block will render its content client side
+	 * If false, then the block will render its content server side using the renderBlock() method
+	 *
+	 * @var bool $dynamic
+	 */
+	private $dynamic = false;
+
+
+	/**
+	 * EditorBlockLoader constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param LoaderInterface $loader
+	 * @param Registry        $assets_registry
+	 */
+	public function __construct(
+		DomainInterface $domain,
+		LoaderInterface $loader,
+		Registry $assets_registry
+	) {
+		$this->domain = $domain;
+		$this->loader = $loader;
+		$this->assets_registry = $assets_registry;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function editorBlockType()
+	{
+		return $this->editor_block_type;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function namespacedEditorBlockType()
+	{
+		return EditorBlock::NS . $this->editor_block_type;
+	}
+
+
+	/**
+	 * @param string $editor_block_type
+	 */
+	protected function setEditorBlockType($editor_block_type)
+	{
+		$this->editor_block_type = $editor_block_type;
+	}
+
+
+	/**
+	 * @param WP_Block_Type $wp_block_type
+	 */
+	protected function setWpBlockType($wp_block_type)
+	{
+		$this->wp_block_type = $wp_block_type;
+	}
+
+
+	/**
+	 * @param array $supported_post_types
+	 */
+	protected function setSupportedPostTypes(array $supported_post_types)
+	{
+		$this->supported_post_types = $supported_post_types;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function attributes()
+	{
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param array $attributes
+	 */
+	public function setAttributes(array $attributes)
+	{
+		$this->attributes = $attributes;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isDynamic()
+	{
+		return $this->dynamic;
+	}
+
+
+	/**
+	 * @param bool $dynamic
+	 */
+	public function setDynamic($dynamic = true)
+	{
+		$this->dynamic = filter_var($dynamic, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function registerBlock()
+	{
+		$context ='core';
+		// todo add route detection (ie inject route) and change context based on route
+		$args          = array(
+			'attributes'      => $this->attributes(),
+			'editor_script'   => "ee-{$context}-blocks",
+			'editor_style'    => "ee-{$context}-blocks",
+			'script'          => "ee-{$context}-blocks",
+			'style'           => "ee-{$context}-blocks",
+		);
+		if (! $this->isDynamic()) {
+			$args['render_callback'] = $this->renderBlock();
+		}
+		$wp_block_type = register_block_type(
+			new WP_Block_Type(
+				$this->namespacedEditorBlockType(),
+				$args
+			)
+		);
+		$this->setWpBlockType($wp_block_type);
+		return $wp_block_type;
+	}
+
+
+	/**
+	 * @return WP_Block_Type|false The registered block type on success, or false on failure.
+	 */
+	public function unRegisterBlock()
+	{
+		return unregister_block_type($this->namespacedEditorBlockType());
+	}
+
+
+	/**
+	 * returns true if the block type applies for the supplied post type
+	 * and should be added to that post type's editor
+	 *
+	 * @param string $post_type
+	 * @return boolean
+	 */
+	public function appliesToPostType($post_type)
+	{
+		return in_array($post_type, $this->supported_post_types, true);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getEditorContainer()
+	{
+		return array(
+			$this->namespacedEditorBlockType(),
+			array()
+		);
+	}
+
+
+	/**
+	 * @return  void
+	 */
+	public function registerScripts()
+	{
+		// wp_register_script(
+		//     'core-blocks',
+		//     $this->domain->distributionAssetsUrl() . 'ee-core-blocks.dist.js',
+		//     array(
+		//         'wp-blocks',    // Provides useful functions and components for extending the editor
+		//         'wp-i18n',      // Provides localization functions
+		//         'wp-element',   // Provides React.Component
+		//         'wp-components' // Provides many prebuilt components and controls
+		//     ),
+		//     filemtime($this->domain->distributionAssetsPath() . 'ee-core-blocks.dist.js')
+		// );
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function registerStyles()
+	{
+		// wp_register_style(
+		//     'ee-block-styles',
+		//     $this->domain->distributionAssetsUrl() . 'style.css',
+		//     array(),
+		//     filemtime($this->domain->distributionAssetsPath() . 'style.css')
+		// );
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -102,7 +102,7 @@ 
      */
     public function namespacedEditorBlockType()
     {
-        return EditorBlock::NS . $this->editor_block_type;
+        return EditorBlock::NS.$this->editor_block_type;
     }
 
 
@@ -177,16 +177,16 @@ 
      */
     public function registerBlock()
     {
-        $context ='core';
+        $context = 'core';
         // todo add route detection (ie inject route) and change context based on route
-        $args          = array(
+        $args = array(
             'attributes'      => $this->attributes(),
             'editor_script'   => "ee-{$context}-blocks",
             'editor_style'    => "ee-{$context}-blocks",
             'script'          => "ee-{$context}-blocks",
             'style'           => "ee-{$context}-blocks",
         );
-        if (! $this->isDynamic()) {
+        if ( ! $this->isDynamic()) {
             $args['render_callback'] = $this->renderBlock();
         }
         $wp_block_type = register_block_type(