Completed
Branch BUG/fatal-with-paypal-debug-li... (3a6198)
by
unknown
09:03 queued 40s
created
line_item_filters/EE_Single_Registration_Line_Item_Filter.class.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -16,12 +16,12 @@
 block discarded – undo
16 16
 class EE_Single_Registration_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
17 17
 {
18 18
 
19
-    /**
20
-     *
21
-     * @param EE_Registration $registration
22
-     */
23
-    public function __construct($registration)
24
-    {
25
-        parent::__construct(array($registration));
26
-    }
19
+	/**
20
+	 *
21
+	 * @param EE_Registration $registration
22
+	 */
23
+	public function __construct($registration)
24
+	{
25
+		parent::__construct(array($registration));
26
+	}
27 27
 }
Please login to merge, or discard this patch.
line_item_filters/EE_Specific_Registrations_Line_Item_Filter.class.php 2 patches
Indentation   +167 added lines, -167 removed lines patch added patch discarded remove patch
@@ -13,182 +13,182 @@
 block discarded – undo
13 13
 class EE_Specific_Registrations_Line_Item_Filter extends EE_Line_Item_Filter_Base
14 14
 {
15 15
 
16
-    /**
17
-     * array of line item codes and their corresponding quantities for registrations
18
-     *
19
-     * @type array $_line_item_registrations
20
-     */
21
-    protected $_line_item_registrations = array();
16
+	/**
17
+	 * array of line item codes and their corresponding quantities for registrations
18
+	 *
19
+	 * @type array $_line_item_registrations
20
+	 */
21
+	protected $_line_item_registrations = array();
22 22
 
23
-    /**
24
-     * Just kept in case we want it someday. Currently unused
25
-     *
26
-     * @var EE_Registration[]
27
-     */
28
-    protected $_registrations = array();
23
+	/**
24
+	 * Just kept in case we want it someday. Currently unused
25
+	 *
26
+	 * @var EE_Registration[]
27
+	 */
28
+	protected $_registrations = array();
29 29
 
30
-    /**
31
-     * @var EE_Registration
32
-     */
33
-    protected $_current_registration;
30
+	/**
31
+	 * @var EE_Registration
32
+	 */
33
+	protected $_current_registration;
34 34
 
35
-    /**
36
-     * these reg statuses should NOT increment the line item quantity
37
-     *
38
-     * @var array
39
-     */
40
-    protected $_closed_reg_statuses = array();
35
+	/**
36
+	 * these reg statuses should NOT increment the line item quantity
37
+	 *
38
+	 * @var array
39
+	 */
40
+	protected $_closed_reg_statuses = array();
41 41
 
42 42
 
43
-    /**
44
-     * EE_Billable_Line_Item_Filter constructor.
45
-     *
46
-     * @param EE_Registration[] $registrations
47
-     * @throws EE_Error
48
-     */
49
-    public function __construct($registrations)
50
-    {
51
-        $this->_registrations = $registrations;
52
-        $this->_calculate_registrations_per_line_item_code($registrations);
53
-        // these reg statuses should NOT increment the line item quantity
54
-        $this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
55
-    }
43
+	/**
44
+	 * EE_Billable_Line_Item_Filter constructor.
45
+	 *
46
+	 * @param EE_Registration[] $registrations
47
+	 * @throws EE_Error
48
+	 */
49
+	public function __construct($registrations)
50
+	{
51
+		$this->_registrations = $registrations;
52
+		$this->_calculate_registrations_per_line_item_code($registrations);
53
+		// these reg statuses should NOT increment the line item quantity
54
+		$this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
55
+	}
56 56
 
57 57
 
58
-    /**
59
-     * sets the _line_item_registrations from the provided registrations
60
-     *
61
-     * @param EE_Registration[] $registrations
62
-     * @return void
63
-     * @throws EE_Error
64
-     */
65
-    protected function _calculate_registrations_per_line_item_code($registrations)
66
-    {
67
-        foreach ($registrations as $registration) {
68
-            $line_item_code = EEM_Line_Item::instance()->get_var(
69
-                EEM_Line_Item::instance()->line_item_for_registration_query_params(
70
-                    $registration,
71
-                    array('limit' => 1)
72
-                ),
73
-                'LIN_code'
74
-            );
75
-            if ($line_item_code) {
76
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
77
-                    $this->_line_item_registrations[ $line_item_code ] = array();
78
-                }
79
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
80
-            }
81
-        }
82
-    }
58
+	/**
59
+	 * sets the _line_item_registrations from the provided registrations
60
+	 *
61
+	 * @param EE_Registration[] $registrations
62
+	 * @return void
63
+	 * @throws EE_Error
64
+	 */
65
+	protected function _calculate_registrations_per_line_item_code($registrations)
66
+	{
67
+		foreach ($registrations as $registration) {
68
+			$line_item_code = EEM_Line_Item::instance()->get_var(
69
+				EEM_Line_Item::instance()->line_item_for_registration_query_params(
70
+					$registration,
71
+					array('limit' => 1)
72
+				),
73
+				'LIN_code'
74
+			);
75
+			if ($line_item_code) {
76
+				if (! isset($this->_line_item_registrations[ $line_item_code ])) {
77
+					$this->_line_item_registrations[ $line_item_code ] = array();
78
+				}
79
+				$this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
80
+			}
81
+		}
82
+	}
83 83
 
84 84
 
85
-    /**
86
-     * Creates a duplicate of the line item tree, except only includes billable items
87
-     * and the portion of line items attributed to billable things
88
-     *
89
-     * @param EEI_Line_Item $line_item
90
-     * @return EEI_Line_Item
91
-     * @throws EE_Error
92
-     */
93
-    public function process(EEI_Line_Item $line_item)
94
-    {
95
-        $this->_adjust_line_item_quantity($line_item);
96
-        if (! $line_item->children()) {
97
-            return $line_item;
98
-        }
99
-        // the original running total (taking ALL tickets into account)
100
-        $running_total_of_children = 0;
101
-        // the new running total (only taking the specified ticket quantities into account)
102
-        $running_total_of_children_under_consideration = 0;
103
-        // let's also track the quantity of tickets that pertain to the registrations
104
-        $total_child_ticket_quantity = 0;
105
-        foreach ($line_item->children() as $child_line_item) {
106
-            $original_li_total = $child_line_item->is_percent()
107
-                ? $running_total_of_children * $child_line_item->percent() / 100
108
-                : $child_line_item->unit_price() * $child_line_item->quantity();
109
-            $this->process($child_line_item);
110
-            // If this line item is a normal line item that isn't for a ticket,
111
-            // we want to modify its total (and unit price if not a percentage line item)
112
-            // so it reflects only that portion of the surcharge/discount shared by these registrations
113
-            if ($child_line_item->type() === EEM_Line_Item::type_line_item
114
-                && $child_line_item->OBJ_type() !== 'Ticket'
115
-            ) {
116
-                $percent_of_running_total = $running_total_of_children
117
-                    ? $original_li_total / $running_total_of_children
118
-                    : 0;
119
-                $child_line_item->set_total(
120
-                    $running_total_of_children_under_consideration * $percent_of_running_total
121
-                );
122
-                if (! $child_line_item->is_percent()) {
123
-                    $child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
124
-                }
125
-            } elseif (// make sure this item's quantity and total matches its parent
126
-                $line_item->type() === EEM_Line_Item::type_line_item
127
-                && $line_item->OBJ_type() === 'Ticket'
128
-                // but not if it's a percentage modifier
129
-                && ! $child_line_item->is_percent()
130
-                && ! (
131
-                    // or a cancellation
132
-                    $child_line_item->is_cancelled()
133
-                    && ! (
134
-                        // unless it IS a cancellation and the current registration is cancelled
135
-                        $child_line_item->is_cancelled()
136
-                        && $this->_current_registration instanceof EE_Registration
137
-                        && in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
138
-                    )
139
-                )
140
-            ) {
141
-                $child_line_item->set_quantity($line_item->quantity());
142
-                $child_line_item->set_total($child_line_item->unit_price() * $child_line_item->quantity());
143
-            }
144
-            $running_total_of_children += $original_li_total;
145
-            $running_total_of_children_under_consideration += $child_line_item->total();
146
-            if ($child_line_item->OBJ_type() === 'Ticket') {
147
-                $total_child_ticket_quantity += $child_line_item->quantity();
148
-            }
149
-        }
150
-        $line_item->set_total($running_total_of_children_under_consideration);
151
-        if ($line_item->quantity()) {
152
-            $line_item->set_unit_price($running_total_of_children_under_consideration / $line_item->quantity());
153
-        } else {
154
-            $line_item->set_unit_price(0);
155
-        }
156
-        if ($line_item->OBJ_type() === 'Event') {
157
-            $line_item->set_quantity($total_child_ticket_quantity);
158
-        }
159
-        return $line_item;
160
-    }
85
+	/**
86
+	 * Creates a duplicate of the line item tree, except only includes billable items
87
+	 * and the portion of line items attributed to billable things
88
+	 *
89
+	 * @param EEI_Line_Item $line_item
90
+	 * @return EEI_Line_Item
91
+	 * @throws EE_Error
92
+	 */
93
+	public function process(EEI_Line_Item $line_item)
94
+	{
95
+		$this->_adjust_line_item_quantity($line_item);
96
+		if (! $line_item->children()) {
97
+			return $line_item;
98
+		}
99
+		// the original running total (taking ALL tickets into account)
100
+		$running_total_of_children = 0;
101
+		// the new running total (only taking the specified ticket quantities into account)
102
+		$running_total_of_children_under_consideration = 0;
103
+		// let's also track the quantity of tickets that pertain to the registrations
104
+		$total_child_ticket_quantity = 0;
105
+		foreach ($line_item->children() as $child_line_item) {
106
+			$original_li_total = $child_line_item->is_percent()
107
+				? $running_total_of_children * $child_line_item->percent() / 100
108
+				: $child_line_item->unit_price() * $child_line_item->quantity();
109
+			$this->process($child_line_item);
110
+			// If this line item is a normal line item that isn't for a ticket,
111
+			// we want to modify its total (and unit price if not a percentage line item)
112
+			// so it reflects only that portion of the surcharge/discount shared by these registrations
113
+			if ($child_line_item->type() === EEM_Line_Item::type_line_item
114
+				&& $child_line_item->OBJ_type() !== 'Ticket'
115
+			) {
116
+				$percent_of_running_total = $running_total_of_children
117
+					? $original_li_total / $running_total_of_children
118
+					: 0;
119
+				$child_line_item->set_total(
120
+					$running_total_of_children_under_consideration * $percent_of_running_total
121
+				);
122
+				if (! $child_line_item->is_percent()) {
123
+					$child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
124
+				}
125
+			} elseif (// make sure this item's quantity and total matches its parent
126
+				$line_item->type() === EEM_Line_Item::type_line_item
127
+				&& $line_item->OBJ_type() === 'Ticket'
128
+				// but not if it's a percentage modifier
129
+				&& ! $child_line_item->is_percent()
130
+				&& ! (
131
+					// or a cancellation
132
+					$child_line_item->is_cancelled()
133
+					&& ! (
134
+						// unless it IS a cancellation and the current registration is cancelled
135
+						$child_line_item->is_cancelled()
136
+						&& $this->_current_registration instanceof EE_Registration
137
+						&& in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
138
+					)
139
+				)
140
+			) {
141
+				$child_line_item->set_quantity($line_item->quantity());
142
+				$child_line_item->set_total($child_line_item->unit_price() * $child_line_item->quantity());
143
+			}
144
+			$running_total_of_children += $original_li_total;
145
+			$running_total_of_children_under_consideration += $child_line_item->total();
146
+			if ($child_line_item->OBJ_type() === 'Ticket') {
147
+				$total_child_ticket_quantity += $child_line_item->quantity();
148
+			}
149
+		}
150
+		$line_item->set_total($running_total_of_children_under_consideration);
151
+		if ($line_item->quantity()) {
152
+			$line_item->set_unit_price($running_total_of_children_under_consideration / $line_item->quantity());
153
+		} else {
154
+			$line_item->set_unit_price(0);
155
+		}
156
+		if ($line_item->OBJ_type() === 'Event') {
157
+			$line_item->set_quantity($total_child_ticket_quantity);
158
+		}
159
+		return $line_item;
160
+	}
161 161
 
162 162
 
163
-    /**
164
-     * Adjusts quantities for line items for tickets according to the registrations provided
165
-     * in the constructor
166
-     *
167
-     * @param EEI_Line_Item $line_item
168
-     * @return EEI_Line_Item
169
-     */
170
-    protected function _adjust_line_item_quantity(EEI_Line_Item $line_item)
171
-    {
172
-        // is this a ticket ?
173
-        if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
174
-            $this->_current_registration = null;
175
-            $quantity = 0;
176
-            // if this ticket is billable at this moment, then we should have a positive quantity
177
-            if (isset($this->_line_item_registrations[ $line_item->code() ])
178
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
179
-            ) {
180
-                // set quantity based on number of open registrations for this ticket
181
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
182
-                    if ($registration instanceof EE_Registration
183
-                    ) {
184
-                        $quantity++;
185
-                        $this->_current_registration = $registration;
186
-                    }
187
-                }
188
-            }
189
-            $line_item->set_quantity($quantity);
190
-            $line_item->set_total($line_item->unit_price() * $line_item->quantity());
191
-        }
192
-        return $line_item;
193
-    }
163
+	/**
164
+	 * Adjusts quantities for line items for tickets according to the registrations provided
165
+	 * in the constructor
166
+	 *
167
+	 * @param EEI_Line_Item $line_item
168
+	 * @return EEI_Line_Item
169
+	 */
170
+	protected function _adjust_line_item_quantity(EEI_Line_Item $line_item)
171
+	{
172
+		// is this a ticket ?
173
+		if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
174
+			$this->_current_registration = null;
175
+			$quantity = 0;
176
+			// if this ticket is billable at this moment, then we should have a positive quantity
177
+			if (isset($this->_line_item_registrations[ $line_item->code() ])
178
+				&& is_array($this->_line_item_registrations[ $line_item->code() ])
179
+			) {
180
+				// set quantity based on number of open registrations for this ticket
181
+				foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
182
+					if ($registration instanceof EE_Registration
183
+					) {
184
+						$quantity++;
185
+						$this->_current_registration = $registration;
186
+					}
187
+				}
188
+			}
189
+			$line_item->set_quantity($quantity);
190
+			$line_item->set_total($line_item->unit_price() * $line_item->quantity());
191
+		}
192
+		return $line_item;
193
+	}
194 194
 }
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -73,10 +73,10 @@  discard block
 block discarded – undo
