eventespresso / event-espresso-core

core/db_models/EEM_Line_Item.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,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 EE_Error
      * @throws InvalidArgumentException

Spacing +3 added lines, -3 removed lines

@@ -324,8 +324,8 @@ 
         );
         $query = $wpdb->prepare(
             'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
+				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)
@@ -598,7 +598,7 @@ 
      */
     public function getTicketLineItemsForExpiredCarts($timestamp = 0)
     {
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'

Indentation +594 added lines, -594 removed lines

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

core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
      */
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
     {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
             $taxonomy,
             $term_slug,
             $cpt_slugs

Indentation +176 added lines, -176 removed lines

@@ -16,180 +16,180 @@
 class RegisterCustomTaxonomyTerms
 {
 
-    /**
-     * @var array[] $custom_taxonomy_terms
-     */
-    public $custom_taxonomy_terms = array();
-
-
-    /**
-     * RegisterCustomTaxonomyTerms constructor.
-     */
-    public function __construct()
-    {
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
-        // IF they don't have a term for that taxonomy set.
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
-        do_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            $this
-        );
-    }
-
-
-    public function registerCustomTaxonomyTerms()
-    {
-        // setup default terms in any of our taxonomies (but only if we're in admin).
-        // Why not added via register_activation_hook?
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
-        // if ( is_admin() ) {
-        // $this->set_must_use_event_types();
-        // }
-        // set default terms
-        $this->registerCustomTaxonomyTerm(
-            'espresso_event_type',
-            'single-event',
-            array('espresso_events')
-        );
-    }
-
-
-    /**
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
-     *
-     * @param string $taxonomy  The taxonomy we're using for the default term
-     * @param string $term_slug The slug of the term that will be the default.
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
-     */
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
-    {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
-            $taxonomy,
-            $term_slug,
-            $cpt_slugs
-        );
-    }
-
-
-    /**
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
-     *
-     * @param  int     $post_id ID of CPT being saved
-     * @param  WP_Post $post    Post object
-     * @return void
-     */
-    public function saveDefaultTerm($post_id, WP_Post $post)
-    {
-        if (empty($this->custom_taxonomy_terms)) {
-            return;
-        }
-        // no default terms set so lets just exit.
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
-                if ($post->post_status === 'publish'
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
-                ) {
-                    // note some error proofing going on here to save unnecessary db queries
-                    $taxonomies = get_object_taxonomies($post->post_type);
-                    foreach ($taxonomies as $taxonomy) {
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
-                            wp_set_object_terms(
-                                $post_id,
-                                array($custom_taxonomy_term->termSlug()),
-                                $taxonomy
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function setMustUseEventTypes()
-    {
-        $term_details = array(
-            // Attendee's register for the first date-time only
-            'single-event'    => array(
-                'term' => esc_html__('Single Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'A single event that spans one or more consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a party or two-day long workshop
-            // Attendee's can register for any of the date-times
-            'multi-event'     => array(
-                'term' => esc_html__('Multi Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple, separate, but related events that occur on consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a three day music festival or week long conference
-            // Attendee's register for the first date-time only
-            'event-series'    => array(
-                'term' => esc_html__('Event Series', 'event_espresso'),
-                'desc' => esc_html__(
-                    ' Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: an 8 week introduction to basket weaving course
-            // Attendee's can register for any of the date-times.
-            'recurring-event' => array(
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a yoga class
-            'ongoing'         => array(
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
-                    'event_espresso'
-                ),
-            )
-            // example: access to a museum
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
-        );
-        $this->setMustUseTerms('espresso_event_type', $term_details);
-    }
-
-
-    /**
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
-     * deleted then it WILL be recreated.
-     *
-     * @param string $taxonomy     The name of the taxonomy
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
-     *                             description as the elements in the array
-     * @return void
-     */
-    public function setMustUseTerms($taxonomy, $term_details)
-    {
-        $term_details = (array) $term_details;
-        foreach ($term_details as $slug => $details) {
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
-                $insert_arr = array(
-                    'slug'        => $slug,
-                    'description' => $details['desc'],
-                );
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
-            }
-        }
-    }
+	/**
+	 * @var array[] $custom_taxonomy_terms
+	 */
+	public $custom_taxonomy_terms = array();
+
+
+	/**
+	 * RegisterCustomTaxonomyTerms constructor.
+	 */
+	public function __construct()
+	{
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
+		// IF they don't have a term for that taxonomy set.
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
+		do_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			$this
+		);
+	}
+
+
+	public function registerCustomTaxonomyTerms()
+	{
+		// setup default terms in any of our taxonomies (but only if we're in admin).
+		// Why not added via register_activation_hook?
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
+		// if ( is_admin() ) {
+		// $this->set_must_use_event_types();
+		// }
+		// set default terms
+		$this->registerCustomTaxonomyTerm(
+			'espresso_event_type',
+			'single-event',
+			array('espresso_events')
+		);
+	}
+
+
+	/**
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
+	 *
+	 * @param string $taxonomy  The taxonomy we're using for the default term
+	 * @param string $term_slug The slug of the term that will be the default.
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
+	 */
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
+	{
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+			$taxonomy,
+			$term_slug,
+			$cpt_slugs
+		);
+	}
+
+
+	/**
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
+	 *
+	 * @param  int     $post_id ID of CPT being saved
+	 * @param  WP_Post $post    Post object
+	 * @return void
+	 */
+	public function saveDefaultTerm($post_id, WP_Post $post)
+	{
+		if (empty($this->custom_taxonomy_terms)) {
+			return;
+		}
+		// no default terms set so lets just exit.
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
+				if ($post->post_status === 'publish'
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
+				) {
+					// note some error proofing going on here to save unnecessary db queries
+					$taxonomies = get_object_taxonomies($post->post_type);
+					foreach ($taxonomies as $taxonomy) {
+						$terms = wp_get_post_terms($post_id, $taxonomy);
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
+							wp_set_object_terms(
+								$post_id,
+								array($custom_taxonomy_term->termSlug()),
+								$taxonomy
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function setMustUseEventTypes()
+	{
+		$term_details = array(
+			// Attendee's register for the first date-time only
+			'single-event'    => array(
+				'term' => esc_html__('Single Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'A single event that spans one or more consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a party or two-day long workshop
+			// Attendee's can register for any of the date-times
+			'multi-event'     => array(
+				'term' => esc_html__('Multi Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple, separate, but related events that occur on consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a three day music festival or week long conference
+			// Attendee's register for the first date-time only
+			'event-series'    => array(
+				'term' => esc_html__('Event Series', 'event_espresso'),
+				'desc' => esc_html__(
+					' Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: an 8 week introduction to basket weaving course
+			// Attendee's can register for any of the date-times.
+			'recurring-event' => array(
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a yoga class
+			'ongoing'         => array(
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
+					'event_espresso'
+				),
+			)
+			// example: access to a museum
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
+		);
+		$this->setMustUseTerms('espresso_event_type', $term_details);
+	}
+
+
+	/**
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
+	 * deleted then it WILL be recreated.
+	 *
+	 * @param string $taxonomy     The name of the taxonomy
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
+	 *                             description as the elements in the array
+	 * @return void
+	 */
+	public function setMustUseTerms($taxonomy, $term_details)
+	{
+		$term_details = (array) $term_details;
+		foreach ($term_details as $slug => $details) {
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
+				$insert_arr = array(
+					'slug'        => $slug,
+					'description' => $details['desc'],
+				);
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
+			}
+		}
+	}
 }

core/services/loaders/CoreLoader.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      */
     public function __construct($generator)
     {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',

Indentation +98 added lines, -98 removed lines

@@ -29,108 +29,108 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
 
 
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
 
 
-    /**
-     * Calls the appropriate loading method from the installed generator;
-     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
-     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
-     * but NOT to the class being instantiated.
-     * This is done by adding the parameters to the $arguments array as follows:
-     *  array(
-     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
-     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
-     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
-     *  )
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws InstantiationException
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws EE_Error
-     * @throws ServiceNotFoundException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
-        if ($this->generator instanceof EE_Registry) {
-            // check if additional EE_Registry::create() arguments have been passed
-            // from_db
-            $from_db = isset($arguments['EE_Registry::create(from_db)'])
-                ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // load_only
-            $load_only = isset($arguments['EE_Registry::create(load_only)'])
-                ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // addon
-            $addon = isset($arguments['EE_Registry::create(addon)'])
-                ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            unset(
-                $arguments['EE_Registry::create(from_db)'],
-                $arguments['EE_Registry::create(load_only)'],
-                $arguments['EE_Registry::create(addon)']
-            );
-            // addons need to be cached on EE_Registry
-            $shared = $addon ? true : $shared;
-            return $this->generator->create(
-                $fqcn,
-                $arguments,
-                $shared,
-                $from_db,
-                $load_only,
-                $addon
-            );
-        }
-        return $this->generator->brew(
-            $fqcn,
-            $arguments,
-            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
-        );
-    }
+	/**
+	 * Calls the appropriate loading method from the installed generator;
+	 * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
+	 * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
+	 * but NOT to the class being instantiated.
+	 * This is done by adding the parameters to the $arguments array as follows:
+	 *  array(
+	 *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
+	 *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
+	 *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
+	 *  )
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws InstantiationException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 * @throws ServiceNotFoundException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		$shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
+		if ($this->generator instanceof EE_Registry) {
+			// check if additional EE_Registry::create() arguments have been passed
+			// from_db
+			$from_db = isset($arguments['EE_Registry::create(from_db)'])
+				? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// load_only
+			$load_only = isset($arguments['EE_Registry::create(load_only)'])
+				? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// addon
+			$addon = isset($arguments['EE_Registry::create(addon)'])
+				? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			unset(
+				$arguments['EE_Registry::create(from_db)'],
+				$arguments['EE_Registry::create(load_only)'],
+				$arguments['EE_Registry::create(addon)']
+			);
+			// addons need to be cached on EE_Registry
+			$shared = $addon ? true : $shared;
+			return $this->generator->create(
+				$fqcn,
+				$arguments,
+				$shared,
+				$from_db,
+				$load_only,
+				$addon
+			);
+		}
+		return $this->generator->brew(
+			$fqcn,
+			$arguments,
+			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
+		);
+	}
 
 
-    /**
-     * calls reset() on generator if method exists
-     */
-    public function reset()
-    {
-        if ($this->generator instanceof ResettableInterface) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * calls reset() on generator if method exists
+	 */
+	public function reset()
+	{
+		if ($this->generator instanceof ResettableInterface) {
+			$this->generator->reset();
+		}
+	}
 }

core/services/loaders/CachingLoader.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
         $identifier = ''
     ) {
         parent::__construct($loader);
-        $this->cache       = $cache;
+        $this->cache = $cache;
         $this->object_identifier = $object_identifier;
         $this->setIdentifier($identifier);
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@ 
      */
     private function setIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;

Indentation +154 added lines, -154 removed lines

@@ -17,158 +17,158 @@
 class CachingLoader extends CachingLoaderDecorator
 {
 
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache       = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = array())
-    {
-        if ($object instanceof $fqcn) {
-            return $this->cache->add(
-                $object,
-                $this->object_identifier->getIdentifier($fqcn, $arguments)
-            );
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if (apply_filters(
-            'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-            false,
-            $this
-        )) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since 4.9.62.p
-     */
-    public function clearCache()
-    {
-        $this->cache->trashAndDetachAll();
-    }
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		$identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache       = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = array())
+	{
+		if ($object instanceof $fqcn) {
+			return $this->cache->add(
+				$object,
+				$this->object_identifier->getIdentifier($fqcn, $arguments)
+			);
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if (apply_filters(
+			'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+			false,
+			$this
+		)) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since 4.9.62.p
+	 */
+	public function clearCache()
+	{
+		$this->cache->trashAndDetachAll();
+	}
 }

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/services/loaders/ObjectIdentifier.php

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
     public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
     {
         return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+               || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0;
     }
 
 
@@ -93,8 +93,8 @@ 
         )
             ? $this->getIdentifierForArguments($arguments)
             : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+        if ( ! empty($identifier)) {
+            $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier);
         }
         return $fqcn;
     }

Indentation +98 added lines, -98 removed lines

@@ -16,113 +16,113 @@
 class ObjectIdentifier
 {
 
-    /**
-     * used to separate the FQCN from the class's arguments identifier
-     */
-    const DELIMITER = '____';
+	/**
+	 * used to separate the FQCN from the class's arguments identifier
+	 */
+	const DELIMITER = '____';
 
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
 
 
-    /**
-     * ObjectIdentifier constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    public function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-    }
+	/**
+	 * ObjectIdentifier constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	public function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+	}
 
 
-    /**
-     * Returns true if the supplied $object_identifier contains
-     * the delimiter used to separate an fqcn from the arguments hash
-     *
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function hasArguments($object_identifier)
-    {
-        // type casting to bool instead of using strpos() !== false
-        // because an object identifier should never begin with the delimiter
-        // therefore the delimiter should NOT be found at position 0
-        return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
-    }
+	/**
+	 * Returns true if the supplied $object_identifier contains
+	 * the delimiter used to separate an fqcn from the arguments hash
+	 *
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function hasArguments($object_identifier)
+	{
+		// type casting to bool instead of using strpos() !== false
+		// because an object identifier should never begin with the delimiter
+		// therefore the delimiter should NOT be found at position 0
+		return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
+	}
 
 
-    /**
-     * Returns true if the supplied FQCN equals the supplied $object_identifier
-     * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
-     * AND that $object_identifier is for an object with arguments.
-     * This allows a request for an object using a FQCN to match
-     * a previously instantiated object with arguments
-     * without having to know those arguments.
-     *
-     * @param string $fqcn
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
-    {
-        return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
-    }
+	/**
+	 * Returns true if the supplied FQCN equals the supplied $object_identifier
+	 * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
+	 * AND that $object_identifier is for an object with arguments.
+	 * This allows a request for an object using a FQCN to match
+	 * a previously instantiated object with arguments
+	 * without having to know those arguments.
+	 *
+	 * @param string $fqcn
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
+	{
+		return $fqcn === $object_identifier
+			   || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+	}
 
 
-    /**
-     * build a string representation of an object's FQCN and arguments
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return string
-     */
-    public function getIdentifier($fqcn, array $arguments = array())
-    {
-        // only build identifier from arguments if class is not ReservedInstanceInterface
-        $identifier = ! $this->class_cache->hasInterface(
-            $fqcn,
-            'EventEspresso\core\interfaces\ReservedInstanceInterface'
-        )
-            ? $this->getIdentifierForArguments($arguments)
-            : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
-        }
-        return $fqcn;
-    }
+	/**
+	 * build a string representation of an object's FQCN and arguments
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return string
+	 */
+	public function getIdentifier($fqcn, array $arguments = array())
+	{
+		// only build identifier from arguments if class is not ReservedInstanceInterface
+		$identifier = ! $this->class_cache->hasInterface(
+			$fqcn,
+			'EventEspresso\core\interfaces\ReservedInstanceInterface'
+		)
+			? $this->getIdentifierForArguments($arguments)
+			: '';
+		if (! empty($identifier)) {
+			$fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+		}
+		return $fqcn;
+	}
 
 
-    /**
-     * build a string representation of a object's arguments
-     * (mostly because Closures can't be serialized)
-     *
-     * @param array $arguments
-     * @return string
-     */
-    protected function getIdentifierForArguments(array $arguments)
-    {
-        if (empty($arguments)) {
-            return '';
-        }
-        $identifier = '';
-        foreach ($arguments as $argument) {
-            switch (true) {
-                case is_object($argument):
-                case $argument instanceof Closure:
-                    $identifier .= spl_object_hash($argument);
-                    break;
-                case is_array($argument):
-                    $identifier .= $this->getIdentifierForArguments($argument);
-                    break;
-                default:
-                    $identifier .= $argument;
-                    break;
-            }
-        }
-        return $identifier;
-    }
+	/**
+	 * build a string representation of a object's arguments
+	 * (mostly because Closures can't be serialized)
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	protected function getIdentifierForArguments(array $arguments)
+	{
+		if (empty($arguments)) {
+			return '';
+		}
+		$identifier = '';
+		foreach ($arguments as $argument) {
+			switch (true) {
+				case is_object($argument):
+				case $argument instanceof Closure:
+					$identifier .= spl_object_hash($argument);
+					break;
+				case is_array($argument):
+					$identifier .= $this->getIdentifierForArguments($argument);
+					break;
+				default:
+					$identifier .= $argument;
+					break;
+			}
+		}
+		return $identifier;
+	}
 }

core/domain/DomainInterface.php

Indentation +36 added lines, -36 removed lines

@@ -16,55 +16,55 @@
 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 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/domain/entities/editor/BlockCollection.php

Indentation +47 added lines, -47 removed lines

@@ -20,55 +20,55 @@
 class BlockCollection extends Collection
 {
 
-    /**
-     * Collection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
-    }
+	/**
+	 * Collection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
+	}
 
 
-    /**
-     * 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/helpers/EEH_Debug_Tools.helper.php

Doc Comments +8 added lines, -5 removed lines

@@ -375,11 +375,11 @@ 
 
 
     /**
-     * @param mixed      $var
+     * @param string      $var
      * @param string     $var_name
      * @param string     $file
      * @param int|string $line
-     * @param int|string $heading_tag
+     * @param integer $heading_tag
      * @param bool       $die
      * @param string     $margin
      */
@@ -411,6 +411,9 @@ 
     }
 
 
+    /**
+     * @param integer $heading_tag
+     */
     protected static function headingTag($heading_tag)
     {
         $heading_tag = absint($heading_tag);
@@ -532,8 +535,8 @@ 
      * @param mixed      $var
      * @param string     $var_name
      * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
+     * @param integer $line
+     * @param integer $heading_tag
      * @param bool       $die
      */
     public static function printr(
@@ -596,7 +599,7 @@ 
 
     /**
      * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
+     * @param string $timer_name
      */
     public function start_timer($timer_name = null)
     {

Spacing +40 added lines, -40 removed lines

@@ -34,7 +34,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -48,13 +48,13 @@ 
     private function __construct()
     {
         // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
+        if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php')) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php');
         }
         // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
         // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
@@ -74,7 +74,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -123,12 +123,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
+            echo '<h5>For Tag: '.$tag.'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -157,12 +157,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -181,17 +181,17 @@ 
     {
         if (WP_DEBUG) {
             $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+            if ( ! empty($activation_errors)) {
+                $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
             }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -211,11 +211,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -275,7 +275,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -319,19 +319,19 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
                 'REQ'  => $display_request ? $_REQUEST : '',
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -348,20 +348,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -395,8 +395,8 @@ 
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -445,7 +445,7 @@ 
             return $heading;
         }
         $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+        return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>';
     }
 
 
@@ -459,7 +459,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return '';
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -473,7 +473,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -513,7 +513,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -530,7 +530,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $var;
         }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+        return '<pre style="color:#999; padding:1em; background: #fff">'.$var.'</pre>';
     }
 
 
@@ -574,7 +574,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);

Indentation +679 added lines, -679 removed lines

@@ -11,670 +11,670 @@ 
 class EEH_Debug_Tools
 {
 
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
-        }
-        // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
-        // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
-        // }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if ((defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo $priority;
-                foreach ($function as $name => $properties) {
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                __('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-                'REQ'  => $display_request ? $_REQUEST : '',
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? "\n"
-            : '';
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR')
-               || (defined('DOING_AJAX') && DOING_AJAX)
-               || (
-                   isset($_SERVER['REQUEST_URI'])
-                   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
-               );
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            $heading = '';
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                $heading .= "\n";
-            }
-            $heading .= "\n{$line}) {$var_name}";
-            return $heading;
-        }
-        $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
-    }
-
-
-
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '</' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})";
-            }
-            return '';
-        }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . '<br />line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $var;
-        }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        $margin = is_admin() ? ' 180px' : '0';
-        // $print_r = false;
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-            // $print_r = true;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-            // $print_r = true;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
+		}
+		// if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
+		// add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
+		// }
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if ((defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . $tag . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo $priority;
+				foreach ($function as $name => $properties) {
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			}
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+				'REQ'  => $display_request ? $_REQUEST : '',
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? "\n"
+			: '';
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR')
+			   || (defined('DOING_AJAX') && DOING_AJAX)
+			   || (
+				   isset($_SERVER['REQUEST_URI'])
+				   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			$heading = '';
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				$heading .= "\n";
+			}
+			$heading .= "\n{$line}) {$var_name}";
+			return $heading;
+		}
+		$margin = "25px 0 0 {$margin}";
+		return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+	}
+
+
+
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '</' . $heading_tag . '>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})";
+			}
+			return '';
+		}
+		return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . '<br />line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $var;
+		}
+		return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		$margin = is_admin() ? ' 180px' : '0';
+		// $print_r = false;
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+			// $print_r = true;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+			// $print_r = true;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -684,31 +684,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }