eventespresso / event-espresso-core

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_Processor.class.php

Indentation +944 added lines, -944 removed lines

@@ -17,948 +17,948 @@
 class EE_Transaction_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
-     *
-     * @var array $registration_query_params
-     * @access private
-     */
-    private $_registration_query_params = array();
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param array $registration_query_params
-     * @return EE_Transaction_Processor instance
-     */
-    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);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    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);
-    }
-
-
-    /**
-     * @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'));
-    }
-
-
-    /**
-     * manually_update_registration_statuses
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $new_reg_status
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function manually_update_registration_statuses(
-        EE_Transaction $transaction,
-        $new_reg_status = '',
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'manually_update_registration_status',
-            $transaction,
-            $registration_query_params,
-            $new_reg_status
-        );
-        // 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(),
-            array('manually_updated' => true)
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_for_default_approved_events(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_for_default_approved_events',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_if_no_monies_owing(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_if_no_monies_owing',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * 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
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $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');
-            $finalized = true;
-        }
-        $transaction->save();
-        // array of details to aid in decision making by systems
-        $update_params = array(
-            'old_txn_status'  => $transaction->old_txn_status(),
-            'new_txn_status'  => $transaction->status_ID(),
-            'finalized'       => $finalized,
-            'revisit'         => $this->_revisit,
-            'payment_updates' => $payment instanceof EE_Payment ? true : false,
-            'last_payment'    => $payment,
-        );
-        // now update the registrations and add the results to our $update_params
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
-            'update_registration_after_checkout_or_payment',
-            $transaction,
-            $this->_registration_query_params,
-            $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(
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
-            $transaction,
-            $update_params
-        );
-        return $update_params;
-    }
-
-
-    /**
-     * 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(),
-        $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)) {
-            return false;
-        }
-        try {
-            $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) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? $success : false;
-        }
-        return $success;
-    }
-
-
-    /**
-     * update_transaction_after_canceled_or_declined_registration
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_canceled_or_declined_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = array(),
-        $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)) {
-            return false;
-        }
-        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);
-            }
-        } 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'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * get_transaction_for_registration
-     *
-     * @access    public
-     * @param    EE_Registration $registration
-     * @return    EE_Transaction
-     * @throws    EE_Error
-     */
-    public function get_transaction_for_registration(EE_Registration $registration)
-    {
-        $transaction = $registration->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'),
-                    $registration->ID()
-                )
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction_registration
-     *
-     * @access    public
-     * @param    EE_Transaction  $transaction
-     * @param    EE_Registration $registration
-     * @return    EE_Line_Item
-     * @throws    EE_Error
-     */
-    public function get_ticket_line_item_for_transaction_registration(
-        EE_Transaction $transaction,
-        EE_Registration $registration
-    ) {
-        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) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID(),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        return $ticket_line_item;
-    }
-
-
-    /**
-     * cancel_transaction_if_all_registrations_canceled
-     * cycles thru related registrations and checks their statuses
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @param    string         $new_TXN_status
-     * @param    array          $registration_query_params - array of query WHERE params to use when
-     *                                                     retrieving cached registrations from a transaction
-     * @param    array          $closed_reg_statuses
-     * @param    bool           $update_txn
-     * @return    bool            true if TXN status was updated, false if not
-     */
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
-        EE_Transaction $transaction,
-        $new_TXN_status = '',
-        $registration_query_params = array(),
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $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();
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if ($registration instanceof EE_Registration
-                && ! 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 ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _call_method_on_registrations_via_Registration_Processor
-     * cycles thru related registrations and calls the requested method on each
-     *
-     * @access private
-     * @param string         $method_name
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @param string         $additional_param
-     * @throws \EE_Error
-     * @return boolean
-     */
-    private function _call_method_on_registrations_via_Registration_Processor(
-        $method_name,
-        EE_Transaction $transaction,
-        $registration_query_params = array(),
-        $additional_param = null
-    ) {
-        $response = false;
-        /** @type EE_Registration_Processor $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'));
-        }
-        // make sure some query params are set for retrieving registrations
-        $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)
-                        ? true
-                        : $response;
-                } else {
-                    $response = $registration_processor->{$method_name}($registration)
-                        ? true
-                        : $response;
-                }
-            }
-        }
-        return $response;
-    }
-
-
-    /**
-     * set_transaction_payment_method_based_on_registration_statuses
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
-     *        the first "default" Payment Method
-     *        the first active Payment Method
-     *    whichever is found first.
-     *
-     * @param  EE_Registration $edited_registration
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_transaction_payment_method_based_on_registration_statuses(
-        EE_Registration $edited_registration
-    ) {
-        if ($edited_registration instanceof EE_Registration) {
-            $transaction = $edited_registration->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $all_not_approved = true;
-                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);
-                    $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)) {
-                        $PMD_ID = 0;
-                        foreach ($available_payment_methods as $available_payment_method) {
-                            if ($available_payment_method instanceof EE_Payment_Method
-                                && $available_payment_method->open_by_default()
-                            ) {
-                                $PMD_ID = $available_payment_method->ID();
-                                break;
-                            }
-                        }
-                        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'
-                                    ),
-                                    __FILE__,
-                                    __LINE__,
-                                    __FUNCTION__
-                                );
-                            }
-                        }
-                        $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'
-                            ),
-                            __FILE__,
-                            __LINE__,
-                            __FUNCTION__
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * @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;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @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;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $exception
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except_final_step();
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $reg_step_slug
-     * @return boolean | int
-     */
-    public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean | int
-     */
-    public function final_reg_step_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->final_reg_step_completed();
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_initiated($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_not_completed($reg_step_slug);
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return void
-     */
-    public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        $transaction->remove_reg_step($reg_step_slug);
-    }
-
-
-    /**
-     *    toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param EE_Transaction $transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_failed_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_failed_transaction_status();
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param  EE_Transaction $transaction
-     * @return boolean
-     */
-    public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_abandoned_transaction_status();
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
+	 *
+	 * @var array $registration_query_params
+	 * @access private
+	 */
+	private $_registration_query_params = array();
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param array $registration_query_params
+	 * @return EE_Transaction_Processor instance
+	 */
+	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);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	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);
+	}
+
+
+	/**
+	 * @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'));
+	}
+
+
+	/**
+	 * manually_update_registration_statuses
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_reg_status
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function manually_update_registration_statuses(
+		EE_Transaction $transaction,
+		$new_reg_status = '',
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'manually_update_registration_status',
+			$transaction,
+			$registration_query_params,
+			$new_reg_status
+		);
+		// 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(),
+			array('manually_updated' => true)
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_for_default_approved_events(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_for_default_approved_events',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_if_no_monies_owing(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_if_no_monies_owing',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * 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
+	) {
+		// make sure some query params are set for retrieving registrations
+		$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');
+			$finalized = true;
+		}
+		$transaction->save();
+		// array of details to aid in decision making by systems
+		$update_params = array(
+			'old_txn_status'  => $transaction->old_txn_status(),
+			'new_txn_status'  => $transaction->status_ID(),
+			'finalized'       => $finalized,
+			'revisit'         => $this->_revisit,
+			'payment_updates' => $payment instanceof EE_Payment ? true : false,
+			'last_payment'    => $payment,
+		);
+		// now update the registrations and add the results to our $update_params
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
+			'update_registration_after_checkout_or_payment',
+			$transaction,
+			$this->_registration_query_params,
+			$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(
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
+			$transaction,
+			$update_params
+		);
+		return $update_params;
+	}
+
+
+	/**
+	 * 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(),
+		$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)) {
+			return false;
+		}
+		try {
+			$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) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? $success : false;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * update_transaction_after_canceled_or_declined_registration
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_canceled_or_declined_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = array(),
+		$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)) {
+			return false;
+		}
+		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);
+			}
+		} 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'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * get_transaction_for_registration
+	 *
+	 * @access    public
+	 * @param    EE_Registration $registration
+	 * @return    EE_Transaction
+	 * @throws    EE_Error
+	 */
+	public function get_transaction_for_registration(EE_Registration $registration)
+	{
+		$transaction = $registration->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'),
+					$registration->ID()
+				)
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction_registration
+	 *
+	 * @access    public
+	 * @param    EE_Transaction  $transaction
+	 * @param    EE_Registration $registration
+	 * @return    EE_Line_Item
+	 * @throws    EE_Error
+	 */
+	public function get_ticket_line_item_for_transaction_registration(
+		EE_Transaction $transaction,
+		EE_Registration $registration
+	) {
+		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) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$transaction->ID(),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		return $ticket_line_item;
+	}
+
+
+	/**
+	 * cancel_transaction_if_all_registrations_canceled
+	 * cycles thru related registrations and checks their statuses
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @param    string         $new_TXN_status
+	 * @param    array          $registration_query_params - array of query WHERE params to use when
+	 *                                                     retrieving cached registrations from a transaction
+	 * @param    array          $closed_reg_statuses
+	 * @param    bool           $update_txn
+	 * @return    bool            true if TXN status was updated, false if not
+	 */
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
+		EE_Transaction $transaction,
+		$new_TXN_status = '',
+		$registration_query_params = array(),
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$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();
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration
+				&& ! 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 ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _call_method_on_registrations_via_Registration_Processor
+	 * cycles thru related registrations and calls the requested method on each
+	 *
+	 * @access private
+	 * @param string         $method_name
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @param string         $additional_param
+	 * @throws \EE_Error
+	 * @return boolean
+	 */
+	private function _call_method_on_registrations_via_Registration_Processor(
+		$method_name,
+		EE_Transaction $transaction,
+		$registration_query_params = array(),
+		$additional_param = null
+	) {
+		$response = false;
+		/** @type EE_Registration_Processor $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'));
+		}
+		// make sure some query params are set for retrieving registrations
+		$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)
+						? true
+						: $response;
+				} else {
+					$response = $registration_processor->{$method_name}($registration)
+						? true
+						: $response;
+				}
+			}
+		}
+		return $response;
+	}
+
+
+	/**
+	 * set_transaction_payment_method_based_on_registration_statuses
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
+	 *        the first "default" Payment Method
+	 *        the first active Payment Method
+	 *    whichever is found first.
+	 *
+	 * @param  EE_Registration $edited_registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_payment_method_based_on_registration_statuses(
+		EE_Registration $edited_registration
+	) {
+		if ($edited_registration instanceof EE_Registration) {
+			$transaction = $edited_registration->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$all_not_approved = true;
+				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);
+					$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)) {
+						$PMD_ID = 0;
+						foreach ($available_payment_methods as $available_payment_method) {
+							if ($available_payment_method instanceof EE_Payment_Method
+								&& $available_payment_method->open_by_default()
+							) {
+								$PMD_ID = $available_payment_method->ID();
+								break;
+							}
+						}
+						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'
+									),
+									__FILE__,
+									__LINE__,
+									__FUNCTION__
+								);
+							}
+						}
+						$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'
+							),
+							__FILE__,
+							__LINE__,
+							__FUNCTION__
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * @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;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @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;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $exception
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except_final_step();
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $reg_step_slug
+	 * @return boolean | int
+	 */
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean | int
+	 */
+	public function final_reg_step_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->final_reg_step_completed();
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_initiated($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return void
+	 */
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		$transaction->remove_reg_step($reg_step_slug);
+	}
+
+
+	/**
+	 *    toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param EE_Transaction $transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_failed_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_failed_transaction_status();
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param  EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_abandoned_transaction_status();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -53,7 +53,7 @@ 
     public static function instance($registration_query_params = array())
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
             self::$_instance = new self($registration_query_params);
         }
         return self::$_instance;
@@ -311,7 +311,7 @@ 
         // 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)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         try {
@@ -363,7 +363,7 @@ 
     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'),
@@ -393,7 +393,7 @@ 
             $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(
                     __(
@@ -476,7 +476,7 @@ 
         /** @type EE_Registration_Processor $registration_processor */
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
         // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
+        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
@@ -534,7 +534,7 @@ 
                         $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) {
                             if ($available_payment_method instanceof EE_Payment_Method
@@ -544,7 +544,7 @@ 
                                 break;
                             }
                         }