73 73
                 'LIN_code'
74 74
             );
75 75
             if ($line_item_code) {
76
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
77
-                    $this->_line_item_registrations[ $line_item_code ] = array();
76
+                if ( ! isset($this->_line_item_registrations[$line_item_code])) {
77
+                    $this->_line_item_registrations[$line_item_code] = array();
78 78
                 }
79
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
79
+                $this->_line_item_registrations[$line_item_code][$registration->ID()] = $registration;
80 80
             }
81 81
         }
82 82
     }
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
     public function process(EEI_Line_Item $line_item)
94 94
     {
95 95
         $this->_adjust_line_item_quantity($line_item);
96
-        if (! $line_item->children()) {
96
+        if ( ! $line_item->children()) {
97 97
             return $line_item;
98 98
         }
99 99
         // the original running total (taking ALL tickets into account)
@@ -119,7 +119,7 @@  discard block
 block discarded – undo
119 119
                 $child_line_item->set_total(
120 120
                     $running_total_of_children_under_consideration * $percent_of_running_total
121 121
                 );
122
-                if (! $child_line_item->is_percent()) {
122
+                if ( ! $child_line_item->is_percent()) {
123 123
                     $child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
124 124
                 }
125 125
             } elseif (// make sure this item's quantity and total matches its parent
@@ -174,11 +174,11 @@  discard block
 block discarded – undo
174 174
             $this->_current_registration = null;
175 175
             $quantity = 0;
176 176
             // if this ticket is billable at this moment, then we should have a positive quantity
177
-            if (isset($this->_line_item_registrations[ $line_item->code() ])
178
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
177
+            if (isset($this->_line_item_registrations[$line_item->code()])
178
+                && is_array($this->_line_item_registrations[$line_item->code()])
179 179
             ) {
180 180
                 // set quantity based on number of open registrations for this ticket
181
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
181
+                foreach ($this->_line_item_registrations[$line_item->code()] as $registration) {
182 182
                     if ($registration instanceof EE_Registration
183 183
                     ) {
184 184
                         $quantity++;
Please login to merge, or discard this patch.
core/libraries/line_item_display/EE_Line_Item_Display.class.php 2 patches
Indentation   +51 added lines, -51 removed lines patch added patch discarded remove patch
@@ -14,62 +14,62 @@
 block discarded – undo
14 14
 class EE_Line_Item_Display
15 15
 {
16 16
 
17
-    private $strategy = null;
17
+	private $strategy = null;
18 18
 
19 19
 
20
-    /**
21
-     * @param string $context - where/how the line items are being displayed
22
-     * @param string $other_line_item_display_strategy
23
-     */
24
-    public function __construct($context = '', $other_line_item_display_strategy = '')
25
-    {
26
-        $context = strtolower($context);
27
-        switch ($context) {
28
-            case 'invoice':
29
-                $this->strategy = new EE_Invoice_Line_Item_Display_Strategy();
30
-                break;
31
-            case 'receipt':
32
-                $this->strategy = new EE_Receipt_Line_Item_Display_Strategy();
33
-                break;
34
-            case 'spco':
35
-                $this->strategy = new EE_SPCO_Line_Item_Display_Strategy();
36
-                break;
37
-            default:
38
-                if (! empty($other_line_item_display_strategy) &&
39
-                    class_exists($other_line_item_display_strategy)
40
-                ) {
41
-                    $this->strategy = new  $other_line_item_display_strategy();
42
-                } else {
43
-                    $this->strategy = new EE_Default_Line_Item_Display_Strategy();
44
-                }
45
-        }
46
-    }
20
+	/**
21
+	 * @param string $context - where/how the line items are being displayed
22
+	 * @param string $other_line_item_display_strategy
23
+	 */
24
+	public function __construct($context = '', $other_line_item_display_strategy = '')
25
+	{
26
+		$context = strtolower($context);
27
+		switch ($context) {
28
+			case 'invoice':
29
+				$this->strategy = new EE_Invoice_Line_Item_Display_Strategy();
30
+				break;
31
+			case 'receipt':
32
+				$this->strategy = new EE_Receipt_Line_Item_Display_Strategy();
33
+				break;
34
+			case 'spco':
35
+				$this->strategy = new EE_SPCO_Line_Item_Display_Strategy();
36
+				break;
37
+			default:
38
+				if (! empty($other_line_item_display_strategy) &&
39
+					class_exists($other_line_item_display_strategy)
40
+				) {
41
+					$this->strategy = new  $other_line_item_display_strategy();
42
+				} else {
43
+					$this->strategy = new EE_Default_Line_Item_Display_Strategy();
44
+				}
45
+		}
46
+	}
47 47
 
48
-    /**
49
-     * @param EE_Line_Item $line_item
50
-     * @param array        $options
51
-     * @return mixed
52
-     */
53
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
54
-    {
55
-        return $this->strategy->display_line_item($line_item, $options);
56
-    }
48
+	/**
49
+	 * @param EE_Line_Item $line_item
50
+	 * @param array        $options
51
+	 * @return mixed
52
+	 */
53
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
54
+	{
55
+		return $this->strategy->display_line_item($line_item, $options);
56
+	}
57 57
 
58 58
 
59
-    /**
60
-     * @return float
61
-     */
62
-    public function grand_total()
63
-    {
64
-        return $this->strategy->grand_total();
65
-    }
59
+	/**
60
+	 * @return float
61
+	 */
62
+	public function grand_total()
63
+	{
64
+		return $this->strategy->grand_total();
65
+	}
66 66
 
67 67
 
68
-    /**
69
-     * @return float
70
-     */
71
-    public function total_items()
72
-    {
73
-        return $this->strategy->total_items();
74
-    }
68
+	/**
69
+	 * @return float
70
+	 */
71
+	public function total_items()
72
+	{
73
+		return $this->strategy->total_items();
74
+	}
75 75
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -35,7 +35,7 @@
 block discarded – undo
35 35
                 $this->strategy = new EE_SPCO_Line_Item_Display_Strategy();
36 36
                 break;
37 37
             default:
38
-                if (! empty($other_line_item_display_strategy) &&
38
+                if ( ! empty($other_line_item_display_strategy) &&
39 39
                     class_exists($other_line_item_display_strategy)
40 40
                 ) {
41 41
                     $this->strategy = new  $other_line_item_display_strategy();
Please login to merge, or discard this patch.
core/libraries/template_parts/EE_Template_Part_Manager.class.php 2 patches
Indentation   +191 added lines, -191 removed lines patch added patch discarded remove patch
@@ -14,195 +14,195 @@
 block discarded – undo
14 14
 class EE_Template_Part_Manager
15 15
 {
16 16
 
17
-    /**
18
-     * @param EE_Template_Part_PriorityQueue $template_parts
19
-     */
20
-    protected $template_parts;
21
-
22
-    /**
23
-     * @param array $priorities
24
-     */
25
-    protected $priorities = array();
26
-
27
-    /**
28
-     * @param int $event_desc_priority
29
-     */
30
-    protected $event_desc_priority;
31
-
32
-    /**
33
-     * @param string $before_event_content
34
-     */
35
-    protected $before_event_content;
36
-
37
-    /**
38
-     * @param string $event_content
39
-     */
40
-    protected $event_content;
41
-
42
-    /**
43
-     * @param string $after_event_content
44
-     */
45
-    protected $after_event_content;
46
-
47
-
48
-    /**
49
-     *    class constructor
50
-     */
51
-    public function __construct()
52
-    {
53
-        $this->template_parts = new EE_Template_Part_PriorityQueue();
54
-    }
55
-
56
-
57
-    /**
58
-     *    add_template_part
59
-     *
60
-     *    used for setting the details about a particular template part
61
-     *
62
-     * @param string $name     - just a simple string identifier - do NOT use 'event'
63
-     * @param string $label    - template part label displayed in admin
64
-     * @param string $template - name or path of template to be used by EEH_Template::locate_template()
65
-     * @param int    $priority - order in which template parts should be applied
66
-     */
67
-    public function add_template_part($name, $label, $template, $priority)
68
-    {
69
-        // SplPriorityQueue doesn't play nice with multiple items having the same priority
70
-        // so if the incoming priority is already occupied, then let's increment it by one,
71
-        // and then pass everything back into this method and try again with the new priority
72
-        if (isset($this->priorities[ $priority ])) {
73
-            $priority++;
74
-            $this->add_template_part($name, $label, $template, $priority);
75
-            return;
76
-        }
77
-        // kk now we can mark this priority as being occupied
78
-        $this->priorities[ $priority ] = true;
79
-        // create the template part and add to the queue
80
-        $this->template_parts->insert(
81
-            new EE_Template_Part($name, $label, $template, $priority),
82
-            $priority
83
-        );
84
-        if ($name === 'event') {
85
-            $this->event_desc_priority = $priority;
86
-        }
87
-    }
88
-
89
-
90
-    /**
91
-     *    apply_template_part_filters
92
-     *
93
-     *    adds template parts to the supplied content
94
-     *    according to the details set when the template parts were added
95
-     *
96
-     * @access public
97
-     * @param string $content
98
-     * @return string
99
-     */
100
-    public function apply_template_part_filters($content = '')
101
-    {
102
-        $this->template_parts->rewind();
103
-        // loop through template parts and position content
104
-        while ($this->template_parts->valid()) {
105
-            $this->_position_template_part(
106
-                $content,
107
-                $this->template_parts->current()->template(),
108
-                $this->template_parts->current()->priority()
109
-            );
110
-            $this->template_parts->next();
111
-        }
112
-        // now simply add our three strings of content together
113
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
114
-    }
115
-
116
-
117
-    /**
118
-     *    position_template_part
119
-     *
120
-     * based on the priority of the incoming template part
121
-     * relative to the known event description template part priority,
122
-     * this method will assign template parts to one of the following:
123
-     *        $this->before_event_content
124
-     *        $this->event_content
125
-     *        $this->after_event_content
126
-     *
127
-     * @access protected
128
-     * @param string $content
129
-     * @param string $template
130
-     * @param int    $priority
131
-     * @return void
132
-     */
133
-    protected function _position_template_part($content, $template, $priority)
134
-    {
135
-        // Event Description content is the actual incoming content itself
136
-        if ($priority === $this->event_desc_priority) {
137
-            $this->event_content = $content;
138
-        } elseif ($priority < $this->event_desc_priority) {
139
-            // everything BEFORE the Event Description
140
-            $this->before_event_content .= EEH_Template::locate_template($template);
141
-        } elseif ($priority > $this->event_desc_priority) {
142
-            // everything AFTER the Event Description
143
-            $this->after_event_content .= EEH_Template::locate_template($template);
144
-        }
145
-    }
146
-
147
-
148
-    /**
149
-     *    generate_sortable_list_of_template_parts
150
-     *
151
-     *    creates an HTML list (<ul>) with list items (<li>) for each template part,
152
-     *    in a format that can be used as a sortable list in the admin
153
-     *
154
-     * @access public
155
-     * @param string $list_css_id
156
-     * @param string $list_css_class
157
-     * @param string $list_item_css_class
158
-     * @param string $list_item_css_id_prefix
159
-     * @return string
160
-     */
161
-    public function generate_sortable_list_of_template_parts(
162
-        $list_css_id = '',
163
-        $list_css_class = '',
164
-        $list_item_css_class = '',
165
-        $list_item_css_id_prefix = ''
166
-    ) {
167
-        $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
168
-        $this->template_parts->rewind();
169
-        // loop through template parts and add template content
170
-        while ($this->template_parts->valid()) {
171
-            $event_archive_display_order .= EEH_HTML::li(
172
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
173
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
174
-                $this->template_parts->current()->label(),
175
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
176
-                $list_item_css_class
177
-            );
178
-            $this->template_parts->next();
179
-        }
180
-        $event_archive_display_order .= EEH_HTML::ulx();
181
-        return $event_archive_display_order;
182
-    }
183
-
184
-
185
-    /**
186
-     *    display_template_parts
187
-     *
188
-     * just for debugging purposes
189
-     *
190
-     * @access    public
191
-     * @return void
192
-     */
193
-    public function display_template_parts()
194
-    {
195
-        if (WP_DEBUG) {
196
-            $this->template_parts->rewind();
197
-            while ($this->template_parts->valid()) {
198
-                EEH_Debug_Tools::printr(
199
-                    $this->template_parts->current(),
200
-                    'template_part',
201
-                    __FILE__,
202
-                    __LINE__
203
-                );
204
-                $this->template_parts->next();
205
-            }
206
-        }
207
-    }
17
+	/**
18
+	 * @param EE_Template_Part_PriorityQueue $template_parts
19
+	 */
20
+	protected $template_parts;
21
+
22
+	/**
23
+	 * @param array $priorities
24
+	 */
25
+	protected $priorities = array();
26
+
27
+	/**
28
+	 * @param int $event_desc_priority
29
+	 */
30
+	protected $event_desc_priority;
31
+
32
+	/**
33
+	 * @param string $before_event_content
34
+	 */
35
+	protected $before_event_content;
36
+
37
+	/**
38
+	 * @param string $event_content
39
+	 */
40
+	protected $event_content;
41
+
42
+	/**
43
+	 * @param string $after_event_content
44
+	 */
45
+	protected $after_event_content;
46
+
47
+
48
+	/**
49
+	 *    class constructor
50
+	 */
51
+	public function __construct()
52
+	{
53
+		$this->template_parts = new EE_Template_Part_PriorityQueue();
54
+	}
55
+
56
+
57
+	/**
58
+	 *    add_template_part
59
+	 *
60
+	 *    used for setting the details about a particular template part
61
+	 *
62
+	 * @param string $name     - just a simple string identifier - do NOT use 'event'
63
+	 * @param string $label    - template part label displayed in admin
64
+	 * @param string $template - name or path of template to be used by EEH_Template::locate_template()
65
+	 * @param int    $priority - order in which template parts should be applied
66
+	 */
67
+	public function add_template_part($name, $label, $template, $priority)
68
+	{
69
+		// SplPriorityQueue doesn't play nice with multiple items having the same priority
70
+		// so if the incoming priority is already occupied, then let's increment it by one,
71
+		// and then pass everything back into this method and try again with the new priority
72
+		if (isset($this->priorities[ $priority ])) {
73
+			$priority++;
74
+			$this->add_template_part($name, $label, $template, $priority);
75
+			return;
76
+		}
77
+		// kk now we can mark this priority as being occupied
78
+		$this->priorities[ $priority ] = true;
79
+		// create the template part and add to the queue
80
+		$this->template_parts->insert(
81
+			new EE_Template_Part($name, $label, $template, $priority),
82
+			$priority
83
+		);
84
+		if ($name === 'event') {
85
+			$this->event_desc_priority = $priority;
86
+		}
87
+	}
88
+
89
+
90
+	/**
91
+	 *    apply_template_part_filters
92
+	 *
93
+	 *    adds template parts to the supplied content
94
+	 *    according to the details set when the template parts were added
95
+	 *
96
+	 * @access public
97
+	 * @param string $content
98
+	 * @return string
99
+	 */
100
+	public function apply_template_part_filters($content = '')
101
+	{
102
+		$this->template_parts->rewind();
103
+		// loop through template parts and position content
104
+		while ($this->template_parts->valid()) {
105
+			$this->_position_template_part(
106
+				$content,
107
+				$this->template_parts->current()->template(),
108
+				$this->template_parts->current()->priority()
109
+			);
110
+			$this->template_parts->next();
111
+		}
112
+		// now simply add our three strings of content together
113
+		return $this->before_event_content . $this->event_content . $this->after_event_content;
114
+	}
115
+
116
+
117
+	/**
118
+	 *    position_template_part
119
+	 *
120
+	 * based on the priority of the incoming template part
121
+	 * relative to the known event description template part priority,
122
+	 * this method will assign template parts to one of the following:
123
+	 *        $this->before_event_content
124
+	 *        $this->event_content
125
+	 *        $this->after_event_content
126
+	 *
127
+	 * @access protected
128
+	 * @param string $content
129
+	 * @param string $template
130
+	 * @param int    $priority
131
+	 * @return void
132
+	 */
133
+	protected function _position_template_part($content, $template, $priority)
134
+	{
135
+		// Event Description content is the actual incoming content itself
136
+		if ($priority === $this->event_desc_priority) {
137
+			$this->event_content = $content;
138
+		} elseif ($priority < $this->event_desc_priority) {
139
+			// everything BEFORE the Event Description
140
+			$this->before_event_content .= EEH_Template::locate_template($template);
141
+		} elseif ($priority > $this->event_desc_priority) {
142
+			// everything AFTER the Event Description
143
+			$this->after_event_content .= EEH_Template::locate_template($template);
144
+		}
145
+	}
146
+
147
+
148
+	/**
149
+	 *    generate_sortable_list_of_template_parts
150
+	 *
151
+	 *    creates an HTML list (<ul>) with list items (<li>) for each template part,
152
+	 *    in a format that can be used as a sortable list in the admin
153
+	 *
154
+	 * @access public
155
+	 * @param string $list_css_id
156
+	 * @param string $list_css_class
157
+	 * @param string $list_item_css_class
158
+	 * @param string $list_item_css_id_prefix
159
+	 * @return string
160
+	 */
161
+	public function generate_sortable_list_of_template_parts(
162
+		$list_css_id = '',
163
+		$list_css_class = '',
164
+		$list_item_css_class = '',
165
+		$list_item_css_id_prefix = ''
166
+	) {
167
+		$event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
168
+		$this->template_parts->rewind();
169
+		// loop through template parts and add template content
170
+		while ($this->template_parts->valid()) {
171
+			$event_archive_display_order .= EEH_HTML::li(
172
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
173
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
174
+				$this->template_parts->current()->label(),
175
+				$list_item_css_id_prefix . $this->template_parts->current()->name(),
176
+				$list_item_css_class
177
+			);
178
+			$this->template_parts->next();
179
+		}
180
+		$event_archive_display_order .= EEH_HTML::ulx();
181
+		return $event_archive_display_order;
182
+	}
183
+
184
+
185
+	/**
186
+	 *    display_template_parts
187
+	 *
188
+	 * just for debugging purposes
189
+	 *
190
+	 * @access    public
191
+	 * @return void
192
+	 */
193
+	public function display_template_parts()
194
+	{
195
+		if (WP_DEBUG) {
196
+			$this->template_parts->rewind();
197
+			while ($this->template_parts->valid()) {
198
+				EEH_Debug_Tools::printr(
199
+					$this->template_parts->current(),
200
+					'template_part',
201
+					__FILE__,
202
+					__LINE__
203
+				);
204
+				$this->template_parts->next();
205
+			}
206
+		}
207
+	}
208 208
 }
Please login to merge, or discard this patch.
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -69,13 +69,13 @@  discard block
 block discarded – undo
69 69
         // SplPriorityQueue doesn't play nice with multiple items having the same priority
70 70
         // so if the incoming priority is already occupied, then let's increment it by one,
71 71
         // and then pass everything back into this method and try again with the new priority
72
-        if (isset($this->priorities[ $priority ])) {
72
+        if (isset($this->priorities[$priority])) {
73 73
             $priority++;
74 74
             $this->add_template_part($name, $label, $template, $priority);
75 75
             return;
76 76
         }
77 77
         // kk now we can mark this priority as being occupied
78
-        $this->priorities[ $priority ] = true;
78
+        $this->priorities[$priority] = true;
79 79
         // create the template part and add to the queue
80 80
         $this->template_parts->insert(
81 81
             new EE_Template_Part($name, $label, $template, $priority),
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
             $this->template_parts->next();
111 111
         }
112 112
         // now simply add our three strings of content together
113
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
113
+        return $this->before_event_content.$this->event_content.$this->after_event_content;
114 114
     }
115 115
 
116 116
 
@@ -169,10 +169,10 @@  discard block
 block discarded – undo
169 169
         // loop through template parts and add template content
170 170
         while ($this->template_parts->valid()) {
171 171
             $event_archive_display_order .= EEH_HTML::li(
172
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
173
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
172
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2').
173
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2').
174 174
                 $this->template_parts->current()->label(),
175
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
175
+                $list_item_css_id_prefix.$this->template_parts->current()->name(),
176 176
                 $list_item_css_class
177 177
             );
178 178
             $this->template_parts->next();
Please login to merge, or discard this patch.
core/libraries/template_parts/EE_Template_Part.class.php 1 patch
Indentation   +108 added lines, -108 removed lines patch added patch discarded remove patch
@@ -16,112 +16,112 @@
 block discarded – undo
16 16
 {
17 17
 
18 18
 
19
-    /**
20
-     * @type string $name
21
-     */
22
-    protected $name;
23
-
24
-    /**
25
-     * @type string $label
26
-     */
27
-    protected $label;
28
-
29
-    /**
30
-     * @type string $template
31
-     */
32
-    protected $template;
33
-
34
-    /**
35
-     * @type int $priority
36
-     */
37
-    protected $priority;
38
-
39
-
40
-    /**
41
-     *    class constructor
42
-     *
43
-     * @param string $name
44
-     * @param string $label
45
-     * @param string $template
46
-     * @param int    $priority
47
-     */
48
-    public function __construct($name, $label, $template, $priority = 100)
49
-    {
50
-        $this->set_name($name);
51
-        $this->set_label($label);
52
-        $this->set_template($template);
53
-        $this->set_priority($priority);
54
-    }
55
-
56
-
57
-    /**
58
-     * @return mixed
59
-     */
60
-    public function name()
61
-    {
62
-        return $this->name;
63
-    }
64
-
65
-
66
-    /**
67
-     * @param mixed $name
68
-     */
69
-    public function set_name($name)
70
-    {
71
-        $this->name = $name;
72
-    }
73
-
74
-
75
-    /**
76
-     * @return string
77
-     */
78
-    public function label()
79
-    {
80
-        return $this->label;
81
-    }
82
-
83
-
84
-    /**
85
-     * @param string $label
86
-     */
87
-    public function set_label($label)
88
-    {
89
-        $this->label = $label;
90
-    }
91
-
92
-
93
-    /**
94
-     * @return array
95
-     */
96
-    public function template()
97
-    {
98
-        return $this->template;
99
-    }
100
-
101
-
102
-    /**
103
-     * @param string $template
104
-     */
105
-    public function set_template($template)
106
-    {
107
-        $this->template = $template;
108
-    }
109
-
110
-
111
-    /**
112
-     * @return int
113
-     */
114
-    public function priority()
115
-    {
116
-        return $this->priority;
117
-    }
118
-
119
-
120
-    /**
121
-     * @param int $priority
122
-     */
123
-    public function set_priority($priority)
124
-    {
125
-        $this->priority = intval($priority);
126
-    }
19
+	/**
20
+	 * @type string $name
21
+	 */
22
+	protected $name;
23
+
24
+	/**
25
+	 * @type string $label
26
+	 */
27
+	protected $label;
28
+
29
+	/**
30
+	 * @type string $template
31
+	 */
32
+	protected $template;
33
+
34
+	/**
35
+	 * @type int $priority
36
+	 */
37
+	protected $priority;
38
+
39
+
40
+	/**
41
+	 *    class constructor
42
+	 *
43
+	 * @param string $name
44
+	 * @param string $label
45
+	 * @param string $template
46
+	 * @param int    $priority
47
+	 */
48
+	public function __construct($name, $label, $template, $priority = 100)
49
+	{
50
+		$this->set_name($name);
51
+		$this->set_label($label);
52
+		$this->set_template($template);
53
+		$this->set_priority($priority);
54
+	}
55
+
56
+
57
+	/**
58
+	 * @return mixed
59
+	 */
60
+	public function name()
61
+	{
62
+		return $this->name;
63
+	}
64
+
65
+
66
+	/**
67
+	 * @param mixed $name
68
+	 */
69
+	public function set_name($name)
70
+	{
71
+		$this->name = $name;
72
+	}
73
+
74
+
75
+	/**
76
+	 * @return string
77
+	 */
78
+	public function label()
79
+	{
80
+		return $this->label;
81
+	}
82
+
83
+
84
+	/**
85
+	 * @param string $label
86
+	 */
87
+	public function set_label($label)
88
+	{
89
+		$this->label = $label;
90
+	}
91
+
92
+
93
+	/**
94
+	 * @return array
95
+	 */
96
+	public function template()
97
+	{
98
+		return $this->template;
99
+	}
100
+
101
+
102
+	/**
103
+	 * @param string $template
104
+	 */
105
+	public function set_template($template)
106
+	{
107
+		$this->template = $template;
108
+	}
109
+
110
+
111
+	/**
112
+	 * @return int
113
+	 */
114
+	public function priority()
115
+	{
116
+		return $this->priority;
117
+	}
118
+
119
+
120
+	/**
121
+	 * @param int $priority
122
+	 */
123
+	public function set_priority($priority)
124
+	{
125
+		$this->priority = intval($priority);
126
+	}
127 127
 }
Please login to merge, or discard this patch.
core/libraries/template_parts/EE_Template_Part_PriorityQueue.class.php 1 patch
Indentation   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -17,43 +17,43 @@
 block discarded – undo
17 17
 {
18 18
 
19 19
 
20
-    /**
21
-     * add
22
-     *
23
-     * attaches aTemplate_Part to the Collection
24
-     * and sets any supplied data associated with the current iterator entry
25
-     *
26
-     * @access public
27
-     * @param EE_Template_Part $object
28
-     * @param int              $priority
29
-     * @return bool
30
-     */
31
-    public function insert($object, $priority = 100)
32
-    {
33
-        if ($object instanceof EE_Template_Part) {
34
-            parent::insert($object, $priority);
35
-            return true;
36
-        } else {
37
-            return false;
38
-        }
39
-    }
20
+	/**
21
+	 * add
22
+	 *
23
+	 * attaches aTemplate_Part to the Collection
24
+	 * and sets any supplied data associated with the current iterator entry
25
+	 *
26
+	 * @access public
27
+	 * @param EE_Template_Part $object
28
+	 * @param int              $priority
29
+	 * @return bool
30
+	 */
31
+	public function insert($object, $priority = 100)
32
+	{
33
+		if ($object instanceof EE_Template_Part) {
34
+			parent::insert($object, $priority);
35
+			return true;
36
+		} else {
37
+			return false;
38
+		}
39
+	}
40 40
 
41 41
 
42
-    /**
43
-     * compare
44
-     *
45
-     * sorts EE_Template_Part in ascending order based on set priority
46
-     *
47
-     * @access public
48
-     * @param int $priority1
49
-     * @param int $priority2
50
-     * @return bool
51
-     */
52
-    public function compare($priority1, $priority2)
53
-    {
54
-        if ($priority1 === $priority2) {
55
-            return 0;
56
-        }
57
-        return $priority1 > $priority2 ? -1 : 1;
58
-    }
42
+	/**
43
+	 * compare
44
+	 *
45
+	 * sorts EE_Template_Part in ascending order based on set priority
46
+	 *
47
+	 * @access public
48
+	 * @param int $priority1
49
+	 * @param int $priority2
50
+	 * @return bool
51
+	 */
52
+	public function compare($priority1, $priority2)
53
+	{
54
+		if ($priority1 === $priority2) {
55
+			return 0;
56
+		}
57
+		return $priority1 > $priority2 ? -1 : 1;
58
+	}
59 59
 }
Please login to merge, or discard this patch.
core/business/EE_Processor_Base.class.php 2 patches
Indentation   +60 added lines, -60 removed lines patch added patch discarded remove patch
@@ -14,71 +14,71 @@
 block discarded – undo
14 14
 class EE_Processor_Base
15 15
 {
16 16
 
17
-    /**
18
-     * Used to indicate whether current request is for an IPN or not.
19
-     *
20
-     * @var bool
21
-     */
22
-    protected static $IPN = false;
17
+	/**
18
+	 * Used to indicate whether current request is for an IPN or not.
19
+	 *
20
+	 * @var bool
21
+	 */
22
+	protected static $IPN = false;
23 23
 
24
-    /**
25
-     * Used to indicate whether SPCO is being revisited by registrant or not.
26
-     *
27
-     * @var bool
28
-     */
29
-    protected $_revisit = false;
24
+	/**
25
+	 * Used to indicate whether SPCO is being revisited by registrant or not.
26
+	 *
27
+	 * @var bool
28
+	 */
29
+	protected $_revisit = false;
30 30
 
31 31
 
32
-    /**
33
-     * @param boolean $IPN
34
-     */
35
-    public static function set_IPN($IPN)
36
-    {
37
-        self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
38
-    }
32
+	/**
33
+	 * @param boolean $IPN
34
+	 */
35
+	public static function set_IPN($IPN)
36
+	{
37
+		self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
38
+	}
39 39
 
40 40
 
41
-    /**
42
-     * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
43
-     *
44
-     * @param bool $revisit
45
-     * @return void
46
-     */
47
-    public function set_revisit($revisit = false)
48
-    {
49
-        $this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
50
-    }
41
+	/**
42
+	 * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
43
+	 *
44
+	 * @param bool $revisit
45
+	 * @return void
46
+	 */
47
+	public function set_revisit($revisit = false)
48
+	{
49
+		$this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
50
+	}
51 51
 
52 52
 
53
-    /**
54
-     * debug
55
-     *
56
-     * @param string          $class
57
-     * @param string          $func
58
-     * @param string          $line
59
-     * @param \EE_Transaction $transaction
60
-     * @param array           $info
61
-     * @param bool            $display_request
62
-     */
63
-    protected function log(
64
-        $class = '',
65
-        $func = '',
66
-        $line = '',
67
-        EE_Transaction $transaction,
68
-        $info = array(),
69
-        $display_request = false
70
-    ) {
71
-        if (WP_DEBUG && false) {
72
-            if ($transaction instanceof EE_Transaction) {
73
-                // don't serialize objects
74
-                $info = EEH_Debug_Tools::strip_objects($info);
75
-                if ($transaction->ID()) {
76
-                    $info['TXN_status'] = $transaction->status_ID();
77
-                    $info['TXN_reg_steps'] = $transaction->reg_steps();
78
-                    $index = 'EE_Transaction: ' . $transaction->ID();
79
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
80
-                }
81
-            }
82
-        }
83
-    }
53
+	/**
54
+	 * debug
55
+	 *
56
+	 * @param string          $class
57
+	 * @param string          $func
58
+	 * @param string          $line
59
+	 * @param \EE_Transaction $transaction
60
+	 * @param array           $info
61
+	 * @param bool            $display_request
62
+	 */
63
+	protected function log(
64
+		$class = '',
65
+		$func = '',
66
+		$line = '',
67
+		EE_Transaction $transaction,
68
+		$info = array(),
69
+		$display_request = false
70
+	) {
71
+		if (WP_DEBUG && false) {
72
+			if ($transaction instanceof EE_Transaction) {
73
+				// don't serialize objects
74
+				$info = EEH_Debug_Tools::strip_objects($info);
75
+				if ($transaction->ID()) {
76
+					$info['TXN_status'] = $transaction->status_ID();
77
+					$info['TXN_reg_steps'] = $transaction->reg_steps();
78
+					$index = 'EE_Transaction: ' . $transaction->ID();
79
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
80
+				}
81
+			}
82
+		}
83
+	}
84 84
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -75,7 +75,7 @@
 block discarded – undo
75 75
                 if ($transaction->ID()) {
76 76
                     $info['TXN_status'] = $transaction->status_ID();
77 77
                     $info['TXN_reg_steps'] = $transaction->reg_steps();
78
-                    $index = 'EE_Transaction: ' . $transaction->ID();
78
+                    $index = 'EE_Transaction: '.$transaction->ID();
79 79
                     EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
80 80
                 }
81 81
             }
Please login to merge, or discard this patch.
core/business/EE_Transaction_Processor.class.php 3 patches
Indentation   +944 added lines, -944 removed lines patch added patch discarded remove patch
@@ -17,948 +17,948 @@
 block discarded – undo
17 17
 class EE_Transaction_Processor extends EE_Processor_Base
18 18
 {
19 19
 
20
-    /**
21
-     * @var EE_Registration_Processor $_instance
22
-     * @access    private
23
-     */
24
-    private static $_instance;
25
-
26
-    /**
27
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
28
-     *
29
-     * @var array $registration_query_params
30
-     * @access private
31
-     */
32
-    private $_registration_query_params = array();
33
-
34
-    /**
35
-     * @deprecated
36
-     * @var string
37
-     */
38
-    protected $_old_txn_status;
39
-
40
-    /**
41
-     * @deprecated
42
-     * @var string
43
-     */
44
-    protected $_new_txn_status;
45
-
46
-
47
-    /**
48
-     * @singleton method used to instantiate class object
49
-     * @access    public
50
-     * @param array $registration_query_params
51
-     * @return EE_Transaction_Processor instance
52
-     */
53
-    public static function instance($registration_query_params = array())
54
-    {
55
-        // check if class object is instantiated
56
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
57
-            self::$_instance = new self($registration_query_params);
58
-        }
59
-        return self::$_instance;
60
-    }
61
-
62
-
63
-    /**
64
-     * @param array $registration_query_params
65
-     */
66
-    private function __construct($registration_query_params = array())
67
-    {
68
-        // make sure some query params are set for retrieving registrations
69
-        $this->_set_registration_query_params($registration_query_params);
70
-    }
71
-
72
-
73
-    /**
74
-     * @access private
75
-     * @param array $registration_query_params
76
-     */
77
-    private function _set_registration_query_params($registration_query_params)
78
-    {
79
-        $this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
80
-            : array('order_by' => array('REG_count' => 'ASC'));
81
-    }
82
-
83
-
84
-    /**
85
-     * manually_update_registration_statuses
86
-     *
87
-     * @access public
88
-     * @param EE_Transaction $transaction
89
-     * @param string         $new_reg_status
90
-     * @param array          $registration_query_params array of query WHERE params to use
91
-     *                                                  when retrieving cached registrations from a transaction
92
-     * @return    boolean
93
-     * @throws \EE_Error
94
-     */
95
-    public function manually_update_registration_statuses(
96
-        EE_Transaction $transaction,
97
-        $new_reg_status = '',
98
-        $registration_query_params = array()
99
-    ) {
100
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
101
-            'manually_update_registration_status',
102
-            $transaction,
103
-            $registration_query_params,
104
-            $new_reg_status
105
-        );
106
-        // send messages
107
-        /** @type EE_Registration_Processor $registration_processor */
108
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
109
-        $registration_processor->trigger_registration_update_notifications(
110
-            $transaction->primary_registration(),
111
-            array('manually_updated' => true)
112
-        );
113
-        do_action(
114
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
115
-            $transaction,
116
-            $status_updates
117
-        );
118
-        return $status_updates;
119
-    }
120
-
121
-
122
-    /**
123
-     * toggle_registration_statuses_for_default_approved_events
124
-     *
125
-     * @access public
126
-     * @param EE_Transaction $transaction
127
-     * @param array          $registration_query_params array of query WHERE params to use
128
-     *                                                  when retrieving cached registrations from a transaction
129
-     * @return    boolean
130
-     * @throws \EE_Error
131
-     */
132
-    public function toggle_registration_statuses_for_default_approved_events(
133
-        EE_Transaction $transaction,
134
-        $registration_query_params = array()
135
-    ) {
136
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
137
-            'toggle_registration_status_for_default_approved_events',
138
-            $transaction,
139
-            $registration_query_params
140
-        );
141
-        do_action(
142
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
143
-            $transaction,
144
-            $status_updates
145
-        );
146
-        return $status_updates;
147
-    }
148
-
149
-
150
-    /**
151
-     * toggle_registration_statuses_if_no_monies_owing
152
-     *
153
-     * @access public
154
-     * @param EE_Transaction $transaction
155
-     * @param array          $registration_query_params array of query WHERE params to use
156
-     *                                                  when retrieving cached registrations from a transaction
157
-     * @return    boolean
158
-     * @throws \EE_Error
159
-     */
160
-    public function toggle_registration_statuses_if_no_monies_owing(
161
-        EE_Transaction $transaction,
162
-        $registration_query_params = array()
163
-    ) {
164
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
165
-            'toggle_registration_status_if_no_monies_owing',
166
-            $transaction,
167
-            $registration_query_params
168
-        );
169
-        do_action(
170
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
171
-            $transaction,
172
-            $status_updates
173
-        );
174
-        return $status_updates;
175
-    }
176
-
177
-
178
-    /**
179
-     * update_transaction_and_registrations_after_checkout_or_payment
180
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
181
-     *
182
-     * @param EE_Transaction     $transaction
183
-     * @param \EE_Payment | NULL $payment
184
-     * @param array              $registration_query_params    array of query WHERE params to use
185
-     *                                                         when retrieving cached registrations from a transaction
186
-     * @param bool               $trigger_notifications        whether or not to call
187
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
188
-     * @return array
189
-     * @throws \EE_Error
190
-     */
191
-    public function update_transaction_and_registrations_after_checkout_or_payment(
192
-        EE_Transaction $transaction,
193
-        $payment = null,
194
-        $registration_query_params = array(),
195
-        $trigger_notifications = true
196
-    ) {
197
-        // make sure some query params are set for retrieving registrations
198
-        $this->_set_registration_query_params($registration_query_params);
199
-        // get final reg step status
200
-        $finalized = $transaction->final_reg_step_completed();
201
-        // if the 'finalize_registration' step has been initiated (has a timestamp)
202
-        // but has not yet been fully completed (TRUE)
203
-        if (is_int($finalized) && $finalized !== false && $finalized !== true) {
204
-            $transaction->set_reg_step_completed('finalize_registration');
205
-            $finalized = true;
206
-        }
207
-        $transaction->save();
208
-        // array of details to aid in decision making by systems
209
-        $update_params = array(
210
-            'old_txn_status'  => $transaction->old_txn_status(),
211
-            'new_txn_status'  => $transaction->status_ID(),
212
-            'finalized'       => $finalized,
213
-            'revisit'         => $this->_revisit,
214
-            'payment_updates' => $payment instanceof EE_Payment ? true : false,
215
-            'last_payment'    => $payment,
216
-        );
217
-        // now update the registrations and add the results to our $update_params
218
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
219
-            'update_registration_after_checkout_or_payment',
220
-            $transaction,
221
-            $this->_registration_query_params,
222
-            $update_params
223
-        );
224
-        if ($trigger_notifications) {
225
-            // send messages
226
-            /** @type EE_Registration_Processor $registration_processor */
227
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
228
-            $registration_processor->trigger_registration_update_notifications(
229
-                $transaction->primary_registration(),
230
-                $update_params
231
-            );
232
-        }
233
-        do_action(
234
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
235
-            $transaction,
236
-            $update_params
237
-        );
238
-        return $update_params;
239
-    }
240
-
241
-
242
-    /**
243
-     * update_transaction_after_registration_reopened
244
-     * readjusts TXN and Line Item totals after a registration is changed from
245
-     * cancelled or declined to another reg status such as pending payment or approved
246
-     *
247
-     * @param \EE_Registration $registration
248
-     * @param array            $closed_reg_statuses
249
-     * @param bool             $update_txn
250
-     * @return bool
251
-     * @throws \EE_Error
252
-     */
253
-    public function update_transaction_after_reinstating_canceled_registration(
254
-        EE_Registration $registration,
255
-        $closed_reg_statuses = array(),
256
-        $update_txn = true
257
-    ) {
258
-        // these reg statuses should not be considered in any calculations involving monies owing
259
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
260
-            : EEM_Registration::closed_reg_statuses();
261
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
262
-            return false;
263
-        }
264
-        try {
265
-            $transaction = $this->get_transaction_for_registration($registration);
266
-            $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
267
-                $transaction,
268
-                $registration
269
-            );
270
-            // un-cancel the ticket
271
-            $success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
272
-        } catch (EE_Error $e) {
273
-            EE_Error::add_error(
274
-                sprintf(
275
-                    __(
276
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
277
-                        'event_espresso'
278
-                    ),
279
-                    $registration->ID(),
280
-                    '<br />',
281
-                    $e->getMessage()
282
-                ),
283
-                __FILE__,
284
-                __FUNCTION__,
285
-                __LINE__
286
-            );
287
-            return false;
288
-        }
289
-        if ($update_txn) {
290
-            return $transaction->save() ? $success : false;
291
-        }
292
-        return $success;
293
-    }
294
-
295
-
296
-    /**
297
-     * update_transaction_after_canceled_or_declined_registration
298
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
299
-     *
300
-     * @param \EE_Registration $registration
301
-     * @param array            $closed_reg_statuses
302
-     * @param bool             $update_txn
303
-     * @return bool
304
-     * @throws \EE_Error
305
-     */
306
-    public function update_transaction_after_canceled_or_declined_registration(
307
-        EE_Registration $registration,
308
-        $closed_reg_statuses = array(),
309
-        $update_txn = true
310
-    ) {
311
-        // these reg statuses should not be considered in any calculations involving monies owing
312
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
313
-            : EEM_Registration::closed_reg_statuses();
314
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
315
-            return false;
316
-        }
317
-        try {
318
-            $transaction = $this->get_transaction_for_registration($registration);
319
-            if (apply_filters(
320
-                'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
321
-                true,
322
-                $registration,
323
-                $transaction
324
-            )) {
325
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
326
-                    $transaction,
327
-                    $registration
328
-                );
329
-                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
330
-            }
331
-        } catch (EE_Error $e) {
332
-            EE_Error::add_error(
333
-                sprintf(
334
-                    __(
335
-                        'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
336
-                        'event_espresso'
337
-                    ),
338
-                    $registration->ID(),
339
-                    '<br />',
340
-                    $e->getMessage()
341
-                ),
342
-                __FILE__,
343
-                __FUNCTION__,
344
-                __LINE__
345
-            );
346
-            return false;
347
-        }
348
-        if ($update_txn) {
349
-            return $transaction->save() ? true : false;
350
-        }
351
-        return true;
352
-    }
353
-
354
-
355
-    /**
356
-     * get_transaction_for_registration
357
-     *
358
-     * @access    public
359
-     * @param    EE_Registration $registration
360
-     * @return    EE_Transaction
361
-     * @throws    EE_Error
362
-     */
363
-    public function get_transaction_for_registration(EE_Registration $registration)
364
-    {
365
-        $transaction = $registration->transaction();
366
-        if (! $transaction instanceof EE_Transaction) {
367
-            throw new EE_Error(
368
-                sprintf(
369
-                    __('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
370
-                    $registration->ID()
371
-                )
372
-            );
373
-        }
374
-        return $transaction;
375
-    }
376
-
377
-
378
-    /**
379
-     * get_ticket_line_item_for_transaction_registration
380
-     *
381
-     * @access    public
382
-     * @param    EE_Transaction  $transaction
383
-     * @param    EE_Registration $registration
384
-     * @return    EE_Line_Item
385
-     * @throws    EE_Error
386
-     */
387
-    public function get_ticket_line_item_for_transaction_registration(
388
-        EE_Transaction $transaction,
389
-        EE_Registration $registration
390
-    ) {
391
-        EE_Registry::instance()->load_helper('Line_Item');
392
-        $ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
393
-            $transaction->ID(),
394
-            $registration->ticket_ID()
395
-        );
396
-        if (! $ticket_line_item instanceof EE_Line_Item) {
397
-            throw new EE_Error(
398
-                sprintf(
399
-                    __(
400
-                        'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
401
-                        'event_espresso'
402
-                    ),
403
-                    $transaction->ID(),
404
-                    $registration->ticket_ID()
405
-                )
406
-            );
407
-        }
408
-        return $ticket_line_item;
409
-    }
410
-
411
-
412
-    /**
413
-     * cancel_transaction_if_all_registrations_canceled
414
-     * cycles thru related registrations and checks their statuses
415
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
416
-     *
417
-     * @access    public
418
-     * @param    EE_Transaction $transaction
419
-     * @param    string         $new_TXN_status
420
-     * @param    array          $registration_query_params - array of query WHERE params to use when
421
-     *                                                     retrieving cached registrations from a transaction
422
-     * @param    array          $closed_reg_statuses
423
-     * @param    bool           $update_txn
424
-     * @return    bool            true if TXN status was updated, false if not
425
-     */
426
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
427
-        EE_Transaction $transaction,
428
-        $new_TXN_status = '',
429
-        $registration_query_params = array(),
430
-        $closed_reg_statuses = array(),
431
-        $update_txn = true
432
-    ) {
433
-        // make sure some query params are set for retrieving registrations
434
-        $this->_set_registration_query_params($registration_query_params);
435
-        // these reg statuses should not be considered in any calculations involving monies owing
436
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
437
-            : EEM_Registration::closed_reg_statuses();
438
-        // loop through cached registrations
439
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
440
-            if ($registration instanceof EE_Registration
441
-                && ! in_array($registration->status_ID(), $closed_reg_statuses)
442
-            ) {
443
-                return false;
444
-            }
445
-        }
446
-        if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
447
-            $transaction->set_status($new_TXN_status);
448
-        }
449
-        if ($update_txn) {
450
-            return $transaction->save() ? true : false;
451
-        }
452
-        return true;
453
-    }
454
-
455
-
456
-    /**
457
-     * _call_method_on_registrations_via_Registration_Processor
458
-     * cycles thru related registrations and calls the requested method on each
459
-     *
460
-     * @access private
461
-     * @param string         $method_name
462
-     * @param EE_Transaction $transaction
463
-     * @param array          $registration_query_params array of query WHERE params to use
464
-     *                                                  when retrieving cached registrations from a transaction
465
-     * @param string         $additional_param
466
-     * @throws \EE_Error
467
-     * @return boolean
468
-     */
469
-    private function _call_method_on_registrations_via_Registration_Processor(
470
-        $method_name,
471
-        EE_Transaction $transaction,
472
-        $registration_query_params = array(),
473
-        $additional_param = null
474
-    ) {
475
-        $response = false;
476
-        /** @type EE_Registration_Processor $registration_processor */
477
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
478
-        // check that method exists
479
-        if (! method_exists($registration_processor, $method_name)) {
480
-            throw new EE_Error(__('Method does not exist.', 'event_espresso'));
481
-        }
482
-        // make sure some query params are set for retrieving registrations
483
-        $this->_set_registration_query_params($registration_query_params);
484
-        // loop through cached registrations
485
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
486
-            if ($registration instanceof EE_Registration) {
487
-                if ($additional_param) {
488
-                    $response = $registration_processor->{$method_name}($registration, $additional_param)
489
-                        ? true
490
-                        : $response;
491
-                } else {
492
-                    $response = $registration_processor->{$method_name}($registration)
493
-                        ? true
494
-                        : $response;
495
-                }
496
-            }
497
-        }
498
-        return $response;
499
-    }
500
-
501
-
502
-    /**
503
-     * set_transaction_payment_method_based_on_registration_statuses
504
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
505
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
506
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
507
-     *        the first "default" Payment Method
508
-     *        the first active Payment Method
509
-     *    whichever is found first.
510
-     *
511
-     * @param  EE_Registration $edited_registration
512
-     * @return void
513
-     * @throws \EE_Error
514
-     */
515
-    public function set_transaction_payment_method_based_on_registration_statuses(
516
-        EE_Registration $edited_registration
517
-    ) {
518
-        if ($edited_registration instanceof EE_Registration) {
519
-            $transaction = $edited_registration->transaction();
520
-            if ($transaction instanceof EE_Transaction) {
521
-                $all_not_approved = true;
522
-                foreach ($transaction->registrations() as $registration) {
523
-                    if ($registration instanceof EE_Registration) {
524
-                        // if any REG != "Not Approved" then toggle to false
525
-                        $all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
526
-                    }
527
-                }
528
-                // if ALL Registrations are "Not Approved"
529
-                if ($all_not_approved) {
530
-                    $transaction->set_payment_method_ID(null);
531
-                    $transaction->save();
532
-                } else {
533
-                    $available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
534
-                        $transaction,
535
-                        EEM_Payment_Method::scope_cart
536
-                    );
537
-                    if (! empty($available_payment_methods)) {
538
-                        $PMD_ID = 0;
539
-                        foreach ($available_payment_methods as $available_payment_method) {
540
-                            if ($available_payment_method instanceof EE_Payment_Method
541
-                                && $available_payment_method->open_by_default()
542
-                            ) {
543
-                                $PMD_ID = $available_payment_method->ID();
544
-                                break;
545
-                            }
546
-                        }
547
-                        if (! $PMD_ID) {
548
-                            $first_payment_method = reset($available_payment_methods);
549
-                            if ($first_payment_method instanceof EE_Payment_Method) {
550
-                                $PMD_ID = $first_payment_method->ID();
551
-                            } else {
552
-                                EE_Error::add_error(
553
-                                    __(
554
-                                        'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
555
-                                        'event_espresso'
556
-                                    ),
557
-                                    __FILE__,
558
-                                    __LINE__,
559
-                                    __FUNCTION__
560
-                                );
561
-                            }
562
-                        }
563
-                        $transaction->set_payment_method_ID($PMD_ID);
564
-                        $transaction->save();
565
-                    } else {
566
-                        EE_Error::add_error(
567
-                            __(
568
-                                'Please activate at least one Payment Method in order for things to operate correctly.',
569
-                                'event_espresso'
570
-                            ),
571
-                            __FILE__,
572
-                            __LINE__,
573
-                            __FUNCTION__
574
-                        );
575
-                    }
576
-                }
577
-            }
578
-        }
579
-    }
580
-
581
-
582
-
583
-    /********************************** DEPRECATED METHODS **********************************/
584
-
585
-
586
-    /**
587
-     * @deprecated 4.9.12
588
-     * @return string
589
-     */
590
-    public function old_txn_status()
591
-    {
592
-        EE_Error::doing_it_wrong(
593
-            __METHOD__,
594
-            esc_html__(
595
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
596
-                'event_espresso'
597
-            ),
598
-            '4.9.12'
599
-        );
600
-        return $this->_old_txn_status;
601
-    }
602
-
603
-
604
-    /**
605
-     * @deprecated 4.9.12
606
-     * @param string $old_txn_status
607
-     */
608
-    public function set_old_txn_status($old_txn_status)
609
-    {
610
-        EE_Error::doing_it_wrong(
611
-            __METHOD__,
612
-            esc_html__(
613
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
614
-                'event_espresso'
615
-            ),
616
-            '4.9.12'
617
-        );
618
-        // only set the first time
619
-        if ($this->_old_txn_status === null) {
620
-            $this->_old_txn_status = $old_txn_status;
621
-        }
622
-    }
623
-
624
-
625
-    /**
626
-     * @deprecated 4.9.12
627
-     * @return string
628
-     */
629
-    public function new_txn_status()
630
-    {
631
-        EE_Error::doing_it_wrong(
632
-            __METHOD__,
633
-            esc_html__(
634
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
635
-                'event_espresso'
636
-            ),
637
-            '4.9.12'
638
-        );
639
-        return $this->_new_txn_status;
640
-    }
641
-
642
-
643
-    /**
644
-     * @deprecated 4.9.12
645
-     * @param string $new_txn_status
646
-     */
647
-    public function set_new_txn_status($new_txn_status)
648
-    {
649
-        EE_Error::doing_it_wrong(
650
-            __METHOD__,
651
-            esc_html__(
652
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
653
-                'event_espresso'
654
-            ),
655
-            '4.9.12'
656
-        );
657
-        $this->_new_txn_status = $new_txn_status;
658
-    }
659
-
660
-
661
-    /**
662
-     * reg_status_updated
663
-     *
664
-     * @deprecated 4.9.12
665
-     * @return bool
666
-     */
667
-    public function txn_status_updated()
668
-    {
669
-        EE_Error::doing_it_wrong(
670
-            __METHOD__,
671
-            esc_html__(
672
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
673
-                'event_espresso'
674
-            ),
675
-            '4.9.12'
676
-        );
677
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
678
-    }
679
-
680
-
681
-    /**
682
-     * all_reg_steps_completed
683
-     * returns:
684
-     *    true if ALL reg steps have been marked as completed
685
-     *        or false if any step is not completed
686
-     *
687
-     * @deprecated 4.9.12
688
-     * @param EE_Transaction $transaction
689
-     * @return boolean
690
-     */
691
-    public function all_reg_steps_completed(EE_Transaction $transaction)
692
-    {
693
-        EE_Error::doing_it_wrong(
694
-            __METHOD__,
695
-            esc_html__(
696
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
697
-                'event_espresso'
698
-            ),
699
-            '4.9.12',
700
-            '5.0.0'
701
-        );
702
-        return $transaction->all_reg_steps_completed();
703
-    }
704
-
705
-
706
-    /**
707
-     * all_reg_steps_completed_except
708
-     * returns:
709
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
710
-     *        or false if any other step is not completed
711
-     *        or false if ALL steps are completed including the exception you are testing !!!
712
-     *
713
-     * @deprecated 4.9.12
714
-     * @param EE_Transaction $transaction
715
-     * @param string         $exception
716
-     * @return boolean
717
-     */
718
-    public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
719
-    {
720
-        EE_Error::doing_it_wrong(
721
-            __METHOD__,
722
-            esc_html__(
723
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
724
-                'event_espresso'
725
-            ),
726
-            '4.9.12',
727
-            '5.0.0'
728
-        );
729
-        return $transaction->all_reg_steps_completed_except($exception);
730
-    }
731
-
732
-
733
-    /**
734
-     * all_reg_steps_completed_except
735
-     * returns:
736
-     *        true if ALL reg steps, except the final step, have been marked as completed
737
-     *        or false if any step is not completed
738
-     *    or false if ALL steps are completed including the final step !!!
739
-     *
740
-     * @deprecated 4.9.12
741
-     * @param EE_Transaction $transaction
742
-     * @return boolean
743
-     */
744
-    public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
745
-    {
746
-        EE_Error::doing_it_wrong(
747
-            __METHOD__,
748
-            esc_html__(
749
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
750
-                'event_espresso'
751
-            ),
752
-            '4.9.12',
753
-            '5.0.0'
754
-        );
755
-        return $transaction->all_reg_steps_completed_except_final_step();
756
-    }
757
-
758
-
759
-    /**
760
-     * reg_step_completed
761
-     * returns:
762
-     *    true if a specific reg step has been marked as completed
763
-     *    a Unix timestamp if it has been initialized but not yet completed,
764
-     *    or false if it has not yet been initialized
765
-     *
766
-     * @deprecated 4.9.12
767
-     * @param EE_Transaction $transaction
768
-     * @param string         $reg_step_slug
769
-     * @return boolean | int
770
-     */
771
-    public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
772
-    {
773
-        EE_Error::doing_it_wrong(
774
-            __METHOD__,
775
-            esc_html__(
776
-                'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
777
-                'event_espresso'
778
-            ),
779
-            '4.9.12',
780
-            '5.0.0'
781
-        );
782
-        return $transaction->reg_step_completed($reg_step_slug);
783
-    }
784
-
785
-
786
-    /**
787
-     * completed_final_reg_step
788
-     * returns:
789
-     *    true if the finalize_registration reg step has been marked as completed
790
-     *    a Unix timestamp if it has been initialized but not yet completed,
791
-     *    or false if it has not yet been initialized
792
-     *
793
-     * @deprecated 4.9.12
794
-     * @param EE_Transaction $transaction
795
-     * @return boolean | int
796
-     */
797
-    public function final_reg_step_completed(EE_Transaction $transaction)
798
-    {
799
-        EE_Error::doing_it_wrong(
800
-            __METHOD__,
801
-            esc_html__(
802
-                'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
803
-                'event_espresso'
804
-            ),
805
-            '4.9.12',
806
-            '5.0.0'
807
-        );
808
-        return $transaction->final_reg_step_completed();
809
-    }
810
-
811
-
812
-    /**
813
-     * set_reg_step_initiated
814
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
815
-     *
816
-     * @deprecated 4.9.12
817
-     * @access     public
818
-     * @param \EE_Transaction $transaction
819
-     * @param string          $reg_step_slug
820
-     * @return boolean
821
-     * @throws \EE_Error
822
-     */
823
-    public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
824
-    {
825
-        EE_Error::doing_it_wrong(
826
-            __METHOD__,
827
-            esc_html__(
828
-                'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
829
-                'event_espresso'
830
-            ),
831
-            '4.9.12',
832
-            '5.0.0'
833
-        );
834
-        return $transaction->set_reg_step_initiated($reg_step_slug);
835
-    }
836
-
837
-
838
-    /**
839
-     * set_reg_step_completed
840
-     * given a valid TXN_reg_step, this sets the step as completed
841
-     *
842
-     * @deprecated 4.9.12
843
-     * @access     public
844
-     * @param \EE_Transaction $transaction
845
-     * @param string          $reg_step_slug
846
-     * @return boolean
847
-     * @throws \EE_Error
848
-     */
849
-    public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
850
-    {
851
-        EE_Error::doing_it_wrong(
852
-            __METHOD__,
853
-            esc_html__(
854
-                'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
855
-                'event_espresso'
856
-            ),
857
-            '4.9.12',
858
-            '5.0.0'
859
-        );
860
-        return $transaction->set_reg_step_completed($reg_step_slug);
861
-    }
862
-
863
-
864
-    /**
865
-     * set_reg_step_completed
866
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
867
-     *
868
-     * @deprecated 4.9.12
869
-     * @access     public
870
-     * @param \EE_Transaction $transaction
871
-     * @param string          $reg_step_slug
872
-     * @return boolean
873
-     * @throws \EE_Error
874
-     */
875
-    public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
876
-    {
877
-        EE_Error::doing_it_wrong(
878
-            __METHOD__,
879
-            esc_html__(
880
-                'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
881
-                'event_espresso'
882
-            ),
883
-            '4.9.12',
884
-            '5.0.0'
885
-        );
886
-        return $transaction->set_reg_step_not_completed($reg_step_slug);
887
-    }
888
-
889
-
890
-    /**
891
-     * remove_reg_step
892
-     * given a valid TXN_reg_step slug, this will remove (unset)
893
-     * the reg step from the TXN reg step array
894
-     *
895
-     * @deprecated 4.9.12
896
-     * @access     public
897
-     * @param \EE_Transaction $transaction
898
-     * @param string          $reg_step_slug
899
-     * @return void
900
-     */
901
-    public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
902
-    {
903
-        EE_Error::doing_it_wrong(
904
-            __METHOD__,
905
-            esc_html__(
906
-                'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
907
-                'event_espresso'
908
-            ),
909
-            '4.9.12',
910
-            '5.0.0'
911
-        );
912
-        $transaction->remove_reg_step($reg_step_slug);
913
-    }
914
-
915
-
916
-    /**
917
-     *    toggle_failed_transaction_status
918
-     * upgrades a TXNs status from failed to abandoned,
919
-     * meaning that contact information has been captured for at least one registrant
920
-     *
921
-     * @deprecated 4.9.12
922
-     * @access     public
923
-     * @param EE_Transaction $transaction
924
-     * @return    boolean
925
-     * @throws \EE_Error
926
-     */
927
-    public function toggle_failed_transaction_status(EE_Transaction $transaction)
928
-    {
929
-        EE_Error::doing_it_wrong(
930
-            __METHOD__,
931
-            esc_html__(
932
-                'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
933
-                'event_espresso'
934
-            ),
935
-            '4.9.12',
936
-            '5.0.0'
937
-        );
938
-        return $transaction->toggle_failed_transaction_status();
939
-    }
940
-
941
-
942
-    /**
943
-     * toggle_abandoned_transaction_status
944
-     * upgrades a TXNs status from failed or abandoned to incomplete
945
-     *
946
-     * @deprecated 4.9.12
947
-     * @access     public
948
-     * @param  EE_Transaction $transaction
949
-     * @return boolean
950
-     */
951
-    public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
952
-    {
953
-        EE_Error::doing_it_wrong(
954
-            __METHOD__,
955
-            esc_html__(
956
-                'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
957
-                'event_espresso'
958
-            ),
959
-            '4.9.12',
960
-            '5.0.0'
961
-        );
962
-        return $transaction->toggle_abandoned_transaction_status();
963
-    }
20
+	/**
21
+	 * @var EE_Registration_Processor $_instance
22
+	 * @access    private
23
+	 */
24
+	private static $_instance;
25
+
26
+	/**
27
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
28
+	 *
29
+	 * @var array $registration_query_params
30
+	 * @access private
31
+	 */
32
+	private $_registration_query_params = array();
33
+
34
+	/**
35
+	 * @deprecated
36
+	 * @var string
37
+	 */
38
+	protected $_old_txn_status;
39
+
40
+	/**
41
+	 * @deprecated
42
+	 * @var string
43
+	 */
44
+	protected $_new_txn_status;
45
+
46
+
47
+	/**
48
+	 * @singleton method used to instantiate class object
49
+	 * @access    public
50
+	 * @param array $registration_query_params
51
+	 * @return EE_Transaction_Processor instance
52
+	 */
53
+	public static function instance($registration_query_params = array())
54
+	{
55
+		// check if class object is instantiated
56
+		if (! self::$_instance instanceof EE_Transaction_Processor) {
57
+			self::$_instance = new self($registration_query_params);
58
+		}
59
+		return self::$_instance;
60
+	}
61
+
62
+
63
+	/**
64
+	 * @param array $registration_query_params
65
+	 */
66
+	private function __construct($registration_query_params = array())
67
+	{
68
+		// make sure some query params are set for retrieving registrations
69
+		$this->_set_registration_query_params($registration_query_params);
70
+	}
71
+
72
+
73
+	/**
74
+	 * @access private
75
+	 * @param array $registration_query_params
76
+	 */
77
+	private function _set_registration_query_params($registration_query_params)
78
+	{
79
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
80
+			: array('order_by' => array('REG_count' => 'ASC'));
81
+	}
82
+
83
+
84
+	/**
85
+	 * manually_update_registration_statuses
86
+	 *
87
+	 * @access public
88
+	 * @param EE_Transaction $transaction
89
+	 * @param string         $new_reg_status
90
+	 * @param array          $registration_query_params array of query WHERE params to use
91
+	 *                                                  when retrieving cached registrations from a transaction
92
+	 * @return    boolean
93
+	 * @throws \EE_Error
94
+	 */
95
+	public function manually_update_registration_statuses(
96
+		EE_Transaction $transaction,
97
+		$new_reg_status = '',
98
+		$registration_query_params = array()
99
+	) {
100
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
101
+			'manually_update_registration_status',
102
+			$transaction,
103
+			$registration_query_params,
104
+			$new_reg_status
105
+		);
106
+		// send messages
107
+		/** @type EE_Registration_Processor $registration_processor */
108
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
109
+		$registration_processor->trigger_registration_update_notifications(
110
+			$transaction->primary_registration(),
111
+			array('manually_updated' => true)
112
+		);
113
+		do_action(
114
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
115
+			$transaction,
116
+			$status_updates
117
+		);
118
+		return $status_updates;
119
+	}
120
+
121
+
122
+	/**
123
+	 * toggle_registration_statuses_for_default_approved_events
124
+	 *
125
+	 * @access public
126
+	 * @param EE_Transaction $transaction
127
+	 * @param array          $registration_query_params array of query WHERE params to use
128
+	 *                                                  when retrieving cached registrations from a transaction
129
+	 * @return    boolean
130
+	 * @throws \EE_Error
131
+	 */
132
+	public function toggle_registration_statuses_for_default_approved_events(
133
+		EE_Transaction $transaction,
134
+		$registration_query_params = array()
135
+	) {
136
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
137
+			'toggle_registration_status_for_default_approved_events',
138
+			$transaction,
139
+			$registration_query_params
140
+		);
141
+		do_action(
142
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
143
+			$transaction,
144
+			$status_updates
145
+		);
146
+		return $status_updates;
147
+	}
148
+
149
+
150
+	/**
151
+	 * toggle_registration_statuses_if_no_monies_owing
152
+	 *
153
+	 * @access public
154
+	 * @param EE_Transaction $transaction
155
+	 * @param array          $registration_query_params array of query WHERE params to use
156
+	 *                                                  when retrieving cached registrations from a transaction
157
+	 * @return    boolean
158
+	 * @throws \EE_Error
159
+	 */
160
+	public function toggle_registration_statuses_if_no_monies_owing(
161
+		EE_Transaction $transaction,
162
+		$registration_query_params = array()
163
+	) {
164
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
165
+			'toggle_registration_status_if_no_monies_owing',
166
+			$transaction,
167
+			$registration_query_params
168
+		);
169
+		do_action(
170
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
171
+			$transaction,
172
+			$status_updates
173
+		);
174
+		return $status_updates;
175
+	}
176
+
177
+
178
+	/**
179
+	 * update_transaction_and_registrations_after_checkout_or_payment
180
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
181
+	 *
182
+	 * @param EE_Transaction     $transaction
183
+	 * @param \EE_Payment | NULL $payment
184
+	 * @param array              $registration_query_params    array of query WHERE params to use
185
+	 *                                                         when retrieving cached registrations from a transaction
186
+	 * @param bool               $trigger_notifications        whether or not to call
187
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
188
+	 * @return array
189
+	 * @throws \EE_Error
190
+	 */
191
+	public function update_transaction_and_registrations_after_checkout_or_payment(
192
+		EE_Transaction $transaction,
193
+		$payment = null,
194
+		$registration_query_params = array(),
195
+		$trigger_notifications = true
196
+	) {
197
+		// make sure some query params are set for retrieving registrations
198
+		$this->_set_registration_query_params($registration_query_params);
199
+		// get final reg step status
200
+		$finalized = $transaction->final_reg_step_completed();
201
+		// if the 'finalize_registration' step has been initiated (has a timestamp)
202
+		// but has not yet been fully completed (TRUE)
203
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
204
+			$transaction->set_reg_step_completed('finalize_registration');
205
+			$finalized = true;
206
+		}
207
+		$transaction->save();
208
+		// array of details to aid in decision making by systems
209
+		$update_params = array(
210
+			'old_txn_status'  => $transaction->old_txn_status(),
211
+			'new_txn_status'  => $transaction->status_ID(),
212
+			'finalized'       => $finalized,
213
+			'revisit'         => $this->_revisit,
214
+			'payment_updates' => $payment instanceof EE_Payment ? true : false,
215
+			'last_payment'    => $payment,
216
+		);
217
+		// now update the registrations and add the results to our $update_params
218
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
219
+			'update_registration_after_checkout_or_payment',
220
+			$transaction,
221
+			$this->_registration_query_params,
222
+			$update_params
223
+		);
224
+		if ($trigger_notifications) {
225
+			// send messages
226
+			/** @type EE_Registration_Processor $registration_processor */
227
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
228
+			$registration_processor->trigger_registration_update_notifications(
229
+				$transaction->primary_registration(),
230
+				$update_params
231
+			);
232
+		}
233
+		do_action(
234
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
235
+			$transaction,
236
+			$update_params
237
+		);
238
+		return $update_params;
239
+	}
240
+
241
+
242
+	/**
243
+	 * update_transaction_after_registration_reopened
244
+	 * readjusts TXN and Line Item totals after a registration is changed from
245
+	 * cancelled or declined to another reg status such as pending payment or approved
246
+	 *
247
+	 * @param \EE_Registration $registration
248
+	 * @param array            $closed_reg_statuses
249
+	 * @param bool             $update_txn
250
+	 * @return bool
251
+	 * @throws \EE_Error
252
+	 */
253
+	public function update_transaction_after_reinstating_canceled_registration(
254
+		EE_Registration $registration,
255
+		$closed_reg_statuses = array(),
256
+		$update_txn = true
257
+	) {
258
+		// these reg statuses should not be considered in any calculations involving monies owing
259
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
260
+			: EEM_Registration::closed_reg_statuses();
261
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
262
+			return false;
263
+		}
264
+		try {
265
+			$transaction = $this->get_transaction_for_registration($registration);
266
+			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
267
+				$transaction,
268
+				$registration
269
+			);
270
+			// un-cancel the ticket
271
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
272
+		} catch (EE_Error $e) {
273
+			EE_Error::add_error(
274
+				sprintf(
275
+					__(
276
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
277
+						'event_espresso'
278
+					),
279
+					$registration->ID(),
280
+					'<br />',
281
+					$e->getMessage()
282
+				),
283
+				__FILE__,
284
+				__FUNCTION__,
285
+				__LINE__
286
+			);
287
+			return false;
288
+		}
289
+		if ($update_txn) {
290
+			return $transaction->save() ? $success : false;
291
+		}
292
+		return $success;
293
+	}
294
+
295
+
296
+	/**
297
+	 * update_transaction_after_canceled_or_declined_registration
298
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
299
+	 *
300
+	 * @param \EE_Registration $registration
301
+	 * @param array            $closed_reg_statuses
302
+	 * @param bool             $update_txn
303
+	 * @return bool
304
+	 * @throws \EE_Error
305
+	 */
306
+	public function update_transaction_after_canceled_or_declined_registration(
307
+		EE_Registration $registration,
308
+		$closed_reg_statuses = array(),
309
+		$update_txn = true
310
+	) {
311
+		// these reg statuses should not be considered in any calculations involving monies owing
312
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
313
+			: EEM_Registration::closed_reg_statuses();
314
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
315
+			return false;
316
+		}
317
+		try {
318
+			$transaction = $this->get_transaction_for_registration($registration);
319
+			if (apply_filters(
320
+				'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
321
+				true,
322
+				$registration,
323
+				$transaction
324
+			)) {
325
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
326
+					$transaction,
327
+					$registration
328
+				);
329
+				EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
330
+			}
331
+		} catch (EE_Error $e) {
332
+			EE_Error::add_error(
333
+				sprintf(
334
+					__(
335
+						'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
336
+						'event_espresso'
337
+					),
338
+					$registration->ID(),
339
+					'<br />',
340
+					$e->getMessage()
341
+				),
342
+				__FILE__,
343
+				__FUNCTION__,
344
+				__LINE__
345
+			);
346
+			return false;
347
+		}
348
+		if ($update_txn) {
349
+			return $transaction->save() ? true : false;
350
+		}
351
+		return true;
352
+	}
353
+
354
+
355
+	/**
356
+	 * get_transaction_for_registration
357
+	 *
358
+	 * @access    public
359
+	 * @param    EE_Registration $registration
360
+	 * @return    EE_Transaction
361
+	 * @throws    EE_Error
362
+	 */
363
+	public function get_transaction_for_registration(EE_Registration $registration)
364
+	{
365
+		$transaction = $registration->transaction();
366
+		if (! $transaction instanceof EE_Transaction) {
367
+			throw new EE_Error(
368
+				sprintf(
369
+					__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
370
+					$registration->ID()
371
+				)
372
+			);
373
+		}
374
+		return $transaction;
375
+	}
376
+
377
+
378
+	/**
379
+	 * get_ticket_line_item_for_transaction_registration
380
+	 *
381
+	 * @access    public
382
+	 * @param    EE_Transaction  $transaction
383
+	 * @param    EE_Registration $registration
384
+	 * @return    EE_Line_Item
385
+	 * @throws    EE_Error
386
+	 */
387
+	public function get_ticket_line_item_for_transaction_registration(
388
+		EE_Transaction $transaction,
389
+		EE_Registration $registration
390
+	) {
391
+		EE_Registry::instance()->load_helper('Line_Item');
392
+		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
393
+			$transaction->ID(),
394
+			$registration->ticket_ID()
395
+		);
396
+		if (! $ticket_line_item instanceof EE_Line_Item) {
397
+			throw new EE_Error(
398
+				sprintf(
399
+					__(
400
+						'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
401
+						'event_espresso'
402
+					),
403
+					$transaction->ID(),
404
+					$registration->ticket_ID()
405
+				)
406
+			);
407
+		}
408
+		return $ticket_line_item;
409
+	}
410
+
411
+
412
+	/**
413
+	 * cancel_transaction_if_all_registrations_canceled
414
+	 * cycles thru related registrations and checks their statuses
415
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
416
+	 *
417
+	 * @access    public
418
+	 * @param    EE_Transaction $transaction
419
+	 * @param    string         $new_TXN_status
420
+	 * @param    array          $registration_query_params - array of query WHERE params to use when
421
+	 *                                                     retrieving cached registrations from a transaction
422
+	 * @param    array          $closed_reg_statuses
423
+	 * @param    bool           $update_txn
424
+	 * @return    bool            true if TXN status was updated, false if not
425
+	 */
426
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
427
+		EE_Transaction $transaction,
428
+		$new_TXN_status = '',
429
+		$registration_query_params = array(),
430
+		$closed_reg_statuses = array(),
431
+		$update_txn = true
432
+	) {
433
+		// make sure some query params are set for retrieving registrations
434
+		$this->_set_registration_query_params($registration_query_params);
435
+		// these reg statuses should not be considered in any calculations involving monies owing
436
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
437
+			: EEM_Registration::closed_reg_statuses();
438
+		// loop through cached registrations
439
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
440
+			if ($registration instanceof EE_Registration
441
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
442
+			) {
443
+				return false;
444
+			}
445
+		}
446
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
447
+			$transaction->set_status($new_TXN_status);
448
+		}
449
+		if ($update_txn) {
450
+			return $transaction->save() ? true : false;
451
+		}
452
+		return true;
453
+	}
454
+
455
+
456
+	/**
457
+	 * _call_method_on_registrations_via_Registration_Processor
458
+	 * cycles thru related registrations and calls the requested method on each
459
+	 *
460
+	 * @access private
461
+	 * @param string         $method_name
462
+	 * @param EE_Transaction $transaction
463
+	 * @param array          $registration_query_params array of query WHERE params to use
464
+	 *                                                  when retrieving cached registrations from a transaction
465
+	 * @param string         $additional_param
466
+	 * @throws \EE_Error
467
+	 * @return boolean
468
+	 */
469
+	private function _call_method_on_registrations_via_Registration_Processor(
470
+		$method_name,
471
+		EE_Transaction $transaction,
472
+		$registration_query_params = array(),
473
+		$additional_param = null
474
+	) {
475
+		$response = false;
476
+		/** @type EE_Registration_Processor $registration_processor */
477
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
478
+		// check that method exists
479
+		if (! method_exists($registration_processor, $method_name)) {
480
+			throw new EE_Error(__('Method does not exist.', 'event_espresso'));
481
+		}
482
+		// make sure some query params are set for retrieving registrations
483
+		$this->_set_registration_query_params($registration_query_params);
484
+		// loop through cached registrations
485
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
486
+			if ($registration instanceof EE_Registration) {
487
+				if ($additional_param) {
488
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
489
+						? true
490
+						: $response;
491
+				} else {
492
+					$response = $registration_processor->{$method_name}($registration)
493
+						? true
494
+						: $response;
495
+				}
496
+			}
497
+		}
498
+		return $response;
499
+	}
500
+
501
+
502
+	/**
503
+	 * set_transaction_payment_method_based_on_registration_statuses
504
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
505
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
506
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
507
+	 *        the first "default" Payment Method
508
+	 *        the first active Payment Method
509
+	 *    whichever is found first.
510
+	 *
511
+	 * @param  EE_Registration $edited_registration
512
+	 * @return void
513
+	 * @throws \EE_Error
514
+	 */
515
+	public function set_transaction_payment_method_based_on_registration_statuses(
516
+		EE_Registration $edited_registration
517
+	) {
518
+		if ($edited_registration instanceof EE_Registration) {
519
+			$transaction = $edited_registration->transaction();
520
+			if ($transaction instanceof EE_Transaction) {
521
+				$all_not_approved = true;
522
+				foreach ($transaction->registrations() as $registration) {
523
+					if ($registration instanceof EE_Registration) {
524
+						// if any REG != "Not Approved" then toggle to false
525
+						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
526
+					}
527
+				}
528
+				// if ALL Registrations are "Not Approved"
529
+				if ($all_not_approved) {
530
+					$transaction->set_payment_method_ID(null);
531
+					$transaction->save();
532
+				} else {
533
+					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
534
+						$transaction,
535
+						EEM_Payment_Method::scope_cart
536
+					);
537
+					if (! empty($available_payment_methods)) {
538
+						$PMD_ID = 0;
539
+						foreach ($available_payment_methods as $available_payment_method) {
540
+							if ($available_payment_method instanceof EE_Payment_Method
541
+								&& $available_payment_method->open_by_default()
542
+							) {
543
+								$PMD_ID = $available_payment_method->ID();
544
+								break;
545
+							}
546
+						}
547
+						if (! $PMD_ID) {
548
+							$first_payment_method = reset($available_payment_methods);
549
+							if ($first_payment_method instanceof EE_Payment_Method) {
550
+								$PMD_ID = $first_payment_method->ID();
551
+							} else {
552
+								EE_Error::add_error(
553
+									__(
554
+										'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
555
+										'event_espresso'
556
+									),
557
+									__FILE__,
558
+									__LINE__,
559
+									__FUNCTION__
560
+								);
561
+							}
562
+						}
563
+						$transaction->set_payment_method_ID($PMD_ID);
564
+						$transaction->save();
565
+					} else {
566
+						EE_Error::add_error(
567
+							__(
568
+								'Please activate at least one Payment Method in order for things to operate correctly.',
569
+								'event_espresso'
570
+							),
571
+							__FILE__,
572
+							__LINE__,
573
+							__FUNCTION__
574
+						);
575
+					}
576
+				}
577
+			}
578
+		}
579
+	}
580
+
581
+
582
+
583
+	/********************************** DEPRECATED METHODS **********************************/
584
+
585
+
586
+	/**
587
+	 * @deprecated 4.9.12
588
+	 * @return string
589
+	 */
590
+	public function old_txn_status()
591
+	{
592
+		EE_Error::doing_it_wrong(
593
+			__METHOD__,
594
+			esc_html__(
595
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
596
+				'event_espresso'
597
+			),
598
+			'4.9.12'
599
+		);
600
+		return $this->_old_txn_status;
601
+	}
602
+
603
+
604
+	/**
605
+	 * @deprecated 4.9.12
606
+	 * @param string $old_txn_status
607
+	 */
608
+	public function set_old_txn_status($old_txn_status)
609
+	{
610
+		EE_Error::doing_it_wrong(
611
+			__METHOD__,
612
+			esc_html__(
613
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
614
+				'event_espresso'
615
+			),
616
+			'4.9.12'
617
+		);
618
+		// only set the first time
619
+		if ($this->_old_txn_status === null) {
620
+			$this->_old_txn_status = $old_txn_status;
621
+		}
622
+	}
623
+
624
+
625
+	/**
626
+	 * @deprecated 4.9.12
627
+	 * @return string
628
+	 */
629
+	public function new_txn_status()
630
+	{
631
+		EE_Error::doing_it_wrong(
632
+			__METHOD__,
633
+			esc_html__(
634
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
635
+				'event_espresso'
636
+			),
637
+			'4.9.12'
638
+		);
639
+		return $this->_new_txn_status;
640
+	}
641
+
642
+
643
+	/**
644
+	 * @deprecated 4.9.12
645
+	 * @param string $new_txn_status
646
+	 */
647
+	public function set_new_txn_status($new_txn_status)
648
+	{
649
+		EE_Error::doing_it_wrong(
650
+			__METHOD__,
651
+			esc_html__(
652
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
653
+				'event_espresso'
654
+			),
655
+			'4.9.12'
656
+		);
657
+		$this->_new_txn_status = $new_txn_status;
658
+	}
659
+
660
+
661
+	/**
662
+	 * reg_status_updated
663
+	 *
664
+	 * @deprecated 4.9.12
665
+	 * @return bool
666
+	 */
667
+	public function txn_status_updated()
668
+	{
669
+		EE_Error::doing_it_wrong(
670
+			__METHOD__,
671
+			esc_html__(
672
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
673
+				'event_espresso'
674
+			),
675
+			'4.9.12'
676
+		);
677
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
678
+	}
679
+
680
+
681
+	/**
682
+	 * all_reg_steps_completed
683
+	 * returns:
684
+	 *    true if ALL reg steps have been marked as completed
685
+	 *        or false if any step is not completed
686
+	 *
687
+	 * @deprecated 4.9.12
688
+	 * @param EE_Transaction $transaction
689
+	 * @return boolean
690
+	 */
691
+	public function all_reg_steps_completed(EE_Transaction $transaction)
692
+	{
693
+		EE_Error::doing_it_wrong(
694
+			__METHOD__,
695
+			esc_html__(
696
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
697
+				'event_espresso'
698
+			),
699
+			'4.9.12',
700
+			'5.0.0'
701
+		);
702
+		return $transaction->all_reg_steps_completed();
703
+	}
704
+
705
+
706
+	/**
707
+	 * all_reg_steps_completed_except
708
+	 * returns:
709
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
710
+	 *        or false if any other step is not completed
711
+	 *        or false if ALL steps are completed including the exception you are testing !!!
712
+	 *
713
+	 * @deprecated 4.9.12
714
+	 * @param EE_Transaction $transaction
715
+	 * @param string         $exception
716
+	 * @return boolean
717
+	 */
718
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
719
+	{
720
+		EE_Error::doing_it_wrong(
721
+			__METHOD__,
722
+			esc_html__(
723
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
724
+				'event_espresso'
725
+			),
726
+			'4.9.12',
727
+			'5.0.0'
728
+		);
729
+		return $transaction->all_reg_steps_completed_except($exception);
730
+	}
731
+
732
+
733
+	/**
734
+	 * all_reg_steps_completed_except
735
+	 * returns:
736
+	 *        true if ALL reg steps, except the final step, have been marked as completed
737
+	 *        or false if any step is not completed
738
+	 *    or false if ALL steps are completed including the final step !!!
739
+	 *
740
+	 * @deprecated 4.9.12
741
+	 * @param EE_Transaction $transaction
742
+	 * @return boolean
743
+	 */
744
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
745
+	{
746
+		EE_Error::doing_it_wrong(
747
+			__METHOD__,
748
+			esc_html__(
749
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
750
+				'event_espresso'
751
+			),
752
+			'4.9.12',
753
+			'5.0.0'
754
+		);
755
+		return $transaction->all_reg_steps_completed_except_final_step();
756
+	}
757
+
758
+
759
+	/**
760
+	 * reg_step_completed
761
+	 * returns:
762
+	 *    true if a specific reg step has been marked as completed
763
+	 *    a Unix timestamp if it has been initialized but not yet completed,
764
+	 *    or false if it has not yet been initialized
765
+	 *
766
+	 * @deprecated 4.9.12
767
+	 * @param EE_Transaction $transaction
768
+	 * @param string         $reg_step_slug
769
+	 * @return boolean | int
770
+	 */
771
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
772
+	{
773
+		EE_Error::doing_it_wrong(
774
+			__METHOD__,
775
+			esc_html__(
776
+				'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
777
+				'event_espresso'
778
+			),
779
+			'4.9.12',
780
+			'5.0.0'
781
+		);
782
+		return $transaction->reg_step_completed($reg_step_slug);
783
+	}
784
+
785
+
786
+	/**
787
+	 * completed_final_reg_step
788
+	 * returns:
789
+	 *    true if the finalize_registration reg step has been marked as completed
790
+	 *    a Unix timestamp if it has been initialized but not yet completed,
791
+	 *    or false if it has not yet been initialized
792
+	 *
793
+	 * @deprecated 4.9.12
794
+	 * @param EE_Transaction $transaction
795
+	 * @return boolean | int
796
+	 */
797
+	public function final_reg_step_completed(EE_Transaction $transaction)
798
+	{
799
+		EE_Error::doing_it_wrong(
800
+			__METHOD__,
801
+			esc_html__(
802
+				'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
803
+				'event_espresso'
804
+			),
805
+			'4.9.12',
806
+			'5.0.0'
807
+		);
808
+		return $transaction->final_reg_step_completed();
809
+	}
810
+
811
+
812
+	/**
813
+	 * set_reg_step_initiated
814
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
815
+	 *
816
+	 * @deprecated 4.9.12
817
+	 * @access     public
818
+	 * @param \EE_Transaction $transaction
819
+	 * @param string          $reg_step_slug
820
+	 * @return boolean
821
+	 * @throws \EE_Error
822
+	 */
823
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
824
+	{
825
+		EE_Error::doing_it_wrong(
826
+			__METHOD__,
827
+			esc_html__(
828
+				'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
829
+				'event_espresso'
830
+			),
831
+			'4.9.12',
832
+			'5.0.0'
833
+		);
834
+		return $transaction->set_reg_step_initiated($reg_step_slug);
835
+	}
836
+
837
+
838
+	/**
839
+	 * set_reg_step_completed
840
+	 * given a valid TXN_reg_step, this sets the step as completed
841
+	 *
842
+	 * @deprecated 4.9.12
843
+	 * @access     public
844
+	 * @param \EE_Transaction $transaction
845
+	 * @param string          $reg_step_slug
846
+	 * @return boolean
847
+	 * @throws \EE_Error
848
+	 */
849
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
850
+	{
851
+		EE_Error::doing_it_wrong(
852
+			__METHOD__,
853
+			esc_html__(
854
+				'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
855
+				'event_espresso'
856
+			),
857
+			'4.9.12',
858
+			'5.0.0'
859
+		);
860
+		return $transaction->set_reg_step_completed($reg_step_slug);
861
+	}
862
+
863
+
864
+	/**
865
+	 * set_reg_step_completed
866
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
867
+	 *
868
+	 * @deprecated 4.9.12
869
+	 * @access     public
870
+	 * @param \EE_Transaction $transaction
871
+	 * @param string          $reg_step_slug
872
+	 * @return boolean
873
+	 * @throws \EE_Error
874
+	 */
875
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
876
+	{
877
+		EE_Error::doing_it_wrong(
878
+			__METHOD__,
879
+			esc_html__(
880
+				'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
881
+				'event_espresso'
882
+			),
883
+			'4.9.12',
884
+			'5.0.0'
885
+		);
886
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
887
+	}
888
+
889
+
890
+	/**
891
+	 * remove_reg_step
892
+	 * given a valid TXN_reg_step slug, this will remove (unset)
893
+	 * the reg step from the TXN reg step array
894
+	 *
895
+	 * @deprecated 4.9.12
896
+	 * @access     public
897
+	 * @param \EE_Transaction $transaction
898
+	 * @param string          $reg_step_slug
899
+	 * @return void
900
+	 */
901
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
902
+	{
903
+		EE_Error::doing_it_wrong(
904
+			__METHOD__,
905
+			esc_html__(
906
+				'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
907
+				'event_espresso'
908
+			),
909
+			'4.9.12',
910
+			'5.0.0'
911
+		);
912
+		$transaction->remove_reg_step($reg_step_slug);
913
+	}
914
+
915
+
916
+	/**
917
+	 *    toggle_failed_transaction_status
918
+	 * upgrades a TXNs status from failed to abandoned,
919
+	 * meaning that contact information has been captured for at least one registrant
920
+	 *
921
+	 * @deprecated 4.9.12
922
+	 * @access     public
923
+	 * @param EE_Transaction $transaction
924
+	 * @return    boolean
925
+	 * @throws \EE_Error
926
+	 */
927
+	public function toggle_failed_transaction_status(EE_Transaction $transaction)
928
+	{
929
+		EE_Error::doing_it_wrong(
930
+			__METHOD__,
931
+			esc_html__(
932
+				'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
933
+				'event_espresso'
934
+			),
935
+			'4.9.12',
936
+			'5.0.0'
937
+		);
938
+		return $transaction->toggle_failed_transaction_status();
939
+	}
940
+
941
+
942
+	/**
943
+	 * toggle_abandoned_transaction_status
944
+	 * upgrades a TXNs status from failed or abandoned to incomplete
945
+	 *
946
+	 * @deprecated 4.9.12
947
+	 * @access     public
948
+	 * @param  EE_Transaction $transaction
949
+	 * @return boolean
950
+	 */
951
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
952
+	{
953
+		EE_Error::doing_it_wrong(
954
+			__METHOD__,
955
+			esc_html__(
956
+				'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
957
+				'event_espresso'
958
+			),
959
+			'4.9.12',
960
+			'5.0.0'
961
+		);
962
+		return $transaction->toggle_abandoned_transaction_status();
963
+	}
964 964
 }
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
     public static function instance($registration_query_params = array())
