eventespresso / event-espresso-core

core/libraries/line_item_filters/EE_Non_Zero_Line_Item_Filter.class.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
+        if ( ! $non_zero_line_item instanceof EEI_Line_Item) {
             return null;
         }
         // if this is an event subtotal, we want to only include it if it
@@ -42,7 +42,7 @@ 
             foreach ($line_item->children() as $child_line_item) {
                 $code = $child_line_item->code();
                 $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
+                if ( ! $child_line_item instanceof EEI_Line_Item) {
                     $line_item->delete_child_line_item($code);
                     continue;
                 }

Indentation +89 added lines, -89 removed lines

@@ -14,99 +14,99 @@
 class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
 
-    /**
-     * EE_Non_Zero_Line_Item_Filter constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * EE_Non_Zero_Line_Item_Filter constructor.
+	 */
+	public function __construct()
+	{
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        if ($line_item->children()) {
-            $ticket_or_subtotals_with_tkt_children_count = 0;
-            foreach ($line_item->children() as $child_line_item) {
-                $code = $child_line_item->code();
-                $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
-                    $line_item->delete_child_line_item($code);
-                    continue;
-                }
-                if (
-                    (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_sub_total
-                    )
-                    || (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_line_item
-                        && $child_line_item->OBJ_type() === 'Ticket'
-                    )
-                ) {
-                    $ticket_or_subtotals_with_tkt_children_count++;
-                }
-            }
-            // if this is an event subtotal with NO ticket children
-            // we basically want to ignore it
-            return $this->_filter_zero_subtotal_line_item(
-                $non_zero_line_item,
-                $ticket_or_subtotals_with_tkt_children_count
-            );
-        }
-        return $non_zero_line_item;
-    }
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$non_zero_line_item = $this->_filter_zero_line_item($line_item);
+		if (! $non_zero_line_item instanceof EEI_Line_Item) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		if ($line_item->children()) {
+			$ticket_or_subtotals_with_tkt_children_count = 0;
+			foreach ($line_item->children() as $child_line_item) {
+				$code = $child_line_item->code();
+				$child_line_item = $this->process($child_line_item);
+				if (! $child_line_item instanceof EEI_Line_Item) {
+					$line_item->delete_child_line_item($code);
+					continue;
+				}
+				if (
+					(
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_sub_total
+					)
+					|| (
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_line_item
+						&& $child_line_item->OBJ_type() === 'Ticket'
+					)
+				) {
+					$ticket_or_subtotals_with_tkt_children_count++;
+				}
+			}
+			// if this is an event subtotal with NO ticket children
+			// we basically want to ignore it
+			return $this->_filter_zero_subtotal_line_item(
+				$non_zero_line_item,
+				$ticket_or_subtotals_with_tkt_children_count
+			);
+		}
+		return $non_zero_line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_line_item(EEI_Line_Item $line_item)
-    {
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === 'Ticket'
-            && (int) $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_line_item(EEI_Line_Item $line_item)
+	{
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === 'Ticket'
+			&& (int) $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @param int           $ticket_children
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
-    {
-        if (
-            (int) $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param int           $ticket_children
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
+	{
+		if (
+			(int) $ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Collection.class.php

Indentation +7 added lines, -7 removed lines

@@ -18,11 +18,11 @@
 {
 
 
-    /**
-     * EE_Line_Item_Filter_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EEI_Line_Item_Filter';
-    }
+	/**
+	 * EE_Line_Item_Filter_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EEI_Line_Item_Filter';
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Base.class.php

Indentation +10 added lines, -10 removed lines

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

core/libraries/line_item_filters/EE_Single_Registration_Line_Item_Filter.class.php

Indentation +8 added lines, -8 removed lines

@@ -16,12 +16,12 @@
 class EE_Single_Registration_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
 {
 
-    /**
-     *
-     * @param EE_Registration $registration
-     */
-    public function __construct($registration)
-    {
-        parent::__construct(array($registration));
-    }
+	/**
+	 *
+	 * @param EE_Registration $registration
+	 */
+	public function __construct($registration)
+	{
+		parent::__construct(array($registration));
+	}
 }

core/libraries/template_parts/EE_Template_Part_Manager.class.php

Indentation +191 added lines, -191 removed lines

@@ -14,195 +14,195 @@
 class EE_Template_Part_Manager
 {
 
-    /**
-     * @param EE_Template_Part_PriorityQueue $template_parts
-     */
-    protected $template_parts;
-
-    /**
-     * @param array $priorities
-     */
-    protected $priorities = array();
-
-    /**
-     * @param int $event_desc_priority
-     */
-    protected $event_desc_priority;
-
-    /**
-     * @param string $before_event_content
-     */
-    protected $before_event_content;
-
-    /**
-     * @param string $event_content
-     */
-    protected $event_content;
-
-    /**
-     * @param string $after_event_content
-     */
-    protected $after_event_content;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->template_parts = new EE_Template_Part_PriorityQueue();
-    }
-
-
-    /**
-     *    add_template_part
-     *
-     *    used for setting the details about a particular template part
-     *
-     * @param string $name     - just a simple string identifier - do NOT use 'event'
-     * @param string $label    - template part label displayed in admin
-     * @param string $template - name or path of template to be used by EEH_Template::locate_template()
-     * @param int    $priority - order in which template parts should be applied
-     */
-    public function add_template_part($name, $label, $template, $priority)
-    {
-        // SplPriorityQueue doesn't play nice with multiple items having the same priority
-        // so if the incoming priority is already occupied, then let's increment it by one,
-        // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
-            $priority++;
-            $this->add_template_part($name, $label, $template, $priority);
-            return;
-        }
-        // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
-        // create the template part and add to the queue
-        $this->template_parts->insert(
-            new EE_Template_Part($name, $label, $template, $priority),
-            $priority
-        );
-        if ($name === 'event') {
-            $this->event_desc_priority = $priority;
-        }
-    }
-
-
-    /**
-     *    apply_template_part_filters
-     *
-     *    adds template parts to the supplied content
-     *    according to the details set when the template parts were added
-     *
-     * @access public
-     * @param string $content
-     * @return string
-     */
-    public function apply_template_part_filters($content = '')
-    {
-        $this->template_parts->rewind();
-        // loop through template parts and position content
-        while ($this->template_parts->valid()) {
-            $this->_position_template_part(
-                $content,
-                $this->template_parts->current()->template(),
-                $this->template_parts->current()->priority()
-            );
-            $this->template_parts->next();
-        }
-        // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
-    }
-
-
-    /**
-     *    position_template_part
-     *
-     * based on the priority of the incoming template part
-     * relative to the known event description template part priority,
-     * this method will assign template parts to one of the following:
-     *        $this->before_event_content
-     *        $this->event_content
-     *        $this->after_event_content
-     *
-     * @access protected
-     * @param string $content
-     * @param string $template
-     * @param int    $priority
-     * @return void
-     */
-    protected function _position_template_part($content, $template, $priority)
-    {
-        // Event Description content is the actual incoming content itself
-        if ($priority === $this->event_desc_priority) {
-            $this->event_content = $content;
-        } elseif ($priority < $this->event_desc_priority) {
-            // everything BEFORE the Event Description
-            $this->before_event_content .= EEH_Template::locate_template($template);
-        } elseif ($priority > $this->event_desc_priority) {
-            // everything AFTER the Event Description
-            $this->after_event_content .= EEH_Template::locate_template($template);
-        }
-    }
-
-
-    /**
-     *    generate_sortable_list_of_template_parts
-     *
-     *    creates an HTML list (<ul>) with list items (<li>) for each template part,
-     *    in a format that can be used as a sortable list in the admin
-     *
-     * @access public
-     * @param string $list_css_id
-     * @param string $list_css_class
-     * @param string $list_item_css_class
-     * @param string $list_item_css_id_prefix
-     * @return string
-     */
-    public function generate_sortable_list_of_template_parts(
-        $list_css_id = '',
-        $list_css_class = '',
-        $list_item_css_class = '',
-        $list_item_css_id_prefix = ''
-    ) {
-        $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
-        $this->template_parts->rewind();
-        // loop through template parts and add template content
-        while ($this->template_parts->valid()) {
-            $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
-                $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
-                $list_item_css_class
-            );
-            $this->template_parts->next();
-        }
-        $event_archive_display_order .= EEH_HTML::ulx();
-        return $event_archive_display_order;
-    }
-
-
-    /**
-     *    display_template_parts
-     *
-     * just for debugging purposes
-     *
-     * @access    public
-     * @return void
-     */
-    public function display_template_parts()
-    {
-        if (WP_DEBUG) {
-            $this->template_parts->rewind();
-            while ($this->template_parts->valid()) {
-                EEH_Debug_Tools::printr(
-                    $this->template_parts->current(),
-                    'template_part',
-                    __FILE__,
-                    __LINE__
-                );
-                $this->template_parts->next();
-            }
-        }
-    }
+	/**
+	 * @param EE_Template_Part_PriorityQueue $template_parts
+	 */
+	protected $template_parts;
+
+	/**
+	 * @param array $priorities
+	 */
+	protected $priorities = array();
+
+	/**
+	 * @param int $event_desc_priority
+	 */
+	protected $event_desc_priority;
+
+	/**
+	 * @param string $before_event_content
+	 */
+	protected $before_event_content;
+
+	/**
+	 * @param string $event_content
+	 */
+	protected $event_content;
+
+	/**
+	 * @param string $after_event_content
+	 */
+	protected $after_event_content;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->template_parts = new EE_Template_Part_PriorityQueue();
+	}
+
+
+	/**
+	 *    add_template_part
+	 *
+	 *    used for setting the details about a particular template part
+	 *
+	 * @param string $name     - just a simple string identifier - do NOT use 'event'
+	 * @param string $label    - template part label displayed in admin
+	 * @param string $template - name or path of template to be used by EEH_Template::locate_template()
+	 * @param int    $priority - order in which template parts should be applied
+	 */
+	public function add_template_part($name, $label, $template, $priority)
+	{
+		// SplPriorityQueue doesn't play nice with multiple items having the same priority
+		// so if the incoming priority is already occupied, then let's increment it by one,
+		// and then pass everything back into this method and try again with the new priority
+		if (isset($this->priorities[ $priority ])) {
+			$priority++;
+			$this->add_template_part($name, $label, $template, $priority);
+			return;
+		}
+		// kk now we can mark this priority as being occupied
+		$this->priorities[ $priority ] = true;
+		// create the template part and add to the queue
+		$this->template_parts->insert(
+			new EE_Template_Part($name, $label, $template, $priority),
+			$priority
+		);
+		if ($name === 'event') {
+			$this->event_desc_priority = $priority;
+		}
+	}
+
+
+	/**
+	 *    apply_template_part_filters
+	 *
+	 *    adds template parts to the supplied content
+	 *    according to the details set when the template parts were added
+	 *
+	 * @access public
+	 * @param string $content
+	 * @return string
+	 */
+	public function apply_template_part_filters($content = '')
+	{
+		$this->template_parts->rewind();
+		// loop through template parts and position content
+		while ($this->template_parts->valid()) {
+			$this->_position_template_part(
+				$content,
+				$this->template_parts->current()->template(),
+				$this->template_parts->current()->priority()
+			);
+			$this->template_parts->next();
+		}
+		// now simply add our three strings of content together
+		return $this->before_event_content . $this->event_content . $this->after_event_content;
+	}
+
+
+	/**
+	 *    position_template_part
+	 *
+	 * based on the priority of the incoming template part
+	 * relative to the known event description template part priority,
+	 * this method will assign template parts to one of the following:
+	 *        $this->before_event_content
+	 *        $this->event_content
+	 *        $this->after_event_content
+	 *
+	 * @access protected
+	 * @param string $content
+	 * @param string $template
+	 * @param int    $priority
+	 * @return void
+	 */
+	protected function _position_template_part($content, $template, $priority)
+	{
+		// Event Description content is the actual incoming content itself
+		if ($priority === $this->event_desc_priority) {
+			$this->event_content = $content;
+		} elseif ($priority < $this->event_desc_priority) {
+			// everything BEFORE the Event Description
+			$this->before_event_content .= EEH_Template::locate_template($template);
+		} elseif ($priority > $this->event_desc_priority) {
+			// everything AFTER the Event Description
+			$this->after_event_content .= EEH_Template::locate_template($template);
+		}
+	}
+
+
+	/**
+	 *    generate_sortable_list_of_template_parts
+	 *
+	 *    creates an HTML list (<ul>) with list items (<li>) for each template part,
+	 *    in a format that can be used as a sortable list in the admin
+	 *
+	 * @access public
+	 * @param string $list_css_id
+	 * @param string $list_css_class
+	 * @param string $list_item_css_class
+	 * @param string $list_item_css_id_prefix
+	 * @return string
+	 */
+	public function generate_sortable_list_of_template_parts(
+		$list_css_id = '',
+		$list_css_class = '',
+		$list_item_css_class = '',
+		$list_item_css_id_prefix = ''
+	) {
+		$event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
+		$this->template_parts->rewind();
+		// loop through template parts and add template content
+		while ($this->template_parts->valid()) {
+			$event_archive_display_order .= EEH_HTML::li(
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+				$this->template_parts->current()->label(),
+				$list_item_css_id_prefix . $this->template_parts->current()->name(),
+				$list_item_css_class
+			);
+			$this->template_parts->next();
+		}
+		$event_archive_display_order .= EEH_HTML::ulx();
+		return $event_archive_display_order;
+	}
+
+
+	/**
+	 *    display_template_parts
+	 *
+	 * just for debugging purposes
+	 *
+	 * @access    public
+	 * @return void
+	 */
+	public function display_template_parts()
+	{
+		if (WP_DEBUG) {
+			$this->template_parts->rewind();
+			while ($this->template_parts->valid()) {
+				EEH_Debug_Tools::printr(
+					$this->template_parts->current(),
+					'template_part',
+					__FILE__,
+					__LINE__
+				);
+				$this->template_parts->next();
+			}
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -69,13 +69,13 @@ 
         // SplPriorityQueue doesn't play nice with multiple items having the same priority
         // so if the incoming priority is already occupied, then let's increment it by one,
         // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
+        if (isset($this->priorities[$priority])) {
             $priority++;
             $this->add_template_part($name, $label, $template, $priority);
             return;
         }
         // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
+        $this->priorities[$priority] = true;
         // create the template part and add to the queue
         $this->template_parts->insert(
             new EE_Template_Part($name, $label, $template, $priority),
@@ -110,7 +110,7 @@ 
             $this->template_parts->next();
         }
         // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
+        return $this->before_event_content.$this->event_content.$this->after_event_content;
     }
 
 
@@ -169,10 +169,10 @@ 
         // loop through template parts and add template content
         while ($this->template_parts->valid()) {
             $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2').
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2').
                 $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
+                $list_item_css_id_prefix.$this->template_parts->current()->name(),
                 $list_item_css_class
             );
             $this->template_parts->next();

core/libraries/template_parts/EE_Template_Part.class.php

Indentation +108 added lines, -108 removed lines

@@ -16,112 +16,112 @@
 {
 
 
-    /**
-     * @type string $name
-     */
-    protected $name;
-
-    /**
-     * @type string $label
-     */
-    protected $label;
-
-    /**
-     * @type string $template
-     */
-    protected $template;
-
-    /**
-     * @type int $priority
-     */
-    protected $priority;
-
-
-    /**
-     *    class constructor
-     *
-     * @param string $name
-     * @param string $label
-     * @param string $template
-     * @param int    $priority
-     */
-    public function __construct($name, $label, $template, $priority = 100)
-    {
-        $this->set_name($name);
-        $this->set_label($label);
-        $this->set_template($template);
-        $this->set_priority($priority);
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function name()
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param mixed $name
-     */
-    public function set_name($name)
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function label()
-    {
-        return $this->label;
-    }
-
-
-    /**
-     * @param string $label
-     */
-    public function set_label($label)
-    {
-        $this->label = $label;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function template()
-    {
-        return $this->template;
-    }
-
-
-    /**
-     * @param string $template
-     */
-    public function set_template($template)
-    {
-        $this->template = $template;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->priority;
-    }
-
-
-    /**
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $this->priority = intval($priority);
-    }
+	/**
+	 * @type string $name
+	 */
+	protected $name;
+
+	/**
+	 * @type string $label
+	 */
+	protected $label;
+
+	/**
+	 * @type string $template
+	 */
+	protected $template;
+
+	/**
+	 * @type int $priority
+	 */
+	protected $priority;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @param string $name
+	 * @param string $label
+	 * @param string $template
+	 * @param int    $priority
+	 */
+	public function __construct($name, $label, $template, $priority = 100)
+	{
+		$this->set_name($name);
+		$this->set_label($label);
+		$this->set_template($template);
+		$this->set_priority($priority);
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function name()
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param mixed $name
+	 */
+	public function set_name($name)
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function label()
+	{
+		return $this->label;
+	}
+
+
+	/**
+	 * @param string $label
+	 */
+	public function set_label($label)
+	{
+		$this->label = $label;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function template()
+	{
+		return $this->template;
+	}
+
+
+	/**
+	 * @param string $template
+	 */
+	public function set_template($template)
+	{
+		$this->template = $template;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->priority;
+	}
+
+
+	/**
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$this->priority = intval($priority);
+	}
 }

core/libraries/template_parts/EE_Template_Part_PriorityQueue.class.php

Indentation +37 added lines, -37 removed lines

@@ -17,43 +17,43 @@
 {
 
 
-    /**
-     * add
-     *
-     * attaches aTemplate_Part to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     *
-     * @access public
-     * @param EE_Template_Part $object
-     * @param int              $priority
-     * @return bool
-     */
-    public function insert($object, $priority = 100)
-    {
-        if ($object instanceof EE_Template_Part) {
-            parent::insert($object, $priority);
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * add
+	 *
+	 * attaches aTemplate_Part to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 *
+	 * @access public
+	 * @param EE_Template_Part $object
+	 * @param int              $priority
+	 * @return bool
+	 */
+	public function insert($object, $priority = 100)
+	{
+		if ($object instanceof EE_Template_Part) {
+			parent::insert($object, $priority);
+			return true;
+		} else {
+			return false;
+		}
+	}
 
 
-    /**
-     * compare
-     *
-     * sorts EE_Template_Part in ascending order based on set priority
-     *
-     * @access public
-     * @param int $priority1
-     * @param int $priority2
-     * @return bool
-     */
-    public function compare($priority1, $priority2)
-    {
-        if ($priority1 === $priority2) {
-            return 0;
-        }
-        return $priority1 > $priority2 ? -1 : 1;
-    }
+	/**
+	 * compare
+	 *
+	 * sorts EE_Template_Part in ascending order based on set priority
+	 *
+	 * @access public
+	 * @param int $priority1
+	 * @param int $priority2
+	 * @return bool
+	 */
+	public function compare($priority1, $priority2)
+	{
+		if ($priority1 === $priority2) {
+			return 0;
+		}
+		return $priority1 > $priority2 ? -1 : 1;
+	}
 }

core/business/EE_Processor_Base.class.php

Indentation +60 added lines, -60 removed lines

@@ -14,71 +14,71 @@
 class EE_Processor_Base
 {
 
-    /**
-     * Used to indicate whether current request is for an IPN or not.
-     *
-     * @var bool
-     */
-    protected static $IPN = false;
+	/**
+	 * Used to indicate whether current request is for an IPN or not.
+	 *
+	 * @var bool
+	 */
+	protected static $IPN = false;
 
-    /**
-     * Used to indicate whether SPCO is being revisited by registrant or not.
-     *
-     * @var bool
-     */
-    protected $_revisit = false;
+	/**
+	 * Used to indicate whether SPCO is being revisited by registrant or not.
+	 *
+	 * @var bool
+	 */
+	protected $_revisit = false;
 
 
-    /**
-     * @param boolean $IPN
-     */
-    public static function set_IPN($IPN)
-    {
-        self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @param boolean $IPN
+	 */
+	public static function set_IPN($IPN)
+	{
+		self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
-     *
-     * @param bool $revisit
-     * @return void
-     */
-    public function set_revisit($revisit = false)
-    {
-        $this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
+	 *
+	 * @param bool $revisit
+	 * @return void
+	 */
+	public function set_revisit($revisit = false)
+	{
+		$this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * debug
-     *
-     * @param string          $class
-     * @param string          $func
-     * @param string          $line
-     * @param \EE_Transaction $transaction
-     * @param array           $info
-     * @param bool            $display_request
-     */
-    protected function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (WP_DEBUG && false) {
-            if ($transaction instanceof EE_Transaction) {
-                // don't serialize objects
-                $info = EEH_Debug_Tools::strip_objects($info);
-                if ($transaction->ID()) {
-                    $info['TXN_status'] = $transaction->status_ID();
-                    $info['TXN_reg_steps'] = $transaction->reg_steps();
-                    $index = 'EE_Transaction: ' . $transaction->ID();
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-                }
-            }
-        }
-    }
+	/**
+	 * debug
+	 *
+	 * @param string          $class
+	 * @param string          $func
+	 * @param string          $line
+	 * @param \EE_Transaction $transaction
+	 * @param array           $info
+	 * @param bool            $display_request
+	 */
+	protected function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (WP_DEBUG && false) {
+			if ($transaction instanceof EE_Transaction) {
+				// don't serialize objects
+				$info = EEH_Debug_Tools::strip_objects($info);
+				if ($transaction->ID()) {
+					$info['TXN_status'] = $transaction->status_ID();
+					$info['TXN_reg_steps'] = $transaction->reg_steps();
+					$index = 'EE_Transaction: ' . $transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+				}
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
                 if ($transaction->ID()) {
                     $info['TXN_status'] = $transaction->status_ID();
                     $info['TXN_reg_steps'] = $transaction->reg_steps();
-                    $index = 'EE_Transaction: ' . $transaction->ID();
+                    $index = 'EE_Transaction: '.$transaction->ID();
                     EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
                 }
             }

core/business/EE_Transaction_Payments.class.php

Spacing +12 added lines, -12 removed lines

@@ -43,7 +43,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
+        if ( ! self::$_instance instanceof EE_Transaction_Payments) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -62,7 +62,7 @@ 
     public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
     {
         $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
+        if ( ! $total_line_item instanceof EE_Line_Item) {
             EE_Error::add_error(
                 sprintf(
                     __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
@@ -101,7 +101,7 @@ 
     public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
     {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -116,7 +116,7 @@ 
         if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
             $transaction->set_paid($total_paid);
             // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+            if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
                 if ($update_txn) {
                     return $transaction->save() ? true : false;
                 }
@@ -145,7 +145,7 @@ 
         $payment_status = EEM_Payment::status_id_approved
     ) {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -178,7 +178,7 @@ 
     public function delete_payment_and_update_transaction(EE_Payment $payment)
     {
         // verify payment
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             EE_Error::add_error(
                 __('A valid Payment object was not received.', 'event_espresso'),
                 __FILE__,
@@ -187,10 +187,10 @@ 
             );
             return false;
         }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+        if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
             return false;
         }
-        if (! $payment->delete()) {
+        if ( ! $payment->delete()) {
             EE_Error::add_error(
                 __('The payment could not be deleted.', 'event_espresso'),
                 __FILE__,
@@ -213,7 +213,7 @@ 
 
         // if this fails, that just means that the transaction didn't get its status changed and/or updated.
         // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
+        if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
             EE_Error::add_attention(
                 __(
                     'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
@@ -255,7 +255,7 @@ 
         $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
             : array(array('PAY_ID' => $payment->ID()));
         $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
+        if ( ! empty($registration_payments)) {
             foreach ($registration_payments as $registration_payment) {
                 if ($registration_payment instanceof EE_Registration_Payment) {
                     $amount_paid = $registration_payment->amount();
@@ -321,7 +321,7 @@ 
     public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction::update_status_based_on_total_paid()'
@@ -330,7 +330,7 @@ 
             '5.0.0'
         );
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,

Indentation +420 added lines, -420 removed lines

@@ -15,424 +15,424 @@
 class EE_Transaction_Payments
 {
 
-    /**
-     * @var EE_Transaction_Payments $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Transaction_Payments instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * recalculate_transaction_total
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @param bool           $update_txn
-     * @return bool true if TXN total was updated, false if not
-     * @throws \EE_Error
-     */
-    public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
-    {
-        $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
-                    $transaction->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $new_total = $total_line_item->recalculate_total_including_taxes();
-        $transaction->set_total($new_total);
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * returns a boolean for whether the TXN was saved to the db
-     * (meaning a status change occurred)
-     * or not saved (which could **still** mean that
-     * the TXN status changed, but just was not yet saved).
-     * So if passing a value of false for the $update_txn param,
-     * then client code needs to take responsibility for saving the TXN
-     * regardless of what happens within EE_Transaction_Payments;
-     *
-     * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
-     * @param    boolean $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
-    {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // calculate total paid
-        $total_paid = $this->recalculate_total_payments_for_transaction($transaction);
-        // if total paid has changed
-        if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
-            $transaction->set_paid($total_paid);
-            // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
-                if ($update_txn) {
-                    return $transaction->save() ? true : false;
-                }
-            } else {
-                // the status got updated and was saved by
-                // update_transaction_status_based_on_total_paid()
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * recalculate_total_payments_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
-     *                                       By default, searches for approved payments
-     * @return float|false   float on success, false on fail
-     * @throws \EE_Error
-     */
-    public function recalculate_total_payments_for_transaction(
-        EE_Transaction $transaction,
-        $payment_status = EEM_Payment::status_id_approved
-    ) {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // ensure Payment model is loaded
-        EE_Registry::instance()->load_model('Payment');
-        // calls EEM_Base::sum()
-        return EEM_Payment::instance()->sum(
-            // query params
-            array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
-            // field to sum
-            'PAY_amount'
-        );
-    }
-
-
-    /**
-     * delete_payment_and_update_transaction
-     * Before deleting the selected payment, we fetch it's transaction,
-     * then delete the payment, and update the transactions' amount paid.
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function delete_payment_and_update_transaction(EE_Payment $payment)
-    {
-        // verify payment
-        if (! $payment instanceof EE_Payment) {
-            EE_Error::add_error(
-                __('A valid Payment object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
-            return false;
-        }
-        if (! $payment->delete()) {
-            EE_Error::add_error(
-                __('The payment could not be deleted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $transaction = $payment->transaction();
-        $TXN_status = $transaction->status_ID();
-        if (
-            $TXN_status === EEM_Transaction::abandoned_status_code
-            || $TXN_status === EEM_Transaction::failed_status_code
-            || $payment->amount() === 0
-        ) {
-            EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
-            return true;
-        }
-
-
-        // if this fails, that just means that the transaction didn't get its status changed and/or updated.
-        // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_attention(
-                __(
-                    'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return true;
-        }
-
-        EE_Error::add_success(
-            __(
-                'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
-                'event_espresso'
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * delete_registration_payments_and_update_registrations
-     *
-     * removes all registration payment records associated with a payment
-     * and subtracts their amounts from the corresponding registrations REG_paid field
-     *
-     * @param EE_Payment $payment
-     * @param array      $reg_payment_query_params
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_registration_payments_and_update_registrations(
-        EE_Payment $payment,
-        $reg_payment_query_params = array()
-    ) {
-        $save_payment = false;
-        $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
-            : array(array('PAY_ID' => $payment->ID()));
-        $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
-            foreach ($registration_payments as $registration_payment) {
-                if ($registration_payment instanceof EE_Registration_Payment) {
-                    $amount_paid = $registration_payment->amount();
-                    $registration = $registration_payment->registration();
-                    if ($registration instanceof EE_Registration) {
-                        $registration->set_paid($registration->paid() - $amount_paid);
-                        if ($registration->save() !== false) {
-                            $registration_payment->delete_permanently();
-                            $save_payment = true;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'An invalid Registration object was associated with Registration Payment ID# %1$d.',
-                                    'event_espresso'
-                                ),
-                                $registration_payment->ID()
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'An invalid Registration Payment object was associated with payment ID# %1$d.',
-                                'event_espresso'
-                            ),
-                            $payment->ID()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        if ($save_payment) {
-            $payment->save();
-        }
-        return true;
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @deprecated 4.9.1
-     * @param EE_Transaction $transaction
-     * @param    boolean     $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction::update_status_based_on_total_paid()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        return $transaction->update_status_based_on_total_paid($update_txn);
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
+	/**
+	 * @var EE_Transaction_Payments $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Transaction_Payments instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Payments) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * recalculate_transaction_total
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @param bool           $update_txn
+	 * @return bool true if TXN total was updated, false if not
+	 * @throws \EE_Error
+	 */
+	public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
+	{
+		$total_line_item = $transaction->total_line_item();
+		if (! $total_line_item instanceof EE_Line_Item) {
+			EE_Error::add_error(
+				sprintf(
+					__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
+					$transaction->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$new_total = $total_line_item->recalculate_total_including_taxes();
+		$transaction->set_total($new_total);
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * returns a boolean for whether the TXN was saved to the db
+	 * (meaning a status change occurred)
+	 * or not saved (which could **still** mean that
+	 * the TXN status changed, but just was not yet saved).
+	 * So if passing a value of false for the $update_txn param,
+	 * then client code needs to take responsibility for saving the TXN
+	 * regardless of what happens within EE_Transaction_Payments;
+	 *
+	 * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
+	 * @param    boolean $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
+	{
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// calculate total paid
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
+		// if total paid has changed
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
+			// maybe update status, and make sure to save transaction if not done already
+			if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
+					return $transaction->save() ? true : false;
+				}
+			} else {
+				// the status got updated and was saved by
+				// update_transaction_status_based_on_total_paid()
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * recalculate_total_payments_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
+	 *                                       By default, searches for approved payments
+	 * @return float|false   float on success, false on fail
+	 * @throws \EE_Error
+	 */
+	public function recalculate_total_payments_for_transaction(
+		EE_Transaction $transaction,
+		$payment_status = EEM_Payment::status_id_approved
+	) {
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// ensure Payment model is loaded
+		EE_Registry::instance()->load_model('Payment');
+		// calls EEM_Base::sum()
+		return EEM_Payment::instance()->sum(
+			// query params
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
+			// field to sum
+			'PAY_amount'
+		);
+	}
+
+
+	/**
+	 * delete_payment_and_update_transaction
+	 * Before deleting the selected payment, we fetch it's transaction,
+	 * then delete the payment, and update the transactions' amount paid.
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function delete_payment_and_update_transaction(EE_Payment $payment)
+	{
+		// verify payment
+		if (! $payment instanceof EE_Payment) {
+			EE_Error::add_error(
+				__('A valid Payment object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+			return false;
+		}
+		if (! $payment->delete()) {
+			EE_Error::add_error(
+				__('The payment could not be deleted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$transaction = $payment->transaction();
+		$TXN_status = $transaction->status_ID();
+		if (
+			$TXN_status === EEM_Transaction::abandoned_status_code
+			|| $TXN_status === EEM_Transaction::failed_status_code
+			|| $payment->amount() === 0
+		) {
+			EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
+			return true;
+		}
+
+
+		// if this fails, that just means that the transaction didn't get its status changed and/or updated.
+		// however the payment was still deleted.
+		if (! $this->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_attention(
+				__(
+					'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return true;
+		}
+
+		EE_Error::add_success(
+			__(
+				'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
+				'event_espresso'
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * delete_registration_payments_and_update_registrations
+	 *
+	 * removes all registration payment records associated with a payment
+	 * and subtracts their amounts from the corresponding registrations REG_paid field
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $reg_payment_query_params
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_registration_payments_and_update_registrations(
+		EE_Payment $payment,
+		$reg_payment_query_params = array()
+	) {
+		$save_payment = false;
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
+			: array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if (! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
+					$amount_paid = $registration_payment->amount();
+					$registration = $registration_payment->registration();
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save() !== false) {
+							$registration_payment->delete_permanently();
+							$save_payment = true;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'An invalid Registration object was associated with Registration Payment ID# %1$d.',
+									'event_espresso'
+								),
+								$registration_payment->ID()
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'An invalid Registration Payment object was associated with payment ID# %1$d.',
+								'event_espresso'
+							),
+							$payment->ID()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		if ($save_payment) {
+			$payment->save();
+		}
+		return true;
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @deprecated 4.9.1
+	 * @param EE_Transaction $transaction
+	 * @param    boolean     $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction::update_status_based_on_total_paid()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		return $transaction->update_status_based_on_total_paid($update_txn);
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
 }