eventespresso / event-espresso-core

core/db_models/EEM_Line_Item.model.php

Spacing +59 added lines, -59 removed lines

@@ -105,41 +105,41 @@ 
 	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
 	 * @return \EEM_Line_Item
 	 */
-	protected function __construct( $timezone ) {
-		$this->singular_item = __('Line Item','event_espresso');
-		$this->plural_item = __('Line Items','event_espresso');
+	protected function __construct($timezone) {
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('Line Items', 'event_espresso');
 
 		$this->_tables = array(
-			'Line_Item'=>new EE_Primary_Table('esp_line_item','LIN_ID')
+			'Line_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' ) );
+		$line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
 		$this->_fields = array(
 			'Line_Item' => array(
-				'LIN_ID' 				=> new EE_Primary_Key_Int_Field( 'LIN_ID', __( "ID", "event_espresso" ) ),
-				'LIN_code' 			=> new EE_Slug_Field( 'LIN_code', __( "Code for index into Cart", "event_espresso" ), TRUE ),
-				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field( 'TXN_ID', __( "Transaction ID", "event_espresso" ), TRUE, NULL, 'Transaction' ),
-				'LIN_name' 			=> new EE_Full_HTML_Field( 'LIN_name', __( "Line Item Name", "event_espresso" ), FALSE, '' ),
-				'LIN_desc' 			=> new EE_Full_HTML_Field( 'LIN_desc', __( "Line Item Description", "event_espresso" ), TRUE ),
-				'LIN_unit_price' 	=> new EE_Money_Field( 'LIN_unit_price', __( "Unit Price", "event_espresso" ), FALSE, 0 ),
-				'LIN_percent' 		=> new EE_Float_Field( 'LIN_percent', __( "Percent", "event_espresso" ), FALSE, 0 ),
-				'LIN_is_taxable' 	=> new EE_Boolean_Field( 'LIN_is_taxable', __( "Taxable", "event_espresso" ), FALSE, FALSE ),
-				'LIN_order' 			=> new EE_Integer_Field( 'LIN_order', __( "Order of Application towards total of parent", "event_espresso" ), FALSE, 1 ),
-				'LIN_total' 			=> new EE_Money_Field( 'LIN_total', __( "Total (unit price x quantity)", "event_espresso" ), FALSE, 0 ),
-				'LIN_quantity' 	=> new EE_Integer_Field( 'LIN_quantity', __( "Quantity", "event_espresso" ), TRUE, 1 ),
-				'LIN_parent' 		=> new EE_Integer_Field( 'LIN_parent', __( "Parent ID (this item goes towards that Line Item's total)", "event_espresso" ), TRUE, NULL ),
-				'LIN_type' 			=> new EE_Enum_Text_Field( 'LIN_type', __( "Type", "event_espresso" ), FALSE, 'line-item', array(
+				'LIN_ID' 				=> new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
+				'LIN_code' 			=> new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), TRUE),
+				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), TRUE, NULL, 'Transaction'),
+				'LIN_name' 			=> new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), FALSE, ''),
+				'LIN_desc' 			=> new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), TRUE),
+				'LIN_unit_price' 	=> new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), FALSE, 0),
+				'LIN_percent' 		=> new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), FALSE, 0),
+				'LIN_is_taxable' 	=> new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), FALSE, FALSE),
+				'LIN_order' 			=> new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), FALSE, 1),
+				'LIN_total' 			=> new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), FALSE, 0),
+				'LIN_quantity' 	=> new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), TRUE, 1),
+				'LIN_parent' 		=> new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), TRUE, NULL),
+				'LIN_type' 			=> new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), FALSE, 'line-item', array(
 						self::type_line_item		=>  __("Line Item", "event_espresso"),
 						self::type_sub_line_item	=>  __("Sub-Item", "event_espresso"),
 						self::type_sub_total		=>  __("Subtotal", "event_espresso"),
 						self::type_tax_sub_total 	=> __("Tax Subtotal", "event_espresso"),
 						self::type_tax					=>  __("Tax", "event_espresso"),
 						self::type_total				=>  __("Total", "event_espresso"),
-						self::type_cancellation	=> __( 'Cancellation', 'event_espresso' )
+						self::type_cancellation	=> __('Cancellation', 'event_espresso')
 					)
 				),
-				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field( 'OBJ_ID', __( 'ID of Item purchased.', 'event_espresso' ), TRUE, NULL, $line_items_can_be_for ),
-				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field( 'OBJ_type', __( "Model Name this Line Item is for", "event_espresso" ), TRUE, NULL, $line_items_can_be_for ),
-				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created','event_espresso'), false, EE_Datetime_Field::now, $timezone ),
+				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), TRUE, NULL, $line_items_can_be_for),
+				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), TRUE, NULL, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
 			)
 		);
 		$this->_model_relations = array(
@@ -150,7 +150,7 @@ 
 		);
 		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
 		$this->_caps_slug = 'transactions';
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -161,9 +161,9 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_of_type_for_transaction( $line_item_type, $transaction ){
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	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
 		)));
@@ -177,14 +177,14 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_non_ticket_line_items_for_transaction( $transaction ) {
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	public function get_all_non_ticket_line_items_for_transaction($transaction) {
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
 			'LIN_type' => self::type_line_item,
 			'TXN_ID' => $transaction,
 			'OR' => array(
-				'OBJ_type*notticket' => array( '!=', 'Ticket'),
-				'OBJ_type*null' => array( 'IS_NULL' ))
+				'OBJ_type*notticket' => array('!=', 'Ticket'),
+				'OBJ_type*null' => array('IS_NULL'))
 		)));
 	}
 
@@ -194,7 +194,7 @@ 
 	 * because if there are spam bots afoot there will be LOTS of line items
 	 * @return int count of how many deleted
 	 */
-	public function delete_line_items_with_no_transaction(){
+	public function delete_line_items_with_no_transaction() {
 		/** @type WPDB $wpdb */
 		global $wpdb;
 		$time_to_leave_alone = apply_filters(
@@ -202,13 +202,13 @@ 
 		);
 		$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 )
+				date('Y-m-d H:i:s', time() - $time_to_leave_alone)
 				);
-		return $wpdb->query( $query );
+		return $wpdb->query($query);
 	}
 
 
@@ -221,10 +221,10 @@ 
 	 * @param \EE_Base_Class $object
 	 * @return EE_Line_Item[]
 	 */
-	public function get_line_item_for_transaction_object( $TXN_ID, EE_Base_Class $object ){
-		return $this->get_all( array( array(
+	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_type' 	=> str_replace('EE_', '', get_class($object)),
 			'OBJ_ID' 		=> $object->ID()
 		)));
 	}
@@ -240,16 +240,16 @@ 
 	 * @param array $OBJ_IDs
 	 * @return EE_Line_Item[]
 	 */