54 54
     {
55 55
         // check if class object is instantiated
56
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
56
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
57 57
             self::$_instance = new self($registration_query_params);
58 58
         }
59 59
         return self::$_instance;
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
311 311
         // these reg statuses should not be considered in any calculations involving monies owing
312 312
         $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
313 313
             : EEM_Registration::closed_reg_statuses();
314
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
314
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
315 315
             return false;
316 316
         }
317 317
         try {
@@ -363,7 +363,7 @@  discard block
 block discarded – undo
363 363
     public function get_transaction_for_registration(EE_Registration $registration)
364 364
     {
365 365
         $transaction = $registration->transaction();
366
-        if (! $transaction instanceof EE_Transaction) {
366
+        if ( ! $transaction instanceof EE_Transaction) {
367 367
             throw new EE_Error(
368 368
                 sprintf(
369 369
                     __('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
             $transaction->ID(),
394 394
             $registration->ticket_ID()
395 395
         );
396
-        if (! $ticket_line_item instanceof EE_Line_Item) {
396
+        if ( ! $ticket_line_item instanceof EE_Line_Item) {
397 397
             throw new EE_Error(
398 398
                 sprintf(
399 399
                     __(
@@ -476,7 +476,7 @@  discard block
 block discarded – undo
476 476
         /** @type EE_Registration_Processor $registration_processor */
477 477
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
478 478
         // check that method exists
479
-        if (! method_exists($registration_processor, $method_name)) {
479
+        if ( ! method_exists($registration_processor, $method_name)) {
480 480
             throw new EE_Error(__('Method does not exist.', 'event_espresso'));
481 481
         }
482 482
         // make sure some query params are set for retrieving registrations
@@ -534,7 +534,7 @@  discard block
 block discarded – undo
534 534
                         $transaction,
535 535
                         EEM_Payment_Method::scope_cart
536 536
                     );
537
-                    if (! empty($available_payment_methods)) {
537
+                    if ( ! empty($available_payment_methods)) {
538 538
                         $PMD_ID = 0;
539 539
                         foreach ($available_payment_methods as $available_payment_method) {
540 540
                             if ($available_payment_method instanceof EE_Payment_Method
@@ -544,7 +544,7 @@  discard block
 block discarded – undo
544 544
                                 break;
545 545
                             }
546 546
                         }
547
-                        if (! $PMD_ID) {
547
+                        if ( ! $PMD_ID) {
548 548
                             $first_payment_method = reset($available_payment_methods);
549 549
                             if ($first_payment_method instanceof EE_Payment_Method) {
550 550
                                 $PMD_ID = $first_payment_method->ID();
Please login to merge, or discard this patch.
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -185,6 +185,7 @@
 block discarded – undo
185 185
      *                                                         when retrieving cached registrations from a transaction
186 186
      * @param bool               $trigger_notifications        whether or not to call
187 187
      *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
188
+     * @param EE_Base_Class $payment
188 189
      * @return array
189 190
      * @throws \EE_Error
190 191
      */
Please login to merge, or discard this patch.
core/admin/EE_Help_Tour_final_stop.class.php 2 patches
Indentation   +43 added lines, -43 removed lines patch added patch discarded remove patch
@@ -15,51 +15,51 @@
 block discarded – undo
15 15
 class EE_Help_Tour_final_stop extends EE_Help_Tour
16 16
 {
17 17
 
18
-    protected function _set_tour_properties()
19
-    {
20
-        $this->_label = __('Final Stop Tour', 'event_espresso');
21
-        $this->_slug = 'final-stop-tour';
22
-    }
18
+	protected function _set_tour_properties()
19
+	{
20
+		$this->_label = __('Final Stop Tour', 'event_espresso');
21
+		$this->_slug = 'final-stop-tour';
22
+	}
23 23
 
24 24
 
25
-    protected function _set_tour_stops()
26
-    {
27
-        $this->_stops = array(
28
-            10 => array(
29
-                'id'          => 'contextual-help-link',
30
-                'content'     => $this->_end(),
31
-                'button_text' => __('Quit', 'event_espresso'),
32
-                'options'     => array(
33
-                    'tipLocation'    => 'left',
34
-                    'tipAdjustmentY' => -20,
35
-                    'tipAdjustmentX' => 10,
36
-                ),
37
-            ),
38
-        );
39
-    }
25
+	protected function _set_tour_stops()
26
+	{
27
+		$this->_stops = array(
28
+			10 => array(
29
+				'id'          => 'contextual-help-link',
30
+				'content'     => $this->_end(),
31
+				'button_text' => __('Quit', 'event_espresso'),
32
+				'options'     => array(
33
+					'tipLocation'    => 'left',
34
+					'tipAdjustmentY' => -20,
35
+					'tipAdjustmentX' => 10,
36
+				),
37
+			),
38
+		);
39
+	}
40 40
 
41 41
 
42
-    /**
43
-     * 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
44
-     * the first time.
45
-     *
46
-     * @return string
47
-     */
48
-    protected function _end()
49
-    {
50
-        $query_args = array(
51
-            'action' => 'admin_option_settings',
52
-            'page'   => 'espresso_general_settings',
53
-        );
54
-        return '<p>'
55
-               . sprintf(
56
-                   __(
57
-                       '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!',
58
-                       'event_espresso'
59
-                   ),
60
-                   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
61
-                   '</a>'
62
-               )
63
-               . '</p>';
64
-    }
42
+	/**
43
+	 * 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
44
+	 * the first time.
45
+	 *
46
+	 * @return string
47
+	 */
48
+	protected function _end()
49
+	{
50
+		$query_args = array(
51
+			'action' => 'admin_option_settings',
52
+			'page'   => 'espresso_general_settings',
53
+		);
54
+		return '<p>'
55
+			   . sprintf(
56
+				   __(
57
+					   '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!',
58
+					   'event_espresso'
59
+				   ),
60
+				   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
61
+				   '</a>'
62
+			   )
63
+			   . '</p>';
64
+	}
65 65
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -57,7 +57,7 @@
 block discarded – undo
57 57
                        '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!',
58 58
                        'event_espresso'
59 59
                    ),
60
-                   '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">',
60
+                   '<a href="'.EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')).'">',
61 61
                    '</a>'
62 62
                )
63 63
                . '</p>';
Please login to merge, or discard this patch.