@@ -14,62 +14,62 @@ |
||
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 | } |
@@ -35,7 +35,7 @@ |
||
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(); |
@@ -14,195 +14,195 @@ |
||
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 | } |
@@ -69,13 +69,13 @@ discard block |
||
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 |
||
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 |
||
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(); |
@@ -16,112 +16,112 @@ |
||
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 | } |
@@ -17,43 +17,43 @@ |
||
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 | } |
@@ -24,767 +24,767 @@ |
||
24 | 24 | class EE_Registration_Processor extends EE_Processor_Base |
25 | 25 | { |
26 | 26 | |
27 | - /** |
|
28 | - * @var EE_Registration_Processor $_instance |
|
29 | - * @access private |
|
30 | - */ |
|
31 | - private static $_instance; |
|
32 | - |
|
33 | - /** |
|
34 | - * initial reg status at the beginning of this request. |
|
35 | - * indexed by registration ID |
|
36 | - * |
|
37 | - * @var array |
|
38 | - */ |
|
39 | - protected $_old_reg_status = array(); |
|
40 | - |
|
41 | - /** |
|
42 | - * reg status at the end of the request after all processing. |
|
43 | - * indexed by registration ID |
|
44 | - * |
|
45 | - * @var array |
|
46 | - */ |
|
47 | - protected $_new_reg_status = array(); |
|
48 | - |
|
49 | - /** |
|
50 | - * amounts paid at the end of the request after all processing. |
|
51 | - * indexed by registration ID |
|
52 | - * |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - protected static $_amount_paid = array(); |
|
56 | - |
|
57 | - /** |
|
58 | - * Cache of the reg final price for registrations corresponding to a ticket line item |
|
59 | - * |
|
60 | - * @deprecated |
|
61 | - * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value |
|
62 | - */ |
|
63 | - protected $_reg_final_price_per_tkt_line_item; |
|
64 | - |
|
65 | - /** |
|
66 | - * @var EE_Request $request |
|
67 | - */ |
|
68 | - protected $request; |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @singleton method used to instantiate class object |
|
73 | - * @param EE_Request|null $request |
|
74 | - * @return EE_Registration_Processor instance |
|
75 | - * @throws \InvalidArgumentException |
|
76 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
77 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
78 | - */ |
|
79 | - public static function instance(EE_Request $request = null) |
|
80 | - { |
|
81 | - // check if class object is instantiated |
|
82 | - if (! self::$_instance instanceof EE_Registration_Processor) { |
|
83 | - if (! $request instanceof EE_Request) { |
|
84 | - $request = LoaderFactory::getLoader()->getShared('EE_Request'); |
|
85 | - } |
|
86 | - self::$_instance = new self($request); |
|
87 | - } |
|
88 | - return self::$_instance; |
|
89 | - } |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * EE_Registration_Processor constructor. |
|
94 | - * |
|
95 | - * @param EE_Request $request |
|
96 | - */ |
|
97 | - public function __construct(EE_Request $request) |
|
98 | - { |
|
99 | - $this->request = $request; |
|
100 | - } |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * @param int $REG_ID |
|
105 | - * @return string |
|
106 | - */ |
|
107 | - public function old_reg_status($REG_ID) |
|
108 | - { |
|
109 | - return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null; |
|
110 | - } |
|
111 | - |
|
112 | - |
|
113 | - /** |
|
114 | - * @param int $REG_ID |
|
115 | - * @param string $old_reg_status |
|
116 | - */ |
|
117 | - public function set_old_reg_status($REG_ID, $old_reg_status) |
|
118 | - { |
|
119 | - // only set the first time |
|
120 | - if (! isset($this->_old_reg_status[ $REG_ID ])) { |
|
121 | - $this->_old_reg_status[ $REG_ID ] = $old_reg_status; |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @param int $REG_ID |
|
128 | - * @return string |
|
129 | - */ |
|
130 | - public function new_reg_status($REG_ID) |
|
131 | - { |
|
132 | - return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null; |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @param int $REG_ID |
|
138 | - * @param string $new_reg_status |
|
139 | - */ |
|
140 | - public function set_new_reg_status($REG_ID, $new_reg_status) |
|
141 | - { |
|
142 | - $this->_new_reg_status[ $REG_ID ] = $new_reg_status; |
|
143 | - } |
|
144 | - |
|
145 | - |
|
146 | - /** |
|
147 | - * reg_status_updated |
|
148 | - * |
|
149 | - * @param int $REG_ID |
|
150 | - * @return bool |
|
151 | - */ |
|
152 | - public function reg_status_updated($REG_ID) |
|
153 | - { |
|
154 | - return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID); |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * @param EE_Registration $registration |
|
160 | - * @throws EE_Error |
|
161 | - * @throws EntityNotFoundException |
|
162 | - * @throws InvalidArgumentException |
|
163 | - * @throws InvalidDataTypeException |
|
164 | - * @throws InvalidInterfaceException |
|
165 | - * @throws ReflectionException |
|
166 | - * @throws RuntimeException |
|
167 | - */ |
|
168 | - public function update_registration_status_and_trigger_notifications(EE_Registration $registration) |
|
169 | - { |
|
170 | - $this->toggle_incomplete_registration_status_to_default($registration, false); |
|
171 | - $this->toggle_registration_status_for_default_approved_events($registration, false); |
|
172 | - $this->toggle_registration_status_if_no_monies_owing($registration, false); |
|
173 | - $registration->save(); |
|
174 | - // trigger notifications |
|
175 | - $this->trigger_registration_update_notifications($registration); |
|
176 | - } |
|
177 | - |
|
178 | - |
|
179 | - /** |
|
180 | - * manually_update_registration_status |
|
181 | - * |
|
182 | - * @access public |
|
183 | - * @param EE_Registration $registration |
|
184 | - * @param string $new_reg_status |
|
185 | - * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
186 | - * to client code |
|
187 | - * @return bool |
|
188 | - * @throws EE_Error |
|
189 | - * @throws EntityNotFoundException |
|
190 | - * @throws InvalidArgumentException |
|
191 | - * @throws InvalidDataTypeException |
|
192 | - * @throws InvalidInterfaceException |
|
193 | - * @throws ReflectionException |
|
194 | - * @throws RuntimeException |
|
195 | - */ |
|
196 | - public function manually_update_registration_status( |
|
197 | - EE_Registration $registration, |
|
198 | - $new_reg_status = '', |
|
199 | - $save = true |
|
200 | - ) { |
|
201 | - // set initial REG_Status |
|
202 | - $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
203 | - // set incoming REG_Status |
|
204 | - $this->set_new_reg_status($registration->ID(), $new_reg_status); |
|
205 | - // toggle reg status but only if it has changed and the user can do so |
|
206 | - if ($this->reg_status_updated($registration->ID()) |
|
207 | - && ( |
|
208 | - (! $this->request->isAdmin() || $this->request->isFrontAjax()) |
|
209 | - || EE_Registry::instance()->CAP->current_user_can( |
|
210 | - 'ee_edit_registration', |
|
211 | - 'toggle_registration_status', |
|
212 | - $registration->ID() |
|
213 | - ) |
|
214 | - ) |
|
215 | - ) { |
|
216 | - // change status to new value |
|
217 | - $updated = $registration->set_status($this->new_reg_status($registration->ID())); |
|
218 | - if ($updated && $save) { |
|
219 | - $registration->save(); |
|
220 | - } |
|
221 | - return true; |
|
222 | - } |
|
223 | - return false; |
|
224 | - } |
|
225 | - |
|
226 | - |
|
227 | - /** |
|
228 | - * toggle_incomplete_registration_status_to_default |
|
229 | - * changes any incomplete registrations to either the event or global default registration status |
|
230 | - * |
|
231 | - * @access public |
|
232 | - * @param EE_Registration $registration |
|
233 | - * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave |
|
234 | - * that up to client code |
|
235 | - * @param ContextInterface|null $context |
|
236 | - * @return void |
|
237 | - * @throws EE_Error |
|
238 | - * @throws InvalidArgumentException |
|
239 | - * @throws ReflectionException |
|
240 | - * @throws RuntimeException |
|
241 | - * @throws EntityNotFoundException |
|
242 | - * @throws InvalidDataTypeException |
|
243 | - * @throws InvalidInterfaceException |
|
244 | - */ |
|
245 | - public function toggle_incomplete_registration_status_to_default( |
|
246 | - EE_Registration $registration, |
|
247 | - $save = true, |
|
248 | - ContextInterface $context = null |
|
249 | - ) { |
|
250 | - $existing_reg_status = $registration->status_ID(); |
|
251 | - // set initial REG_Status |
|
252 | - $this->set_old_reg_status($registration->ID(), $existing_reg_status); |
|
253 | - // is the registration currently incomplete ? |
|
254 | - if ($registration->status_ID() === EEM_Registration::status_id_incomplete) { |
|
255 | - // grab default reg status for the event, if set |
|
256 | - $event_default_registration_status = $registration->event()->default_registration_status(); |
|
257 | - // if no default reg status is set for the event, then use the global value |
|
258 | - $STS_ID = ! empty($event_default_registration_status) |
|
259 | - ? $event_default_registration_status |
|
260 | - : EE_Registry::instance()->CFG->registration->default_STS_ID; |
|
261 | - // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered |
|
262 | - $STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment |
|
263 | - : $STS_ID; |
|
264 | - // set incoming REG_Status |
|
265 | - $this->set_new_reg_status($registration->ID(), $STS_ID); |
|
266 | - $registration->set_status($STS_ID, false, $context); |
|
267 | - if ($save) { |
|
268 | - $registration->save(); |
|
269 | - } |
|
270 | - // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
271 | - if (! EE_Processor_Base::$IPN) { |
|
272 | - // otherwise, send out notifications |
|
273 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
274 | - } |
|
275 | - // DEBUG LOG |
|
276 | - // $this->log( |
|
277 | - // __CLASS__, |
|
278 | - // __FUNCTION__, |
|
279 | - // __LINE__, |
|
280 | - // $registration->transaction(), |
|
281 | - // array( |
|
282 | - // 'IPN' => EE_Processor_Base::$IPN, |
|
283 | - // 'deliver_notifications' => has_filter( |
|
284 | - // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
285 | - // ), |
|
286 | - // ) |
|
287 | - // ); |
|
288 | - } |
|
289 | - } |
|
290 | - |
|
291 | - |
|
292 | - /** |
|
293 | - * toggle_registration_status_for_default_approved_events |
|
294 | - * |
|
295 | - * @access public |
|
296 | - * @param EE_Registration $registration |
|
297 | - * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
298 | - * to client code |
|
299 | - * @return bool |
|
300 | - * @throws EE_Error |
|
301 | - * @throws EntityNotFoundException |
|
302 | - * @throws InvalidArgumentException |
|
303 | - * @throws InvalidDataTypeException |
|
304 | - * @throws InvalidInterfaceException |
|
305 | - * @throws ReflectionException |
|
306 | - * @throws RuntimeException |
|
307 | - */ |
|
308 | - public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true) |
|
309 | - { |
|
310 | - $reg_status = $registration->status_ID(); |
|
311 | - // set initial REG_Status |
|
312 | - $this->set_old_reg_status($registration->ID(), $reg_status); |
|
313 | - // if not already, toggle reg status to approved IF the event default reg status is approved |
|
314 | - // ( as long as the registration wasn't cancelled or declined at some point ) |
|
315 | - if ($reg_status !== EEM_Registration::status_id_cancelled |
|
316 | - && $reg_status |
|
317 | - !== EEM_Registration::status_id_declined |
|
318 | - && $reg_status !== EEM_Registration::status_id_approved |
|
319 | - && $registration->event()->default_registration_status() === EEM_Registration::status_id_approved |
|
320 | - ) { |
|
321 | - // set incoming REG_Status |
|
322 | - $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved); |
|
323 | - // toggle status to approved |
|
324 | - $registration->set_status(EEM_Registration::status_id_approved); |
|
325 | - if ($save) { |
|
326 | - $registration->save(); |
|
327 | - } |
|
328 | - // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
329 | - if (! EE_Processor_Base::$IPN) { |
|
330 | - // otherwise, send out notifications |
|
331 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
332 | - } |
|
333 | - // DEBUG LOG |
|
334 | - // $this->log( |
|
335 | - // __CLASS__, |
|
336 | - // __FUNCTION__, |
|
337 | - // __LINE__, |
|
338 | - // $registration->transaction(), |
|
339 | - // array( |
|
340 | - // 'IPN' => EE_Processor_Base::$IPN, |
|
341 | - // 'deliver_notifications' => has_filter( |
|
342 | - // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
343 | - // ), |
|
344 | - // ) |
|
345 | - // ); |
|
346 | - return true; |
|
347 | - } |
|
348 | - return false; |
|
349 | - } |
|
350 | - |
|
351 | - |
|
352 | - /** |
|
353 | - * toggle_registration_statuses_if_no_monies_owing |
|
354 | - * |
|
355 | - * @access public |
|
356 | - * @param EE_Registration $registration |
|
357 | - * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
358 | - * to client code |
|
359 | - * @param array $additional_details |
|
360 | - * @return bool |
|
361 | - * @throws EE_Error |
|
362 | - * @throws EntityNotFoundException |
|
363 | - * @throws InvalidArgumentException |
|
364 | - * @throws InvalidDataTypeException |
|
365 | - * @throws InvalidInterfaceException |
|
366 | - * @throws ReflectionException |
|
367 | - * @throws RuntimeException |
|
368 | - */ |
|
369 | - public function toggle_registration_status_if_no_monies_owing( |
|
370 | - EE_Registration $registration, |
|
371 | - $save = true, |
|
372 | - array $additional_details = array() |
|
373 | - ) { |
|
374 | - // set initial REG_Status |
|
375 | - $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
376 | - // was a payment just made ? |
|
377 | - $payment = isset($additional_details['payment_updates'], $additional_details['last_payment']) |
|
378 | - && $additional_details['payment_updates'] |
|
379 | - && $additional_details['last_payment'] instanceof EE_Payment |
|
380 | - ? $additional_details['last_payment'] |
|
381 | - : null; |
|
382 | - $total_paid = array_sum(self::$_amount_paid); |
|
383 | - // toggle reg status to approved IF |
|
384 | - if (// REG status is pending payment |
|
385 | - $registration->status_ID() === EEM_Registration::status_id_pending_payment |
|
386 | - // AND no monies are owing |
|
387 | - && ( |
|
388 | - ( |
|
389 | - $registration->transaction()->is_completed() |
|
390 | - || $registration->transaction()->is_overpaid() |
|
391 | - || $registration->transaction()->is_free() |
|
392 | - || apply_filters( |
|
393 | - 'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', |
|
394 | - false, |
|
395 | - $registration |
|
396 | - ) |
|
397 | - ) |
|
398 | - || ( |
|
399 | - $payment instanceof EE_Payment && $payment->is_approved() |
|
400 | - && // this specific registration has not yet been paid for |
|
401 | - ! isset(self::$_amount_paid[ $registration->ID() ]) |
|
402 | - && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price |
|
403 | - $payment->amount() - $total_paid >= $registration->final_price() |
|
404 | - ) |
|
405 | - ) |
|
406 | - ) { |
|
407 | - // mark as paid |
|
408 | - self::$_amount_paid[ $registration->ID() ] = $registration->final_price(); |
|
409 | - // track new REG_Status |
|
410 | - $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved); |
|
411 | - // toggle status to approved |
|
412 | - $registration->set_status(EEM_Registration::status_id_approved); |
|
413 | - if ($save) { |
|
414 | - $registration->save(); |
|
415 | - } |
|
416 | - // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
417 | - if (! EE_Processor_Base::$IPN) { |
|
418 | - // otherwise, send out notifications |
|
419 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
420 | - } |
|
421 | - // DEBUG LOG |
|
422 | - // $this->log( |
|
423 | - // __CLASS__, |
|
424 | - // __FUNCTION__, |
|
425 | - // __LINE__, |
|
426 | - // $registration->transaction(), |
|
427 | - // array( |
|
428 | - // 'IPN' => EE_Processor_Base::$IPN, |
|
429 | - // 'deliver_notifications' => has_filter( |
|
430 | - // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
431 | - // ), |
|
432 | - // ) |
|
433 | - // ); |
|
434 | - return true; |
|
435 | - } |
|
436 | - return false; |
|
437 | - } |
|
438 | - |
|
439 | - |
|
440 | - /** |
|
441 | - * registration_status_changed |
|
442 | - * |
|
443 | - * @access public |
|
444 | - * @param EE_Registration $registration |
|
445 | - * @param array $additional_details |
|
446 | - * @return void |
|
447 | - */ |
|
448 | - public function trigger_registration_update_notifications($registration, array $additional_details = array()) |
|
449 | - { |
|
450 | - try { |
|
451 | - if (! $registration instanceof EE_Registration) { |
|
452 | - throw new EE_Error( |
|
453 | - esc_html__('An invalid registration was received.', 'event_espresso') |
|
454 | - ); |
|
455 | - } |
|
456 | - // EE_Registry::instance()->load_helper('Debug_Tools'); |
|
457 | - // EEH_Debug_Tools::log( |
|
458 | - // __CLASS__, |
|
459 | - // __FUNCTION__, |
|
460 | - // __LINE__, |
|
461 | - // array($registration->transaction(), $additional_details), |
|
462 | - // false, |
|
463 | - // 'EE_Transaction: ' . $registration->transaction()->ID() |
|
464 | - // ); |
|
465 | - if (! $registration->is_primary_registrant()) { |
|
466 | - return; |
|
467 | - } |
|
468 | - do_action( |
|
469 | - 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', |
|
470 | - $registration, |
|
471 | - $additional_details |
|
472 | - ); |
|
473 | - } catch (Exception $e) { |
|
474 | - EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine()); |
|
475 | - } |
|
476 | - } |
|
477 | - |
|
478 | - |
|
479 | - /** |
|
480 | - * sets reg status based either on passed param or on transaction status and event pre-approval setting |
|
481 | - * |
|
482 | - * @param EE_Registration $registration |
|
483 | - * @param array $additional_details |
|
484 | - * @return bool |
|
485 | - * @throws EE_Error |
|
486 | - * @throws EntityNotFoundException |
|
487 | - * @throws InvalidArgumentException |
|
488 | - * @throws InvalidDataTypeException |
|
489 | - * @throws InvalidInterfaceException |
|
490 | - * @throws ReflectionException |
|
491 | - * @throws RuntimeException |
|
492 | - */ |
|
493 | - public function update_registration_after_checkout_or_payment( |
|
494 | - EE_Registration $registration, |
|
495 | - array $additional_details = array() |
|
496 | - ) { |
|
497 | - // set initial REG_Status |
|
498 | - $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
499 | - // if the registration status gets updated, then save the registration |
|
500 | - if ($this->toggle_registration_status_for_default_approved_events($registration, false) |
|
501 | - || $this->toggle_registration_status_if_no_monies_owing( |
|
502 | - $registration, |
|
503 | - false, |
|
504 | - $additional_details |
|
505 | - ) |
|
506 | - ) { |
|
507 | - $registration->save(); |
|
508 | - } |
|
509 | - // set new REG_Status |
|
510 | - $this->set_new_reg_status($registration->ID(), $registration->status_ID()); |
|
511 | - return $this->reg_status_updated($registration->ID()) |
|
512 | - && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved; |
|
513 | - } |
|
514 | - |
|
515 | - |
|
516 | - /** |
|
517 | - * Updates the registration' final prices based on the current line item tree (taking into account |
|
518 | - * discounts, taxes, and other line items unrelated to tickets.) |
|
519 | - * |
|
520 | - * @param EE_Transaction $transaction |
|
521 | - * @param boolean $save_regs whether to immediately save registrations in this function or not |
|
522 | - * @return void |
|
523 | - * @throws EE_Error |
|
524 | - * @throws InvalidArgumentException |
|
525 | - * @throws InvalidDataTypeException |
|
526 | - * @throws InvalidInterfaceException |
|
527 | - * @throws RuntimeException |
|
528 | - */ |
|
529 | - public function update_registration_final_prices($transaction, $save_regs = true) |
|
530 | - { |
|
531 | - $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
532 | - $transaction->total_line_item() |
|
533 | - ); |
|
534 | - foreach ($transaction->registrations() as $registration) { |
|
535 | - /** @var EE_Line_Item $line_item */ |
|
536 | - $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration); |
|
537 | - if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) { |
|
538 | - $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]); |
|
539 | - if ($save_regs) { |
|
540 | - $registration->save(); |
|
541 | - } |
|
542 | - } |
|
543 | - } |
|
544 | - // and make sure there's no rounding problem |
|
545 | - $this->fix_reg_final_price_rounding_issue($transaction); |
|
546 | - } |
|
547 | - |
|
548 | - |
|
549 | - /** |
|
550 | - * Makes sure there is no rounding errors for the REG_final_prices. |
|
551 | - * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them, |
|
552 | - * they will each be for $0.99333333, which gets rounded to $1 again. |
|
553 | - * So the transaction total will be $2.99, but each registration will be for $1, |
|
554 | - * so if each registrant paid individually they will have overpaid by $0.01. |
|
555 | - * So in order to overcome this, we check for any difference, and if there is a difference |
|
556 | - * we just grab one registrant at random and make them responsible for it. |
|
557 | - * This should be used after setting REG_final_prices (it's done automatically as part of |
|
558 | - * EE_Registration_Processor::update_registration_final_prices()) |
|
559 | - * |
|
560 | - * @param EE_Transaction $transaction |
|
561 | - * @return bool success verifying that there is NO difference after this method is done |
|
562 | - * @throws EE_Error |
|
563 | - * @throws InvalidArgumentException |
|
564 | - * @throws InvalidDataTypeException |
|
565 | - * @throws InvalidInterfaceException |
|
566 | - */ |
|
567 | - public function fix_reg_final_price_rounding_issue($transaction) |
|
568 | - { |
|
569 | - $reg_final_price_sum = EEM_Registration::instance()->sum( |
|
570 | - array( |
|
571 | - array( |
|
572 | - 'TXN_ID' => $transaction->ID(), |
|
573 | - ), |
|
574 | - ), |
|
575 | - 'REG_final_price' |
|
576 | - ); |
|
577 | - $diff = $transaction->total() - $reg_final_price_sum; |
|
578 | - // ok then, just grab one of the registrations |
|
579 | - if ($diff !== 0) { |
|
580 | - $a_reg = EEM_Registration::instance()->get_one( |
|
581 | - array( |
|
582 | - array( |
|
583 | - 'TXN_ID' => $transaction->ID(), |
|
584 | - ), |
|
585 | - ) |
|
586 | - ); |
|
587 | - return $a_reg instanceof EE_Registration |
|
588 | - ? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff)) |
|
589 | - : false; |
|
590 | - } |
|
591 | - return true; |
|
592 | - } |
|
593 | - |
|
594 | - |
|
595 | - /** |
|
596 | - * update_registration_after_being_canceled_or_declined |
|
597 | - * |
|
598 | - * @param EE_Registration $registration |
|
599 | - * @param array $closed_reg_statuses |
|
600 | - * @param bool $update_reg |
|
601 | - * @return bool |
|
602 | - * @throws EE_Error |
|
603 | - * @throws RuntimeException |
|
604 | - */ |
|
605 | - public function update_registration_after_being_canceled_or_declined( |
|
606 | - EE_Registration $registration, |
|
607 | - array $closed_reg_statuses = array(), |
|
608 | - $update_reg = true |
|
609 | - ) { |
|
610 | - // these reg statuses should not be considered in any calculations involving monies owing |
|
611 | - $closed_reg_statuses = ! empty($closed_reg_statuses) |
|
612 | - ? $closed_reg_statuses |
|
613 | - : EEM_Registration::closed_reg_statuses(); |
|
614 | - if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
615 | - return false; |
|
616 | - } |
|
617 | - // release a reserved ticket by decrementing ticket and datetime reserved values |
|
618 | - $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__); |
|
619 | - $registration->set_final_price(0); |
|
620 | - if ($update_reg) { |
|
621 | - $registration->save(); |
|
622 | - } |
|
623 | - return true; |
|
624 | - } |
|
625 | - |
|
626 | - |
|
627 | - /** |
|
628 | - * update_canceled_or_declined_registration_after_being_reinstated |
|
629 | - * |
|
630 | - * @param EE_Registration $registration |
|
631 | - * @param array $closed_reg_statuses |
|
632 | - * @param bool $update_reg |
|
633 | - * @return bool |
|
634 | - * @throws EE_Error |
|
635 | - * @throws RuntimeException |
|
636 | - */ |
|
637 | - public function update_canceled_or_declined_registration_after_being_reinstated( |
|
638 | - EE_Registration $registration, |
|
639 | - array $closed_reg_statuses = array(), |
|
640 | - $update_reg = true |
|
641 | - ) { |
|
642 | - // these reg statuses should not be considered in any calculations involving monies owing |
|
643 | - $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses |
|
644 | - : EEM_Registration::closed_reg_statuses(); |
|
645 | - if (in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
646 | - return false; |
|
647 | - } |
|
648 | - $ticket = $registration->ticket(); |
|
649 | - if (! $ticket instanceof EE_Ticket) { |
|
650 | - throw new EE_Error( |
|
651 | - sprintf( |
|
652 | - esc_html__( |
|
653 | - 'The Ticket for Registration %1$d was not found or is invalid.', |
|
654 | - 'event_espresso' |
|
655 | - ), |
|
656 | - $registration->ticket_ID() |
|
657 | - ) |
|
658 | - ); |
|
659 | - } |
|
660 | - $registration->set_final_price($ticket->price()); |
|
661 | - if ($update_reg) { |
|
662 | - $registration->save(); |
|
663 | - } |
|
664 | - return true; |
|
665 | - } |
|
666 | - |
|
667 | - |
|
668 | - /** |
|
669 | - * generate_ONE_registration_from_line_item |
|
670 | - * Although a ticket line item may have a quantity greater than 1, |
|
671 | - * this method will ONLY CREATE ONE REGISTRATION !!! |
|
672 | - * Regardless of the ticket line item quantity. |
|
673 | - * This means that any code calling this method is responsible for ensuring |
|
674 | - * that the final registration count matches the ticket line item quantity. |
|
675 | - * This was done to make it easier to match the number of registrations |
|
676 | - * to the number of tickets in the cart, when the cart has been edited |
|
677 | - * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass |
|
678 | - * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets. |
|
679 | - * |
|
680 | - * @deprecated |
|
681 | - * @since 4.9.1 |
|
682 | - * @param EE_Line_Item $line_item |
|
683 | - * @param \EE_Transaction $transaction |
|
684 | - * @param int $att_nmbr |
|
685 | - * @param int $total_ticket_count |
|
686 | - * @return EE_Registration | null |
|
687 | - * @throws \OutOfRangeException |
|
688 | - * @throws \EventEspresso\core\exceptions\UnexpectedEntityException |
|
689 | - * @throws \EE_Error |
|
690 | - */ |
|
691 | - public function generate_ONE_registration_from_line_item( |
|
692 | - EE_Line_Item $line_item, |
|
693 | - EE_Transaction $transaction, |
|
694 | - $att_nmbr = 1, |
|
695 | - $total_ticket_count = 1 |
|
696 | - ) { |
|
697 | - EE_Error::doing_it_wrong( |
|
698 | - __CLASS__ . '::' . __FUNCTION__, |
|
699 | - sprintf( |
|
700 | - esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
701 | - '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()' |
|
702 | - ), |
|
703 | - '4.9.1', |
|
704 | - '5.0.0' |
|
705 | - ); |
|
706 | - // grab the related ticket object for this line_item |
|
707 | - $ticket = $line_item->ticket(); |
|
708 | - if (! $ticket instanceof EE_Ticket) { |
|
709 | - EE_Error::add_error( |
|
710 | - sprintf( |
|
711 | - esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'), |
|
712 | - $line_item->ID() |
|
713 | - ), |
|
714 | - __FILE__, |
|
715 | - __FUNCTION__, |
|
716 | - __LINE__ |
|
717 | - ); |
|
718 | - return null; |
|
719 | - } |
|
720 | - $registration_service = new CreateRegistrationService(); |
|
721 | - // then generate a new registration from that |
|
722 | - return $registration_service->create( |
|
723 | - $ticket->get_related_event(), |
|
724 | - $transaction, |
|
725 | - $ticket, |
|
726 | - $line_item, |
|
727 | - $att_nmbr, |
|
728 | - $total_ticket_count |
|
729 | - ); |
|
730 | - } |
|
731 | - |
|
732 | - |
|
733 | - /** |
|
734 | - * generates reg_url_link |
|
735 | - * |
|
736 | - * @deprecated |
|
737 | - * @since 4.9.1 |
|
738 | - * @param int $att_nmbr |
|
739 | - * @param EE_Line_Item | string $item |
|
740 | - * @return string |
|
741 | - * @throws InvalidArgumentException |
|
742 | - */ |
|
743 | - public function generate_reg_url_link($att_nmbr, $item) |
|
744 | - { |
|
745 | - EE_Error::doing_it_wrong( |
|
746 | - __CLASS__ . '::' . __FUNCTION__, |
|
747 | - sprintf( |
|
748 | - esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
749 | - 'EventEspresso\core\domain\entities\RegUrlLink' |
|
750 | - ), |
|
751 | - '4.9.1', |
|
752 | - '5.0.0' |
|
753 | - ); |
|
754 | - return new RegUrlLink($att_nmbr, $item); |
|
755 | - } |
|
756 | - |
|
757 | - |
|
758 | - /** |
|
759 | - * generates reg code |
|
760 | - * |
|
761 | - * @deprecated |
|
762 | - * @since 4.9.1 |
|
763 | - * @param EE_Registration $registration |
|
764 | - * @return string |
|
765 | - * @throws EE_Error |
|
766 | - * @throws EntityNotFoundException |
|
767 | - * @throws InvalidArgumentException |
|
768 | - */ |
|
769 | - public function generate_reg_code(EE_Registration $registration) |
|
770 | - { |
|
771 | - EE_Error::doing_it_wrong( |
|
772 | - __CLASS__ . '::' . __FUNCTION__, |
|
773 | - sprintf( |
|
774 | - esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
775 | - 'EventEspresso\core\domain\entities\RegCode' |
|
776 | - ), |
|
777 | - '4.9.1', |
|
778 | - '5.0.0' |
|
779 | - ); |
|
780 | - return apply_filters( |
|
781 | - 'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code', |
|
782 | - new RegCode( |
|
783 | - RegUrlLink::fromRegistration($registration), |
|
784 | - $registration->transaction(), |
|
785 | - $registration->ticket() |
|
786 | - ), |
|
787 | - $registration |
|
788 | - ); |
|
789 | - } |
|
27 | + /** |
|
28 | + * @var EE_Registration_Processor $_instance |
|
29 | + * @access private |
|
30 | + */ |
|
31 | + private static $_instance; |
|
32 | + |
|
33 | + /** |
|
34 | + * initial reg status at the beginning of this request. |
|
35 | + * indexed by registration ID |
|
36 | + * |
|
37 | + * @var array |
|
38 | + */ |
|
39 | + protected $_old_reg_status = array(); |
|
40 | + |
|
41 | + /** |
|
42 | + * reg status at the end of the request after all processing. |
|
43 | + * indexed by registration ID |
|
44 | + * |
|
45 | + * @var array |
|
46 | + */ |
|
47 | + protected $_new_reg_status = array(); |
|
48 | + |
|
49 | + /** |
|
50 | + * amounts paid at the end of the request after all processing. |
|
51 | + * indexed by registration ID |
|
52 | + * |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + protected static $_amount_paid = array(); |
|
56 | + |
|
57 | + /** |
|
58 | + * Cache of the reg final price for registrations corresponding to a ticket line item |
|
59 | + * |
|
60 | + * @deprecated |
|
61 | + * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value |
|
62 | + */ |
|
63 | + protected $_reg_final_price_per_tkt_line_item; |
|
64 | + |
|
65 | + /** |
|
66 | + * @var EE_Request $request |
|
67 | + */ |
|
68 | + protected $request; |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @singleton method used to instantiate class object |
|
73 | + * @param EE_Request|null $request |
|
74 | + * @return EE_Registration_Processor instance |
|
75 | + * @throws \InvalidArgumentException |
|
76 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
77 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
78 | + */ |
|
79 | + public static function instance(EE_Request $request = null) |
|
80 | + { |
|
81 | + // check if class object is instantiated |
|
82 | + if (! self::$_instance instanceof EE_Registration_Processor) { |
|
83 | + if (! $request instanceof EE_Request) { |
|
84 | + $request = LoaderFactory::getLoader()->getShared('EE_Request'); |
|
85 | + } |
|
86 | + self::$_instance = new self($request); |
|
87 | + } |
|
88 | + return self::$_instance; |
|
89 | + } |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * EE_Registration_Processor constructor. |
|
94 | + * |
|
95 | + * @param EE_Request $request |
|
96 | + */ |
|
97 | + public function __construct(EE_Request $request) |
|
98 | + { |
|
99 | + $this->request = $request; |
|
100 | + } |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * @param int $REG_ID |
|
105 | + * @return string |
|
106 | + */ |
|
107 | + public function old_reg_status($REG_ID) |
|
108 | + { |
|
109 | + return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null; |
|
110 | + } |
|
111 | + |
|
112 | + |
|
113 | + /** |
|
114 | + * @param int $REG_ID |
|
115 | + * @param string $old_reg_status |
|
116 | + */ |
|
117 | + public function set_old_reg_status($REG_ID, $old_reg_status) |
|
118 | + { |
|
119 | + // only set the first time |
|
120 | + if (! isset($this->_old_reg_status[ $REG_ID ])) { |
|
121 | + $this->_old_reg_status[ $REG_ID ] = $old_reg_status; |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @param int $REG_ID |
|
128 | + * @return string |
|
129 | + */ |
|
130 | + public function new_reg_status($REG_ID) |
|
131 | + { |
|
132 | + return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null; |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @param int $REG_ID |
|
138 | + * @param string $new_reg_status |
|
139 | + */ |
|
140 | + public function set_new_reg_status($REG_ID, $new_reg_status) |
|
141 | + { |
|
142 | + $this->_new_reg_status[ $REG_ID ] = $new_reg_status; |
|
143 | + } |
|
144 | + |
|
145 | + |
|
146 | + /** |
|
147 | + * reg_status_updated |
|
148 | + * |
|
149 | + * @param int $REG_ID |
|
150 | + * @return bool |
|
151 | + */ |
|
152 | + public function reg_status_updated($REG_ID) |
|
153 | + { |
|
154 | + return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID); |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * @param EE_Registration $registration |
|
160 | + * @throws EE_Error |
|
161 | + * @throws EntityNotFoundException |
|
162 | + * @throws InvalidArgumentException |
|
163 | + * @throws InvalidDataTypeException |
|
164 | + * @throws InvalidInterfaceException |
|
165 | + * @throws ReflectionException |
|
166 | + * @throws RuntimeException |
|
167 | + */ |
|
168 | + public function update_registration_status_and_trigger_notifications(EE_Registration $registration) |
|
169 | + { |
|
170 | + $this->toggle_incomplete_registration_status_to_default($registration, false); |
|
171 | + $this->toggle_registration_status_for_default_approved_events($registration, false); |
|
172 | + $this->toggle_registration_status_if_no_monies_owing($registration, false); |
|
173 | + $registration->save(); |
|
174 | + // trigger notifications |
|
175 | + $this->trigger_registration_update_notifications($registration); |
|
176 | + } |
|
177 | + |
|
178 | + |
|
179 | + /** |
|
180 | + * manually_update_registration_status |
|
181 | + * |
|
182 | + * @access public |
|
183 | + * @param EE_Registration $registration |
|
184 | + * @param string $new_reg_status |
|
185 | + * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
186 | + * to client code |
|
187 | + * @return bool |
|
188 | + * @throws EE_Error |
|
189 | + * @throws EntityNotFoundException |
|
190 | + * @throws InvalidArgumentException |
|
191 | + * @throws InvalidDataTypeException |
|
192 | + * @throws InvalidInterfaceException |
|
193 | + * @throws ReflectionException |
|
194 | + * @throws RuntimeException |
|
195 | + */ |
|
196 | + public function manually_update_registration_status( |
|
197 | + EE_Registration $registration, |
|
198 | + $new_reg_status = '', |
|
199 | + $save = true |
|
200 | + ) { |
|
201 | + // set initial REG_Status |
|
202 | + $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
203 | + // set incoming REG_Status |
|
204 | + $this->set_new_reg_status($registration->ID(), $new_reg_status); |
|
205 | + // toggle reg status but only if it has changed and the user can do so |
|
206 | + if ($this->reg_status_updated($registration->ID()) |
|
207 | + && ( |
|
208 | + (! $this->request->isAdmin() || $this->request->isFrontAjax()) |
|
209 | + || EE_Registry::instance()->CAP->current_user_can( |
|
210 | + 'ee_edit_registration', |
|
211 | + 'toggle_registration_status', |
|
212 | + $registration->ID() |
|
213 | + ) |
|
214 | + ) |
|
215 | + ) { |
|
216 | + // change status to new value |
|
217 | + $updated = $registration->set_status($this->new_reg_status($registration->ID())); |
|
218 | + if ($updated && $save) { |
|
219 | + $registration->save(); |
|
220 | + } |
|
221 | + return true; |
|
222 | + } |
|
223 | + return false; |
|
224 | + } |
|
225 | + |
|
226 | + |
|
227 | + /** |
|
228 | + * toggle_incomplete_registration_status_to_default |
|
229 | + * changes any incomplete registrations to either the event or global default registration status |
|
230 | + * |
|
231 | + * @access public |
|
232 | + * @param EE_Registration $registration |
|
233 | + * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave |
|
234 | + * that up to client code |
|
235 | + * @param ContextInterface|null $context |
|
236 | + * @return void |
|
237 | + * @throws EE_Error |
|
238 | + * @throws InvalidArgumentException |
|
239 | + * @throws ReflectionException |
|
240 | + * @throws RuntimeException |
|
241 | + * @throws EntityNotFoundException |
|
242 | + * @throws InvalidDataTypeException |
|
243 | + * @throws InvalidInterfaceException |
|
244 | + */ |
|
245 | + public function toggle_incomplete_registration_status_to_default( |
|
246 | + EE_Registration $registration, |
|
247 | + $save = true, |
|
248 | + ContextInterface $context = null |
|
249 | + ) { |
|
250 | + $existing_reg_status = $registration->status_ID(); |
|
251 | + // set initial REG_Status |
|
252 | + $this->set_old_reg_status($registration->ID(), $existing_reg_status); |
|
253 | + // is the registration currently incomplete ? |
|
254 | + if ($registration->status_ID() === EEM_Registration::status_id_incomplete) { |
|
255 | + // grab default reg status for the event, if set |
|
256 | + $event_default_registration_status = $registration->event()->default_registration_status(); |
|
257 | + // if no default reg status is set for the event, then use the global value |
|
258 | + $STS_ID = ! empty($event_default_registration_status) |
|
259 | + ? $event_default_registration_status |
|
260 | + : EE_Registry::instance()->CFG->registration->default_STS_ID; |
|
261 | + // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered |
|
262 | + $STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment |
|
263 | + : $STS_ID; |
|
264 | + // set incoming REG_Status |
|
265 | + $this->set_new_reg_status($registration->ID(), $STS_ID); |
|
266 | + $registration->set_status($STS_ID, false, $context); |
|
267 | + if ($save) { |
|
268 | + $registration->save(); |
|
269 | + } |
|
270 | + // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
271 | + if (! EE_Processor_Base::$IPN) { |
|
272 | + // otherwise, send out notifications |
|
273 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
274 | + } |
|
275 | + // DEBUG LOG |
|
276 | + // $this->log( |
|
277 | + // __CLASS__, |
|
278 | + // __FUNCTION__, |
|
279 | + // __LINE__, |
|
280 | + // $registration->transaction(), |
|
281 | + // array( |
|
282 | + // 'IPN' => EE_Processor_Base::$IPN, |
|
283 | + // 'deliver_notifications' => has_filter( |
|
284 | + // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
285 | + // ), |
|
286 | + // ) |
|
287 | + // ); |
|
288 | + } |
|
289 | + } |
|
290 | + |
|
291 | + |
|
292 | + /** |
|
293 | + * toggle_registration_status_for_default_approved_events |
|
294 | + * |
|
295 | + * @access public |
|
296 | + * @param EE_Registration $registration |
|
297 | + * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
298 | + * to client code |
|
299 | + * @return bool |
|
300 | + * @throws EE_Error |
|
301 | + * @throws EntityNotFoundException |
|
302 | + * @throws InvalidArgumentException |
|
303 | + * @throws InvalidDataTypeException |
|
304 | + * @throws InvalidInterfaceException |
|
305 | + * @throws ReflectionException |
|
306 | + * @throws RuntimeException |
|
307 | + */ |
|
308 | + public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true) |
|
309 | + { |
|
310 | + $reg_status = $registration->status_ID(); |
|
311 | + // set initial REG_Status |
|
312 | + $this->set_old_reg_status($registration->ID(), $reg_status); |
|
313 | + // if not already, toggle reg status to approved IF the event default reg status is approved |
|
314 | + // ( as long as the registration wasn't cancelled or declined at some point ) |
|
315 | + if ($reg_status !== EEM_Registration::status_id_cancelled |
|
316 | + && $reg_status |
|
317 | + !== EEM_Registration::status_id_declined |
|
318 | + && $reg_status !== EEM_Registration::status_id_approved |
|
319 | + && $registration->event()->default_registration_status() === EEM_Registration::status_id_approved |
|
320 | + ) { |
|
321 | + // set incoming REG_Status |
|
322 | + $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved); |
|
323 | + // toggle status to approved |
|
324 | + $registration->set_status(EEM_Registration::status_id_approved); |
|
325 | + if ($save) { |
|
326 | + $registration->save(); |
|
327 | + } |
|
328 | + // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
329 | + if (! EE_Processor_Base::$IPN) { |
|
330 | + // otherwise, send out notifications |
|
331 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
332 | + } |
|
333 | + // DEBUG LOG |
|
334 | + // $this->log( |
|
335 | + // __CLASS__, |
|
336 | + // __FUNCTION__, |
|
337 | + // __LINE__, |
|
338 | + // $registration->transaction(), |
|
339 | + // array( |
|
340 | + // 'IPN' => EE_Processor_Base::$IPN, |
|
341 | + // 'deliver_notifications' => has_filter( |
|
342 | + // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
343 | + // ), |
|
344 | + // ) |
|
345 | + // ); |
|
346 | + return true; |
|
347 | + } |
|
348 | + return false; |
|
349 | + } |
|
350 | + |
|
351 | + |
|
352 | + /** |
|
353 | + * toggle_registration_statuses_if_no_monies_owing |
|
354 | + * |
|
355 | + * @access public |
|
356 | + * @param EE_Registration $registration |
|
357 | + * @param bool $save TRUE will save the registration if the status is updated, FALSE will leave that up |
|
358 | + * to client code |
|
359 | + * @param array $additional_details |
|
360 | + * @return bool |
|
361 | + * @throws EE_Error |
|
362 | + * @throws EntityNotFoundException |
|
363 | + * @throws InvalidArgumentException |
|
364 | + * @throws InvalidDataTypeException |
|
365 | + * @throws InvalidInterfaceException |
|
366 | + * @throws ReflectionException |
|
367 | + * @throws RuntimeException |
|
368 | + */ |
|
369 | + public function toggle_registration_status_if_no_monies_owing( |
|
370 | + EE_Registration $registration, |
|
371 | + $save = true, |
|
372 | + array $additional_details = array() |
|
373 | + ) { |
|
374 | + // set initial REG_Status |
|
375 | + $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
376 | + // was a payment just made ? |
|
377 | + $payment = isset($additional_details['payment_updates'], $additional_details['last_payment']) |
|
378 | + && $additional_details['payment_updates'] |
|
379 | + && $additional_details['last_payment'] instanceof EE_Payment |
|
380 | + ? $additional_details['last_payment'] |
|
381 | + : null; |
|
382 | + $total_paid = array_sum(self::$_amount_paid); |
|
383 | + // toggle reg status to approved IF |
|
384 | + if (// REG status is pending payment |
|
385 | + $registration->status_ID() === EEM_Registration::status_id_pending_payment |
|
386 | + // AND no monies are owing |
|
387 | + && ( |
|
388 | + ( |
|
389 | + $registration->transaction()->is_completed() |
|
390 | + || $registration->transaction()->is_overpaid() |
|
391 | + || $registration->transaction()->is_free() |
|
392 | + || apply_filters( |
|
393 | + 'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', |
|
394 | + false, |
|
395 | + $registration |
|
396 | + ) |
|
397 | + ) |
|
398 | + || ( |
|
399 | + $payment instanceof EE_Payment && $payment->is_approved() |
|
400 | + && // this specific registration has not yet been paid for |
|
401 | + ! isset(self::$_amount_paid[ $registration->ID() ]) |
|
402 | + && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price |
|
403 | + $payment->amount() - $total_paid >= $registration->final_price() |
|
404 | + ) |
|
405 | + ) |
|
406 | + ) { |
|
407 | + // mark as paid |
|
408 | + self::$_amount_paid[ $registration->ID() ] = $registration->final_price(); |
|
409 | + // track new REG_Status |
|
410 | + $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved); |
|
411 | + // toggle status to approved |
|
412 | + $registration->set_status(EEM_Registration::status_id_approved); |
|
413 | + if ($save) { |
|
414 | + $registration->save(); |
|
415 | + } |
|
416 | + // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
|
417 | + if (! EE_Processor_Base::$IPN) { |
|
418 | + // otherwise, send out notifications |
|
419 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
|
420 | + } |
|
421 | + // DEBUG LOG |
|
422 | + // $this->log( |
|
423 | + // __CLASS__, |
|
424 | + // __FUNCTION__, |
|
425 | + // __LINE__, |
|
426 | + // $registration->transaction(), |
|
427 | + // array( |
|
428 | + // 'IPN' => EE_Processor_Base::$IPN, |
|
429 | + // 'deliver_notifications' => has_filter( |
|
430 | + // 'FHEE__EED_Messages___maybe_registration__deliver_notifications' |
|
431 | + // ), |
|
432 | + // ) |
|
433 | + // ); |
|
434 | + return true; |
|
435 | + } |
|
436 | + return false; |
|
437 | + } |
|
438 | + |
|
439 | + |
|
440 | + /** |
|
441 | + * registration_status_changed |
|
442 | + * |
|
443 | + * @access public |
|
444 | + * @param EE_Registration $registration |
|
445 | + * @param array $additional_details |
|
446 | + * @return void |
|
447 | + */ |
|
448 | + public function trigger_registration_update_notifications($registration, array $additional_details = array()) |
|
449 | + { |
|
450 | + try { |
|
451 | + if (! $registration instanceof EE_Registration) { |
|
452 | + throw new EE_Error( |
|
453 | + esc_html__('An invalid registration was received.', 'event_espresso') |
|
454 | + ); |
|
455 | + } |
|
456 | + // EE_Registry::instance()->load_helper('Debug_Tools'); |
|
457 | + // EEH_Debug_Tools::log( |
|
458 | + // __CLASS__, |
|
459 | + // __FUNCTION__, |
|
460 | + // __LINE__, |
|
461 | + // array($registration->transaction(), $additional_details), |
|
462 | + // false, |
|
463 | + // 'EE_Transaction: ' . $registration->transaction()->ID() |
|
464 | + // ); |
|
465 | + if (! $registration->is_primary_registrant()) { |
|
466 | + return; |
|
467 | + } |
|
468 | + do_action( |
|
469 | + 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', |
|
470 | + $registration, |
|
471 | + $additional_details |
|
472 | + ); |
|
473 | + } catch (Exception $e) { |
|
474 | + EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine()); |
|
475 | + } |
|
476 | + } |
|
477 | + |
|
478 | + |
|
479 | + /** |
|
480 | + * sets reg status based either on passed param or on transaction status and event pre-approval setting |
|
481 | + * |
|
482 | + * @param EE_Registration $registration |
|
483 | + * @param array $additional_details |
|
484 | + * @return bool |
|
485 | + * @throws EE_Error |
|
486 | + * @throws EntityNotFoundException |
|
487 | + * @throws InvalidArgumentException |
|
488 | + * @throws InvalidDataTypeException |
|
489 | + * @throws InvalidInterfaceException |
|
490 | + * @throws ReflectionException |
|
491 | + * @throws RuntimeException |
|
492 | + */ |
|
493 | + public function update_registration_after_checkout_or_payment( |
|
494 | + EE_Registration $registration, |
|
495 | + array $additional_details = array() |
|
496 | + ) { |
|
497 | + // set initial REG_Status |
|
498 | + $this->set_old_reg_status($registration->ID(), $registration->status_ID()); |
|
499 | + // if the registration status gets updated, then save the registration |
|
500 | + if ($this->toggle_registration_status_for_default_approved_events($registration, false) |
|
501 | + || $this->toggle_registration_status_if_no_monies_owing( |
|
502 | + $registration, |
|
503 | + false, |
|
504 | + $additional_details |
|
505 | + ) |
|
506 | + ) { |
|
507 | + $registration->save(); |
|
508 | + } |
|
509 | + // set new REG_Status |
|
510 | + $this->set_new_reg_status($registration->ID(), $registration->status_ID()); |
|
511 | + return $this->reg_status_updated($registration->ID()) |
|
512 | + && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved; |
|
513 | + } |
|
514 | + |
|
515 | + |
|
516 | + /** |
|
517 | + * Updates the registration' final prices based on the current line item tree (taking into account |
|
518 | + * discounts, taxes, and other line items unrelated to tickets.) |
|
519 | + * |
|
520 | + * @param EE_Transaction $transaction |
|
521 | + * @param boolean $save_regs whether to immediately save registrations in this function or not |
|
522 | + * @return void |
|
523 | + * @throws EE_Error |
|
524 | + * @throws InvalidArgumentException |
|
525 | + * @throws InvalidDataTypeException |
|
526 | + * @throws InvalidInterfaceException |
|
527 | + * @throws RuntimeException |
|
528 | + */ |
|
529 | + public function update_registration_final_prices($transaction, $save_regs = true) |
|
530 | + { |
|
531 | + $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
532 | + $transaction->total_line_item() |
|
533 | + ); |
|
534 | + foreach ($transaction->registrations() as $registration) { |
|
535 | + /** @var EE_Line_Item $line_item */ |
|
536 | + $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration); |
|
537 | + if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) { |
|
538 | + $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]); |
|
539 | + if ($save_regs) { |
|
540 | + $registration->save(); |
|
541 | + } |
|
542 | + } |
|
543 | + } |
|
544 | + // and make sure there's no rounding problem |
|
545 | + $this->fix_reg_final_price_rounding_issue($transaction); |
|
546 | + } |
|
547 | + |
|
548 | + |
|
549 | + /** |
|
550 | + * Makes sure there is no rounding errors for the REG_final_prices. |
|
551 | + * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them, |
|
552 | + * they will each be for $0.99333333, which gets rounded to $1 again. |
|
553 | + * So the transaction total will be $2.99, but each registration will be for $1, |
|
554 | + * so if each registrant paid individually they will have overpaid by $0.01. |
|
555 | + * So in order to overcome this, we check for any difference, and if there is a difference |
|
556 | + * we just grab one registrant at random and make them responsible for it. |
|
557 | + * This should be used after setting REG_final_prices (it's done automatically as part of |
|
558 | + * EE_Registration_Processor::update_registration_final_prices()) |
|
559 | + * |
|
560 | + * @param EE_Transaction $transaction |
|
561 | + * @return bool success verifying that there is NO difference after this method is done |
|
562 | + * @throws EE_Error |
|
563 | + * @throws InvalidArgumentException |
|
564 | + * @throws InvalidDataTypeException |
|
565 | + * @throws InvalidInterfaceException |
|
566 | + */ |
|
567 | + public function fix_reg_final_price_rounding_issue($transaction) |
|
568 | + { |
|
569 | + $reg_final_price_sum = EEM_Registration::instance()->sum( |
|
570 | + array( |
|
571 | + array( |
|
572 | + 'TXN_ID' => $transaction->ID(), |
|
573 | + ), |
|
574 | + ), |
|
575 | + 'REG_final_price' |
|
576 | + ); |
|
577 | + $diff = $transaction->total() - $reg_final_price_sum; |
|
578 | + // ok then, just grab one of the registrations |
|
579 | + if ($diff !== 0) { |
|
580 | + $a_reg = EEM_Registration::instance()->get_one( |
|
581 | + array( |
|
582 | + array( |
|
583 | + 'TXN_ID' => $transaction->ID(), |
|
584 | + ), |
|
585 | + ) |
|
586 | + ); |
|
587 | + return $a_reg instanceof EE_Registration |
|
588 | + ? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff)) |
|
589 | + : false; |
|
590 | + } |
|
591 | + return true; |
|
592 | + } |
|
593 | + |
|
594 | + |
|
595 | + /** |
|
596 | + * update_registration_after_being_canceled_or_declined |
|
597 | + * |
|
598 | + * @param EE_Registration $registration |
|
599 | + * @param array $closed_reg_statuses |
|
600 | + * @param bool $update_reg |
|
601 | + * @return bool |
|
602 | + * @throws EE_Error |
|
603 | + * @throws RuntimeException |
|
604 | + */ |
|
605 | + public function update_registration_after_being_canceled_or_declined( |
|
606 | + EE_Registration $registration, |
|
607 | + array $closed_reg_statuses = array(), |
|
608 | + $update_reg = true |
|
609 | + ) { |
|
610 | + // these reg statuses should not be considered in any calculations involving monies owing |
|
611 | + $closed_reg_statuses = ! empty($closed_reg_statuses) |
|
612 | + ? $closed_reg_statuses |
|
613 | + : EEM_Registration::closed_reg_statuses(); |
|
614 | + if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
615 | + return false; |
|
616 | + } |
|
617 | + // release a reserved ticket by decrementing ticket and datetime reserved values |
|
618 | + $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__); |
|
619 | + $registration->set_final_price(0); |
|
620 | + if ($update_reg) { |
|
621 | + $registration->save(); |
|
622 | + } |
|
623 | + return true; |
|
624 | + } |
|
625 | + |
|
626 | + |
|
627 | + /** |
|
628 | + * update_canceled_or_declined_registration_after_being_reinstated |
|
629 | + * |
|
630 | + * @param EE_Registration $registration |
|
631 | + * @param array $closed_reg_statuses |
|
632 | + * @param bool $update_reg |
|
633 | + * @return bool |
|
634 | + * @throws EE_Error |
|
635 | + * @throws RuntimeException |
|
636 | + */ |
|
637 | + public function update_canceled_or_declined_registration_after_being_reinstated( |
|
638 | + EE_Registration $registration, |
|
639 | + array $closed_reg_statuses = array(), |
|
640 | + $update_reg = true |
|
641 | + ) { |
|
642 | + // these reg statuses should not be considered in any calculations involving monies owing |
|
643 | + $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses |
|
644 | + : EEM_Registration::closed_reg_statuses(); |
|
645 | + if (in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
646 | + return false; |
|
647 | + } |
|
648 | + $ticket = $registration->ticket(); |
|
649 | + if (! $ticket instanceof EE_Ticket) { |
|
650 | + throw new EE_Error( |
|
651 | + sprintf( |
|
652 | + esc_html__( |
|
653 | + 'The Ticket for Registration %1$d was not found or is invalid.', |
|
654 | + 'event_espresso' |
|
655 | + ), |
|
656 | + $registration->ticket_ID() |
|
657 | + ) |
|
658 | + ); |
|
659 | + } |
|
660 | + $registration->set_final_price($ticket->price()); |
|
661 | + if ($update_reg) { |
|
662 | + $registration->save(); |
|
663 | + } |
|
664 | + return true; |
|
665 | + } |
|
666 | + |
|
667 | + |
|
668 | + /** |
|
669 | + * generate_ONE_registration_from_line_item |
|
670 | + * Although a ticket line item may have a quantity greater than 1, |
|
671 | + * this method will ONLY CREATE ONE REGISTRATION !!! |
|
672 | + * Regardless of the ticket line item quantity. |
|
673 | + * This means that any code calling this method is responsible for ensuring |
|
674 | + * that the final registration count matches the ticket line item quantity. |
|
675 | + * This was done to make it easier to match the number of registrations |
|
676 | + * to the number of tickets in the cart, when the cart has been edited |
|
677 | + * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass |
|
678 | + * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets. |
|
679 | + * |
|
680 | + * @deprecated |
|
681 | + * @since 4.9.1 |
|
682 | + * @param EE_Line_Item $line_item |
|
683 | + * @param \EE_Transaction $transaction |
|
684 | + * @param int $att_nmbr |
|
685 | + * @param int $total_ticket_count |
|
686 | + * @return EE_Registration | null |
|
687 | + * @throws \OutOfRangeException |
|
688 | + * @throws \EventEspresso\core\exceptions\UnexpectedEntityException |
|
689 | + * @throws \EE_Error |
|
690 | + */ |
|
691 | + public function generate_ONE_registration_from_line_item( |
|
692 | + EE_Line_Item $line_item, |
|
693 | + EE_Transaction $transaction, |
|
694 | + $att_nmbr = 1, |
|
695 | + $total_ticket_count = 1 |
|
696 | + ) { |
|
697 | + EE_Error::doing_it_wrong( |
|
698 | + __CLASS__ . '::' . __FUNCTION__, |
|
699 | + sprintf( |
|
700 | + esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
701 | + '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()' |
|
702 | + ), |
|
703 | + '4.9.1', |
|
704 | + '5.0.0' |
|
705 | + ); |
|
706 | + // grab the related ticket object for this line_item |
|
707 | + $ticket = $line_item->ticket(); |
|
708 | + if (! $ticket instanceof EE_Ticket) { |
|
709 | + EE_Error::add_error( |
|
710 | + sprintf( |
|
711 | + esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'), |
|
712 | + $line_item->ID() |
|
713 | + ), |
|
714 | + __FILE__, |
|
715 | + __FUNCTION__, |
|
716 | + __LINE__ |
|
717 | + ); |
|
718 | + return null; |
|
719 | + } |
|
720 | + $registration_service = new CreateRegistrationService(); |
|
721 | + // then generate a new registration from that |
|
722 | + return $registration_service->create( |
|
723 | + $ticket->get_related_event(), |
|
724 | + $transaction, |
|
725 | + $ticket, |
|
726 | + $line_item, |
|
727 | + $att_nmbr, |
|
728 | + $total_ticket_count |
|
729 | + ); |
|
730 | + } |
|
731 | + |
|
732 | + |
|
733 | + /** |
|
734 | + * generates reg_url_link |
|
735 | + * |
|
736 | + * @deprecated |
|
737 | + * @since 4.9.1 |
|
738 | + * @param int $att_nmbr |
|
739 | + * @param EE_Line_Item | string $item |
|
740 | + * @return string |
|
741 | + * @throws InvalidArgumentException |
|
742 | + */ |
|
743 | + public function generate_reg_url_link($att_nmbr, $item) |
|
744 | + { |
|
745 | + EE_Error::doing_it_wrong( |
|
746 | + __CLASS__ . '::' . __FUNCTION__, |
|
747 | + sprintf( |
|
748 | + esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
749 | + 'EventEspresso\core\domain\entities\RegUrlLink' |
|
750 | + ), |
|
751 | + '4.9.1', |
|
752 | + '5.0.0' |
|
753 | + ); |
|
754 | + return new RegUrlLink($att_nmbr, $item); |
|
755 | + } |
|
756 | + |
|
757 | + |
|
758 | + /** |
|
759 | + * generates reg code |
|
760 | + * |
|
761 | + * @deprecated |
|
762 | + * @since 4.9.1 |
|
763 | + * @param EE_Registration $registration |
|
764 | + * @return string |
|
765 | + * @throws EE_Error |
|
766 | + * @throws EntityNotFoundException |
|
767 | + * @throws InvalidArgumentException |
|
768 | + */ |
|
769 | + public function generate_reg_code(EE_Registration $registration) |
|
770 | + { |
|
771 | + EE_Error::doing_it_wrong( |
|
772 | + __CLASS__ . '::' . __FUNCTION__, |
|
773 | + sprintf( |
|
774 | + esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
775 | + 'EventEspresso\core\domain\entities\RegCode' |
|
776 | + ), |
|
777 | + '4.9.1', |
|
778 | + '5.0.0' |
|
779 | + ); |
|
780 | + return apply_filters( |
|
781 | + 'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code', |
|
782 | + new RegCode( |
|
783 | + RegUrlLink::fromRegistration($registration), |
|
784 | + $registration->transaction(), |
|
785 | + $registration->ticket() |
|
786 | + ), |
|
787 | + $registration |
|
788 | + ); |
|
789 | + } |
|
790 | 790 | } |
@@ -79,8 +79,8 @@ discard block |
||
79 | 79 | public static function instance(EE_Request $request = null) |
80 | 80 | { |
81 | 81 | // check if class object is instantiated |
82 | - if (! self::$_instance instanceof EE_Registration_Processor) { |
|
83 | - if (! $request instanceof EE_Request) { |
|
82 | + if ( ! self::$_instance instanceof EE_Registration_Processor) { |
|
83 | + if ( ! $request instanceof EE_Request) { |
|
84 | 84 | $request = LoaderFactory::getLoader()->getShared('EE_Request'); |
85 | 85 | } |
86 | 86 | self::$_instance = new self($request); |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | */ |
107 | 107 | public function old_reg_status($REG_ID) |
108 | 108 | { |
109 | - return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null; |
|
109 | + return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null; |
|
110 | 110 | } |
111 | 111 | |
112 | 112 | |
@@ -117,8 +117,8 @@ discard block |
||
117 | 117 | public function set_old_reg_status($REG_ID, $old_reg_status) |
118 | 118 | { |
119 | 119 | // only set the first time |
120 | - if (! isset($this->_old_reg_status[ $REG_ID ])) { |
|
121 | - $this->_old_reg_status[ $REG_ID ] = $old_reg_status; |
|
120 | + if ( ! isset($this->_old_reg_status[$REG_ID])) { |
|
121 | + $this->_old_reg_status[$REG_ID] = $old_reg_status; |
|
122 | 122 | } |
123 | 123 | } |
124 | 124 | |
@@ -129,7 +129,7 @@ discard block |
||
129 | 129 | */ |
130 | 130 | public function new_reg_status($REG_ID) |
131 | 131 | { |
132 | - return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null; |
|
132 | + return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null; |
|
133 | 133 | } |
134 | 134 | |
135 | 135 | |
@@ -139,7 +139,7 @@ discard block |
||
139 | 139 | */ |
140 | 140 | public function set_new_reg_status($REG_ID, $new_reg_status) |
141 | 141 | { |
142 | - $this->_new_reg_status[ $REG_ID ] = $new_reg_status; |
|
142 | + $this->_new_reg_status[$REG_ID] = $new_reg_status; |
|
143 | 143 | } |
144 | 144 | |
145 | 145 | |
@@ -205,7 +205,7 @@ discard block |
||
205 | 205 | // toggle reg status but only if it has changed and the user can do so |
206 | 206 | if ($this->reg_status_updated($registration->ID()) |
207 | 207 | && ( |
208 | - (! $this->request->isAdmin() || $this->request->isFrontAjax()) |
|
208 | + ( ! $this->request->isAdmin() || $this->request->isFrontAjax()) |
|
209 | 209 | || EE_Registry::instance()->CAP->current_user_can( |
210 | 210 | 'ee_edit_registration', |
211 | 211 | 'toggle_registration_status', |
@@ -268,7 +268,7 @@ discard block |
||
268 | 268 | $registration->save(); |
269 | 269 | } |
270 | 270 | // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
271 | - if (! EE_Processor_Base::$IPN) { |
|
271 | + if ( ! EE_Processor_Base::$IPN) { |
|
272 | 272 | // otherwise, send out notifications |
273 | 273 | add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
274 | 274 | } |
@@ -326,7 +326,7 @@ discard block |
||
326 | 326 | $registration->save(); |
327 | 327 | } |
328 | 328 | // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
329 | - if (! EE_Processor_Base::$IPN) { |
|
329 | + if ( ! EE_Processor_Base::$IPN) { |
|
330 | 330 | // otherwise, send out notifications |
331 | 331 | add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
332 | 332 | } |
@@ -398,14 +398,14 @@ discard block |
||
398 | 398 | || ( |
399 | 399 | $payment instanceof EE_Payment && $payment->is_approved() |
400 | 400 | && // this specific registration has not yet been paid for |
401 | - ! isset(self::$_amount_paid[ $registration->ID() ]) |
|
401 | + ! isset(self::$_amount_paid[$registration->ID()]) |
|
402 | 402 | && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price |
403 | 403 | $payment->amount() - $total_paid >= $registration->final_price() |
404 | 404 | ) |
405 | 405 | ) |
406 | 406 | ) { |
407 | 407 | // mark as paid |
408 | - self::$_amount_paid[ $registration->ID() ] = $registration->final_price(); |
|
408 | + self::$_amount_paid[$registration->ID()] = $registration->final_price(); |
|
409 | 409 | // track new REG_Status |
410 | 410 | $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved); |
411 | 411 | // toggle status to approved |
@@ -414,7 +414,7 @@ discard block |
||
414 | 414 | $registration->save(); |
415 | 415 | } |
416 | 416 | // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor |
417 | - if (! EE_Processor_Base::$IPN) { |
|
417 | + if ( ! EE_Processor_Base::$IPN) { |
|
418 | 418 | // otherwise, send out notifications |
419 | 419 | add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10); |
420 | 420 | } |
@@ -448,7 +448,7 @@ discard block |
||
448 | 448 | public function trigger_registration_update_notifications($registration, array $additional_details = array()) |
449 | 449 | { |
450 | 450 | try { |
451 | - if (! $registration instanceof EE_Registration) { |
|
451 | + if ( ! $registration instanceof EE_Registration) { |
|
452 | 452 | throw new EE_Error( |
453 | 453 | esc_html__('An invalid registration was received.', 'event_espresso') |
454 | 454 | ); |
@@ -462,7 +462,7 @@ discard block |
||
462 | 462 | // false, |
463 | 463 | // 'EE_Transaction: ' . $registration->transaction()->ID() |
464 | 464 | // ); |
465 | - if (! $registration->is_primary_registrant()) { |
|
465 | + if ( ! $registration->is_primary_registrant()) { |
|
466 | 466 | return; |
467 | 467 | } |
468 | 468 | do_action( |
@@ -534,8 +534,8 @@ discard block |
||
534 | 534 | foreach ($transaction->registrations() as $registration) { |
535 | 535 | /** @var EE_Line_Item $line_item */ |
536 | 536 | $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration); |
537 | - if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) { |
|
538 | - $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]); |
|
537 | + if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) { |
|
538 | + $registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]); |
|
539 | 539 | if ($save_regs) { |
540 | 540 | $registration->save(); |
541 | 541 | } |
@@ -611,11 +611,11 @@ discard block |
||
611 | 611 | $closed_reg_statuses = ! empty($closed_reg_statuses) |
612 | 612 | ? $closed_reg_statuses |
613 | 613 | : EEM_Registration::closed_reg_statuses(); |
614 | - if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
614 | + if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) { |
|
615 | 615 | return false; |
616 | 616 | } |
617 | 617 | // release a reserved ticket by decrementing ticket and datetime reserved values |
618 | - $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__); |
|
618 | + $registration->release_reserved_ticket(true, 'RegProcessor:'.__LINE__); |
|
619 | 619 | $registration->set_final_price(0); |
620 | 620 | if ($update_reg) { |
621 | 621 | $registration->save(); |
@@ -646,7 +646,7 @@ discard block |
||
646 | 646 | return false; |
647 | 647 | } |
648 | 648 | $ticket = $registration->ticket(); |
649 | - if (! $ticket instanceof EE_Ticket) { |
|
649 | + if ( ! $ticket instanceof EE_Ticket) { |
|
650 | 650 | throw new EE_Error( |
651 | 651 | sprintf( |
652 | 652 | esc_html__( |
@@ -695,7 +695,7 @@ discard block |
||
695 | 695 | $total_ticket_count = 1 |
696 | 696 | ) { |
697 | 697 | EE_Error::doing_it_wrong( |
698 | - __CLASS__ . '::' . __FUNCTION__, |
|
698 | + __CLASS__.'::'.__FUNCTION__, |
|
699 | 699 | sprintf( |
700 | 700 | esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
701 | 701 | '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()' |
@@ -705,7 +705,7 @@ discard block |
||
705 | 705 | ); |
706 | 706 | // grab the related ticket object for this line_item |
707 | 707 | $ticket = $line_item->ticket(); |
708 | - if (! $ticket instanceof EE_Ticket) { |
|
708 | + if ( ! $ticket instanceof EE_Ticket) { |
|
709 | 709 | EE_Error::add_error( |
710 | 710 | sprintf( |
711 | 711 | esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'), |
@@ -743,7 +743,7 @@ discard block |
||
743 | 743 | public function generate_reg_url_link($att_nmbr, $item) |
744 | 744 | { |
745 | 745 | EE_Error::doing_it_wrong( |
746 | - __CLASS__ . '::' . __FUNCTION__, |
|
746 | + __CLASS__.'::'.__FUNCTION__, |
|
747 | 747 | sprintf( |
748 | 748 | esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
749 | 749 | 'EventEspresso\core\domain\entities\RegUrlLink' |
@@ -769,7 +769,7 @@ discard block |
||
769 | 769 | public function generate_reg_code(EE_Registration $registration) |
770 | 770 | { |
771 | 771 | EE_Error::doing_it_wrong( |
772 | - __CLASS__ . '::' . __FUNCTION__, |
|
772 | + __CLASS__.'::'.__FUNCTION__, |
|
773 | 773 | sprintf( |
774 | 774 | esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
775 | 775 | 'EventEspresso\core\domain\entities\RegCode' |
@@ -14,71 +14,71 @@ |
||
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 | } |
@@ -75,7 +75,7 @@ |
||
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 | } |
@@ -16,423 +16,423 @@ |
||
16 | 16 | class EE_Transaction_Payments |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var EE_Transaction_Payments $_instance |
|
21 | - * @access private |
|
22 | - */ |
|
23 | - private static $_instance; |
|
24 | - |
|
25 | - /** |
|
26 | - * @deprecated |
|
27 | - * @var string |
|
28 | - */ |
|
29 | - protected $_old_txn_status; |
|
30 | - |
|
31 | - /** |
|
32 | - * @deprecated |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - protected $_new_txn_status; |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * @singleton method used to instantiate class object |
|
40 | - * @access public |
|
41 | - * @return EE_Transaction_Payments instance |
|
42 | - */ |
|
43 | - public static function instance() |
|
44 | - { |
|
45 | - // check if class object is instantiated |
|
46 | - if (! self::$_instance instanceof EE_Transaction_Payments) { |
|
47 | - self::$_instance = new self(); |
|
48 | - } |
|
49 | - return self::$_instance; |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * recalculate_transaction_total |
|
55 | - * |
|
56 | - * @access private |
|
57 | - * @param EE_Transaction $transaction |
|
58 | - * @param bool $update_txn |
|
59 | - * @return bool true if TXN total was updated, false if not |
|
60 | - * @throws \EE_Error |
|
61 | - */ |
|
62 | - public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true) |
|
63 | - { |
|
64 | - $total_line_item = $transaction->total_line_item(); |
|
65 | - if (! $total_line_item instanceof EE_Line_Item) { |
|
66 | - EE_Error::add_error( |
|
67 | - sprintf( |
|
68 | - __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'), |
|
69 | - $transaction->ID() |
|
70 | - ), |
|
71 | - __FILE__, |
|
72 | - __FUNCTION__, |
|
73 | - __LINE__ |
|
74 | - ); |
|
75 | - return false; |
|
76 | - } |
|
77 | - $new_total = $total_line_item->recalculate_total_including_taxes(); |
|
78 | - $transaction->set_total($new_total); |
|
79 | - if ($update_txn) { |
|
80 | - return $transaction->save() ? true : false; |
|
81 | - } |
|
82 | - return false; |
|
83 | - } |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * Updates the provided EE_Transaction with all the applicable payments |
|
88 | - * returns a boolean for whether the TXN was saved to the db |
|
89 | - * (meaning a status change occurred) |
|
90 | - * or not saved (which could **still** mean that |
|
91 | - * the TXN status changed, but just was not yet saved). |
|
92 | - * So if passing a value of false for the $update_txn param, |
|
93 | - * then client code needs to take responsibility for saving the TXN |
|
94 | - * regardless of what happens within EE_Transaction_Payments; |
|
95 | - * |
|
96 | - * @param EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID |
|
97 | - * @param boolean $update_txn whether to save the TXN |
|
98 | - * @return boolean whether the TXN was saved |
|
99 | - * @throws \EE_Error |
|
100 | - */ |
|
101 | - public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) |
|
102 | - { |
|
103 | - // verify transaction |
|
104 | - if (! $transaction instanceof EE_Transaction) { |
|
105 | - EE_Error::add_error( |
|
106 | - __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
107 | - __FILE__, |
|
108 | - __FUNCTION__, |
|
109 | - __LINE__ |
|
110 | - ); |
|
111 | - return false; |
|
112 | - } |
|
113 | - // calculate total paid |
|
114 | - $total_paid = $this->recalculate_total_payments_for_transaction($transaction); |
|
115 | - // if total paid has changed |
|
116 | - if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) { |
|
117 | - $transaction->set_paid($total_paid); |
|
118 | - // maybe update status, and make sure to save transaction if not done already |
|
119 | - if (! $transaction->update_status_based_on_total_paid($update_txn)) { |
|
120 | - if ($update_txn) { |
|
121 | - return $transaction->save() ? true : false; |
|
122 | - } |
|
123 | - } else { |
|
124 | - // the status got updated and was saved by |
|
125 | - // update_transaction_status_based_on_total_paid() |
|
126 | - return true; |
|
127 | - } |
|
128 | - } |
|
129 | - return false; |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * recalculate_total_payments_for_transaction |
|
135 | - * |
|
136 | - * @access public |
|
137 | - * @param EE_Transaction $transaction |
|
138 | - * @param string $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved). |
|
139 | - * By default, searches for approved payments |
|
140 | - * @return float|false float on success, false on fail |
|
141 | - * @throws \EE_Error |
|
142 | - */ |
|
143 | - public function recalculate_total_payments_for_transaction( |
|
144 | - EE_Transaction $transaction, |
|
145 | - $payment_status = EEM_Payment::status_id_approved |
|
146 | - ) { |
|
147 | - // verify transaction |
|
148 | - if (! $transaction instanceof EE_Transaction) { |
|
149 | - EE_Error::add_error( |
|
150 | - __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
151 | - __FILE__, |
|
152 | - __FUNCTION__, |
|
153 | - __LINE__ |
|
154 | - ); |
|
155 | - return false; |
|
156 | - } |
|
157 | - // ensure Payment model is loaded |
|
158 | - EE_Registry::instance()->load_model('Payment'); |
|
159 | - // calls EEM_Base::sum() |
|
160 | - return EEM_Payment::instance()->sum( |
|
161 | - // query params |
|
162 | - array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)), |
|
163 | - // field to sum |
|
164 | - 'PAY_amount' |
|
165 | - ); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * delete_payment_and_update_transaction |
|
171 | - * Before deleting the selected payment, we fetch it's transaction, |
|
172 | - * then delete the payment, and update the transactions' amount paid. |
|
173 | - * |
|
174 | - * @param EE_Payment $payment |
|
175 | - * @return boolean |
|
176 | - * @throws \EE_Error |
|
177 | - */ |
|
178 | - public function delete_payment_and_update_transaction(EE_Payment $payment) |
|
179 | - { |
|
180 | - // verify payment |
|
181 | - if (! $payment instanceof EE_Payment) { |
|
182 | - EE_Error::add_error( |
|
183 | - __('A valid Payment object was not received.', 'event_espresso'), |
|
184 | - __FILE__, |
|
185 | - __FUNCTION__, |
|
186 | - __LINE__ |
|
187 | - ); |
|
188 | - return false; |
|
189 | - } |
|
190 | - if (! $this->delete_registration_payments_and_update_registrations($payment)) { |
|
191 | - return false; |
|
192 | - } |
|
193 | - if (! $payment->delete()) { |
|
194 | - EE_Error::add_error( |
|
195 | - __('The payment could not be deleted.', 'event_espresso'), |
|
196 | - __FILE__, |
|
197 | - __FUNCTION__, |
|
198 | - __LINE__ |
|
199 | - ); |
|
200 | - return false; |
|
201 | - } |
|
202 | - |
|
203 | - $transaction = $payment->transaction(); |
|
204 | - $TXN_status = $transaction->status_ID(); |
|
205 | - if ($TXN_status === EEM_Transaction::abandoned_status_code |
|
206 | - || $TXN_status === EEM_Transaction::failed_status_code |
|
207 | - || $payment->amount() === 0 |
|
208 | - ) { |
|
209 | - EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso')); |
|
210 | - return true; |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - // if this fails, that just means that the transaction didn't get its status changed and/or updated. |
|
215 | - // however the payment was still deleted. |
|
216 | - if (! $this->calculate_total_payments_and_update_status($transaction)) { |
|
217 | - EE_Error::add_attention( |
|
218 | - __( |
|
219 | - 'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..', |
|
220 | - 'event_espresso' |
|
221 | - ), |
|
222 | - __FILE__, |
|
223 | - __FUNCTION__, |
|
224 | - __LINE__ |
|
225 | - ); |
|
226 | - return true; |
|
227 | - } |
|
228 | - |
|
229 | - EE_Error::add_success( |
|
230 | - __( |
|
231 | - 'The Payment was successfully deleted, and the Transaction has been updated accordingly.', |
|
232 | - 'event_espresso' |
|
233 | - ) |
|
234 | - ); |
|
235 | - return true; |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * delete_registration_payments_and_update_registrations |
|
241 | - * |
|
242 | - * removes all registration payment records associated with a payment |
|
243 | - * and subtracts their amounts from the corresponding registrations REG_paid field |
|
244 | - * |
|
245 | - * @param EE_Payment $payment |
|
246 | - * @param array $reg_payment_query_params |
|
247 | - * @return bool |
|
248 | - * @throws \EE_Error |
|
249 | - */ |
|
250 | - public function delete_registration_payments_and_update_registrations( |
|
251 | - EE_Payment $payment, |
|
252 | - $reg_payment_query_params = array() |
|
253 | - ) { |
|
254 | - $save_payment = false; |
|
255 | - $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params |
|
256 | - : array(array('PAY_ID' => $payment->ID())); |
|
257 | - $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params); |
|
258 | - if (! empty($registration_payments)) { |
|
259 | - foreach ($registration_payments as $registration_payment) { |
|
260 | - if ($registration_payment instanceof EE_Registration_Payment) { |
|
261 | - $amount_paid = $registration_payment->amount(); |
|
262 | - $registration = $registration_payment->registration(); |
|
263 | - if ($registration instanceof EE_Registration) { |
|
264 | - $registration->set_paid($registration->paid() - $amount_paid); |
|
265 | - if ($registration->save() !== false) { |
|
266 | - $registration_payment->delete_permanently(); |
|
267 | - $save_payment = true; |
|
268 | - } |
|
269 | - } else { |
|
270 | - EE_Error::add_error( |
|
271 | - sprintf( |
|
272 | - __( |
|
273 | - 'An invalid Registration object was associated with Registration Payment ID# %1$d.', |
|
274 | - 'event_espresso' |
|
275 | - ), |
|
276 | - $registration_payment->ID() |
|
277 | - ), |
|
278 | - __FILE__, |
|
279 | - __FUNCTION__, |
|
280 | - __LINE__ |
|
281 | - ); |
|
282 | - return false; |
|
283 | - } |
|
284 | - } else { |
|
285 | - EE_Error::add_error( |
|
286 | - sprintf( |
|
287 | - __( |
|
288 | - 'An invalid Registration Payment object was associated with payment ID# %1$d.', |
|
289 | - 'event_espresso' |
|
290 | - ), |
|
291 | - $payment->ID() |
|
292 | - ), |
|
293 | - __FILE__, |
|
294 | - __FUNCTION__, |
|
295 | - __LINE__ |
|
296 | - ); |
|
297 | - return false; |
|
298 | - } |
|
299 | - } |
|
300 | - } |
|
301 | - if ($save_payment) { |
|
302 | - $payment->save(); |
|
303 | - } |
|
304 | - return true; |
|
305 | - } |
|
306 | - |
|
307 | - |
|
308 | - |
|
309 | - /********************************** DEPRECATED METHODS **********************************/ |
|
310 | - |
|
311 | - |
|
312 | - /** |
|
313 | - * possibly toggles TXN status |
|
314 | - * |
|
315 | - * @deprecated 4.9.1 |
|
316 | - * @param EE_Transaction $transaction |
|
317 | - * @param boolean $update_txn whether to save the TXN |
|
318 | - * @return boolean whether the TXN was saved |
|
319 | - * @throws \EE_Error |
|
320 | - */ |
|
321 | - public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true) |
|
322 | - { |
|
323 | - EE_Error::doing_it_wrong( |
|
324 | - __CLASS__ . '::' . __FUNCTION__, |
|
325 | - sprintf( |
|
326 | - __('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
327 | - 'EE_Transaction::update_status_based_on_total_paid()' |
|
328 | - ), |
|
329 | - '4.9.1', |
|
330 | - '5.0.0' |
|
331 | - ); |
|
332 | - // verify transaction |
|
333 | - if (! $transaction instanceof EE_Transaction) { |
|
334 | - EE_Error::add_error( |
|
335 | - __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
336 | - __FILE__, |
|
337 | - __FUNCTION__, |
|
338 | - __LINE__ |
|
339 | - ); |
|
340 | - return false; |
|
341 | - } |
|
342 | - // set transaction status based on comparison of TXN_paid vs TXN_total |
|
343 | - return $transaction->update_status_based_on_total_paid($update_txn); |
|
344 | - } |
|
345 | - |
|
346 | - |
|
347 | - /** |
|
348 | - * @deprecated 4.9.12 |
|
349 | - * @return string |
|
350 | - */ |
|
351 | - public function old_txn_status() |
|
352 | - { |
|
353 | - EE_Error::doing_it_wrong( |
|
354 | - __METHOD__, |
|
355 | - esc_html__( |
|
356 | - 'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.', |
|
357 | - 'event_espresso' |
|
358 | - ), |
|
359 | - '4.9.12' |
|
360 | - ); |
|
361 | - return $this->_old_txn_status; |
|
362 | - } |
|
363 | - |
|
364 | - |
|
365 | - /** |
|
366 | - * @deprecated 4.9.12 |
|
367 | - * @param string $old_txn_status |
|
368 | - */ |
|
369 | - public function set_old_txn_status($old_txn_status) |
|
370 | - { |
|
371 | - EE_Error::doing_it_wrong( |
|
372 | - __METHOD__, |
|
373 | - esc_html__( |
|
374 | - 'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.', |
|
375 | - 'event_espresso' |
|
376 | - ), |
|
377 | - '4.9.12' |
|
378 | - ); |
|
379 | - // only set the first time |
|
380 | - if ($this->_old_txn_status === null) { |
|
381 | - $this->_old_txn_status = $old_txn_status; |
|
382 | - } |
|
383 | - } |
|
384 | - |
|
385 | - |
|
386 | - /** |
|
387 | - * @deprecated 4.9.12 |
|
388 | - * @return string |
|
389 | - */ |
|
390 | - public function new_txn_status() |
|
391 | - { |
|
392 | - EE_Error::doing_it_wrong( |
|
393 | - __METHOD__, |
|
394 | - esc_html__( |
|
395 | - 'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.', |
|
396 | - 'event_espresso' |
|
397 | - ), |
|
398 | - '4.9.12' |
|
399 | - ); |
|
400 | - return $this->_new_txn_status; |
|
401 | - } |
|
402 | - |
|
403 | - |
|
404 | - /** |
|
405 | - * @deprecated 4.9.12 |
|
406 | - * @param string $new_txn_status |
|
407 | - */ |
|
408 | - public function set_new_txn_status($new_txn_status) |
|
409 | - { |
|
410 | - EE_Error::doing_it_wrong( |
|
411 | - __METHOD__, |
|
412 | - esc_html__( |
|
413 | - 'This logic has been removed. Please just use \EE_Transaction::set_status() instead.', |
|
414 | - 'event_espresso' |
|
415 | - ), |
|
416 | - '4.9.12' |
|
417 | - ); |
|
418 | - $this->_new_txn_status = $new_txn_status; |
|
419 | - } |
|
420 | - |
|
421 | - |
|
422 | - /** |
|
423 | - * @deprecated 4.9.12 |
|
424 | - * @return bool |
|
425 | - */ |
|
426 | - public function txn_status_updated() |
|
427 | - { |
|
428 | - EE_Error::doing_it_wrong( |
|
429 | - __METHOD__, |
|
430 | - esc_html__( |
|
431 | - 'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.', |
|
432 | - 'event_espresso' |
|
433 | - ), |
|
434 | - '4.9.12' |
|
435 | - ); |
|
436 | - return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false; |
|
437 | - } |
|
19 | + /** |
|
20 | + * @var EE_Transaction_Payments $_instance |
|
21 | + * @access private |
|
22 | + */ |
|
23 | + private static $_instance; |
|
24 | + |
|
25 | + /** |
|
26 | + * @deprecated |
|
27 | + * @var string |
|
28 | + */ |
|
29 | + protected $_old_txn_status; |
|
30 | + |
|
31 | + /** |
|
32 | + * @deprecated |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + protected $_new_txn_status; |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * @singleton method used to instantiate class object |
|
40 | + * @access public |
|
41 | + * @return EE_Transaction_Payments instance |
|
42 | + */ |
|
43 | + public static function instance() |
|
44 | + { |
|
45 | + // check if class object is instantiated |
|
46 | + if (! self::$_instance instanceof EE_Transaction_Payments) { |
|
47 | + self::$_instance = new self(); |
|
48 | + } |
|
49 | + return self::$_instance; |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * recalculate_transaction_total |
|
55 | + * |
|
56 | + * @access private |
|
57 | + * @param EE_Transaction $transaction |
|
58 | + * @param bool $update_txn |
|
59 | + * @return bool true if TXN total was updated, false if not |
|
60 | + * @throws \EE_Error |
|
61 | + */ |
|
62 | + public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true) |
|
63 | + { |
|
64 | + $total_line_item = $transaction->total_line_item(); |
|
65 | + if (! $total_line_item instanceof EE_Line_Item) { |
|
66 | + EE_Error::add_error( |
|
67 | + sprintf( |
|
68 | + __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'), |
|
69 | + $transaction->ID() |
|
70 | + ), |
|
71 | + __FILE__, |
|
72 | + __FUNCTION__, |
|
73 | + __LINE__ |
|
74 | + ); |
|
75 | + return false; |
|
76 | + } |
|
77 | + $new_total = $total_line_item->recalculate_total_including_taxes(); |
|
78 | + $transaction->set_total($new_total); |
|
79 | + if ($update_txn) { |
|
80 | + return $transaction->save() ? true : false; |
|
81 | + } |
|
82 | + return false; |
|
83 | + } |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * Updates the provided EE_Transaction with all the applicable payments |
|
88 | + * returns a boolean for whether the TXN was saved to the db |
|
89 | + * (meaning a status change occurred) |
|
90 | + * or not saved (which could **still** mean that |
|
91 | + * the TXN status changed, but just was not yet saved). |
|
92 | + * So if passing a value of false for the $update_txn param, |
|
93 | + * then client code needs to take responsibility for saving the TXN |
|
94 | + * regardless of what happens within EE_Transaction_Payments; |
|
95 | + * |
|
96 | + * @param EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID |
|
97 | + * @param boolean $update_txn whether to save the TXN |
|
98 | + * @return boolean whether the TXN was saved |
|
99 | + * @throws \EE_Error |
|
100 | + */ |
|
101 | + public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) |
|
102 | + { |
|
103 | + // verify transaction |
|
104 | + if (! $transaction instanceof EE_Transaction) { |
|
105 | + EE_Error::add_error( |
|
106 | + __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
107 | + __FILE__, |
|
108 | + __FUNCTION__, |
|
109 | + __LINE__ |
|
110 | + ); |
|
111 | + return false; |
|
112 | + } |
|
113 | + // calculate total paid |
|
114 | + $total_paid = $this->recalculate_total_payments_for_transaction($transaction); |
|
115 | + // if total paid has changed |
|
116 | + if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) { |
|
117 | + $transaction->set_paid($total_paid); |
|
118 | + // maybe update status, and make sure to save transaction if not done already |
|
119 | + if (! $transaction->update_status_based_on_total_paid($update_txn)) { |
|
120 | + if ($update_txn) { |
|
121 | + return $transaction->save() ? true : false; |
|
122 | + } |
|
123 | + } else { |
|
124 | + // the status got updated and was saved by |
|
125 | + // update_transaction_status_based_on_total_paid() |
|
126 | + return true; |
|
127 | + } |
|
128 | + } |
|
129 | + return false; |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * recalculate_total_payments_for_transaction |
|
135 | + * |
|
136 | + * @access public |
|
137 | + * @param EE_Transaction $transaction |
|
138 | + * @param string $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved). |
|
139 | + * By default, searches for approved payments |
|
140 | + * @return float|false float on success, false on fail |
|
141 | + * @throws \EE_Error |
|
142 | + */ |
|
143 | + public function recalculate_total_payments_for_transaction( |
|
144 | + EE_Transaction $transaction, |
|
145 | + $payment_status = EEM_Payment::status_id_approved |
|
146 | + ) { |
|
147 | + // verify transaction |
|
148 | + if (! $transaction instanceof EE_Transaction) { |
|
149 | + EE_Error::add_error( |
|
150 | + __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
151 | + __FILE__, |
|
152 | + __FUNCTION__, |
|
153 | + __LINE__ |
|
154 | + ); |
|
155 | + return false; |
|
156 | + } |
|
157 | + // ensure Payment model is loaded |
|
158 | + EE_Registry::instance()->load_model('Payment'); |
|
159 | + // calls EEM_Base::sum() |
|
160 | + return EEM_Payment::instance()->sum( |
|
161 | + // query params |
|
162 | + array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)), |
|
163 | + // field to sum |
|
164 | + 'PAY_amount' |
|
165 | + ); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * delete_payment_and_update_transaction |
|
171 | + * Before deleting the selected payment, we fetch it's transaction, |
|
172 | + * then delete the payment, and update the transactions' amount paid. |
|
173 | + * |
|
174 | + * @param EE_Payment $payment |
|
175 | + * @return boolean |
|
176 | + * @throws \EE_Error |
|
177 | + */ |
|
178 | + public function delete_payment_and_update_transaction(EE_Payment $payment) |
|
179 | + { |
|
180 | + // verify payment |
|
181 | + if (! $payment instanceof EE_Payment) { |
|
182 | + EE_Error::add_error( |
|
183 | + __('A valid Payment object was not received.', 'event_espresso'), |
|
184 | + __FILE__, |
|
185 | + __FUNCTION__, |
|
186 | + __LINE__ |
|
187 | + ); |
|
188 | + return false; |
|
189 | + } |
|
190 | + if (! $this->delete_registration_payments_and_update_registrations($payment)) { |
|
191 | + return false; |
|
192 | + } |
|
193 | + if (! $payment->delete()) { |
|
194 | + EE_Error::add_error( |
|
195 | + __('The payment could not be deleted.', 'event_espresso'), |
|
196 | + __FILE__, |
|
197 | + __FUNCTION__, |
|
198 | + __LINE__ |
|
199 | + ); |
|
200 | + return false; |
|
201 | + } |
|
202 | + |
|
203 | + $transaction = $payment->transaction(); |
|
204 | + $TXN_status = $transaction->status_ID(); |
|
205 | + if ($TXN_status === EEM_Transaction::abandoned_status_code |
|
206 | + || $TXN_status === EEM_Transaction::failed_status_code |
|
207 | + || $payment->amount() === 0 |
|
208 | + ) { |
|
209 | + EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso')); |
|
210 | + return true; |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + // if this fails, that just means that the transaction didn't get its status changed and/or updated. |
|
215 | + // however the payment was still deleted. |
|
216 | + if (! $this->calculate_total_payments_and_update_status($transaction)) { |
|
217 | + EE_Error::add_attention( |
|
218 | + __( |
|
219 | + 'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..', |
|
220 | + 'event_espresso' |
|
221 | + ), |
|
222 | + __FILE__, |
|
223 | + __FUNCTION__, |
|
224 | + __LINE__ |
|
225 | + ); |
|
226 | + return true; |
|
227 | + } |
|
228 | + |
|
229 | + EE_Error::add_success( |
|
230 | + __( |
|
231 | + 'The Payment was successfully deleted, and the Transaction has been updated accordingly.', |
|
232 | + 'event_espresso' |
|
233 | + ) |
|
234 | + ); |
|
235 | + return true; |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * delete_registration_payments_and_update_registrations |
|
241 | + * |
|
242 | + * removes all registration payment records associated with a payment |
|
243 | + * and subtracts their amounts from the corresponding registrations REG_paid field |
|
244 | + * |
|
245 | + * @param EE_Payment $payment |
|
246 | + * @param array $reg_payment_query_params |
|
247 | + * @return bool |
|
248 | + * @throws \EE_Error |
|
249 | + */ |
|
250 | + public function delete_registration_payments_and_update_registrations( |
|
251 | + EE_Payment $payment, |
|
252 | + $reg_payment_query_params = array() |
|
253 | + ) { |
|
254 | + $save_payment = false; |
|
255 | + $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params |
|
256 | + : array(array('PAY_ID' => $payment->ID())); |
|
257 | + $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params); |
|
258 | + if (! empty($registration_payments)) { |
|
259 | + foreach ($registration_payments as $registration_payment) { |
|
260 | + if ($registration_payment instanceof EE_Registration_Payment) { |
|
261 | + $amount_paid = $registration_payment->amount(); |
|
262 | + $registration = $registration_payment->registration(); |
|
263 | + if ($registration instanceof EE_Registration) { |
|
264 | + $registration->set_paid($registration->paid() - $amount_paid); |
|
265 | + if ($registration->save() !== false) { |
|
266 | + $registration_payment->delete_permanently(); |
|
267 | + $save_payment = true; |
|
268 | + } |
|
269 | + } else { |
|
270 | + EE_Error::add_error( |
|
271 | + sprintf( |
|
272 | + __( |
|
273 | + 'An invalid Registration object was associated with Registration Payment ID# %1$d.', |
|
274 | + 'event_espresso' |
|
275 | + ), |
|
276 | + $registration_payment->ID() |
|
277 | + ), |
|
278 | + __FILE__, |
|
279 | + __FUNCTION__, |
|
280 | + __LINE__ |
|
281 | + ); |
|
282 | + return false; |
|
283 | + } |
|
284 | + } else { |
|
285 | + EE_Error::add_error( |
|
286 | + sprintf( |
|
287 | + __( |
|
288 | + 'An invalid Registration Payment object was associated with payment ID# %1$d.', |
|
289 | + 'event_espresso' |
|
290 | + ), |
|
291 | + $payment->ID() |
|
292 | + ), |
|
293 | + __FILE__, |
|
294 | + __FUNCTION__, |
|
295 | + __LINE__ |
|
296 | + ); |
|
297 | + return false; |
|
298 | + } |
|
299 | + } |
|
300 | + } |
|
301 | + if ($save_payment) { |
|
302 | + $payment->save(); |
|
303 | + } |
|
304 | + return true; |
|
305 | + } |
|
306 | + |
|
307 | + |
|
308 | + |
|
309 | + /********************************** DEPRECATED METHODS **********************************/ |
|
310 | + |
|
311 | + |
|
312 | + /** |
|
313 | + * possibly toggles TXN status |
|
314 | + * |
|
315 | + * @deprecated 4.9.1 |
|
316 | + * @param EE_Transaction $transaction |
|
317 | + * @param boolean $update_txn whether to save the TXN |
|
318 | + * @return boolean whether the TXN was saved |
|
319 | + * @throws \EE_Error |
|
320 | + */ |
|
321 | + public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true) |
|
322 | + { |
|
323 | + EE_Error::doing_it_wrong( |
|
324 | + __CLASS__ . '::' . __FUNCTION__, |
|
325 | + sprintf( |
|
326 | + __('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
|
327 | + 'EE_Transaction::update_status_based_on_total_paid()' |
|
328 | + ), |
|
329 | + '4.9.1', |
|
330 | + '5.0.0' |
|
331 | + ); |
|
332 | + // verify transaction |
|
333 | + if (! $transaction instanceof EE_Transaction) { |
|
334 | + EE_Error::add_error( |
|
335 | + __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
|
336 | + __FILE__, |
|
337 | + __FUNCTION__, |
|
338 | + __LINE__ |
|
339 | + ); |
|
340 | + return false; |
|
341 | + } |
|
342 | + // set transaction status based on comparison of TXN_paid vs TXN_total |
|
343 | + return $transaction->update_status_based_on_total_paid($update_txn); |
|
344 | + } |
|
345 | + |
|
346 | + |
|
347 | + /** |
|
348 | + * @deprecated 4.9.12 |
|
349 | + * @return string |
|
350 | + */ |
|
351 | + public function old_txn_status() |
|
352 | + { |
|
353 | + EE_Error::doing_it_wrong( |
|
354 | + __METHOD__, |
|
355 | + esc_html__( |
|
356 | + 'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.', |
|
357 | + 'event_espresso' |
|
358 | + ), |
|
359 | + '4.9.12' |
|
360 | + ); |
|
361 | + return $this->_old_txn_status; |
|
362 | + } |
|
363 | + |
|
364 | + |
|
365 | + /** |
|
366 | + * @deprecated 4.9.12 |
|
367 | + * @param string $old_txn_status |
|
368 | + */ |
|
369 | + public function set_old_txn_status($old_txn_status) |
|
370 | + { |
|
371 | + EE_Error::doing_it_wrong( |
|
372 | + __METHOD__, |
|
373 | + esc_html__( |
|
374 | + 'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.', |
|
375 | + 'event_espresso' |
|
376 | + ), |
|
377 | + '4.9.12' |
|
378 | + ); |
|
379 | + // only set the first time |
|
380 | + if ($this->_old_txn_status === null) { |
|
381 | + $this->_old_txn_status = $old_txn_status; |
|
382 | + } |
|
383 | + } |
|
384 | + |
|
385 | + |
|
386 | + /** |
|
387 | + * @deprecated 4.9.12 |
|
388 | + * @return string |
|
389 | + */ |
|
390 | + public function new_txn_status() |
|
391 | + { |
|
392 | + EE_Error::doing_it_wrong( |
|
393 | + __METHOD__, |
|
394 | + esc_html__( |
|
395 | + 'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.', |
|
396 | + 'event_espresso' |
|
397 | + ), |
|
398 | + '4.9.12' |
|
399 | + ); |
|
400 | + return $this->_new_txn_status; |
|
401 | + } |
|
402 | + |
|
403 | + |
|
404 | + /** |
|
405 | + * @deprecated 4.9.12 |
|
406 | + * @param string $new_txn_status |
|
407 | + */ |
|
408 | + public function set_new_txn_status($new_txn_status) |
|
409 | + { |
|
410 | + EE_Error::doing_it_wrong( |
|
411 | + __METHOD__, |
|
412 | + esc_html__( |
|
413 | + 'This logic has been removed. Please just use \EE_Transaction::set_status() instead.', |
|
414 | + 'event_espresso' |
|
415 | + ), |
|
416 | + '4.9.12' |
|
417 | + ); |
|
418 | + $this->_new_txn_status = $new_txn_status; |
|
419 | + } |
|
420 | + |
|
421 | + |
|
422 | + /** |
|
423 | + * @deprecated 4.9.12 |
|
424 | + * @return bool |
|
425 | + */ |
|
426 | + public function txn_status_updated() |
|
427 | + { |
|
428 | + EE_Error::doing_it_wrong( |
|
429 | + __METHOD__, |
|
430 | + esc_html__( |
|
431 | + 'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.', |
|
432 | + 'event_espresso' |
|
433 | + ), |
|
434 | + '4.9.12' |
|
435 | + ); |
|
436 | + return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false; |
|
437 | + } |
|
438 | 438 | } |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | public static function instance() |
44 | 44 | { |
45 | 45 | // check if class object is instantiated |
46 | - if (! self::$_instance instanceof EE_Transaction_Payments) { |
|
46 | + if ( ! self::$_instance instanceof EE_Transaction_Payments) { |
|
47 | 47 | self::$_instance = new self(); |
48 | 48 | } |
49 | 49 | return self::$_instance; |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true) |
63 | 63 | { |
64 | 64 | $total_line_item = $transaction->total_line_item(); |
65 | - if (! $total_line_item instanceof EE_Line_Item) { |
|
65 | + if ( ! $total_line_item instanceof EE_Line_Item) { |
|
66 | 66 | EE_Error::add_error( |
67 | 67 | sprintf( |
68 | 68 | __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'), |
@@ -101,7 +101,7 @@ discard block |
||
101 | 101 | public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) |
102 | 102 | { |
103 | 103 | // verify transaction |
104 | - if (! $transaction instanceof EE_Transaction) { |
|
104 | + if ( ! $transaction instanceof EE_Transaction) { |
|
105 | 105 | EE_Error::add_error( |
106 | 106 | __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
107 | 107 | __FILE__, |
@@ -116,7 +116,7 @@ discard block |
||
116 | 116 | if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) { |
117 | 117 | $transaction->set_paid($total_paid); |
118 | 118 | // maybe update status, and make sure to save transaction if not done already |
119 | - if (! $transaction->update_status_based_on_total_paid($update_txn)) { |
|
119 | + if ( ! $transaction->update_status_based_on_total_paid($update_txn)) { |
|
120 | 120 | if ($update_txn) { |
121 | 121 | return $transaction->save() ? true : false; |
122 | 122 | } |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | $payment_status = EEM_Payment::status_id_approved |
146 | 146 | ) { |
147 | 147 | // verify transaction |
148 | - if (! $transaction instanceof EE_Transaction) { |
|
148 | + if ( ! $transaction instanceof EE_Transaction) { |
|
149 | 149 | EE_Error::add_error( |
150 | 150 | __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
151 | 151 | __FILE__, |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | public function delete_payment_and_update_transaction(EE_Payment $payment) |
179 | 179 | { |
180 | 180 | // verify payment |
181 | - if (! $payment instanceof EE_Payment) { |
|
181 | + if ( ! $payment instanceof EE_Payment) { |
|
182 | 182 | EE_Error::add_error( |
183 | 183 | __('A valid Payment object was not received.', 'event_espresso'), |
184 | 184 | __FILE__, |
@@ -187,10 +187,10 @@ discard block |
||
187 | 187 | ); |
188 | 188 | return false; |
189 | 189 | } |
190 | - if (! $this->delete_registration_payments_and_update_registrations($payment)) { |
|
190 | + if ( ! $this->delete_registration_payments_and_update_registrations($payment)) { |
|
191 | 191 | return false; |
192 | 192 | } |
193 | - if (! $payment->delete()) { |
|
193 | + if ( ! $payment->delete()) { |
|
194 | 194 | EE_Error::add_error( |
195 | 195 | __('The payment could not be deleted.', 'event_espresso'), |
196 | 196 | __FILE__, |
@@ -213,7 +213,7 @@ discard block |
||
213 | 213 | |
214 | 214 | // if this fails, that just means that the transaction didn't get its status changed and/or updated. |
215 | 215 | // however the payment was still deleted. |
216 | - if (! $this->calculate_total_payments_and_update_status($transaction)) { |
|
216 | + if ( ! $this->calculate_total_payments_and_update_status($transaction)) { |
|
217 | 217 | EE_Error::add_attention( |
218 | 218 | __( |
219 | 219 | 'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..', |
@@ -255,7 +255,7 @@ discard block |
||
255 | 255 | $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params |
256 | 256 | : array(array('PAY_ID' => $payment->ID())); |
257 | 257 | $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params); |
258 | - if (! empty($registration_payments)) { |
|
258 | + if ( ! empty($registration_payments)) { |
|
259 | 259 | foreach ($registration_payments as $registration_payment) { |
260 | 260 | if ($registration_payment instanceof EE_Registration_Payment) { |
261 | 261 | $amount_paid = $registration_payment->amount(); |
@@ -321,7 +321,7 @@ discard block |
||
321 | 321 | public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true) |
322 | 322 | { |
323 | 323 | EE_Error::doing_it_wrong( |
324 | - __CLASS__ . '::' . __FUNCTION__, |
|
324 | + __CLASS__.'::'.__FUNCTION__, |
|
325 | 325 | sprintf( |
326 | 326 | __('This method is deprecated. Please use "%s" instead', 'event_espresso'), |
327 | 327 | 'EE_Transaction::update_status_based_on_total_paid()' |
@@ -330,7 +330,7 @@ discard block |
||
330 | 330 | '5.0.0' |
331 | 331 | ); |
332 | 332 | // verify transaction |
333 | - if (! $transaction instanceof EE_Transaction) { |
|
333 | + if ( ! $transaction instanceof EE_Transaction) { |
|
334 | 334 | EE_Error::add_error( |
335 | 335 | __('Please provide a valid EE_Transaction object.', 'event_espresso'), |
336 | 336 | __FILE__, |
@@ -17,948 +17,948 @@ |
||
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 | } |
@@ -53,7 +53,7 @@ discard block |
||
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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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(); |
@@ -15,51 +15,51 @@ |
||
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 | } |
@@ -57,7 +57,7 @@ |
||
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>'; |