-                        if (! $PMD_ID) {
+                        if ( ! $PMD_ID) {
                             $first_payment_method = reset($available_payment_methods);
                             if ($first_payment_method instanceof EE_Payment_Method) {
                                 $PMD_ID = $first_payment_method->ID();

Doc Comments +1 added lines

@@ -185,6 +185,7 @@
      *                                                         when retrieving cached registrations from a transaction
      * @param bool               $trigger_notifications        whether or not to call
      *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+     * @param EE_Base_Class $payment
      * @return array
      * @throws \EE_Error
      */

core/admin/EE_Help_Tour_final_stop.class.php

Indentation +43 added lines, -43 removed lines

@@ -15,51 +15,51 @@
 class EE_Help_Tour_final_stop extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Final Stop Tour', 'event_espresso');
-        $this->_slug = 'final-stop-tour';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Final Stop Tour', 'event_espresso');
+		$this->_slug = 'final-stop-tour';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'id'          => 'contextual-help-link',
-                'content'     => $this->_end(),
-                'button_text' => __('Quit', 'event_espresso'),
-                'options'     => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -20,
-                    'tipAdjustmentX' => 10,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'id'          => 'contextual-help-link',
+				'content'     => $this->_end(),
+				'button_text' => __('Quit', 'event_espresso'),
+				'options'     => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -20,
+					'tipAdjustmentX' => 10,
+				),
+			),
+		);
+	}
 
 
-    /**
-     * This is the default last stop for all tours that is displayed at the end of a tour OR when a tour is exited for
-     * the first time.
-     *
-     * @return string
-     */
-    protected function _end()
-    {
-        $query_args = array(
-            'action' => 'admin_option_settings',
-            'page'   => 'espresso_general_settings',
-        );
-        return '<p>'
-               . sprintf(
-                   __(
-                       'That\'s it for the tour!  At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons.  There are help tours available on all Event Espresso Admin pages.  If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!',
-                       'event_espresso'
-                   ),
-                   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
-                   '</a>'
-               )
-               . '</p>';
-    }
+	/**
+	 * This is the default last stop for all tours that is displayed at the end of a tour OR when a tour is exited for
+	 * the first time.
+	 *
+	 * @return string
+	 */
+	protected function _end()
+	{
+		$query_args = array(
+			'action' => 'admin_option_settings',
+			'page'   => 'espresso_general_settings',
+		);
+		return '<p>'
+			   . sprintf(
+				   __(
+					   'That\'s it for the tour!  At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons.  There are help tours available on all Event Espresso Admin pages.  If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!',
+					   'event_espresso'
+				   ),
+				   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
+				   '</a>'
+			   )
+			   . '</p>';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
                        'That\'s it for the tour!  At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons.  There are help tours available on all Event Espresso Admin pages.  If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!',
                        'event_espresso'
                    ),