-	public function get_object_line_items_for_transaction( $TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array() ){
+	public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array()) {
 		$query_params = array(
 			'OBJ_type' 	=> $OBJ_type,
 			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-			'OBJ_ID' 		=> is_array( $OBJ_IDs ) && ! isset( $OBJ_IDs['IN'] ) ? array( 'IN', $OBJ_IDs ) : $OBJ_IDs
+			'OBJ_ID' 		=> is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
 		);
-		if ( $TXN_ID ) {
+		if ($TXN_ID) {
 			$query_params['TXN_ID'] = $TXN_ID;
 		}
-		return $this->get_all( array( $query_params ));
+		return $this->get_all(array($query_params));
 	}
 
 
@@ -260,13 +260,13 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_ticket_line_items_for_transaction( EE_Transaction $transaction ) {
-		return $this->get_all( array(
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) {
+		return $this->get_all(array(
 		   array(
 			   'TXN_ID'   => $transaction->ID(),
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -278,14 +278,14 @@ 
 	 * @param int $TKT_ID
 	 * @return \EE_Line_Item
 	 */
-	public function get_ticket_line_item_for_transaction( $TXN_ID, $TKT_ID ) {
-		return $this->get_one( array(
+	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 ),
+			   'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
 			   'OBJ_ID'   => $TKT_ID,
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -300,8 +300,8 @@ 
 	 * @param EE_Promotion $promotion
 	 * @return EE_Line_Item
 	 */
-	public function get_existing_promotion_line_item( EE_Line_Item $parent_line_item, EE_Promotion $promotion ) {
-		return $this->get_one( array(
+	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(),
@@ -322,8 +322,8 @@ 
 	 * @param EE_Line_Item $parent_line_item
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_promotion_line_items( EE_Line_Item $parent_line_item ) {
-		return $this->get_all( array(
+	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(),
@@ -340,8 +340,8 @@ 
 	 * @param EE_Registration $registration
 	 * @return EE_Line_ITem
 	 */
-	public function get_line_item_for_registration( EE_Registration $registration ) {
-		return $this->get_one( $this->line_item_for_registration_query_params( $registration ));
+	public function get_line_item_for_registration(EE_Registration $registration) {
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
 	}
 
 	/**
@@ -350,14 +350,14 @@ 
 	 * @param array $original_query_params any extra query params you'd like to be merged with
 	 * @return array like EEM_Base::get_all()'s $query_params
 	 */
-	public function line_item_for_registration_query_params( EE_Registration $registration, $original_query_params = array() ) {
-		return array_replace_recursive( $original_query_params, array(
+	public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array()) {
+		return array_replace_recursive($original_query_params, array(
 			array(
 				'OBJ_ID' => $registration->ticket_ID(),
 				'OBJ_type' => 'Ticket',
 				'TXN_ID' => $registration->transaction_ID()
 			)
-		) );
+		));
 	}
 
 

Indentation +56 added lines, -56 removed lines

@@ -362,62 +362,62 @@
 
 
 
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    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 \EE_Error
-     */
-    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 \EE_Error
-     */
-    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 bool|null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID'        => 0,
-            'LIN_type'      => 'total',
-        );
-        if ($expired !== null) {
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                time() - EE_Registry::instance()->SSN->lifespan(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	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 \EE_Error
+	 */
+	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 \EE_Error
+	 */
+	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 bool|null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID'        => 0,
+			'LIN_type'      => 'total',
+		);
+		if ($expired !== null) {
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				time() - EE_Registry::instance()->SSN->lifespan(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
 
 
 

core/db_models/EEM_Ticket.model.php

Indentation +38 added lines, -38 removed lines

@@ -129,13 +129,13 @@ 
 
 
 
-    /**
-     * Updates the TKT_sold quantity on all the tickets matching $query_params
-     *
-     * @param EE_Ticket[] $tickets
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Updates the TKT_sold quantity on all the tickets matching $query_params
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function update_tickets_sold($tickets){
 		foreach($tickets as $ticket){
 			/* @var  $ticket EE_Ticket */
@@ -145,41 +145,41 @@ 
 
 
 
-    /**
-     * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws \EE_Error
-     */
-    public function get_tickets_with_reservations()
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'TKT_reserved' => array( '>', 0 )
-                )
-            )
-        );
+	/**
+	 * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws \EE_Error
+	 */
+	public function get_tickets_with_reservations()
+	{
+		return $this->get_all(
+			array(
+				array(
+					'TKT_reserved' => array( '>', 0 )
+				)
+			)
+		);
 	}
 
 
 
-    /**
-     * returns an array of EE_Ticket objects matching the supplied list of IDs
-     *
-     * @param array $ticket_IDs
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws \EE_Error
-     */
-    public function get_tickets_with_IDs(array $ticket_IDs)
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'TKT_ID' => array( 'IN', $ticket_IDs )
-                )
-            )
-        );
+	/**
+	 * returns an array of EE_Ticket objects matching the supplied list of IDs
+	 *
+	 * @param array $ticket_IDs
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws \EE_Error
+	 */
+	public function get_tickets_with_IDs(array $ticket_IDs)
+	{
+		return $this->get_all(
+			array(
+				array(
+					'TKT_ID' => array( 'IN', $ticket_IDs )
+				)
+			)
+		);
 	}
 
 

Spacing +39 added lines, -39 removed lines

@@ -21,8 +21,8 @@ 
  *
  * ------------------------------------------------------------------------
  */
-require_once ( EE_MODELS . 'EEM_Soft_Delete_Base.model.php' );
-require_once ( EE_CLASSES . 'EE_Ticket.class.php' );
+require_once (EE_MODELS.'EEM_Soft_Delete_Base.model.php');
+require_once (EE_CLASSES.'EE_Ticket.class.php');
 
 class EEM_Ticket extends EEM_Soft_Delete_Base {
 
@@ -35,36 +35,36 @@ 
 	 *		@access private
 	 *		@param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
 	 */
-	protected function __construct( $timezone ) {
-		$this->singular_item = __('Ticket','event_espresso');
-		$this->plural_item = __('Tickets','event_espresso');
+	protected function __construct($timezone) {
+		$this->singular_item = __('Ticket', 'event_espresso');
+		$this->plural_item = __('Tickets', 'event_espresso');
 
 		$this->_tables = array(
 			'Ticket'=> new EE_Primary_Table('esp_ticket', 'TKT_ID')
 		);
 		$this->_fields = array(
 			'Ticket'=>array(
-				'TKT_ID'=> new EE_Primary_Key_Int_Field('TKT_ID', __('Ticket ID','event_espresso')),
-				'TTM_ID'=>new EE_Foreign_Key_Int_Field('TTM_ID', __('Ticket Template ID','event_espresso'), false, 0, 'Ticket_Template'),
+				'TKT_ID'=> new EE_Primary_Key_Int_Field('TKT_ID', __('Ticket ID', 'event_espresso')),
+				'TTM_ID'=>new EE_Foreign_Key_Int_Field('TTM_ID', __('Ticket Template ID', 'event_espresso'), false, 0, 'Ticket_Template'),
 				'TKT_name'=>new EE_Plain_Text_Field('TKT_name', __('Ticket Name', 'event_espresso'), false, ''),
-				'TKT_description'=>new EE_Post_Content_Field('TKT_description', __('Description of Ticket', 'event_espresso'), false, '' ),
-				'TKT_start_date'=>new EE_Datetime_Field('TKT_start_date', __('Start time/date of Ticket','event_espresso'), false, EE_Datetime_Field::now, $timezone ),
-				'TKT_end_date'=>new EE_Datetime_Field('TKT_end_date', __('End time/date of Ticket','event_espresso'), false, EE_Datetime_Field::now, $timezone ),
-				'TKT_min'=>new EE_Integer_Field('TKT_min', __('Minimum quantity of this ticket that must be purchased', 'event_espresso'), false, 0 ),
-				'TKT_max'=>new EE_Infinite_Integer_Field('TKT_max', __('Maximum quantity of this ticket that can be purchased in one transaction', 'event_espresso'), false, EE_INF ),
+				'TKT_description'=>new EE_Post_Content_Field('TKT_description', __('Description of Ticket', 'event_espresso'), false, ''),
+				'TKT_start_date'=>new EE_Datetime_Field('TKT_start_date', __('Start time/date of Ticket', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
+				'TKT_end_date'=>new EE_Datetime_Field('TKT_end_date', __('End time/date of Ticket', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
+				'TKT_min'=>new EE_Integer_Field('TKT_min', __('Minimum quantity of this ticket that must be purchased', 'event_espresso'), false, 0),
+				'TKT_max'=>new EE_Infinite_Integer_Field('TKT_max', __('Maximum quantity of this ticket that can be purchased in one transaction', 'event_espresso'), false, EE_INF),
 				'TKT_price'=> new EE_Money_Field('TKT_price', 'Final calculated price for ticket', false, 0),
 				'TKT_sold' => new EE_Integer_Field('TKT_sold', __('Number of this ticket sold', 'event_espresso'), false, 0),
-				'TKT_qty'=>new EE_Infinite_Integer_Field('TKT_qty', __('Quantity of this ticket that is available','event_espresso'), false, EE_INF),
-				'TKT_reserved'=>new EE_Integer_Field('TKT_reserved', __('Quantity of this ticket that is reserved, but not yet fully purchased','event_espresso'), false, 0 ),
-				'TKT_uses'=>new EE_Infinite_Integer_Field('TKT_uses', __('Number of datetimes this ticket can be used at', 'event_espresso'), false, EE_INF ),
-				'TKT_required'=>new EE_Boolean_Field('TKT_required', __("Flag indicating whether this ticket must be purchased with a transaction", "event_espresso"), false, false ),
-				'TKT_taxable'=>new EE_Boolean_Field('TKT_taxable', __("Flag indicating whether there is tax applied on this ticket", "event_espresso"), false,false),
-				'TKT_is_default'=>new EE_Boolean_Field('TKT_is_default', __('Flag indicating that this ticket is a default ticket', 'event_espresso'), false, false ),
+				'TKT_qty'=>new EE_Infinite_Integer_Field('TKT_qty', __('Quantity of this ticket that is available', 'event_espresso'), false, EE_INF),
+				'TKT_reserved'=>new EE_Integer_Field('TKT_reserved', __('Quantity of this ticket that is reserved, but not yet fully purchased', 'event_espresso'), false, 0),
+				'TKT_uses'=>new EE_Infinite_Integer_Field('TKT_uses', __('Number of datetimes this ticket can be used at', 'event_espresso'), false, EE_INF),
+				'TKT_required'=>new EE_Boolean_Field('TKT_required', __("Flag indicating whether this ticket must be purchased with a transaction", "event_espresso"), false, false),
+				'TKT_taxable'=>new EE_Boolean_Field('TKT_taxable', __("Flag indicating whether there is tax applied on this ticket", "event_espresso"), false, false),
+				'TKT_is_default'=>new EE_Boolean_Field('TKT_is_default', __('Flag indicating that this ticket is a default ticket', 'event_espresso'), false, false),
 				'TKT_order' => new EE_Integer_Field('TKT_order', __('The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)', 'event_espresso'), false, 0),
-				'TKT_row' => new EE_Integer_Field('TKT_row', __('How tickets are displayed in the ui', 'event_espresso'), false, 0 ),
+				'TKT_row' => new EE_Integer_Field('TKT_row', __('How tickets are displayed in the ui', 'event_espresso'), false, 0),
 				'TKT_deleted' => new EE_Trashed_Flag_Field('TKT_deleted', __('Flag indicating if this has been archived or not', 'event_espresso'), false, false),
-				'TKT_wp_user' => new EE_WP_User_Field('TKT_wp_user', __('Ticket Creator ID', 'event_espresso'), FALSE ),
-				'TKT_parent' => new EE_Integer_Field('TKT_parent', __('Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)'), true, 0 )
+				'TKT_wp_user' => new EE_WP_User_Field('TKT_wp_user', __('Ticket Creator ID', 'event_espresso'), FALSE),
+				'TKT_parent' => new EE_Integer_Field('TKT_parent', __('Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)'), true, 0)
 			));
 		$this->_model_relations = array(
 			'Datetime'=>new EE_HABTM_Relation('Datetime_Ticket'),
@@ -76,12 +76,12 @@ 
 		);
 
 		//this model is generally available for reading
-		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('TKT_is_default', 'Datetime.Event');
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('TKT_is_default', 'Datetime.Event');
 		//account for default tickets in the caps
-		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected( 'TKT_is_default', 'Datetime.Event' );
-		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected( 'TKT_is_default', 'Datetime.Event' );
-		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected( 'TKT_is_default', 'Datetime.Event' );
-		parent::__construct( $timezone );
+		$this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('TKT_is_default', 'Datetime.Event');
+		$this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('TKT_is_default', 'Datetime.Event');
+		$this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('TKT_is_default', 'Datetime.Event');
+		parent::__construct($timezone);
 	}
 
 
@@ -92,9 +92,9 @@ 
 	 */
 	public function get_all_default_tickets() {
 		/** @type EE_Ticket[] $tickets */
-		$tickets = $this->get_all( array( array('TKT_is_default' => 1), 'order_by' => array('TKT_ID' => 'ASC')) );
+		$tickets = $this->get_all(array(array('TKT_is_default' => 1), 'order_by' => array('TKT_ID' => 'ASC')));
 		//we need to set the start date and end date to today's date and the start of the default dtt
-		return $this->_set_default_dates( $tickets );
+		return $this->_set_default_dates($tickets);
 	}
 
 
@@ -104,11 +104,11 @@ 
 	 * @param EE_Ticket[] $tickets
 	 * @return EE_Ticket[]
 	 */
-	private function _set_default_dates( $tickets ) {
-		foreach ( $tickets as $ticket ) {
-			$ticket->set('TKT_start_date', (int)$this->current_time_for_query('TKT_start_date', true) );
-			$ticket->set('TKT_end_date', (int)$this->current_time_for_query( 'TKT_end_date', true ) + (60 * 60 * 24 * 30 ) );
-			$ticket->set_end_time( $this->convert_datetime_for_query( 'TKT_end_date', '11:59 pm', 'g:i a', $this->_timezone ) );
+	private function _set_default_dates($tickets) {
+		foreach ($tickets as $ticket) {
+			$ticket->set('TKT_start_date', (int) $this->current_time_for_query('TKT_start_date', true));
+			$ticket->set('TKT_end_date', (int) $this->current_time_for_query('TKT_end_date', true) + (60 * 60 * 24 * 30));
+			$ticket->set_end_time($this->convert_datetime_for_query('TKT_end_date', '11:59 pm', 'g:i a', $this->_timezone));
 		}
 
 		return $tickets;
@@ -123,8 +123,8 @@ 
 	 * @param array $query_params
 	 * @return int
 	 */
-	public function sum_tickets_currently_available_at_datetime($DTT_ID, $query_params = array()){
-		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime( $DTT_ID, $query_params );
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, $query_params = array()) {
+		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
 	}
 
 
@@ -136,8 +136,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function update_tickets_sold($tickets){
-		foreach($tickets as $ticket){
+	public function update_tickets_sold($tickets) {
+		foreach ($tickets as $ticket) {
 			/* @var  $ticket EE_Ticket */
 			$ticket->update_tickets_sold();
 		}
@@ -156,7 +156,7 @@ 
         return $this->get_all(
             array(
                 array(
-                    'TKT_reserved' => array( '>', 0 )
+                    'TKT_reserved' => array('>', 0)
                 )
             )
         );
@@ -176,7 +176,7 @@ 
         return $this->get_all(
             array(
                 array(
-                    'TKT_ID' => array( 'IN', $ticket_IDs )
+                    'TKT_ID' => array('IN', $ticket_IDs)
                 )
             )
         );

core/db_classes/EE_Line_Item.class.php

Spacing +209 added lines, -209 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -50,9 +50,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -63,8 +63,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -75,10 +75,10 @@ 
 	 * @param bool   $bydb
 	 * @param string $timezone
 	 */
-	protected function __construct( $fieldValues = array(), $bydb = FALSE, $timezone = '' ) {
-		parent::__construct( $fieldValues, $bydb, $timezone );
-		if ( ! $this->get( 'LIN_code' ) ) {
-			$this->set_code( $this->generate_code() );
+	protected function __construct($fieldValues = array(), $bydb = FALSE, $timezone = '') {
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if ( ! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
 		}
 	}
 
@@ -89,7 +89,7 @@ 
 	 * @return int
 	 */
 	public function ID() {
-		return $this->get( 'LIN_ID' );
+		return $this->get('LIN_ID');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @return int
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -108,8 +108,8 @@ 
 	 * Sets TXN_ID
 	 * @param int $TXN_ID
 	 */
-	public function set_TXN_ID( $TXN_ID ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_TXN_ID($TXN_ID) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -119,9 +119,9 @@ 
 	 * @return string
 	 */
 	public function name() {
-		$name =  $this->get( 'LIN_name' );
-		if( ! $name ){
-			$name = ucwords( str_replace( '-', ' ', $this->type() ) );
+		$name = $this->get('LIN_name');
+		if ( ! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
 		}
 		return $name;
 	}
@@ -132,8 +132,8 @@ 
 	 * Sets name
 	 * @param string $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'LIN_name', $name );
+	public function set_name($name) {
+		$this->set('LIN_name', $name);
 	}
 
 
@@ -143,7 +143,7 @@ 
 	 * @return string
 	 */
 	public function desc() {
-		return $this->get( 'LIN_desc' );
+		return $this->get('LIN_desc');
 	}
 
 
@@ -152,8 +152,8 @@ 
 	 * Sets desc
 	 * @param string $desc
 	 */
-	public function set_desc( $desc ) {
-		$this->set( 'LIN_desc', $desc );
+	public function set_desc($desc) {
+		$this->set('LIN_desc', $desc);
 	}
 
 
@@ -163,7 +163,7 @@ 
 	 * @return int
 	 */
 	public function quantity() {
-		return $this->get( 'LIN_quantity' );
+		return $this->get('LIN_quantity');
 	}
 
 
@@ -172,8 +172,8 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
-		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
+    public function set_quantity($quantity) {
+		$this->set('LIN_quantity', max($quantity, 0));
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_ID() {
-		return $this->get( 'OBJ_ID' );
+		return $this->get('OBJ_ID');
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * Sets item_id
 	 * @param string $item_id
 	 */
-	public function set_OBJ_ID( $item_id ) {
-		$this->set( 'OBJ_ID', $item_id );
+	public function set_OBJ_ID($item_id) {
+		$this->set('OBJ_ID', $item_id);
 	}
 
 
@@ -203,7 +203,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_type() {
-		return $this->get( 'OBJ_type' );
+		return $this->get('OBJ_type');
 	}
 
 
@@ -240,8 +240,8 @@ 
 	 * Sets item_type
 	 * @param string $OBJ_type
 	 */
-	public function set_OBJ_type( $OBJ_type ) {
-		$this->set( 'OBJ_type', $OBJ_type );
+	public function set_OBJ_type($OBJ_type) {
+		$this->set('OBJ_type', $OBJ_type);
 	}
 
 
@@ -251,7 +251,7 @@ 
 	 * @return float
 	 */
 	public function unit_price() {
-		return $this->get( 'LIN_unit_price' );
+		return $this->get('LIN_unit_price');
 	}
 
 
@@ -261,8 +261,8 @@ 
 	 *
 	 * @param float $unit_price
 	 */
-	public function set_unit_price( $unit_price ) {
-		$this->set( 'LIN_unit_price', $unit_price );
+	public function set_unit_price($unit_price) {
+		$this->set('LIN_unit_price', $unit_price);
 	}
 
 
@@ -273,19 +273,19 @@ 
 	 * @return boolean
 	 */
 	public function is_percent() {
-		if( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			//tax subtotals HAVE a percent on them, that percentage only applies
 			//to taxable items, so its' an exception. Treat it like a flat line item
 			return false;
 		}
-		$unit_price = abs( $this->get( 'LIN_unit_price' ) );
-		$percent = abs( $this->get( 'LIN_percent' ) );
-		if ( $unit_price < .001 && $percent ) {
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
 			return TRUE;
-		} elseif ( $unit_price >= .001 && !$percent ) {
+		} elseif ($unit_price >= .001 && ! $percent) {
 			return FALSE;
-		} elseif ( $unit_price >= .001 && $percent ) {
-			throw new EE_Error( sprintf( __( "A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso" ), $unit_price, $percent ) );
+		} elseif ($unit_price >= .001 && $percent) {
+			throw new EE_Error(sprintf(__("A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso"), $unit_price, $percent));
 		} else {
 			// if they're both 0, assume its not a percent item
 			return FALSE;
@@ -299,7 +299,7 @@ 
 	 * @return float
 	 */
 	public function percent() {
-		return $this->get( 'LIN_percent' );
+		return $this->get('LIN_percent');
 	}
 
 
@@ -308,8 +308,8 @@ 
 	 * Sets percent (between 100-0.01)
 	 * @param float $percent
 	 */
-	public function set_percent( $percent ) {
-		$this->set( 'LIN_percent', $percent );
+	public function set_percent($percent) {
+		$this->set('LIN_percent', $percent);
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return float
 	 */
 	public function total() {
-		return $this->get( 'LIN_total' );
+		return $this->get('LIN_total');
 	}
 
 
@@ -328,8 +328,8 @@ 
 	 * Sets total
 	 * @param float $total
 	 */
-	public function set_total( $total ) {
-		$this->set( 'LIN_total', $total );
+	public function set_total($total) {
+		$this->set('LIN_total', $total);
 	}
 
 
@@ -339,7 +339,7 @@ 
 	 * @return int
 	 */
 	public function order() {
-		return $this->get( 'LIN_order' );
+		return $this->get('LIN_order');
 	}
 
 
@@ -348,8 +348,8 @@ 
 	 * Sets order
 	 * @param int $order
 	 */
-	public function set_order( $order ) {
-		$this->set( 'LIN_order', $order );
+	public function set_order($order) {
+		$this->set('LIN_order', $order);
 	}
 
 
@@ -359,7 +359,7 @@ 
 	 * @return int
 	 */
 	public function parent_ID() {
-		return $this->get( 'LIN_parent' );
+		return $this->get('LIN_parent');
 	}
 
 
@@ -368,8 +368,8 @@ 
 	 * Sets parent
 	 * @param int $parent
 	 */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'LIN_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('LIN_parent', $parent);
 	}
 
 
@@ -379,7 +379,7 @@ 
 	 * @return string
 	 */
 	public function type() {
-		return $this->get( 'LIN_type' );
+		return $this->get('LIN_type');
 	}
 
 
@@ -388,8 +388,8 @@ 
 	 * Sets type
 	 * @param string $type
 	 */
-	public function set_type( $type ) {
-		$this->set( 'LIN_type', $type );
+	public function set_type($type) {
+		$this->set('LIN_type', $type);
 	}
 
 
@@ -402,8 +402,8 @@ 
 	 * @return EE_Line_Item
 	 */
 	public function parent() {
-		if( $this->ID() ) {
-			return $this->get_model()->get_one_by_ID( $this->parent_ID() );
+		if ($this->ID()) {
+			return $this->get_model()->get_one_by_ID($this->parent_ID());
 		} else {
 			return $this->_parent;
 		}
@@ -416,13 +416,13 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function children() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->get_model()->get_all(
 					array(
-						array( 'LIN_parent' => $this->ID() ),
-						'order_by' => array( 'LIN_order' => 'ASC' ) ) );
+						array('LIN_parent' => $this->ID()),
+						'order_by' => array('LIN_order' => 'ASC') ) );
 		} else {
-			if ( ! is_array( $this->_children ) ) {
+			if ( ! is_array($this->_children)) {
 				$this->_children = array();
 			}
 			return $this->_children;
@@ -436,7 +436,7 @@ 
 	 * @return string
 	 */
 	public function code() {
-		return $this->get( 'LIN_code' );
+		return $this->get('LIN_code');
 	}
 
 
@@ -445,8 +445,8 @@ 
 	 * Sets code
 	 * @param string $code
 	 */
-	public function set_code( $code ) {
-		$this->set( 'LIN_code', $code );
+	public function set_code($code) {
+		$this->set('LIN_code', $code);
 	}
 
 
@@ -456,7 +456,7 @@ 
 	 * @return boolean
 	 */
 	public function is_taxable() {
-		return $this->get( 'LIN_is_taxable' );
+		return $this->get('LIN_is_taxable');
 	}
 
 
@@ -465,8 +465,8 @@ 
 	 * Sets is_taxable
 	 * @param boolean $is_taxable
 	 */
-	public function set_is_taxable( $is_taxable ) {
-		$this->set( 'LIN_is_taxable', $is_taxable );
+	public function set_is_taxable($is_taxable) {
+		$this->set('LIN_is_taxable', $is_taxable);
 	}
 
 
@@ -481,7 +481,7 @@ 
 	 */
 	public function get_object() {
 		$model_name_of_related_obj = $this->OBJ_type();
-		return $this->get_model()->has_relation(  $model_name_of_related_obj ) ? $this->get_first_related( $model_name_of_related_obj ) : NULL;
+		return $this->get_model()->has_relation($model_name_of_related_obj) ? $this->get_first_related($model_name_of_related_obj) : NULL;
 	}
 
 
@@ -492,11 +492,11 @@ 
 	 * @param array $query_params
 	 * @return EE_Ticket
 	 */
-	public function ticket( $query_params = array() ) {
+	public function ticket($query_params = array()) {
 		//we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
-		$remove_defaults = array( 'default_where_conditions' => 'none' );
-		$query_params = array_merge( $remove_defaults, $query_params );
-		return $this->get_first_related( 'Ticket', $query_params );
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -506,11 +506,11 @@ 
 	 * @return EE_Datetime | NULL
 	 */
 	public function get_ticket_datetime() {
-		if ( $this->OBJ_type() === 'Ticket' ) {
+		if ($this->OBJ_type() === 'Ticket') {
 			$ticket = $this->ticket();
-			if ( $ticket instanceof EE_Ticket ) {
+			if ($ticket instanceof EE_Ticket) {
 				$datetime = $ticket->first_datetime();
-				if ( $datetime instanceof EE_Datetime ) {
+				if ($datetime instanceof EE_Datetime) {
 					return $datetime;
 				}
 			}
@@ -526,9 +526,9 @@ 
 	 * @return string
 	 */
 	public function ticket_event_name() {
-		$event_name = __( "Unknown", "event_espresso" );
+		$event_name = __("Unknown", "event_espresso");
 		$event = $this->ticket_event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			$event_name = $event->name();
 		}
 		return $event_name;
@@ -542,9 +542,9 @@ 
 	public function ticket_event() {
 		$event = null;
 		$ticket = $this->ticket();
-		if ( $ticket instanceof EE_Ticket ) {
+		if ($ticket instanceof EE_Ticket) {
 			$datetime = $ticket->first_datetime();
-			if ( $datetime instanceof EE_Datetime ) {
+			if ($datetime instanceof EE_Datetime) {
 				$event = $datetime->event();
 			}
 		}
@@ -559,11 +559,11 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function ticket_datetime_start( $date_format = '', $time_format = '' ) {
-		$first_datetime_string = __( "Unknown", "event_espresso" );
+	public function ticket_datetime_start($date_format = '', $time_format = '') {
+		$first_datetime_string = __("Unknown", "event_espresso");
 		$datetime = $this->get_ticket_datetime();
-		if ( $datetime ) {
-			$first_datetime_string = $datetime->start_date_and_time( $date_format, $time_format );
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
 		}
 		return $first_datetime_string;
 	}
@@ -578,26 +578,26 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	public function add_child_line_item( EEI_Line_Item $line_item, $set_order = true ) {
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) {
 		// should we calculate the LIN_order for this line item ?
-		if ( $set_order || $line_item->order() === null ) {
-			$line_item->set_order( count( $this->children() ) );
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
 		}
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			//check for any duplicate line items (with the same code), if so, this replaces it
-			$line_item_with_same_code = $this->get_child_line_item(  $line_item->code() );
-			if( $line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item ) {
-				$this->delete_child_line_item( $line_item_with_same_code->code() );
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
 			}
-			$line_item->set_parent_ID( $this->ID() );
-			if( $this->TXN_ID() ){
-				$line_item->set_TXN_ID( $this->TXN_ID() );
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
 			}
 			return $line_item->save();
 		} else {
-			$this->_children[ $line_item->code() ] = $line_item;
-			if( $line_item->parent() != $this ) {
-				$line_item->set_parent( $this );
+			$this->_children[$line_item->code()] = $line_item;
+			if ($line_item->parent() != $this) {
+				$line_item->set_parent($this);
 			}
 			return TRUE;
 		}
@@ -611,16 +611,16 @@ 
 	 * @param EE_Line_Item $line_item
 	 *
 	 */
-	public function set_parent( $line_item ) {
-		if ( $this->ID() ) {
-			if( ! $line_item->ID() ) {
+	public function set_parent($line_item) {
+		if ($this->ID()) {
+			if ( ! $line_item->ID()) {
 				$line_item->save();
 			}
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 			$this->save();
 		} else {
 			$this->_parent = $line_item;
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 		}
 	}
 
@@ -633,11 +633,11 @@ 
 	 * @param string $code
 	 * @return EE_Line_Item
 	 */
-	public function get_child_line_item( $code ) {
-		if ( $this->ID() ) {
-			return $this->get_model()->get_one( array( array( 'LIN_parent' => $this->ID(), 'LIN_code' => $code ) ) );
+	public function get_child_line_item($code) {
+		if ($this->ID()) {
+			return $this->get_model()->get_one(array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)));
 		} else {
-			return isset( $this->_children[ $code ] ) ? $this->_children[ $code ] : null;
+			return isset($this->_children[$code]) ? $this->_children[$code] : null;
 		}
 	}
 
@@ -648,10 +648,10 @@ 
 	 * @return int
 	 */
 	public function delete_children_line_items() {
-		if ( $this->ID() ) {
-			return $this->get_model()->delete( array( array( 'LIN_parent' => $this->ID() ) ) );
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
 		} else {
-			$count = count( $this->_children );
+			$count = count($this->_children);
 			$this->_children = array();
 			return $count;
 		}
@@ -668,25 +668,25 @@ 
 	 * @param bool $stop_search_once_found
 	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
 	 */
-	public function delete_child_line_item( $code, $stop_search_once_found = true ) {
-		if ( $this->ID() ) {
+	public function delete_child_line_item($code, $stop_search_once_found = true) {
+		if ($this->ID()) {
 			$items_deleted = 0;
-			if( $this->code() == $code ) {
-				$items_deleted += EEH_Line_Item::delete_all_child_items( $this );
+			if ($this->code() == $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
 				$items_deleted += (int) $this->delete();
-				if( $stop_search_once_found ){
+				if ($stop_search_once_found) {
 					return $items_deleted;
 				}
 			}
-			foreach( $this->children() as $child_line_item ) {
-				$items_deleted += $child_line_item->delete_child_line_item( $code, $stop_search_once_found );
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
 			}
 			return $items_deleted;
 		} else {
-			if( isset( $this->_children[ $code ] ) ) {
-				unset( $this->_children[ $code ] );
+			if (isset($this->_children[$code])) {
+				unset($this->_children[$code]);
 				return 1;
-			}else{
+			} else {
 				return 0;
 			}
 		}
@@ -699,9 +699,9 @@ 
 	 * @return boolean
 	 */
 	public function delete_if_childless_subtotal() {
-		if( $this->ID() &&
+		if ($this->ID() &&
 				$this->type() == EEM_Line_Item::type_sub_total &&
-				! $this->children() ) {
+				! $this->children()) {
 			return $this->delete();
 		} else {
 			return false;
@@ -716,7 +716,7 @@ 
 	 */
 	public function generate_code() {
 		// each line item in the cart requires a unique identifier
-		return md5( $this->get( 'OBJ_type' ) . $this->get( 'OBJ_ID' ) . microtime() );
+		return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
 	}
 
 
@@ -799,7 +799,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function unit_price_no_code() {
-		return $this->get_pretty( 'LIN_unit_price', 'no_currency_code' );
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
 	}
 
 
@@ -809,7 +809,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function total_no_code() {
-		return $this->get_pretty( 'LIN_total', 'no_currency_code' );
+		return $this->get_pretty('LIN_total', 'no_currency_code');
 	}
 
 
@@ -829,17 +829,17 @@ 
 		$tax_total = $this->recalculate_taxes_and_tax_total();
 		$total = $pre_tax_total + $tax_total;
 		// no negative totals plz
-		$total = max( $total, 0 );
-		$this->set_total( $total );
+		$total = max($total, 0);
+		$this->set_total($total);
 		//only update the related transaction's total
 		//if we intend to save this line item and its a grand total
-		if(
+		if (
 			$this->allow_persist() &&
 			$this->type() === EEM_Line_Item::type_total &&
 			$this->transaction() instanceof EE_Transaction
-		){
-			$this->transaction()->set_total( $total );
-			if ( $this->transaction()->ID() ) {
+		) {
+			$this->transaction()->set_total($total);
+			if ($this->transaction()->ID()) {
 				$this->transaction()->save();
 			}
 		}
@@ -858,47 +858,47 @@ 
 	public function recalculate_pre_tax_total() {
 		$total = 0;
 		$my_children = $this->children();
-		$has_children = ! empty( $my_children );
-		if ( $has_children && $this->is_line_item() ) {
-			$total = $this->_recalculate_pretax_total_for_line_item( $total, $my_children );
-		} elseif ( ! $has_children && ( $this->is_sub_line_item() || $this->is_line_item() ) ) {
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
 			$total = $this->unit_price() * $this->quantity();
-		} elseif( $this->is_sub_total() || $this->is_total() ) {
-			$total = $this->_recalculate_pretax_total_for_subtotal( $total, $my_children );
-		} elseif ( $this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled() ) {
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
 			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
 			return 0;
 		}
 		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-		if(
+		if (
 			! $this->is_line_item() &&
 			! $this->is_sub_line_item() &&
 			! $this->is_cancellation()
 		) {
-			if ( $this->OBJ_type() !== 'Event' ) {
-				$this->set_quantity( 1 );
+			if ($this->OBJ_type() !== 'Event') {
+				$this->set_quantity(1);
 			}
-			if( ! $this->is_percent() ) {
-				$this->set_unit_price( $this->total() );
+			if ( ! $this->is_percent()) {
+				$this->set_unit_price($this->total());
 			}
 		}
 
 		//we don't want to bother saving grand totals, because that needs to factor in taxes anyways
 		//so it ought to be
-		if( ! $this->is_total() ) {
-			$this->set_total( $total );
+		if ( ! $this->is_total()) {
+			$this->set_total($total);
 			//if not a percent line item, make sure we keep the unit price in sync
-			if(
+			if (
 				$has_children
 				&& $this->is_line_item()
 				&& ! $this->is_percent()
 			) {
-				if( $this->quantity() === 0 ){
+				if ($this->quantity() === 0) {
 					$new_unit_price = 0;
 				} else {
 					$new_unit_price = $this->total() / $this->quantity();
 				}
-				$this->set_unit_price( $new_unit_price );
+				$this->set_unit_price($new_unit_price);
 			}
 			$this->maybe_save();
 		}
@@ -918,39 +918,39 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_subtotal( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation() ) {
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
 				// percentage line items are based on total so far
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//round as we go so that the line items add up ok
 					$percent_total = round(
 						$calculated_total_so_far * $child_line_item->percent() / 100,
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
 				}
 			}
 		}
 
-		if( $this->is_sub_total() ){
+		if ($this->is_sub_total()) {
 			// no negative totals plz
-			$calculated_total_so_far = max( $calculated_total_so_far, 0 );
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
 		}
 		return $calculated_total_so_far;
 	}
@@ -968,8 +968,8 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_line_item( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//we need to keep track of the running total for a single item,
@@ -977,10 +977,10 @@ 
 		$unit_price_for_total = 0;
 		$quantity_for_total = 1;
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item &&
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item &&
 					! $child_line_item->is_cancellation()) {
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
 					//not total multiplied by percent, because that ignores rounding along-the-way
 					$percent_unit_price = round(
@@ -988,17 +988,17 @@ 
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
 					$percent_total = $percent_unit_price * $quantity_for_total;
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 					$unit_price_for_total += $percent_unit_price;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$quantity_for_total = $child_line_item->quantity();
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
@@ -1022,10 +1022,10 @@ 
 		//calculate the pretax total
 		$taxable_total = $this->taxable_total();
 		$tax_total = 0;
-		foreach ( $taxes as $tax ) {
+		foreach ($taxes as $tax) {
 			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
 			//remember the total on this line item
-			$tax->set_total( $total_on_this_tax );
+			$tax->set_total($total_on_this_tax);
 			$tax_total += $tax->total();
 		}
 		$this->_recalculate_tax_sub_total();
@@ -1039,21 +1039,21 @@ 
 	 * @return void
 	 */
 	private function _recalculate_tax_sub_total() {
-		if ( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			$total = 0;
 			$total_percent = 0;
 			//simply loop through all its children (which should be taxes) and sum their total
-			foreach ( $this->children() as $child_tax ) {
-				if ( $child_tax instanceof EE_Line_Item ) {
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
 					$total += $child_tax->total();
 					$total_percent += $child_tax->percent();
 				}
 			}
-			$this->set_total( $total );
-			$this->set_percent( $total_percent );
-		} elseif ( $this->is_total() ) {
-			foreach ( $this->children() as $maybe_tax_subtotal ) {
-				if ( $maybe_tax_subtotal instanceof EE_Line_Item ) {
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
 					$maybe_tax_subtotal->_recalculate_tax_sub_total();
 				}
 			}
@@ -1069,8 +1069,8 @@ 
 	public function get_total_tax() {
 		$this->_recalculate_tax_sub_total();
 		$total = 0;
-		foreach ( $this->tax_descendants() as $tax_line_item ) {
-			if ( $tax_line_item instanceof EE_Line_Item ) {
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
 				$total += $tax_line_item->total();
 			}
 		}
@@ -1084,15 +1084,15 @@ 
 	 */
 	public function get_items_total() {
 		//by default, let's make sure we're consistent with the existing line item
-		if( $this->is_total() ) {
-			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal( $this );
-			if( $pretax_subtotal_li instanceof EE_Line_Item ) {
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
 				return $pretax_subtotal_li->total();
 			}
 		}
 		$total = 0;
-		foreach ( $this->get_items() as $item ) {
-			if ( $item instanceof EE_Line_Item ) {
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
 				$total += $item->total();
 			}
 		}
@@ -1107,7 +1107,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function tax_descendants() {
-		return EEH_Line_Item::get_tax_descendants( $this );
+		return EEH_Line_Item::get_tax_descendants($this);
 	}
 
 
@@ -1117,7 +1117,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_items() {
-		return EEH_Line_Item::get_line_item_descendants( $this );
+		return EEH_Line_Item::get_line_item_descendants($this);
 	}
 
 
@@ -1133,22 +1133,22 @@ 
 	 */
 	public function taxable_total() {
 		$total = 0;
-		if ( $this->children() ) {
-			foreach ( $this->children() as $child_line_item ) {
-				if ( $child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
 					//if it's a percent item, only take into account the percent
 					//that's taxable too (the taxable total so far)
-					if( $child_line_item->is_percent() ) {
-						$total = $total + ( $total * $child_line_item->percent() / 100 );
-					}else{
+					if ($child_line_item->is_percent()) {
+						$total = $total + ($total * $child_line_item->percent() / 100);
+					} else {
 						$total += $child_line_item->total();
 					}
-				}elseif( $child_line_item->type() === EEM_Line_Item::type_sub_total ){
+				}elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
 					$total += $child_line_item->taxable_total();
 				}
 			}
 		}
-		return max( $total, 0 );
+		return max($total, 0);
 	}
 
 
@@ -1158,7 +1158,7 @@ 
 	 * @return EE_Transaction
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -1171,18 +1171,18 @@ 
 	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
 	 * @return int count of items saved
 	 */
-	public function save_this_and_descendants_to_txn( $txn_id = NULL ) {
+	public function save_this_and_descendants_to_txn($txn_id = NULL) {
 		$count = 0;
-		if ( ! $txn_id ) {
+		if ( ! $txn_id) {
 			$txn_id = $this->TXN_ID();
 		}
-		$this->set_TXN_ID( $txn_id );
+		$this->set_TXN_ID($txn_id);
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
-				$count += $child_line_item->save_this_and_descendants_to_txn( $txn_id );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
 			}
 		}
 		return $count;
@@ -1199,9 +1199,9 @@ 
 		$count = 0;
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
 				$count += $child_line_item->save_this_and_descendants();
 			}
 		}
@@ -1215,8 +1215,8 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_cancellations() {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
-		return EEH_Line_Item::get_descendants_of_type( $this, EEM_Line_Item::type_cancellation );
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
 	}
 
 
@@ -1227,7 +1227,7 @@ 
 	 * @return int count of items saved
 	 */
 	public function maybe_save() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->save();
 		}
 		return false;

Indentation +52 added lines, -52 removed lines

@@ -172,7 +172,7 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
+	public function set_quantity( $quantity ) {
 		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
 	}
 
@@ -212,25 +212,25 @@ 
 	 * Gets item_type
 	 * @return string
 	 */
-    public function OBJ_type_i18n() {
-	    $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case 'Event':
-                $obj_type = __('Event', 'event_espresso');
-                break;
-            case 'Price':
-                $obj_type = __('Price', 'event_espresso');
-                break;
-            case 'Promotion':
-                $obj_type = __('Promotion', 'event_espresso');
-                break;
-            case 'Ticket':
-                $obj_type = __('Ticket', 'event_espresso');
-                break;
-            case 'Transaction':
-                $obj_type = __('Transaction', 'event_espresso');
-                break;
-        }
+	public function OBJ_type_i18n() {
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case 'Event':
+				$obj_type = __('Event', 'event_espresso');
+				break;
+			case 'Price':
+				$obj_type = __('Price', 'event_espresso');
+				break;
+			case 'Promotion':
+				$obj_type = __('Promotion', 'event_espresso');
+				break;
+			case 'Ticket':
+				$obj_type = __('Ticket', 'event_espresso');
+				break;
+			case 'Transaction':
+				$obj_type = __('Transaction', 'event_espresso');
+				break;
+		}
 		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
 	}
 
@@ -1244,48 +1244,48 @@ 
 
 
 
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws \EE_Error
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
-    }
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
+	}
 
 
 
 
-    /************************* DEPRECATED *************************/
+	/************************* DEPRECATED *************************/
 
 
 
-    /**
-     * @deprecated 4.6.0
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
-            __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
+			__('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
 
 
 
-    /**
-     * @deprecated 4.6.0
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
-            __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
+			__('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 
 
 

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +946 added lines, -946 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\UnexpectedEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,952 +21,952 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // release tickets for expired carts
-        add_action('EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20, 3
-        );
-        // add notices for sold out tickets
-        add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-        // handle ticket quantities adjusted in cart
-        //add_action(
-        //	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
-        //	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
-        //	10, 2
-        //);
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10, 2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10, 1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10, 1
-        );
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        $expired_ticket_IDs = array();
-        $valid_ticket_line_items = array();
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
-        if(empty($total_line_items)){
-            return;
-        }
-        $expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
-        foreach ($total_line_items as $total_line_item) {
-            /** @var EE_Line_Item $total_line_item */
-            $ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if(! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                if ($total_line_item->timestamp(true) <= $expired ) {
-                    $expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
-                } else {
-                    $valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
-                }
-            }
-        }
-        if (! empty($expired_ticket_IDs)) {
-            EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-                \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-                $valid_ticket_line_items
-            );
-            // let's get rid of expired line items so that they can't interfere with tracking
-            add_action(
-                'shutdown',
-                array('EED_Ticket_Sales_Monitor', 'clear_expired_line_items_with_no_transaction'),
-                999
-            );
-        }
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-
-    /**
-     *    validate_ticket_sales
-     *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @access    public
-     * @param int $qty
-     * @param \EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-
-    /**
-     *    _validate_ticket_sale
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @access    protected
-     * @param   \EE_Ticket $ticket
-     * @param int          $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if ( ! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-
-    /**
-     *  _reserve_ticket
-     *    increments ticket reserved based on quantity passed
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @param int           $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity);
-        return $ticket->save();
-    }
-
-
-
-    /**
-     * _release_reserved_ticket
-     *
-     * @access protected
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity);
-        if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-
-    /**
-     *    _ticket_sold_out
-     *    removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _ticket_quantity_decremented
-     *    adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _get_ticket_and_event_name
-     *    builds string out of ticket and event name
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-
-    /**
-     * ticket_quantity_updated
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-
-    /**
-     * ticket_removed_from_cart
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-
-    /**
-     *    post_notices
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-
-    /**
-     *    _post_notices
-     *
-     * @access    protected
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg = __('Please refresh the page to view updated ticket quantities.',
-                'event_espresso');
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if ( ! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if ( ! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-
-    /**
-     *    _release_all_reserved_tickets_for_transaction
-     *    releases reserved tickets for all registrations of an EE_Transaction
-     *    by default, will NOT release tickets for finalized transactions
-     *
-     * @access    protected
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__, __FUNCTION__, __LINE__,
-                array('finalized' => $finalized),
-                false, 'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        // if the session is getting cleared BEFORE the TXN has been finalized
-        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // let's cancel any reserved tickets
-            $registrations = $transaction->registrations();
-            if ( ! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        $count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
-                    }
-                }
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     *    _release_reserved_ticket_for_registration
-     *    releases reserved tickets for an EE_Registration
-     *    by default, will NOT release tickets for APPROVED registrations
-     *
-     * @access    protected
-     * @param    EE_Registration $registration
-     * @param    EE_Transaction  $transaction
-     * @return    int
-     * @throws    EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
-            // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                return $this->_release_reserved_ticket($ticket);
-            }
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-
-    /**
-     *    session_cart_reset
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo '<br /><br /> cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
-        } else {
-            if (self::debug) {
-                echo '<br /><br /> invalid EE_Cart: ';
-                var_dump($cart);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _session_cart_reset
-     * releases reserved tickets in the EE_Cart
-     *
-     * @access    protected
-     * @param    EE_Cart $cart
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_cart_reset(EE_Cart $cart)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo '<br /><br /> RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-
-    /**
-     *    session_checkout_reset
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-
-    /**
-     *    _session_checkout_reset
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @access    protected
-     * @param    EE_Checkout $checkout
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-
-    /**
-     *    session_expired_reset
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     *    by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__, __FUNCTION__, __LINE__,
-                    array($transaction),
-                    false, 'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__, __FUNCTION__, __LINE__,
-                        array($payment),
-                        false, 'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
-        foreach ($transactions_in_progress as $transaction_in_progress) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            /** @var EE_Transaction $transaction_in_progress */
-            $total_line_item = $transaction_in_progress->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            EEM_Ticket::instance()->get_tickets_with_reservations(),
-            $valid_reserved_tickets
-        );
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-
-    /**
-     * @param EE_Ticket[] $tickets_with_reservations
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items
-     * @return int
-     * @throws \EE_Error
-     */
-    private static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        $valid_reserved_ticket_line_items = array()
-    ) {
-        $total_tickets_released = 0;
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if (
-                    $valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->decrease_reserved($reserved_qty);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    /********************************** SHUTDOWN  **********************************/
-
-
-
-    /**
-     * @return false|int
-     * @throws \EE_Error
-     */
-    public static function clear_expired_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+	const debug = false;    //	true false
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// release tickets for expired carts
+		add_action('EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20, 3
+		);
+		// add notices for sold out tickets
+		add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+		// handle ticket quantities adjusted in cart
+		//add_action(
+		//	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
+		//	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
+		//	10, 2
+		//);
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10, 2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10, 1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10, 1
+		);
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		$expired_ticket_IDs = array();
+		$valid_ticket_line_items = array();
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
+		if(empty($total_line_items)){
+			return;
+		}
+		$expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
+		foreach ($total_line_items as $total_line_item) {
+			/** @var EE_Line_Item $total_line_item */
+			$ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if(! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				if ($total_line_item->timestamp(true) <= $expired ) {
+					$expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
+				} else {
+					$valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
+				}
+			}
+		}
+		if (! empty($expired_ticket_IDs)) {
+			EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+				\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+				$valid_ticket_line_items
+			);
+			// let's get rid of expired line items so that they can't interfere with tracking
+			add_action(
+				'shutdown',
+				array('EED_Ticket_Sales_Monitor', 'clear_expired_line_items_with_no_transaction'),
+				999
+			);
+		}
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+
+	/**
+	 *    validate_ticket_sales
+	 *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @access    public
+	 * @param int $qty
+	 * @param \EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
+			echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+
+	/**
+	 *    _validate_ticket_sale
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @access    protected
+	 * @param   \EE_Ticket $ticket
+	 * @param int          $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if ( ! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo '<br /> . . . ticket->qty: ' . $ticket->qty();
+			echo '<br /> . . . ticket->sold: ' . $ticket->sold();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+			echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo '<br /> . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /> . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+
+	/**
+	 *  _reserve_ticket
+	 *    increments ticket reserved based on quantity passed
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @param int           $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity);
+		return $ticket->save();
+	}
+
+
+
+	/**
+	 * _release_reserved_ticket
+	 *
+	 * @access protected
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /> . . . ticket->ID: ' . $ticket->ID();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity);
+		if (self::debug) {
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+
+	/**
+	 *    _ticket_sold_out
+	 *    removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _ticket_quantity_decremented
+	 *    adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _get_ticket_and_event_name
+	 *    builds string out of ticket and event name
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+
+	/**
+	 * ticket_quantity_updated
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+
+	/**
+	 * ticket_removed_from_cart
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+
+	/**
+	 *    post_notices
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+
+	/**
+	 *    _post_notices
+	 *
+	 * @access    protected
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg = __('Please refresh the page to view updated ticket quantities.',
+				'event_espresso');
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if ( ! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if ( ! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+
+	/**
+	 *    _release_all_reserved_tickets_for_transaction
+	 *    releases reserved tickets for all registrations of an EE_Transaction
+	 *    by default, will NOT release tickets for finalized transactions
+	 *
+	 * @access    protected
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . transaction->ID: ' . $transaction->ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__, __FUNCTION__, __LINE__,
+				array('finalized' => $finalized),
+				false, 'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo '<br /> . . . finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		// if the session is getting cleared BEFORE the TXN has been finalized
+		if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// let's cancel any reserved tickets
+			$registrations = $transaction->registrations();
+			if ( ! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration) {
+						$count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
+					}
+				}
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 *    _release_reserved_ticket_for_registration
+	 *    releases reserved tickets for an EE_Registration
+	 *    by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @access    protected
+	 * @param    EE_Registration $registration
+	 * @param    EE_Transaction  $transaction
+	 * @return    int
+	 * @throws    EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . registration->ID: ' . $registration->ID();
+			echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
+			echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
+			// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				return $this->_release_reserved_ticket($ticket);
+			}
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+
+	/**
+	 *    session_cart_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo '<br /><br /> cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
+		} else {
+			if (self::debug) {
+				echo '<br /><br /> invalid EE_Cart: ';
+				var_dump($cart);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _session_cart_reset
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @access    protected
+	 * @param    EE_Cart $cart
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_cart_reset(EE_Cart $cart)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo '<br /> . . ticket->ID(): ' . $ticket->ID();
+						echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo '<br /><br /> RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+
+	/**
+	 *    session_checkout_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+
+	/**
+	 *    _session_checkout_reset
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @access    protected
+	 * @param    EE_Checkout $checkout
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+
+	/**
+	 *    session_expired_reset
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 *    by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__, __FUNCTION__, __LINE__,
+					array($transaction),
+					false, 'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__, __FUNCTION__, __LINE__,
+						array($payment),
+						false, 'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
+		foreach ($transactions_in_progress as $transaction_in_progress) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			/** @var EE_Transaction $transaction_in_progress */
+			$total_line_item = $transaction_in_progress->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			EEM_Ticket::instance()->get_tickets_with_reservations(),
+			$valid_reserved_tickets
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+
+	/**
+	 * @param EE_Ticket[] $tickets_with_reservations
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		$valid_reserved_ticket_line_items = array()
+	) {
+		$total_tickets_released = 0;
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if (
+					$valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					$reserved_qty -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->decrease_reserved($reserved_qty);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	/********************************** SHUTDOWN  **********************************/
+
+
+
+	/**
+	 * @return false|int
+	 * @throws \EE_Error
+	 */
+	public static function clear_expired_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
-                // use GMT time because that's what LIN_timestamps are in
-                date('Y-m-d H:i:s', time() - EE_Registry::instance()->SSN->lifespan())
-            )
-        );
-    }
+				// use GMT time because that's what LIN_timestamps are in
+				date('Y-m-d H:i:s', time() - EE_Registry::instance()->SSN->lifespan())
+			)
+		);
+	}
 
 }
 // End of file EED_Ticket_Sales_Monitor.module.php

Spacing +46 added lines, -46 removed lines

@@ -21,7 +21,7 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
+    const debug = false; //	true false
 
     /**
      * an array of raw ticket data from EED_Ticket_Selector
@@ -181,7 +181,7 @@ 
         $expired_ticket_IDs = array();
         $valid_ticket_line_items = array();
         $total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
-        if(empty($total_line_items)){
+        if (empty($total_line_items)) {
             return;
         }
         $expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
@@ -189,17 +189,17 @@ 
             /** @var EE_Line_Item $total_line_item */
             $ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
             foreach ($ticket_line_items as $ticket_line_item) {
-                if(! $ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                if ($total_line_item->timestamp(true) <= $expired ) {
+                if ($total_line_item->timestamp(true) <= $expired) {
                     $expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
                 } else {
                     $valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
                 }
             }
         }
-        if (! empty($expired_ticket_IDs)) {
+        if ( ! empty($expired_ticket_IDs)) {
             EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
                 \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
                 $valid_ticket_line_items
@@ -237,8 +237,8 @@ 
             $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
         }
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'()';
+            echo '<br /><br /><b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -259,36 +259,36 @@ 
     protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+            echo '<br /><b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo '<br /> . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
+            echo '<br /> . . . ticket->qty: '.$ticket->qty();
+            echo '<br /> . . . ticket->sold: '.$ticket->sold();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
+            echo '<br /> . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo '<br /> . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
+            echo '<br /> . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+                echo '<br /> . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -311,7 +311,7 @@ 
     protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+            echo '<br /><br /> . . . INCREASE RESERVED: '.$quantity;
         }
         $ticket->increase_reserved($quantity);
         return $ticket->save();
@@ -331,12 +331,12 @@ 
     protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+            echo '<br /> . . . ticket->ID: '.$ticket->ID();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
         }
         $ticket->decrease_reserved($quantity);
         if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
         }
         return $ticket->save() ? 1 : 0;
     }
@@ -356,8 +356,8 @@ 
     protected function _ticket_sold_out(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -377,8 +377,8 @@ 
     protected function _ticket_quantity_decremented(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -485,7 +485,7 @@ 
     protected function _post_notices()
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg = '';
         $none_added_msg = '';
@@ -552,8 +552,8 @@ 
     protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . transaction->ID: '.$transaction->ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -562,13 +562,13 @@ 
             EEH_Debug_Tools::log(
                 __CLASS__, __FUNCTION__, __LINE__,
                 array('finalized' => $finalized),
-                false, 'EE_Transaction: ' . $transaction->ID()
+                false, 'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
+            echo '<br /> . . . finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -609,10 +609,10 @@ 
     ) {
         $STS_ID = $transaction->status_ID();
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . registration->ID: '.$registration->ID();
+            echo '<br /> . . registration->status_ID: '.$registration->status_ID();
+            echo '<br /> . . transaction->status_ID(): '.$STS_ID;
         }
         if (
             // release Tickets for Failed Transactions and Abandoned Transactions
@@ -650,7 +650,7 @@ 
     public static function session_cart_reset(EE_Session $session)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
@@ -680,7 +680,7 @@ 
     protected function _session_cart_reset(EE_Cart $cart)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         EE_Registry::instance()->load_helper('Line_Item');
         $ticket_line_items = $cart->get_tickets();
@@ -689,17 +689,17 @@ 
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo '<br /> . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo '<br /> . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo '<br /> . . ticket->ID(): '.$ticket->ID();
+                        echo '<br /> . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                     }
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
                 }
@@ -747,7 +747,7 @@ 
     protected function _session_checkout_reset(EE_Checkout $checkout)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -798,7 +798,7 @@ 
                 EEH_Debug_Tools::log(
                     __CLASS__, __FUNCTION__, __LINE__,
                     array($transaction),
-                    false, 'EE_Transaction: ' . $transaction->ID()
+                    false, 'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -812,7 +812,7 @@ 
                     EEH_Debug_Tools::log(
                         __CLASS__, __FUNCTION__, __LINE__,
                         array($payment),
-                        false, 'EE_Transaction: ' . $transaction->ID()
+                        false, 'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -869,7 +869,7 @@ 
             /** @var EE_Transaction $transaction_in_progress */
             $total_line_item = $transaction_in_progress->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
                 );
@@ -923,7 +923,7 @@ 
     ) {
         $total_tickets_released = 0;
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             $reserved_qty = $ticket_with_reservations->reserved();
@@ -960,7 +960,7 @@ 
         global $wpdb;
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+                'DELETE FROM '.EEM_Line_Item::instance()->table().'
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
                 // use GMT time because that's what LIN_timestamps are in
                 date('Y-m-d H:i:s', time() - EE_Registry::instance()->SSN->lifespan())

core/business/EE_Transaction_Processor.class.php

Indentation +45 added lines, -46 removed lines

@@ -7,8 +7,7 @@ 
  * the interaction of EE_Transaction and EE_Registration model objects
  * Provides methods for manipulating and processing changes to an EE_Transaction
  * and it's related EE_Registrations with regards to the checkout/registration process
-
-*
+ *
 *@package     Event Espresso
  * @subpackage 	core
  * @author      Brent Christensen
@@ -177,24 +176,24 @@ 
 
 
 
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool $trigger_notifications                      whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool $trigger_notifications                      whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_and_registrations_after_checkout_or_payment(
 		EE_Transaction $transaction,
 		$payment = null,
 		$registration_query_params = array(),
-        $trigger_notifications = true
+		$trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
 		$this->_set_registration_query_params( $registration_query_params );
@@ -224,15 +223,15 @@ 
 			$update_params
 		);
 		if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
 			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
 			$transaction,
 			$update_params
@@ -242,17 +241,17 @@ 
 
 
 
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_after_reinstating_canceled_registration(
 		EE_Registration $registration,
 		$closed_reg_statuses = array(),
@@ -314,15 +313,15 @@ 
 		try {
 			$transaction = $this->get_transaction_for_registration( $registration );
 			if (
-			    apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			){
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
+				EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
 			}
 		} catch ( EE_Error $e ) {
 			EE_Error::add_error(
@@ -532,7 +531,7 @@ 
 						foreach ( $available_payment_methods as $available_payment_method ) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
-							    && $available_payment_method->open_by_default()
+								&& $available_payment_method->open_by_default()
 							) {
 								$PMD_ID = $available_payment_method->ID();
 								break;

Spacing +86 added lines, -86 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Processor
@@ -50,10 +50,10 @@ 
 	 * @param array $registration_query_params
 	 *@return EE_Transaction_Processor instance
 	 */
-	public static function instance( $registration_query_params = array() ) {
+	public static function instance($registration_query_params = array()) {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Processor ) {
-			self::$_instance = new self( $registration_query_params );
+		if ( ! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
 		}
 		return self::$_instance;
 	}
@@ -63,9 +63,9 @@ 
 	/**
 	 * @param array $registration_query_params
 	 */
-	private function __construct( $registration_query_params = array() ) {
+	private function __construct($registration_query_params = array()) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 	}
 
 
@@ -74,8 +74,8 @@ 
 	 * @access private
 	 * @param array $registration_query_params
 	 */
-	private function _set_registration_query_params( $registration_query_params ) {
-		$this->_registration_query_params = ! empty( $registration_query_params ) ? $registration_query_params : array( 'order_by' => array( 'REG_count' => 'ASC' ));
+	private function _set_registration_query_params($registration_query_params) {
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params : array('order_by' => array('REG_count' => 'ASC'));
 	}
 
 
@@ -104,10 +104,10 @@ 
 		);
 		// send messages
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		$registration_processor->trigger_registration_update_notifications(
 			$transaction->primary_registration(),
-			array( 'manually_updated' 	=> true )
+			array('manually_updated' 	=> true)
 		);
 		do_action(
 			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
@@ -197,13 +197,13 @@ 
         $trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// get final reg step status
 		$finalized = $transaction->final_reg_step_completed();
 		// if the 'finalize_registration' step has been initiated (has a timestamp)
 		// but has not yet been fully completed (TRUE)
-		if ( is_int( $finalized ) && $finalized !== false && $finalized !== true ) {
-			$transaction->set_reg_step_completed( 'finalize_registration' );
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
 			$finalized = true;
 		}
 		$transaction->save();
@@ -259,22 +259,22 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
 				$transaction,
 				$registration
 			);
 			// un-cancel the ticket
-			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item( $ticket_line_item );
-		} catch ( EE_Error $e ) {
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -283,7 +283,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? $success : false;
 		}
 		return $success;
@@ -307,12 +307,12 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( ! in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			if (
 			    apply_filters(
                     'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
@@ -320,14 +320,14 @@ 
                     $registration,
                     $transaction
                 )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+            ) {
+                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration($transaction, $registration);
+                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
 			}
-		} catch ( EE_Error $e ) {
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -336,7 +336,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -352,12 +352,12 @@ 
 	 * @return 	EE_Transaction
 	 * @throws 	EE_Error
 	 */
-	public function get_transaction_for_registration( EE_Registration $registration ) {
+	public function get_transaction_for_registration(EE_Registration $registration) {
 		$transaction = $registration->transaction();
-		if ( ! $transaction instanceof EE_Transaction ) {
+		if ( ! $transaction instanceof EE_Transaction) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso' ),
+					__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
 					$registration->ID()
 				)
 			);
@@ -380,16 +380,16 @@ 
 		EE_Transaction $transaction,
 		EE_Registration $registration
 	) {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
+		EE_Registry::instance()->load_helper('Line_Item');
 		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
 			$transaction->ID(),
 			$registration->ticket_ID()
 		);
-		if ( ! $ticket_line_item instanceof EE_Line_Item ) {
+		if ( ! $ticket_line_item instanceof EE_Line_Item) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-						'event_espresso' ),
+					__('The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'),
 					$transaction->ID(),
 					$registration->ticket_ID()
 				)
@@ -422,22 +422,22 @@ 
 		$update_txn = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
 			if (
 				$registration instanceof EE_Registration
-				&& ! in_array( $registration->status_ID(), $closed_reg_statuses )
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
 			) {
 				return false;
 			}
 		}
-		if ( in_array( $new_TXN_status, EEM_Transaction::txn_status_array() ) ) {
-			$transaction->set_status( $new_TXN_status );
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -466,22 +466,22 @@ 
 	) {
 		$response = false;
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// check that method exists
-		if ( ! method_exists( $registration_processor, $method_name )) {
-			throw new EE_Error( __( 'Method does not exist.', 'event_espresso' ));
+		if ( ! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(__('Method does not exist.', 'event_espresso'));
 		}
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
-				if ( $additional_param ) {
-					$response = $registration_processor->{$method_name}( $registration, $additional_param )
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
 						? true
 						: $response;
 				} else {
-					$response = $registration_processor->{$method_name}( $registration )
+					$response = $registration_processor->{$method_name}($registration)
 						? true
 						: $response;
 				}
@@ -508,28 +508,28 @@ 
 	public function set_transaction_payment_method_based_on_registration_statuses(
 		EE_Registration $edited_registration
 	) {
-		if ( $edited_registration instanceof EE_Registration ) {
+		if ($edited_registration instanceof EE_Registration) {
 			$transaction = $edited_registration->transaction();
-			if ( $transaction instanceof EE_Transaction ) {
+			if ($transaction instanceof EE_Transaction) {
 				$all_not_approved = true;
-				foreach ( $transaction->registrations() as $registration ) {
-					if ( $registration instanceof EE_Registration ) {
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
 						// if any REG != "Not Approved" then toggle to false
 						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
 					}
 				}
 				// if ALL Registrations are "Not Approved"
-				if ( $all_not_approved ) {
-					$transaction->set_payment_method_ID( null );
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
 					$transaction->save();
 				} else {
 					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
 						$transaction,
 						EEM_Payment_Method::scope_cart
 					);
-					if ( ! empty( $available_payment_methods ) ) {
+					if ( ! empty($available_payment_methods)) {
 						$PMD_ID = 0;
-						foreach ( $available_payment_methods as $available_payment_method ) {
+						foreach ($available_payment_methods as $available_payment_method) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
 							    && $available_payment_method->open_by_default()
@@ -538,22 +538,22 @@ 
 								break;
 							}
 						}
-						if ( ! $PMD_ID ) {
-							$first_payment_method = reset( $available_payment_methods );
-							if ( $first_payment_method instanceof EE_Payment_Method ) {
+						if ( ! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
 								$PMD_ID = $first_payment_method->ID();
 							} else {
 								EE_Error::add_error(
-									__( 'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso' ),
+									__('A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso'),
 									__FILE__, __LINE__, __FUNCTION__
 								);
 							}
 						}
-						$transaction->set_payment_method_ID( $PMD_ID );
+						$transaction->set_payment_method_ID($PMD_ID);
 						$transaction->save();
 					} else {
 						EE_Error::add_error(
-							__( 'Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso' ),
+							__('Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso'),
 							__FILE__, __LINE__, __FUNCTION__
 						);
 					}
@@ -590,7 +590,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -600,7 +600,7 @@ 
 			'4.9.12'
 		);
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -629,7 +629,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -673,7 +673,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -700,7 +700,7 @@ 
 	 * @param string         $exception
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except( EE_Transaction $transaction, $exception = '' ) {
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '') {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -710,7 +710,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->all_reg_steps_completed_except( $exception );
+		return $transaction->all_reg_steps_completed_except($exception);
 	}
 
 
@@ -726,7 +726,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except_final_step( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -753,7 +753,7 @@ 
 	 * @param string         $reg_step_slug
 	 * @return boolean | int
 	 */
-	public function reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -763,7 +763,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->reg_step_completed( $reg_step_slug );
+		return $transaction->reg_step_completed($reg_step_slug);
 	}
 
 
@@ -779,7 +779,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean | int
 	 */
-	public function final_reg_step_completed( EE_Transaction $transaction ) {
+	public function final_reg_step_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -805,7 +805,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_initiated( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -815,7 +815,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_initiated( $reg_step_slug );
+		return $transaction->set_reg_step_initiated($reg_step_slug);
 	}
 
 
@@ -831,7 +831,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -841,7 +841,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_completed( $reg_step_slug );
+		return $transaction->set_reg_step_completed($reg_step_slug);
 	}
 
 
@@ -857,7 +857,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_not_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -867,7 +867,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_not_completed( $reg_step_slug );
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
 	}
 
 
@@ -884,7 +884,7 @@ 
 	 * @param string          $reg_step_slug
 	 * @return void
 	 */
-	public function remove_reg_step( EE_Transaction $transaction, $reg_step_slug ) {
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -894,7 +894,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		$transaction->remove_reg_step( $reg_step_slug );
+		$transaction->remove_reg_step($reg_step_slug);
 	}
 
 
@@ -910,7 +910,7 @@ 
 	 * @return    boolean
 	 * @throws \EE_Error
 	 */
-	public function toggle_failed_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_failed_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -934,7 +934,7 @@ 
 	 * @param  EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function toggle_abandoned_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(

core/libraries/rest_api/changes/Changes_In_4_8_34.php

Doc Comments -1 removed lines

@@ -32,7 +32,6 @@
      * Removes the checkin and checkout endpoints from the index for requests
      * to api versions lowers than 4.8.33
      *
-     * @param array                                                  $routes_on_this_version
      * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
      * @return array like $routes_on_this_version
      */

Indentation +34 added lines, -34 removed lines

@@ -12,39 +12,39 @@
 class Changes_In_4_8_34 extends Changes_In_Base
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function set_hooks()
-    {
-        //set a hook to remove the checkout/checkout endpoints if the request 
-        //is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'remove_response_headers'),
-            10,
-            3
-        );
-    }
-
-
-
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array                                                  $routes_on_this_version
-     * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
-     * @return array like $routes_on_this_version
-     */
-    public function remove_response_headers($response_headers, $controller, $requested_version)
-    {
-        if ($controller instanceof Base
-            && $this->applies_to_version($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function set_hooks()
+	{
+		//set a hook to remove the checkout/checkout endpoints if the request 
+		//is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'remove_response_headers'),
+			10,
+			3
+		);
+	}
+
+
+
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array                                                  $routes_on_this_version
+	 * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
+	 * @return array like $routes_on_this_version
+	 */
+	public function remove_response_headers($response_headers, $controller, $requested_version)
+	{
+		if ($controller instanceof Base
+			&& $this->applies_to_version($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }
 

core/libraries/rest_api/controllers/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -314,7 +314,7 @@
      *
      * @param string $route
      * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
+     * @param string[]  $match_keys EXCLUDING matching the entire regex
      * @return array where  $match_keys are the keys (the first value of $match_keys
      *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
      *                           array( 'model', 'id' ), will, if the regex is successful, will return

Indentation +304 added lines, -304 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\rest_api\Rest_Exception;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,309 +20,309 @@ 
 class Base
 {
 
-    const header_prefix_for_ee = 'X-EE-';
-
-    const header_prefix_for_wp = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $_debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $_debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $_requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $_response_headers = array();
-
-
-
-    public function __construct()
-    {
-        $this->_debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
-    }
-
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function set_requested_version($version)
-    {
-        $this->_requested_version = $version;
-    }
-
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function _set_debug_info($key, $info)
-    {
-        $this->_debug_info[$key] = $info;
-    }
-
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function _set_response_header($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
-            $this->_response_headers[$prefix . $header_key] = $value;
-        }
-    }
-
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function _get_response_headers()
-    {
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->_response_headers,
-            $this,
-            $this->_requested_version
-        );
-    }
-
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param \WP_Error $wp_error_response
-     * @return \WP_Error
-     */
-    protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = \EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message));
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|\WP_Error|\Exception $response
-     * @return \WP_REST_Response
-     */
-    public function send_response($response)
-    {
-        if ($response instanceof Rest_Exception) {
-            $response = new \WP_Error($response->get_string_code(), $response->getMessage(), $response->get_data());
-        }
-        if ($response instanceof \Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new \WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof \WP_Error) {
-            $response = $this->_add_ee_errors_to_response($response);
-            $rest_response = $this->_create_rest_response_from_wp_error($response);
-        } else {
-            $rest_response = new \WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->_debug_mode && is_array($this->_debug_info)) {
-            foreach ($this->_debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->_get_response_headers(),
-            $this->_get_headers_from_ee_notices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param \WP_Error $wp_error
-     * @return \WP_REST_Response
-     */
-    protected function _create_rest_response_from_wp_error(\WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new \WP_REST_Response($data, $status);
-    }
-
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function _get_headers_from_ee_notices()
-    {
-        $headers = array();
-        $notices = \EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers['X-EE4-Notices-'
-                         . \EEH_Inflector::humanize($notice_type)
-                         . '['
-                         . $notice_code
-                         . ']'] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->_requested_version,
-            $notices
-        );
-    }
-
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29"
-     *
-     * @param string $route
-     * @return string
-     */
-    public function get_requested_version($route = null)
-    {
-        $matches = $this->parse_route(
-            $route,
-            '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws \EE_Error if it couldn't be parsed
-     */
-    public function parse_route($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (
-        is_array($matches)
-        ) {
-            //skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
-                }
-            }
-        }
-        if (! $success) {
-            throw new \EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
+	const header_prefix_for_ee = 'X-EE-';
+
+	const header_prefix_for_wp = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $_debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $_debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $_requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $_response_headers = array();
+
+
+
+	public function __construct()
+	{
+		$this->_debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
+	}
+
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function set_requested_version($version)
+	{
+		$this->_requested_version = $version;
+	}
+
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function _set_debug_info($key, $info)
+	{
+		$this->_debug_info[$key] = $info;
+	}
+
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function _set_response_header($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
+			$this->_response_headers[$prefix . $header_key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function _get_response_headers()
+	{
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->_response_headers,
+			$this,
+			$this->_requested_version
+		);
+	}
+
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param \WP_Error $wp_error_response
+	 * @return \WP_Error
+	 */
+	protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = \EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message));
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|\WP_Error|\Exception $response
+	 * @return \WP_REST_Response
+	 */
+	public function send_response($response)
+	{
+		if ($response instanceof Rest_Exception) {
+			$response = new \WP_Error($response->get_string_code(), $response->getMessage(), $response->get_data());
+		}
+		if ($response instanceof \Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new \WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof \WP_Error) {
+			$response = $this->_add_ee_errors_to_response($response);
+			$rest_response = $this->_create_rest_response_from_wp_error($response);
+		} else {
+			$rest_response = new \WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->_debug_mode && is_array($this->_debug_info)) {
+			foreach ($this->_debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->_get_response_headers(),
+			$this->_get_headers_from_ee_notices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param \WP_Error $wp_error
+	 * @return \WP_REST_Response
+	 */
+	protected function _create_rest_response_from_wp_error(\WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array)$wp_error->errors as $code => $messages) {
+			foreach ((array)$messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new \WP_REST_Response($data, $status);
+	}
+
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function _get_headers_from_ee_notices()
+	{
+		$headers = array();
+		$notices = \EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers['X-EE4-Notices-'
+						 . \EEH_Inflector::humanize($notice_type)
+						 . '['
+						 . $notice_code
+						 . ']'] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->_requested_version,
+			$notices
+		);
+	}
+
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29"
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function get_requested_version($route = null)
+	{
+		$matches = $this->parse_route(
+			$route,
+			'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws \EE_Error if it couldn't be parsed
+	 */
+	public function parse_route($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (
+		is_array($matches)
+		) {
+			//skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[$i])) {
+					$success = false;
+				} else {
+					$indexed_matches[$match_keys[$i - 1]] = $matches[$i];
+				}
+			}
+		}
+		if (! $success) {
+			throw new \EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
 }
 
 // End of file Base.php
\ No newline at end of file

Spacing +11 added lines, -11 removed lines

@@ -3,7 +3,7 @@ 
 
 use EventEspresso\core\libraries\rest_api\Rest_Exception;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -99,11 +99,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
+                $this->_set_response_header($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
-            $this->_response_headers[$prefix . $header_key] = $value;
+            $this->_response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -134,7 +134,7 @@ 
     protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
     {
         $notices_during_checkin = \EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -177,7 +177,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -208,8 +208,8 @@ 
             $status = 500;
         }
         $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
+        foreach ((array) $wp_error->errors as $code => $messages) {
+            foreach ((array) $messages as $message) {
                 $errors[] = array(
                     'code'    => $code,
                     'message' => $message,
@@ -238,7 +238,7 @@ 
         $headers = array();
         $notices = \EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
@@ -271,7 +271,7 @@ 
     {
         $matches = $this->parse_route(
             $route,
-            '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -308,14 +308,14 @@ 
         ) {
             //skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
                     $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

core/libraries/rest_api/Model_Version_Info.php

Indentation +457 added lines, -457 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,462 +24,462 @@ 
 class Model_Version_Info
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const model_added = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $_model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $_resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $_requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $_cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $_cached_fields_on_models = array();
-
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->_requested_version = $requested_version;
-        $this->_model_changes = array(
-            '4.8.29' => array(
-                //first version where the REST API is in EE core, so no need
-                //to specify how its different from the previous
-            ),
-        );
-        //setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->_resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->_resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
-                            $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function model_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->model_changes() as $version => $models_changed_in_version) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $model_changes[$version] = $models_changed_in_version;
-                }
-            }
-            $this->_cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->_cached_model_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resource_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resource_changes() as $version => $model_classnames) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $resource_changes[$version] = $model_classnames;
-                }
-            }
-            $this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->_cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requested_version()
-    {
-        return $this->_requested_version;
-    }
-
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function model_changes()
-    {
-        return $this->_model_changes;
-    }
-
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function models_for_requested_version()
-    {
-        if ($this->_cached_models_for_requested_version === null) {
-            $all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
-                        unset($all_models_in_current_version[$model_name]);
-                    }
-                }
-            }
-            $this->_cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->_cached_models_for_requested_version;
-    }
-
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function is_model_name_in_this_version($model_name)
-    {
-        $model_names = $this->models_for_requested_version();
-        if (isset($model_names[$model_name])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function load_model($model_name)
-    {
-        if ($this->is_model_name_in_this_version($model_name)) {
-            return \EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requested_version()
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fields_on_model_in_this_version($model)
-    {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
-            //get all model changes between the requested version and current core version
-            $changes = $this->model_changes_between_requested_version_and_current();
-            //fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            //remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (
-                    isset($changes_in_version[$model->get_this_model_name()])
-                    && $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[$model->get_this_model_name()])
-                    );
-                }
-            }
-            $this->_cached_fields_on_models = $current_fields;
-        }
-        return $this->_cached_fields_on_models;
-    }
-
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function is_subclass_of_one($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fields_ignored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_is_ignored($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_rendered_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_rendered_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_pretty_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_pretty_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
-    }
-
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resource_changes()
-    {
-        return $this->_resource_changes;
-    }
-
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extra_resource_properties_for_model($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relation_settings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->is_model_name_in_this_version($relation_name)) {
-                $relations[$relation_name] = $relation_obj;
-            }
-        }
-        //filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const model_added = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $_model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $_resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $_requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $_cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $_cached_fields_on_models = array();
+
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->_requested_version = $requested_version;
+		$this->_model_changes = array(
+			'4.8.29' => array(
+				//first version where the REST API is in EE core, so no need
+				//to specify how its different from the previous
+			),
+		);
+		//setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->_resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->_resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+							$this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function model_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->model_changes() as $version => $models_changed_in_version) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$model_changes[$version] = $models_changed_in_version;
+				}
+			}
+			$this->_cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->_cached_model_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resource_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resource_changes() as $version => $model_classnames) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$resource_changes[$version] = $model_classnames;
+				}
+			}
+			$this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->_cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requested_version()
+	{
+		return $this->_requested_version;
+	}
+
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function model_changes()
+	{
+		return $this->_model_changes;
+	}
+
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function models_for_requested_version()
+	{
+		if ($this->_cached_models_for_requested_version === null) {
+			$all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
+						unset($all_models_in_current_version[$model_name]);
+					}
+				}
+			}
+			$this->_cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->_cached_models_for_requested_version;
+	}
+
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function is_model_name_in_this_version($model_name)
+	{
+		$model_names = $this->models_for_requested_version();
+		if (isset($model_names[$model_name])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function load_model($model_name)
+	{
+		if ($this->is_model_name_in_this_version($model_name)) {
+			return \EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requested_version()
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fields_on_model_in_this_version($model)
+	{
+		if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+			//get all model changes between the requested version and current core version
+			$changes = $this->model_changes_between_requested_version_and_current();
+			//fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			//remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (
+					isset($changes_in_version[$model->get_this_model_name()])
+					&& $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[$model->get_this_model_name()])
+					);
+				}
+			}
+			$this->_cached_fields_on_models = $current_fields;
+		}
+		return $this->_cached_fields_on_models;
+	}
+
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function is_subclass_of_one($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fields_ignored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_is_ignored($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_rendered_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_rendered_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_pretty_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_pretty_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
+	}
+
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resource_changes()
+	{
+		return $this->_resource_changes;
+	}
+
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extra_resource_properties_for_model($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relation_settings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->is_model_name_in_this_version($relation_name)) {
+				$relations[$relation_name] = $relation_obj;
+			}
+		}
+		//filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 
 }
 

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -120,7 +120,7 @@ 
                 foreach ($extra_fields as $fieldname => $field_data) {
                     $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+                        if ( ! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
                             $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
@@ -292,7 +292,7 @@ 
      */
     public function fields_on_model_in_this_version($model)
     {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+        if ( ! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
             //get all model changes between the requested version and current core version
             $changes = $this->model_changes_between_requested_version_and_current();
             //fetch all fields currently on this model

core/libraries/rest_api/Model_Data_Translator.php

Indentation +481 added lines, -481 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,485 +27,485 @@ 
 class Model_Data_Translator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const ee_inf_in_rest = null;
-
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_values_from_json(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $array_item,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_value_from_json(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    )
-    {
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        if ($field_obj instanceof \EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
-                $field_obj->get_timezone_offset(
-                    new \DateTimeZone($timezone_string)
-                )
-            );
-            $offset_string =
-                str_pad(
-                    floor($offset_secs / HOUR_IN_SECONDS),
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                )
-                . ':'
-                . str_pad(
-                    ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parse_timezone_offset($timezone_offset)
-    {
-        $first_char = substr((string)$timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @return mixed
-     */
-    public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = Model_Data_Translator::ee_inf_in_rest;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } else {
-                $new_value = $original_value;
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array     $inputted_query_params_of_this_type
-     * @param \EEM_Base $model
-     * @param string    $requested_version
-     * @return array
-     * @throws \DomainException
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_models(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
-                && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
-                $field = Model_Data_Translator::deduce_field_from_query_param(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-            } else {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            }
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
-                            $requested_version, $timezone);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
-                        $requested_version, $timezone);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function is_gmt_date_field_name($field_name)
-    {
-        return substr(
-                   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
-                   -4,
-                   4
-               ) === '_gmt';
-    }
-
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function remove_gmt_from_field_name($field_name)
-    {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepare_field_name_from_json($field_name)
-    {
-        if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return Model_Data_Translator::remove_gmt_from_field_name($field_name);
-        }
-        return $field_name;
-    }
-
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepare_field_names_from_json(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array     $model_query_params
-     * @param \EEM_Base $model
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws \EE_Error
-     */
-    public static function prepare_query_params_for_rest_api(
-        array $model_query_params,
-        \EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params, $model_query_params, $model, $requested_version);
-    }
-
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param \EEM_Base $model
-     * @param string    $requested_version                  eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_rest_api(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
-                $model
-            );
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
-                            $requested_version);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
-                        $requested_version);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param \EEM_Base $model
-     * @return \EE_Model_Field_Base
-     * @throws \EE_Error
-     */
-    public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
-    {
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
-        //which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
-                'event_espresso'), $query_param_name));
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
-        }
-        try {
-            return $model->field_settings_for($field_name);
-        } catch (\EE_Error $e) {
-            return null;
-        }
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const ee_inf_in_rest = null;
+
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_values_from_json(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$array_item,
+					$request_version
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_value_from_json(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	)
+	{
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		if ($field_obj instanceof \EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
+				$field_obj->get_timezone_offset(
+					new \DateTimeZone($timezone_string)
+				)
+			);
+			$offset_string =
+				str_pad(
+					floor($offset_secs / HOUR_IN_SECONDS),
+					2,
+					'0',
+					STR_PAD_LEFT
+				)
+				. ':'
+				. str_pad(
+					($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+					2,
+					'0',
+					STR_PAD_LEFT
+				);
+			$new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parse_timezone_offset($timezone_offset)
+	{
+		$first_char = substr((string)$timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string)$timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @return mixed
+	 */
+	public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = Model_Data_Translator::ee_inf_in_rest;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} else {
+				$new_value = $original_value;
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array     $inputted_query_params_of_this_type
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version
+	 * @return array
+	 * @throws \DomainException
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_models(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if (! $field instanceof \EE_Model_Field_Base
+				&& Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
+				$field = Model_Data_Translator::deduce_field_from_query_param(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+			} else {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			}
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
+							$requested_version, $timezone);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
+						$requested_version, $timezone);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function is_gmt_date_field_name($field_name)
+	{
+		return substr(
+				   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
+				   -4,
+				   4
+			   ) === '_gmt';
+	}
+
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function remove_gmt_from_field_name($field_name)
+	{
+		if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepare_field_name_from_json($field_name)
+	{
+		if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return Model_Data_Translator::remove_gmt_from_field_name($field_name);
+		}
+		return $field_name;
+	}
+
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepare_field_names_from_json(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array     $model_query_params
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws \EE_Error
+	 */
+	public static function prepare_query_params_for_rest_api(
+		array $model_query_params,
+		\EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params, $model_query_params, $model, $requested_version);
+	}
+
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version                  eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_rest_api(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
+				$model
+			);
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
+							$requested_version);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
+						$requested_version);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Field_Base
+	 * @throws \EE_Error
+	 */
+	public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
+	{
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
+		//which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
+				'event_espresso'), $query_param_name));
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
+		}
+		try {
+			return $model->field_settings_for($field_name);
+		} catch (\EE_Error $e) {
+			return null;
+		}
+	}
 
 }

Spacing +6 added lines, -6 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -149,7 +149,7 @@ 
                     '0',
                     STR_PAD_LEFT
                 );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+            $new_value = rest_parse_date($original_value.$offset_sign.$offset_string);
         } else {
             $new_value = $original_value;
         }
@@ -166,10 +166,10 @@ 
      */
     private static function parse_timezone_offset($timezone_offset)
     {
-        $first_char = substr((string)$timezone_offset, 0, 1);
+        $first_char = substr((string) $timezone_offset, 0, 1);
         if ($first_char === '+' || $first_char === '-') {
             $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
+            $offset_secs = substr((string) $timezone_offset, 1);
         } else {
             $offset_sign = '+';
             $offset_secs = $timezone_offset;
@@ -237,7 +237,7 @@ 
                 $model
             );
             //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
+            if ( ! $field instanceof \EE_Model_Field_Base
                 && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
             ) {
                 //yep, take off '_gmt', and find the field
@@ -303,7 +303,7 @@ 
      */
     public static function remove_gmt_from_field_name($field_name)
     {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+        if ( ! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);