-                   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
+                   '<a href="'.EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')).'">',
                    '</a>'
                )
                . '</p>';

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +627 added lines, -627 removed lines

@@ -12,631 +12,631 @@
 abstract class EE_SPCO_Reg_Step
 {
 
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = array();
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-    /**
-     * @return string
-     */
-    abstract public function generate_reg_form();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
-
-
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
-
-
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    __('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    __('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
-
-
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function template()
-    {
-        return $this->_template;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-        // hidden inputs for frontend registrations
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                'subsections'     => array(
-                    'action'         => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
-                            'default'   => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                                empty($this->checkout->reg_url_link)
-                                    ? 'process_reg_step'
-                                    : 'update_reg_step',
-                                $this
-                            ),
-                        )
-                    ),
-                    'next_step'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                            'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                ? $this->checkout->next_step->slug()
-                                : '',
-                        )
-                    ),
-                    'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'e_reg_url_link',
-                            'html_id'   => 'spco-reg_url_link',
-                            'default'   => $this->checkout->reg_url_link,
-                        )
-                    ),
-                    'revisit'        => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'revisit',
-                            'html_id'   => 'spco-revisit',
-                            'default'   => $this->checkout->revisit,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = array())
-    {
-        $actions = array_merge(
-            array(
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ),
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if (EE_Registry::instance()->REQ->ajax) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $sbmt_btn = new EE_Submit_Input(
-            array(
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $this->submit_button_text(),
-            )
-        );
-        $sbmt_btn->set_button_css_attributes(true, 'large');
-        $sbmt_btn_html = $sbmt_btn->get_html_for_input();
-        $html .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
-    }
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = array();
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+	/**
+	 * @return string
+	 */
+	abstract public function generate_reg_form();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
+
+
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
+
+
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
+
+
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function template()
+	{
+		return $this->_template;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = array('step' => $this->slug());
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'next_step' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							)
+						),
+					),
+				)
+			);
+		}
+		// hidden inputs for frontend registrations
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+				'subsections'     => array(
+					'action'         => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'action',
+							'html_id'   => 'spco-' . $this->slug() . '-action',
+							'default'   => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+								empty($this->checkout->reg_url_link)
+									? 'process_reg_step'
+									: 'update_reg_step',
+								$this
+							),
+						)
+					),
+					'next_step'      => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'next_step',
+							'html_id'   => 'spco-' . $this->slug() . '-next-step',
+							'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+								? $this->checkout->next_step->slug()
+								: '',
+						)
+					),
+					'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'e_reg_url_link',
+							'html_id'   => 'spco-reg_url_link',
+							'default'   => $this->checkout->reg_url_link,
+						)
+					),
+					'revisit'        => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'revisit',
+							'html_id'   => 'spco-revisit',
+							'default'   => $this->checkout->revisit,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = array())
+	{
+		$actions = array_merge(
+			array(
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			),
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if (EE_Registry::instance()->REQ->ajax) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$sbmt_btn = new EE_Submit_Input(
+			array(
+				'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_class'            => 'spco-next-step-btn',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $this->submit_button_text(),
+			)
+		);
+		$sbmt_btn->set_button_css_attributes(true, 'large');
+		$sbmt_btn_html = $sbmt_btn->get_html_for_input();
+		$html .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -221,7 +221,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -379,7 +379,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -403,7 +403,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -433,12 +433,12 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'next_step' => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -452,12 +452,12 @@ 
         return new EE_Form_Section_Proper(
             array(
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                 'subsections'     => array(
                     'action'         => new EE_Fixed_Hidden_Input(
                         array(
                             'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
+                            'html_id'   => 'spco-'.$this->slug().'-action',
                             'default'   => apply_filters(
                                 'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
                                 empty($this->checkout->reg_url_link)
@@ -470,7 +470,7 @@ 
                     'next_step'      => new EE_Fixed_Hidden_Input(
                         array(
                             'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                            'html_id'   => 'spco-'.$this->slug().'-next-step',
                             'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                 ? $this->checkout->next_step->slug()
                                 : '',
@@ -547,7 +547,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -561,10 +561,10 @@ 
         // generate submit button
         $sbmt_btn = new EE_Submit_Input(
             array(
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+                'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+                'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
                 'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $this->submit_button_text(),
             )
         );
@@ -572,7 +572,7 @@ 
         $sbmt_btn_html = $sbmt_btn->get_html_for_input();
         $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

modules/single_page_checkout/reg_steps/finalize_registration/EE_SPCO_Reg_Step_Finalize_Registration.class.php

Spacing +4 added lines, -4 removed lines

@@ -92,14 +92,14 @@ 
             $txn_update_params
         );
         // check if transaction has a primary registrant and that it has a related Attendee object
-        if (! $this->_validate_primary_registrant()) {
+        if ( ! $this->_validate_primary_registrant()) {
             return false;
         }
         // you don't have to go home but you can't stay here !
         $this->checkout->redirect = true;
         $this->checkout->continue_reg = true;
         $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-        if (! (
+        if ( ! (
             $this->checkout->payment_method instanceof EE_Payment_Method
             && $this->checkout->payment_method->is_off_site()
         )) {
@@ -210,7 +210,7 @@ 
      */
     protected function _validate_primary_registrant()
     {
-        if (! $this->checkout->transaction_has_primary_registrant()) {
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
             EE_Error::add_error(
                 __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
                 __FILE__,
@@ -236,7 +236,7 @@ 
     public function update_reg_step()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FILE__,
+            __CLASS__.'::'.__FILE__,
             __(
                 'Can not call update_reg_step() on the Finalize Registration reg step.',
                 'event_espresso'

Indentation +236 added lines, -236 removed lines

@@ -12,240 +12,240 @@
 class EE_SPCO_Reg_Step_Finalize_Registration extends EE_SPCO_Reg_Step
 {
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug = 'finalize_registration';
-        $this->_name = __('Finalize Registration', 'event_espresso');
-        $this->_submit_button_text = $this->_name;
-        $this->_template = '';
-        $this->checkout = $checkout;
-    }
-
-
-    public function translate_js_strings()
-    {
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        // there's actually no reg form to process if this is the final step
-        if ($this->is_current_step()) {
-            $this->checkout->step = $_REQUEST['step'] = $this->slug();
-            $this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
-            $this->checkout->generate_reg_form = false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function generate_reg_form()
-    {
-        // create empty form so that things don't break
-        $this->reg_form = new EE_Form_Section_Proper();
-        return '';
-    }
-
-
-    /**
-     * @return boolean
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function process_reg_step()
-    {
-        // ensure all data gets refreshed from the db
-        $this->checkout->refresh_all_entities(true);
-        // ensures that all details and statuses for transaction, registration, and payments are updated
-        $txn_update_params = $this->_finalize_transaction();
-        // maybe send messages
-        $this->_set_notification_triggers();
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $this->checkout->transaction->primary_registration(),
-            $txn_update_params
-        );
-        // set a hook point
-        do_action(
-            'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-            $this->checkout,
-            $txn_update_params
-        );
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        if (! $this->_validate_primary_registrant()) {
-            return false;
-        }
-        // you don't have to go home but you can't stay here !
-        $this->checkout->redirect = true;
-        $this->checkout->continue_reg = true;
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-        if (! (
-            $this->checkout->payment_method instanceof EE_Payment_Method
-            && $this->checkout->payment_method->is_off_site()
-        )) {
-            // mark this reg step as completed
-            $this->set_completed();
-        }
-        $this->checkout->set_exit_spco();
-        return true;
-    }
-
-
-    /**
-     * _finalize_transaction
-     * ensures that all details and statuses for transaction, registration, and payments are updated
-     *
-     * @return array
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    protected function _finalize_transaction()
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag in txn processor
-        $transaction_processor->set_revisit($this->checkout->revisit);
-        // at this point we'll consider a TXN to not have been abandoned
-        $this->checkout->transaction->toggle_abandoned_transaction_status();
-        if ($this->checkout->cart instanceof EE_Cart) {
-            // save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $this->checkout->transaction->update_status_based_on_total_paid(false);
-        // this will result in the base session properties getting saved to the TXN_Session_data field
-        $session_data = EE_Registry::instance()->SSN->get_session_data(null, true);
-        // anonymize the last part of the IP address, now that the transaction is complete (we won't be using the IP address
-        // for spam or bot detection now)
-        if (function_exists('wp_privacy_anonymize_ip') && isset($session_data['ip_address'])) {
-            $session_data['ip_address'] = wp_privacy_anonymize_ip($session_data['ip_address']);
-        }
-        $this->checkout->transaction->set_txn_session_data($session_data);
-        // update the TXN if payment conditions have changed, but do NOT trigger notifications,
-        // because we will do that in process_reg_step() after setting some more triggers
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->checkout->transaction,
-            $this->checkout->payment,
-            $this->checkout->reg_cache_where_params,
-            false
-        );
-    }
-
-
-    /**
-     * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected...
-     * OR
-     * if it IS a revisit and the TXN and/or one or more REG statuses have changed...
-     * then trigger notifications
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_notification_triggers()
-    {
-
-        if ($this->checkout->payment_method instanceof EE_Payment_Method) {
-            // let's start with the assumption that we need to trigger notifications
-            // then toggle this to false for conditions where we know we don't need to
-            $deliver_notifications = true;
-            if (// if SPCO revisit
-                filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
-                // and TXN or REG statuses have NOT changed due to a payment
-                && ! (
-                    $this->checkout->transaction->txn_status_updated()
-                    || $this->checkout->any_reg_status_updated()
-                )
-            ) {
-                $deliver_notifications = false;
-            }
-            if ($this->checkout->payment_method->is_off_site()) {
-                /** @var EE_Gateway $gateway */
-                $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-                // and the gateway uses a separate request to process the IPN
-                if ($gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
-                ) {
-                    // IPN request will handle triggering notifications
-                    $deliver_notifications = false;
-                    // no really... don't send any notices in this request
-                    remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
-                    add_filter(
-                        'FHEE__EED_Messages___maybe_registration__deliver_notifications',
-                        '__return_false',
-                        15
-                    );
-                }
-            }
-            if ($deliver_notifications) {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-        }
-    }
-
-
-    /**
-     * check if transaction has a primary registrant and that it has a related Attendee object
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _validate_primary_registrant()
-    {
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            EE_Error::add_error(
-                __('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->checkout->redirect = false;
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        // setup URL for redirect
-        $this->checkout->redirect_url = add_query_arg(
-            array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
-            $this->checkout->thank_you_page_url
-        );
-        return true;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function update_reg_step()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FILE__,
-            __(
-                'Can not call update_reg_step() on the Finalize Registration reg step.',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug = 'finalize_registration';
+		$this->_name = __('Finalize Registration', 'event_espresso');
+		$this->_submit_button_text = $this->_name;
+		$this->_template = '';
+		$this->checkout = $checkout;
+	}
+
+
+	public function translate_js_strings()
+	{
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		// there's actually no reg form to process if this is the final step
+		if ($this->is_current_step()) {
+			$this->checkout->step = $_REQUEST['step'] = $this->slug();
+			$this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
+			$this->checkout->generate_reg_form = false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function generate_reg_form()
+	{
+		// create empty form so that things don't break
+		$this->reg_form = new EE_Form_Section_Proper();
+		return '';
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function process_reg_step()
+	{
+		// ensure all data gets refreshed from the db
+		$this->checkout->refresh_all_entities(true);
+		// ensures that all details and statuses for transaction, registration, and payments are updated
+		$txn_update_params = $this->_finalize_transaction();
+		// maybe send messages
+		$this->_set_notification_triggers();
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$this->checkout->transaction->primary_registration(),
+			$txn_update_params
+		);
+		// set a hook point
+		do_action(
+			'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+			$this->checkout,
+			$txn_update_params
+		);
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		if (! $this->_validate_primary_registrant()) {
+			return false;
+		}
+		// you don't have to go home but you can't stay here !
+		$this->checkout->redirect = true;
+		$this->checkout->continue_reg = true;
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+		if (! (
+			$this->checkout->payment_method instanceof EE_Payment_Method
+			&& $this->checkout->payment_method->is_off_site()
+		)) {
+			// mark this reg step as completed
+			$this->set_completed();
+		}
+		$this->checkout->set_exit_spco();
+		return true;
+	}
+
+
+	/**
+	 * _finalize_transaction
+	 * ensures that all details and statuses for transaction, registration, and payments are updated
+	 *
+	 * @return array
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	protected function _finalize_transaction()
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag in txn processor
+		$transaction_processor->set_revisit($this->checkout->revisit);
+		// at this point we'll consider a TXN to not have been abandoned
+		$this->checkout->transaction->toggle_abandoned_transaction_status();
+		if ($this->checkout->cart instanceof EE_Cart) {
+			// save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$this->checkout->transaction->update_status_based_on_total_paid(false);
+		// this will result in the base session properties getting saved to the TXN_Session_data field
+		$session_data = EE_Registry::instance()->SSN->get_session_data(null, true);
+		// anonymize the last part of the IP address, now that the transaction is complete (we won't be using the IP address
+		// for spam or bot detection now)
+		if (function_exists('wp_privacy_anonymize_ip') && isset($session_data['ip_address'])) {
+			$session_data['ip_address'] = wp_privacy_anonymize_ip($session_data['ip_address']);
+		}
+		$this->checkout->transaction->set_txn_session_data($session_data);
+		// update the TXN if payment conditions have changed, but do NOT trigger notifications,
+		// because we will do that in process_reg_step() after setting some more triggers
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->checkout->transaction,
+			$this->checkout->payment,
+			$this->checkout->reg_cache_where_params,
+			false
+		);
+	}
+
+
+	/**
+	 * If request is not a revisit, and an Off-Site gateway using IPNs has NOT been selected...
+	 * OR
+	 * if it IS a revisit and the TXN and/or one or more REG statuses have changed...
+	 * then trigger notifications
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_notification_triggers()
+	{
+
+		if ($this->checkout->payment_method instanceof EE_Payment_Method) {
+			// let's start with the assumption that we need to trigger notifications
+			// then toggle this to false for conditions where we know we don't need to
+			$deliver_notifications = true;
+			if (// if SPCO revisit
+				filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
+				// and TXN or REG statuses have NOT changed due to a payment
+				&& ! (
+					$this->checkout->transaction->txn_status_updated()
+					|| $this->checkout->any_reg_status_updated()
+				)
+			) {
+				$deliver_notifications = false;
+			}
+			if ($this->checkout->payment_method->is_off_site()) {
+				/** @var EE_Gateway $gateway */
+				$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+				// and the gateway uses a separate request to process the IPN
+				if ($gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
+				) {
+					// IPN request will handle triggering notifications
+					$deliver_notifications = false;
+					// no really... don't send any notices in this request
+					remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
+					add_filter(
+						'FHEE__EED_Messages___maybe_registration__deliver_notifications',
+						'__return_false',
+						15
+					);
+				}
+			}
+			if ($deliver_notifications) {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+		}
+	}
+
+
+	/**
+	 * check if transaction has a primary registrant and that it has a related Attendee object
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _validate_primary_registrant()
+	{
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			EE_Error::add_error(
+				__('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->checkout->redirect = false;
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		// setup URL for redirect
+		$this->checkout->redirect_url = add_query_arg(
+			array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
+			$this->checkout->thank_you_page_url
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function update_reg_step()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FILE__,
+			__(
+				'Can not call update_reg_step() on the Finalize Registration reg step.',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+	}
 }

admin_pages/registrations/help_tours/Event_Checkin_Help_Tour.class.php

Indentation +266 added lines, -266 removed lines

@@ -15,289 +15,289 @@
 class Event_Checkin_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Event Check-in Tour', 'event_espresso');
-        if (isset($this->_req_data['event_id'])) {
-            $this->_slug = 'event-checkin-overview-joyride';
-        } else {
-            $this->_slug = 'all-event-checkin-overview-joyride';
-        }
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Event Check-in Tour', 'event_espresso');
+		if (isset($this->_req_data['event_id'])) {
+			$this->_slug = 'event-checkin-overview-joyride';
+		} else {
+			$this->_slug = 'all-event-checkin-overview-joyride';
+		}
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10  => array(
-                'content' => $this->_start(),
-            ),
-            20  => array(
-                'id'      => '_REG_count',
-                'content' => $this->_reg_count_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            30  => array(
-                'id'      => 'ATT_name',
-                'content' => $this->_attendee_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            40  => array(
-                'id'      => 'ATT_email',
-                'content' => $this->_attendee_email_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            50  => array(
-                'id'      => '_REG_date',
-                'content' => $this->_reg_date_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            60  => array(
-                'id'      => '_REG_code',
-                'content' => $this->_reg_code_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            80  => array(
-                'id'      => '_REG_final_price',
-                'content' => $this->_reg_final_price_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -20,
-                ),
-            ),
-            90  => array(
-                'id'      => 'TXN_paid',
-                'content' => $this->_txn_paid_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            100 => array(
-                'id'      => 'TXN_total',
-                'content' => $this->_txn_total_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            110 => array(
-                'id'      => 'PRC_name',
-                'content' => $this->_prc_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -50,
-                ),
-            ),
-            115 => array(
-                'id'      => 'actions',
-                'content' => $this->_actions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentX' => 0,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            120 => array(
-                'class'   => 'ee-list-table-legend-container',
-                'content' => $this->_legend_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 15,
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            125 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulkactions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            130 => array(
-                'id'      => 'event_id',
-                'content' => $this->_event_selector_stop(),
-                'options' => array(
-                    'tipLocation'    => 'right',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => 25,
-                ),
-            ),
-            135 => array(
-                'id'      => 'DTT_ID',
-                'content' => $this->_dtt_selector_stop(),
-                'options' => array(
-                    'tipLocation'    => 'bottom',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 15,
-                ),
-            ),
-            140 => array(
-                'id'      => 'event-espresso_page_espresso_registrations-search-input',
-                'content' => $this->_search_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10  => array(
+				'content' => $this->_start(),
+			),
+			20  => array(
+				'id'      => '_REG_count',
+				'content' => $this->_reg_count_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			30  => array(
+				'id'      => 'ATT_name',
+				'content' => $this->_attendee_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			40  => array(
+				'id'      => 'ATT_email',
+				'content' => $this->_attendee_email_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			50  => array(
+				'id'      => '_REG_date',
+				'content' => $this->_reg_date_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			60  => array(
+				'id'      => '_REG_code',
+				'content' => $this->_reg_code_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			80  => array(
+				'id'      => '_REG_final_price',
+				'content' => $this->_reg_final_price_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -20,
+				),
+			),
+			90  => array(
+				'id'      => 'TXN_paid',
+				'content' => $this->_txn_paid_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			100 => array(
+				'id'      => 'TXN_total',
+				'content' => $this->_txn_total_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			110 => array(
+				'id'      => 'PRC_name',
+				'content' => $this->_prc_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -50,
+				),
+			),
+			115 => array(
+				'id'      => 'actions',
+				'content' => $this->_actions_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentX' => 0,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			120 => array(
+				'class'   => 'ee-list-table-legend-container',
+				'content' => $this->_legend_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 15,
+					'tipAdjustmentY' => -40,
+				),
+			),
+			125 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulkactions_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			130 => array(
+				'id'      => 'event_id',
+				'content' => $this->_event_selector_stop(),
+				'options' => array(
+					'tipLocation'    => 'right',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => 25,
+				),
+			),
+			135 => array(
+				'id'      => 'DTT_ID',
+				'content' => $this->_dtt_selector_stop(),
+				'options' => array(
+					'tipLocation'    => 'bottom',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 15,
+				),
+			),
+			140 => array(
+				'id'      => 'event-espresso_page_espresso_registrations-search-input',
+				'content' => $this->_search_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
-        if (isset($this->_req_data['event_id'])) {
-            $content .= '<p>'
-                        . __(
-                            'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
-                            'event_espresso'
-                        ) . '</p>';
-        } else {
-            $content .= '<p>'
-                        . __(
-                            'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
-                            'event_espresso'
-                        ) . '</p>';
-        }
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
+		if (isset($this->_req_data['event_id'])) {
+			$content .= '<p>'
+						. __(
+							'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
+							'event_espresso'
+						) . '</p>';
+		} else {
+			$content .= '<p>'
+						. __(
+							'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
+							'event_espresso'
+						) . '</p>';
+		}
+		return $content;
+	}
 
-    protected function _reg_count_stop()
-    {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_count_stop()
+	{
+		return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+	}
 
-    protected function _attendee_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'View name of registrant. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _attendee_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View name of registrant. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _attendee_email_stop()
-    {
-        return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
-    }
+	protected function _attendee_email_stop()
+	{
+		return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
+	}
 
-    protected function _reg_date_stop()
-    {
-        return '<p>'
-               . __(
-                   'View registration date. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_date_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View registration date. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_code_stop()
-    {
-        return '<p>'
-               . __(
-                   'View registration code. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _reg_code_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View registration code. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _reg_final_price_stop()
-    {
-        return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _reg_final_price_stop()
+	{
+		return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _txn_paid_stop()
-    {
-        return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _txn_paid_stop()
+	{
+		return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _txn_total_stop()
-    {
-        return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
-    }
+	protected function _txn_total_stop()
+	{
+		return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
+	}
 
-    protected function _prc_name_stop()
-    {
-        return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
-    }
+	protected function _prc_name_stop()
+	{
+		return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
+	}
 
-    protected function _actions_stop()
-    {
-        return '<p>'
-               . __(
-                   'Perform an action to a registration. See legend in bottom left corner.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _actions_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Perform an action to a registration. See legend in bottom left corner.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _legend_stop()
-    {
-        return '<p>'
-               . __(
-                   'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _legend_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _bulkactions_stop()
-    {
-        return '<p>'
-               . __(
-                   'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _bulkactions_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _event_selector_stop()
-    {
-        return '<p>'
-               . __(
-                   'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _event_selector_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _dtt_selector_stop()
-    {
-        return '<p>'
-               . __(
-                   'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _dtt_selector_stop()
+	{
+		return '<p>'
+			   . __(
+				   'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _search_stop()
-    {
-        return '<p>'
-               . __(
-                   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -173,26 +173,26 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Event Check-in', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Event Check-in', 'event_espresso').'</h3>';
         if (isset($this->_req_data['event_id'])) {
             $content .= '<p>'
                         . __(
                             'This tour of the Event Check-in page will go over different areas of the screen to help you understand what they are used for.<br /><br /> Note: You are currently viewing the check-in for a specific event so you can toggle the check-in status for attendees.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         } else {
             $content .= '<p>'
                         . __(
                             'This tour of the event check-in page will go over different areas of the screen to help you understand what they are used for. <br /><br /> Note: You must select an event from the dropdown menu before you can toggle the check-in status for an attendee.',
                             'event_espresso'
-                        ) . '</p>';
+                        ).'</p>';
         }
         return $content;
     }
 
     protected function _reg_count_stop()
     {
-        return '<p>' . __('View registration number.', 'event_espresso') . '</p>';
+        return '<p>'.__('View registration number.', 'event_espresso').'</p>';
     }
 
     protected function _attendee_name_stop()
@@ -201,12 +201,12 @@ 
                . __(
                    'View name of registrant. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _attendee_email_stop()
     {
-        return '<p>' . __('View email address for a registrant.', 'event_espresso') . '</p>';
+        return '<p>'.__('View email address for a registrant.', 'event_espresso').'</p>';
     }
 
     protected function _reg_date_stop()
@@ -215,7 +215,7 @@ 
                . __(
                    'View registration date. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_code_stop()
@@ -224,27 +224,27 @@ 
                . __(
                    'View registration code. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _reg_final_price_stop()
     {
-        return '<p>' . __('View price for ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View price for ticket.', 'event_espresso').'</p>';
     }
 
     protected function _txn_paid_stop()
     {
-        return '<p>' . __('View if registrant has paid for ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View if registrant has paid for ticket.', 'event_espresso').'</p>';
     }
 
     protected function _txn_total_stop()
     {
-        return '<p>' . __('View total amount paid.', 'event_espresso') . '</p>';
+        return '<p>'.__('View total amount paid.', 'event_espresso').'</p>';
     }
 
     protected function _prc_name_stop()
     {
-        return '<p>' . __('View type of ticket.', 'event_espresso') . '</p>';
+        return '<p>'.__('View type of ticket.', 'event_espresso').'</p>';
     }
 
     protected function _actions_stop()
@@ -253,7 +253,7 @@ 
                . __(
                    'Perform an action to a registration. See legend in bottom left corner.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _legend_stop()
@@ -262,7 +262,7 @@ 
                . __(
                    'This is the legend that describes the different check-in statuses. Also shows available status for registrations.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _bulkactions_stop()
@@ -271,7 +271,7 @@ 
                . __(
                    'Perform a bulk action to multiple registrations (only available when viewing check-in for a specific event).',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _event_selector_stop()
@@ -280,7 +280,7 @@ 
                . __(
                    'Select an event from this dropdown and click the filter button to see the check-in registration list for a specific event. You will then be able to toggle the check-in status for a registration.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _dtt_selector_stop()
@@ -289,7 +289,7 @@ 
                . __(
                    'This dropdown shows you the date and time that a displayed registration is attached to. You can switch to a different event by selecting another date and clicking on the filter button. You can also switch out of this view by clicking on the reset filters button.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _search_stop()
@@ -298,6 +298,6 @@ 
                . __(
                    'Search through registrations. The following sources will be searched: Event Name, Event Description, First Name, Last Name, Biography, Email Address, Address, Comments, Notes, Registration Final Price, Registration Code, Registration Group Size, Ticket Name, and Ticket Description.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }