@@ -22,137 +22,137 @@ |
||
22 | 22 | { |
23 | 23 | |
24 | 24 | |
25 | - protected function _init_props() |
|
26 | - { |
|
27 | - $this->label = __('Datetime List Shortcodes', 'event_espresso'); |
|
28 | - $this->description = __('All shortcodes specific to datetime lists', 'event_espresso'); |
|
29 | - $this->_shortcodes = array( |
|
30 | - '[DATETIME_LIST]' => __( |
|
31 | - 'Will output a list of datetimes according to the layout specified in the datetime list field.', |
|
32 | - 'event_espresso' |
|
33 | - ), |
|
34 | - ); |
|
35 | - } |
|
36 | - |
|
37 | - |
|
38 | - protected function _parser($shortcode) |
|
39 | - { |
|
40 | - switch ($shortcode) { |
|
41 | - case '[DATETIME_LIST]': |
|
42 | - return $this->_get_datetime_list(); |
|
43 | - break; |
|
44 | - } |
|
45 | - return ''; |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * figure out what the incoming data is and then return the appropriate parsed value. |
|
51 | - * |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - private function _get_datetime_list() |
|
55 | - { |
|
56 | - $this->_validate_list_requirements(); |
|
57 | - |
|
58 | - if ($this->_data['data'] instanceof EE_Ticket) { |
|
59 | - return $this->_get_datetime_list_for_ticket(); |
|
60 | - } elseif ($this->_data['data'] instanceof EE_Event) { |
|
61 | - return $this->_get_datetime_list_for_event(); |
|
62 | - } elseif ($this->_data['data'] instanceof EE_Messages_Addressee && $this->_data['data']->reg_obj instanceof EE_Registration) { |
|
63 | - return $this->_get_datetime_list_for_registration(); |
|
64 | - } // prevent recursive loop |
|
65 | - else { |
|
66 | - return ''; |
|
67 | - } |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * return parsed list of datetimes for an event |
|
73 | - * |
|
74 | - * @return string |
|
75 | - */ |
|
76 | - private function _get_datetime_list_for_event() |
|
77 | - { |
|
78 | - $valid_shortcodes = array('datetime', 'attendee'); |
|
79 | - $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list']) |
|
80 | - ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list']; |
|
81 | - $event = $this->_data['data']; |
|
82 | - |
|
83 | - // here we're setting up the datetimes for the datetime list template for THIS event. |
|
84 | - $dtt_parsed = ''; |
|
85 | - $datetimes = $this->_get_datetimes_from_event($event); |
|
86 | - |
|
87 | - // each datetime in this case should be an datetime object. |
|
88 | - foreach ($datetimes as $datetime) { |
|
89 | - $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template( |
|
90 | - $template, |
|
91 | - $datetime, |
|
92 | - $valid_shortcodes, |
|
93 | - $this->_extra_data |
|
94 | - ); |
|
95 | - } |
|
96 | - |
|
97 | - return $dtt_parsed; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * return parsed list of datetimes for an ticket |
|
103 | - * |
|
104 | - * @return string |
|
105 | - */ |
|
106 | - private function _get_datetime_list_for_ticket() |
|
107 | - { |
|
108 | - $valid_shortcodes = array('datetime', 'attendee'); |
|
109 | - |
|
110 | - $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list']) |
|
111 | - ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list']; |
|
112 | - $ticket = $this->_data['data']; |
|
113 | - |
|
114 | - // here we're setting up the datetimes for the datetime list template for THIS ticket. |
|
115 | - $dtt_parsed = ''; |
|
116 | - $datetimes = $this->_get_datetimes_from_ticket($ticket); |
|
117 | - |
|
118 | - // each datetime in this case should be an datetime object. |
|
119 | - foreach ($datetimes as $datetime) { |
|
120 | - $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template( |
|
121 | - $template, |
|
122 | - $datetime, |
|
123 | - $valid_shortcodes, |
|
124 | - $this->_extra_data |
|
125 | - ); |
|
126 | - } |
|
127 | - |
|
128 | - return $dtt_parsed; |
|
129 | - } |
|
130 | - |
|
131 | - |
|
132 | - /** |
|
133 | - * return parsed list of datetimes from a given registration. |
|
134 | - * |
|
135 | - * @return string |
|
136 | - */ |
|
137 | - private function _get_datetime_list_for_registration() |
|
138 | - { |
|
139 | - $registration = $this->_data['data']->reg_obj; |
|
140 | - |
|
141 | - // now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket(); |
|
142 | - $this->_data['data'] = $registration->ticket(); |
|
143 | - return $this->_get_datetime_list_for_ticket(); |
|
144 | - } |
|
145 | - |
|
146 | - |
|
147 | - private function _get_datetimes_from_event(EE_Event $event, $att = null) |
|
148 | - { |
|
149 | - return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
150 | - ) ]['dtt_objs'] : array(); |
|
151 | - } |
|
152 | - |
|
153 | - private function _get_datetimes_from_ticket(EE_Ticket $ticket, $att = null) |
|
154 | - { |
|
155 | - return isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
156 | - ) ]['dtt_objs'] : array(); |
|
157 | - } |
|
25 | + protected function _init_props() |
|
26 | + { |
|
27 | + $this->label = __('Datetime List Shortcodes', 'event_espresso'); |
|
28 | + $this->description = __('All shortcodes specific to datetime lists', 'event_espresso'); |
|
29 | + $this->_shortcodes = array( |
|
30 | + '[DATETIME_LIST]' => __( |
|
31 | + 'Will output a list of datetimes according to the layout specified in the datetime list field.', |
|
32 | + 'event_espresso' |
|
33 | + ), |
|
34 | + ); |
|
35 | + } |
|
36 | + |
|
37 | + |
|
38 | + protected function _parser($shortcode) |
|
39 | + { |
|
40 | + switch ($shortcode) { |
|
41 | + case '[DATETIME_LIST]': |
|
42 | + return $this->_get_datetime_list(); |
|
43 | + break; |
|
44 | + } |
|
45 | + return ''; |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * figure out what the incoming data is and then return the appropriate parsed value. |
|
51 | + * |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + private function _get_datetime_list() |
|
55 | + { |
|
56 | + $this->_validate_list_requirements(); |
|
57 | + |
|
58 | + if ($this->_data['data'] instanceof EE_Ticket) { |
|
59 | + return $this->_get_datetime_list_for_ticket(); |
|
60 | + } elseif ($this->_data['data'] instanceof EE_Event) { |
|
61 | + return $this->_get_datetime_list_for_event(); |
|
62 | + } elseif ($this->_data['data'] instanceof EE_Messages_Addressee && $this->_data['data']->reg_obj instanceof EE_Registration) { |
|
63 | + return $this->_get_datetime_list_for_registration(); |
|
64 | + } // prevent recursive loop |
|
65 | + else { |
|
66 | + return ''; |
|
67 | + } |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * return parsed list of datetimes for an event |
|
73 | + * |
|
74 | + * @return string |
|
75 | + */ |
|
76 | + private function _get_datetime_list_for_event() |
|
77 | + { |
|
78 | + $valid_shortcodes = array('datetime', 'attendee'); |
|
79 | + $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list']) |
|
80 | + ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list']; |
|
81 | + $event = $this->_data['data']; |
|
82 | + |
|
83 | + // here we're setting up the datetimes for the datetime list template for THIS event. |
|
84 | + $dtt_parsed = ''; |
|
85 | + $datetimes = $this->_get_datetimes_from_event($event); |
|
86 | + |
|
87 | + // each datetime in this case should be an datetime object. |
|
88 | + foreach ($datetimes as $datetime) { |
|
89 | + $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template( |
|
90 | + $template, |
|
91 | + $datetime, |
|
92 | + $valid_shortcodes, |
|
93 | + $this->_extra_data |
|
94 | + ); |
|
95 | + } |
|
96 | + |
|
97 | + return $dtt_parsed; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * return parsed list of datetimes for an ticket |
|
103 | + * |
|
104 | + * @return string |
|
105 | + */ |
|
106 | + private function _get_datetime_list_for_ticket() |
|
107 | + { |
|
108 | + $valid_shortcodes = array('datetime', 'attendee'); |
|
109 | + |
|
110 | + $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list']) |
|
111 | + ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list']; |
|
112 | + $ticket = $this->_data['data']; |
|
113 | + |
|
114 | + // here we're setting up the datetimes for the datetime list template for THIS ticket. |
|
115 | + $dtt_parsed = ''; |
|
116 | + $datetimes = $this->_get_datetimes_from_ticket($ticket); |
|
117 | + |
|
118 | + // each datetime in this case should be an datetime object. |
|
119 | + foreach ($datetimes as $datetime) { |
|
120 | + $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template( |
|
121 | + $template, |
|
122 | + $datetime, |
|
123 | + $valid_shortcodes, |
|
124 | + $this->_extra_data |
|
125 | + ); |
|
126 | + } |
|
127 | + |
|
128 | + return $dtt_parsed; |
|
129 | + } |
|
130 | + |
|
131 | + |
|
132 | + /** |
|
133 | + * return parsed list of datetimes from a given registration. |
|
134 | + * |
|
135 | + * @return string |
|
136 | + */ |
|
137 | + private function _get_datetime_list_for_registration() |
|
138 | + { |
|
139 | + $registration = $this->_data['data']->reg_obj; |
|
140 | + |
|
141 | + // now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket(); |
|
142 | + $this->_data['data'] = $registration->ticket(); |
|
143 | + return $this->_get_datetime_list_for_ticket(); |
|
144 | + } |
|
145 | + |
|
146 | + |
|
147 | + private function _get_datetimes_from_event(EE_Event $event, $att = null) |
|
148 | + { |
|
149 | + return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
150 | + ) ]['dtt_objs'] : array(); |
|
151 | + } |
|
152 | + |
|
153 | + private function _get_datetimes_from_ticket(EE_Ticket $ticket, $att = null) |
|
154 | + { |
|
155 | + return isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
156 | + ) ]['dtt_objs'] : array(); |
|
157 | + } |
|
158 | 158 | } |
@@ -146,13 +146,13 @@ |
||
146 | 146 | |
147 | 147 | private function _get_datetimes_from_event(EE_Event $event, $att = null) |
148 | 148 | { |
149 | - return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
150 | - ) ]['dtt_objs'] : array(); |
|
149 | + return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID( |
|
150 | + )]['dtt_objs'] : array(); |
|
151 | 151 | } |
152 | 152 | |
153 | 153 | private function _get_datetimes_from_ticket(EE_Ticket $ticket, $att = null) |
154 | 154 | { |
155 | - return isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
156 | - ) ]['dtt_objs'] : array(); |
|
155 | + return isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[$ticket->ID( |
|
156 | + )]['dtt_objs'] : array(); |
|
157 | 157 | } |
158 | 158 | } |
@@ -20,202 +20,202 @@ |
||
20 | 20 | { |
21 | 21 | |
22 | 22 | |
23 | - protected function _init_props() |
|
24 | - { |
|
25 | - $this->label = __('Line Item List Shortcodes', 'event_espresso'); |
|
26 | - $this->description = __('All shortcodes specific to line item lists', 'event_espresso'); |
|
27 | - $this->_shortcodes = array( |
|
28 | - '[TICKET_LINE_ITEM_LIST]' => __('Outputs a list of ticket line items.', 'event_espresso'), |
|
29 | - '[TAX_LINE_ITEM_LIST]' => __('Outputs a list of tax line items.', 'event_espresso'), |
|
30 | - '[ADDITIONAL_LINE_ITEM_LIST]' => __( |
|
31 | - 'Outputs a list of additional line items (other charges or discounts)', |
|
32 | - 'event_espresso' |
|
33 | - ), |
|
34 | - '[PRICE_MODIFIER_LINE_ITEM_LIST]' => __('Outputs a list of price modifier line items', 'event_espresso'), |
|
35 | - ); |
|
36 | - } |
|
37 | - |
|
38 | - |
|
39 | - protected function _parser($shortcode) |
|
40 | - { |
|
41 | - |
|
42 | - switch ($shortcode) { |
|
43 | - case '[TICKET_LINE_ITEM_LIST]': |
|
44 | - return $this->_get_ticket_line_item_list(); |
|
45 | - break; |
|
46 | - |
|
47 | - case '[TAX_LINE_ITEM_LIST]': |
|
48 | - return $this->_get_tax_line_item_list(); |
|
49 | - break; |
|
50 | - |
|
51 | - case '[PRICE_MODIFIER_LINE_ITEM_LIST]': |
|
52 | - return $this->_get_price_mod_line_item_list(); |
|
53 | - break; |
|
54 | - |
|
55 | - case '[ADDITIONAL_LINE_ITEM_LIST]': |
|
56 | - return $this->_get_additional_line_item_list(); |
|
57 | - break; |
|
58 | - |
|
59 | - default: |
|
60 | - return ''; |
|
61 | - break; |
|
62 | - } |
|
63 | - } |
|
64 | - |
|
65 | - |
|
66 | - /** |
|
67 | - * verify incoming data contains what is needed for retrieving and parsing each ticket line item for an event. |
|
68 | - * |
|
69 | - * @since 4.5.0 |
|
70 | - * |
|
71 | - * @return string parsed ticket line item list. |
|
72 | - */ |
|
73 | - private function _get_ticket_line_item_list() |
|
74 | - { |
|
75 | - $this->_validate_list_requirements(); |
|
76 | - |
|
77 | - if (! $this->_data['data'] instanceof EE_Ticket) { |
|
78 | - return ''; |
|
79 | - } |
|
80 | - |
|
81 | - $valid_shortcodes = array('line_item', 'line_item_list', 'ticket'); |
|
82 | - |
|
83 | - $ticket = $this->_data['data']; |
|
84 | - $templates = $this->_extra_data['template']; |
|
85 | - $addressee_obj = $this->_extra_data['data']; |
|
86 | - |
|
87 | - // made it here so we have an EE_Ticket, so we should have what we need. |
|
88 | - $ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item']) |
|
89 | - ? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null; |
|
90 | - $sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items']) |
|
91 | - ? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array(); |
|
92 | - |
|
93 | - $template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms'] |
|
94 | - : $templates['ticket_line_item_pms']; |
|
95 | - |
|
96 | - if (empty($ticket_line_item) || empty($sub_line_items)) { |
|
97 | - return ''; |
|
98 | - } |
|
99 | - |
|
100 | - // now we just return the appropriate template parsed for each ticket. |
|
101 | - return $this->_shortcode_helper->parse_line_item_list_template( |
|
102 | - $template, |
|
103 | - $ticket_line_item, |
|
104 | - $valid_shortcodes, |
|
105 | - $this->_extra_data |
|
106 | - ); |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * Verify incoming data contains what is needed for retrieving and parsing each tax line item for a transaction. |
|
112 | - * |
|
113 | - * @since 4.5.0 |
|
114 | - * |
|
115 | - * @return string parsed tax line item list. |
|
116 | - */ |
|
117 | - private function _get_tax_line_item_list() |
|
118 | - { |
|
119 | - |
|
120 | - $this->_validate_list_requirements(); |
|
121 | - |
|
122 | - if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
123 | - return ''; |
|
124 | - } |
|
125 | - |
|
126 | - // made it here so we're good to go. |
|
127 | - $valid_shortcodes = array('line_item'); |
|
128 | - $templates = $this->_data['template']; |
|
129 | - |
|
130 | - $tax_line_items = $this->_data['data']->tax_line_items; |
|
131 | - $line_item_list = ''; |
|
132 | - foreach ($tax_line_items as $line_item) { |
|
133 | - $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
134 | - $templates['tax_line_item_list'], |
|
135 | - $line_item, |
|
136 | - $valid_shortcodes, |
|
137 | - $this->_extra_data |
|
138 | - ); |
|
139 | - } |
|
140 | - |
|
141 | - return $line_item_list; |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Verify incoming data contains what is needed for retrieving and parsing each other line item for a transaction. |
|
146 | - * |
|
147 | - * @since 4.5.0 |
|
148 | - * |
|
149 | - * @return string parsed other line item list. |
|
150 | - */ |
|
151 | - private function _get_additional_line_item_list() |
|
152 | - { |
|
153 | - |
|
154 | - $this->_validate_list_requirements(); |
|
155 | - |
|
156 | - if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
157 | - return ''; |
|
158 | - } |
|
159 | - |
|
160 | - // made it here so we're good to go. |
|
161 | - $valid_shortcodes = array('line_item'); |
|
162 | - $templates = $this->_data['template']; |
|
163 | - |
|
164 | - $additional_line_items = $this->_data['data']->additional_line_items; |
|
165 | - $line_item_list = ''; |
|
166 | - foreach ($additional_line_items as $line_item) { |
|
167 | - $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
168 | - $templates['additional_line_item_list'], |
|
169 | - $line_item, |
|
170 | - $valid_shortcodes, |
|
171 | - $this->_extra_data |
|
172 | - ); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - return $line_item_list; |
|
177 | - } |
|
178 | - |
|
179 | - |
|
180 | - /** |
|
181 | - * Verify incoming data contains what is needed for retrieving and parsing each price modifier line item for a |
|
182 | - * parent ticket line item. |
|
183 | - * |
|
184 | - * @since 4.5.0 |
|
185 | - * |
|
186 | - * @return string parsed price modifier line item list. |
|
187 | - */ |
|
188 | - private function _get_price_mod_line_item_list() |
|
189 | - { |
|
190 | - $this->_validate_list_requirements(); |
|
191 | - |
|
192 | - if (! $this->_data['data'] instanceof EE_Line_Item) { |
|
193 | - return ''; |
|
194 | - } |
|
195 | - |
|
196 | - // made it here so we're good to go. |
|
197 | - $main_line_item = $this->_data['data']; |
|
198 | - $templates = $this->_extra_data['template']; |
|
199 | - $addressee_obj = $this->_extra_data['data']; |
|
200 | - |
|
201 | - $valid_shortcodes = array('line_item'); |
|
202 | - |
|
203 | - $main_line_item_id = $main_line_item->ID(); |
|
204 | - |
|
205 | - $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children']) |
|
206 | - ? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array(); |
|
207 | - |
|
208 | - $line_item_list = ''; |
|
209 | - |
|
210 | - foreach ($price_mod_line_items as $line_item) { |
|
211 | - $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
212 | - $templates['price_modifier_line_item_list'], |
|
213 | - $line_item, |
|
214 | - $valid_shortcodes, |
|
215 | - $this->_extra_data |
|
216 | - ); |
|
217 | - } |
|
218 | - |
|
219 | - return $line_item_list; |
|
220 | - } |
|
23 | + protected function _init_props() |
|
24 | + { |
|
25 | + $this->label = __('Line Item List Shortcodes', 'event_espresso'); |
|
26 | + $this->description = __('All shortcodes specific to line item lists', 'event_espresso'); |
|
27 | + $this->_shortcodes = array( |
|
28 | + '[TICKET_LINE_ITEM_LIST]' => __('Outputs a list of ticket line items.', 'event_espresso'), |
|
29 | + '[TAX_LINE_ITEM_LIST]' => __('Outputs a list of tax line items.', 'event_espresso'), |
|
30 | + '[ADDITIONAL_LINE_ITEM_LIST]' => __( |
|
31 | + 'Outputs a list of additional line items (other charges or discounts)', |
|
32 | + 'event_espresso' |
|
33 | + ), |
|
34 | + '[PRICE_MODIFIER_LINE_ITEM_LIST]' => __('Outputs a list of price modifier line items', 'event_espresso'), |
|
35 | + ); |
|
36 | + } |
|
37 | + |
|
38 | + |
|
39 | + protected function _parser($shortcode) |
|
40 | + { |
|
41 | + |
|
42 | + switch ($shortcode) { |
|
43 | + case '[TICKET_LINE_ITEM_LIST]': |
|
44 | + return $this->_get_ticket_line_item_list(); |
|
45 | + break; |
|
46 | + |
|
47 | + case '[TAX_LINE_ITEM_LIST]': |
|
48 | + return $this->_get_tax_line_item_list(); |
|
49 | + break; |
|
50 | + |
|
51 | + case '[PRICE_MODIFIER_LINE_ITEM_LIST]': |
|
52 | + return $this->_get_price_mod_line_item_list(); |
|
53 | + break; |
|
54 | + |
|
55 | + case '[ADDITIONAL_LINE_ITEM_LIST]': |
|
56 | + return $this->_get_additional_line_item_list(); |
|
57 | + break; |
|
58 | + |
|
59 | + default: |
|
60 | + return ''; |
|
61 | + break; |
|
62 | + } |
|
63 | + } |
|
64 | + |
|
65 | + |
|
66 | + /** |
|
67 | + * verify incoming data contains what is needed for retrieving and parsing each ticket line item for an event. |
|
68 | + * |
|
69 | + * @since 4.5.0 |
|
70 | + * |
|
71 | + * @return string parsed ticket line item list. |
|
72 | + */ |
|
73 | + private function _get_ticket_line_item_list() |
|
74 | + { |
|
75 | + $this->_validate_list_requirements(); |
|
76 | + |
|
77 | + if (! $this->_data['data'] instanceof EE_Ticket) { |
|
78 | + return ''; |
|
79 | + } |
|
80 | + |
|
81 | + $valid_shortcodes = array('line_item', 'line_item_list', 'ticket'); |
|
82 | + |
|
83 | + $ticket = $this->_data['data']; |
|
84 | + $templates = $this->_extra_data['template']; |
|
85 | + $addressee_obj = $this->_extra_data['data']; |
|
86 | + |
|
87 | + // made it here so we have an EE_Ticket, so we should have what we need. |
|
88 | + $ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item']) |
|
89 | + ? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null; |
|
90 | + $sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items']) |
|
91 | + ? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array(); |
|
92 | + |
|
93 | + $template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms'] |
|
94 | + : $templates['ticket_line_item_pms']; |
|
95 | + |
|
96 | + if (empty($ticket_line_item) || empty($sub_line_items)) { |
|
97 | + return ''; |
|
98 | + } |
|
99 | + |
|
100 | + // now we just return the appropriate template parsed for each ticket. |
|
101 | + return $this->_shortcode_helper->parse_line_item_list_template( |
|
102 | + $template, |
|
103 | + $ticket_line_item, |
|
104 | + $valid_shortcodes, |
|
105 | + $this->_extra_data |
|
106 | + ); |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * Verify incoming data contains what is needed for retrieving and parsing each tax line item for a transaction. |
|
112 | + * |
|
113 | + * @since 4.5.0 |
|
114 | + * |
|
115 | + * @return string parsed tax line item list. |
|
116 | + */ |
|
117 | + private function _get_tax_line_item_list() |
|
118 | + { |
|
119 | + |
|
120 | + $this->_validate_list_requirements(); |
|
121 | + |
|
122 | + if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
123 | + return ''; |
|
124 | + } |
|
125 | + |
|
126 | + // made it here so we're good to go. |
|
127 | + $valid_shortcodes = array('line_item'); |
|
128 | + $templates = $this->_data['template']; |
|
129 | + |
|
130 | + $tax_line_items = $this->_data['data']->tax_line_items; |
|
131 | + $line_item_list = ''; |
|
132 | + foreach ($tax_line_items as $line_item) { |
|
133 | + $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
134 | + $templates['tax_line_item_list'], |
|
135 | + $line_item, |
|
136 | + $valid_shortcodes, |
|
137 | + $this->_extra_data |
|
138 | + ); |
|
139 | + } |
|
140 | + |
|
141 | + return $line_item_list; |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Verify incoming data contains what is needed for retrieving and parsing each other line item for a transaction. |
|
146 | + * |
|
147 | + * @since 4.5.0 |
|
148 | + * |
|
149 | + * @return string parsed other line item list. |
|
150 | + */ |
|
151 | + private function _get_additional_line_item_list() |
|
152 | + { |
|
153 | + |
|
154 | + $this->_validate_list_requirements(); |
|
155 | + |
|
156 | + if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
157 | + return ''; |
|
158 | + } |
|
159 | + |
|
160 | + // made it here so we're good to go. |
|
161 | + $valid_shortcodes = array('line_item'); |
|
162 | + $templates = $this->_data['template']; |
|
163 | + |
|
164 | + $additional_line_items = $this->_data['data']->additional_line_items; |
|
165 | + $line_item_list = ''; |
|
166 | + foreach ($additional_line_items as $line_item) { |
|
167 | + $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
168 | + $templates['additional_line_item_list'], |
|
169 | + $line_item, |
|
170 | + $valid_shortcodes, |
|
171 | + $this->_extra_data |
|
172 | + ); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + return $line_item_list; |
|
177 | + } |
|
178 | + |
|
179 | + |
|
180 | + /** |
|
181 | + * Verify incoming data contains what is needed for retrieving and parsing each price modifier line item for a |
|
182 | + * parent ticket line item. |
|
183 | + * |
|
184 | + * @since 4.5.0 |
|
185 | + * |
|
186 | + * @return string parsed price modifier line item list. |
|
187 | + */ |
|
188 | + private function _get_price_mod_line_item_list() |
|
189 | + { |
|
190 | + $this->_validate_list_requirements(); |
|
191 | + |
|
192 | + if (! $this->_data['data'] instanceof EE_Line_Item) { |
|
193 | + return ''; |
|
194 | + } |
|
195 | + |
|
196 | + // made it here so we're good to go. |
|
197 | + $main_line_item = $this->_data['data']; |
|
198 | + $templates = $this->_extra_data['template']; |
|
199 | + $addressee_obj = $this->_extra_data['data']; |
|
200 | + |
|
201 | + $valid_shortcodes = array('line_item'); |
|
202 | + |
|
203 | + $main_line_item_id = $main_line_item->ID(); |
|
204 | + |
|
205 | + $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children']) |
|
206 | + ? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array(); |
|
207 | + |
|
208 | + $line_item_list = ''; |
|
209 | + |
|
210 | + foreach ($price_mod_line_items as $line_item) { |
|
211 | + $line_item_list .= $this->_shortcode_helper->parse_line_item_list_template( |
|
212 | + $templates['price_modifier_line_item_list'], |
|
213 | + $line_item, |
|
214 | + $valid_shortcodes, |
|
215 | + $this->_extra_data |
|
216 | + ); |
|
217 | + } |
|
218 | + |
|
219 | + return $line_item_list; |
|
220 | + } |
|
221 | 221 | } |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | { |
75 | 75 | $this->_validate_list_requirements(); |
76 | 76 | |
77 | - if (! $this->_data['data'] instanceof EE_Ticket) { |
|
77 | + if ( ! $this->_data['data'] instanceof EE_Ticket) { |
|
78 | 78 | return ''; |
79 | 79 | } |
80 | 80 | |
@@ -85,10 +85,10 @@ discard block |
||
85 | 85 | $addressee_obj = $this->_extra_data['data']; |
86 | 86 | |
87 | 87 | // made it here so we have an EE_Ticket, so we should have what we need. |
88 | - $ticket_line_item = isset($addressee_obj->tickets[ $ticket->ID() ]['line_item']) |
|
89 | - ? $addressee_obj->tickets[ $ticket->ID() ]['line_item'] : null; |
|
90 | - $sub_line_items = isset($addressee_obj->tickets[ $ticket->ID() ]['sub_line_items']) |
|
91 | - ? $addressee_obj->tickets[ $ticket->ID() ]['sub_line_items'] : array(); |
|
88 | + $ticket_line_item = isset($addressee_obj->tickets[$ticket->ID()]['line_item']) |
|
89 | + ? $addressee_obj->tickets[$ticket->ID()]['line_item'] : null; |
|
90 | + $sub_line_items = isset($addressee_obj->tickets[$ticket->ID()]['sub_line_items']) |
|
91 | + ? $addressee_obj->tickets[$ticket->ID()]['sub_line_items'] : array(); |
|
92 | 92 | |
93 | 93 | $template = count($sub_line_items) < 2 ? $templates['ticket_line_item_no_pms'] |
94 | 94 | : $templates['ticket_line_item_pms']; |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | |
120 | 120 | $this->_validate_list_requirements(); |
121 | 121 | |
122 | - if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
122 | + if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
123 | 123 | return ''; |
124 | 124 | } |
125 | 125 | |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | |
154 | 154 | $this->_validate_list_requirements(); |
155 | 155 | |
156 | - if (! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
156 | + if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) { |
|
157 | 157 | return ''; |
158 | 158 | } |
159 | 159 | |
@@ -189,7 +189,7 @@ discard block |
||
189 | 189 | { |
190 | 190 | $this->_validate_list_requirements(); |
191 | 191 | |
192 | - if (! $this->_data['data'] instanceof EE_Line_Item) { |
|
192 | + if ( ! $this->_data['data'] instanceof EE_Line_Item) { |
|
193 | 193 | return ''; |
194 | 194 | } |
195 | 195 | |
@@ -202,8 +202,8 @@ discard block |
||
202 | 202 | |
203 | 203 | $main_line_item_id = $main_line_item->ID(); |
204 | 204 | |
205 | - $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[ $main_line_item_id ]['children']) |
|
206 | - ? $addressee_obj->line_items_with_children[ $main_line_item_id ]['children'] : array(); |
|
205 | + $price_mod_line_items = ! empty($addressee_obj->line_items_with_children[$main_line_item_id]['children']) |
|
206 | + ? $addressee_obj->line_items_with_children[$main_line_item_id]['children'] : array(); |
|
207 | 207 | |
208 | 208 | $line_item_list = ''; |
209 | 209 |
@@ -18,65 +18,65 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - protected function _init_props() |
|
22 | - { |
|
23 | - $this->label = __('Line Item Shortcodes', 'event_espresso'); |
|
24 | - $this->description = __('All shortcodes specific to line items', 'event_espresso'); |
|
25 | - $this->_shortcodes = array( |
|
26 | - '[LINE_ITEM_NAME]' => __('Outputs the line item name.', 'event_espresso'), |
|
27 | - '[LINE_ITEM_DESCRIPTION]' => __('Outputs a the description for the line item.', 'event_espresso'), |
|
28 | - '[LINE_ITEM_QUANTITY]' => __('Outputs the quantity for this line item.', 'event_espresso'), |
|
29 | - '[LINE_ITEM_AMOUNT]' => __( |
|
30 | - 'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).', |
|
31 | - 'event_espresso' |
|
32 | - ), |
|
33 | - '[LINE_ITEM_TOTAL]' => __('This outputs the line item total.', 'event_espresso'), |
|
34 | - '[LINE_ITEM_TAXABLE_*]' => __( |
|
35 | - 'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not. One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item. So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned. The default symbol if no attribute is included is the "*" symbol.', |
|
36 | - 'event_espresso' |
|
37 | - ), |
|
38 | - ); |
|
39 | - } |
|
21 | + protected function _init_props() |
|
22 | + { |
|
23 | + $this->label = __('Line Item Shortcodes', 'event_espresso'); |
|
24 | + $this->description = __('All shortcodes specific to line items', 'event_espresso'); |
|
25 | + $this->_shortcodes = array( |
|
26 | + '[LINE_ITEM_NAME]' => __('Outputs the line item name.', 'event_espresso'), |
|
27 | + '[LINE_ITEM_DESCRIPTION]' => __('Outputs a the description for the line item.', 'event_espresso'), |
|
28 | + '[LINE_ITEM_QUANTITY]' => __('Outputs the quantity for this line item.', 'event_espresso'), |
|
29 | + '[LINE_ITEM_AMOUNT]' => __( |
|
30 | + 'This will either output the unit price for a line item if its not a percent, or the percent of the line item (if it is percent).', |
|
31 | + 'event_espresso' |
|
32 | + ), |
|
33 | + '[LINE_ITEM_TOTAL]' => __('This outputs the line item total.', 'event_espresso'), |
|
34 | + '[LINE_ITEM_TAXABLE_*]' => __( |
|
35 | + 'This attribute type shortcode allows users to indicate what to output if a line item is taxable or not. One can use the key "symbol=" with the shortcode to indicate what they\'d like to represent a taxable line item. So doing something like <code>[LINE_ITEM_TAXABLE_* symbol="*"]</code> means that when the line item is parsed, if it\'s taxable the "*" symbol will be returned. The default symbol if no attribute is included is the "*" symbol.', |
|
36 | + 'event_espresso' |
|
37 | + ), |
|
38 | + ); |
|
39 | + } |
|
40 | 40 | |
41 | 41 | |
42 | - protected function _parser($shortcode) |
|
43 | - { |
|
44 | - // ensure that the incoming object IS a line item. If it isn't then bail early. |
|
45 | - if (! $this->_data instanceof EE_Line_Item) { |
|
46 | - return ''; |
|
47 | - } |
|
42 | + protected function _parser($shortcode) |
|
43 | + { |
|
44 | + // ensure that the incoming object IS a line item. If it isn't then bail early. |
|
45 | + if (! $this->_data instanceof EE_Line_Item) { |
|
46 | + return ''; |
|
47 | + } |
|
48 | 48 | |
49 | - $line_item = $this->_data; |
|
49 | + $line_item = $this->_data; |
|
50 | 50 | |
51 | - switch ($shortcode) { |
|
52 | - case '[LINE_ITEM_NAME]': |
|
53 | - return $line_item->name(); |
|
54 | - break; |
|
51 | + switch ($shortcode) { |
|
52 | + case '[LINE_ITEM_NAME]': |
|
53 | + return $line_item->name(); |
|
54 | + break; |
|
55 | 55 | |
56 | - case '[LINE_ITEM_DESCRIPTION]': |
|
57 | - return $line_item->desc(); |
|
58 | - break; |
|
56 | + case '[LINE_ITEM_DESCRIPTION]': |
|
57 | + return $line_item->desc(); |
|
58 | + break; |
|
59 | 59 | |
60 | - case '[LINE_ITEM_QUANTITY]': |
|
61 | - return $line_item->quantity(); |
|
62 | - break; |
|
60 | + case '[LINE_ITEM_QUANTITY]': |
|
61 | + return $line_item->quantity(); |
|
62 | + break; |
|
63 | 63 | |
64 | - case '[LINE_ITEM_AMOUNT]': |
|
65 | - return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
66 | - break; |
|
64 | + case '[LINE_ITEM_AMOUNT]': |
|
65 | + return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
66 | + break; |
|
67 | 67 | |
68 | - case '[LINE_ITEM_TOTAL]': |
|
69 | - return $line_item->total_no_code(); |
|
70 | - break; |
|
71 | - } |
|
68 | + case '[LINE_ITEM_TOTAL]': |
|
69 | + return $line_item->total_no_code(); |
|
70 | + break; |
|
71 | + } |
|
72 | 72 | |
73 | - if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) { |
|
74 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
75 | - if ($line_item->is_taxable()) { |
|
76 | - return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*'; |
|
77 | - } |
|
78 | - } |
|
73 | + if (strpos($shortcode, '[LINE_ITEM_TAXABLE_*') !== false) { |
|
74 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
75 | + if ($line_item->is_taxable()) { |
|
76 | + return ! empty($attrs['symbol']) ? $attrs['symbol'] : '*'; |
|
77 | + } |
|
78 | + } |
|
79 | 79 | |
80 | - return ''; |
|
81 | - } |
|
80 | + return ''; |
|
81 | + } |
|
82 | 82 | } |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | protected function _parser($shortcode) |
43 | 43 | { |
44 | 44 | // ensure that the incoming object IS a line item. If it isn't then bail early. |
45 | - if (! $this->_data instanceof EE_Line_Item) { |
|
45 | + if ( ! $this->_data instanceof EE_Line_Item) { |
|
46 | 46 | return ''; |
47 | 47 | } |
48 | 48 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | break; |
63 | 63 | |
64 | 64 | case '[LINE_ITEM_AMOUNT]': |
65 | - return $line_item->is_percent() ? $line_item->percent() . '%' : $line_item->unit_price_no_code(); |
|
65 | + return $line_item->is_percent() ? $line_item->percent().'%' : $line_item->unit_price_no_code(); |
|
66 | 66 | break; |
67 | 67 | |
68 | 68 | case '[LINE_ITEM_TOTAL]': |
@@ -18,83 +18,83 @@ |
||
18 | 18 | class EE_Datetime_Shortcodes extends EE_Shortcodes |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * _init_props |
|
23 | - * |
|
24 | - * @access protected |
|
25 | - * @return void |
|
26 | - */ |
|
27 | - protected function _init_props() |
|
28 | - { |
|
29 | - $this->label = __('Datetime Shortcodes', 'event_espresso'); |
|
30 | - $this->description = __('All shortcodes specific to datetime related data', 'event_espresso'); |
|
31 | - $this->_shortcodes = array( |
|
32 | - '[DATETIME_START]' => __('The start date and time.', 'event_espresso'), |
|
33 | - '[DATETIME_END]' => __('The end date and time.', 'event_espresso'), |
|
34 | - '[DATETIME_TIMEZONE]' => __('The timezone for the date and time', 'event_espresso'), |
|
35 | - '[DATE_START]' => __('The datetime start date.', 'event_espresso'), |
|
36 | - '[DATE_END]' => __('The datetime end date.', 'event_espresso'), |
|
37 | - '[TIME_START]' => __('The datetime start time.', 'event_espresso'), |
|
38 | - '[TIME_END]' => __('The datetime end time.', 'event_espresso'), |
|
39 | - '[ICAL_LINK_*]' => __( |
|
40 | - 'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").', |
|
41 | - 'event_espresso' |
|
42 | - ), |
|
43 | - ); |
|
44 | - } |
|
21 | + /** |
|
22 | + * _init_props |
|
23 | + * |
|
24 | + * @access protected |
|
25 | + * @return void |
|
26 | + */ |
|
27 | + protected function _init_props() |
|
28 | + { |
|
29 | + $this->label = __('Datetime Shortcodes', 'event_espresso'); |
|
30 | + $this->description = __('All shortcodes specific to datetime related data', 'event_espresso'); |
|
31 | + $this->_shortcodes = array( |
|
32 | + '[DATETIME_START]' => __('The start date and time.', 'event_espresso'), |
|
33 | + '[DATETIME_END]' => __('The end date and time.', 'event_espresso'), |
|
34 | + '[DATETIME_TIMEZONE]' => __('The timezone for the date and time', 'event_espresso'), |
|
35 | + '[DATE_START]' => __('The datetime start date.', 'event_espresso'), |
|
36 | + '[DATE_END]' => __('The datetime end date.', 'event_espresso'), |
|
37 | + '[TIME_START]' => __('The datetime start time.', 'event_espresso'), |
|
38 | + '[TIME_END]' => __('The datetime end time.', 'event_espresso'), |
|
39 | + '[ICAL_LINK_*]' => __( |
|
40 | + 'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").', |
|
41 | + 'event_espresso' |
|
42 | + ), |
|
43 | + ); |
|
44 | + } |
|
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * _parser |
|
49 | - * |
|
50 | - * @access protected |
|
51 | - * @param string $shortcode |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - protected function _parser($shortcode) |
|
55 | - { |
|
47 | + /** |
|
48 | + * _parser |
|
49 | + * |
|
50 | + * @access protected |
|
51 | + * @param string $shortcode |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + protected function _parser($shortcode) |
|
55 | + { |
|
56 | 56 | |
57 | - if (! $this->_data instanceof EE_Datetime) { |
|
58 | - return ''; // get out cause we can only parse with the datetime object. |
|
59 | - } |
|
57 | + if (! $this->_data instanceof EE_Datetime) { |
|
58 | + return ''; // get out cause we can only parse with the datetime object. |
|
59 | + } |
|
60 | 60 | |
61 | - switch ($shortcode) { |
|
62 | - case '[DATETIME_START]': |
|
63 | - return $this->_data->get_i18n_datetime('DTT_EVT_start'); |
|
64 | - break; |
|
61 | + switch ($shortcode) { |
|
62 | + case '[DATETIME_START]': |
|
63 | + return $this->_data->get_i18n_datetime('DTT_EVT_start'); |
|
64 | + break; |
|
65 | 65 | |
66 | - case '[DATETIME_END]': |
|
67 | - return $this->_data->get_i18n_datetime('DTT_EVT_end'); |
|
68 | - break; |
|
66 | + case '[DATETIME_END]': |
|
67 | + return $this->_data->get_i18n_datetime('DTT_EVT_end'); |
|
68 | + break; |
|
69 | 69 | |
70 | - case '[DATETIME_TIMEZONE]': |
|
71 | - return $this->_data->get_timezone(); |
|
72 | - break; |
|
73 | - case '[DATE_START]': |
|
74 | - return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format')); |
|
75 | - break; |
|
76 | - case '[DATE_END]': |
|
77 | - return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format')); |
|
78 | - break; |
|
79 | - case '[TIME_START]': |
|
80 | - return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format')); |
|
81 | - break; |
|
82 | - case '[TIME_END]': |
|
83 | - return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format')); |
|
84 | - break; |
|
85 | - } |
|
70 | + case '[DATETIME_TIMEZONE]': |
|
71 | + return $this->_data->get_timezone(); |
|
72 | + break; |
|
73 | + case '[DATE_START]': |
|
74 | + return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format')); |
|
75 | + break; |
|
76 | + case '[DATE_END]': |
|
77 | + return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format')); |
|
78 | + break; |
|
79 | + case '[TIME_START]': |
|
80 | + return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format')); |
|
81 | + break; |
|
82 | + case '[TIME_END]': |
|
83 | + return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format')); |
|
84 | + break; |
|
85 | + } |
|
86 | 86 | |
87 | - if (strpos($shortcode, '[ICAL_LINK_*') !== false) { |
|
88 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
87 | + if (strpos($shortcode, '[ICAL_LINK_*') !== false) { |
|
88 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
89 | 89 | |
90 | - $link_text = empty($attrs['link_text']) ? __('Add to iCal Calendar', 'event_espresso') |
|
91 | - : $attrs['link_text']; |
|
90 | + $link_text = empty($attrs['link_text']) ? __('Add to iCal Calendar', 'event_espresso') |
|
91 | + : $attrs['link_text']; |
|
92 | 92 | |
93 | - $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
|
93 | + $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
|
94 | 94 | |
95 | - return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
96 | - } |
|
95 | + return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
96 | + } |
|
97 | 97 | |
98 | - return ''; |
|
99 | - } |
|
98 | + return ''; |
|
99 | + } |
|
100 | 100 | } |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | protected function _parser($shortcode) |
55 | 55 | { |
56 | 56 | |
57 | - if (! $this->_data instanceof EE_Datetime) { |
|
57 | + if ( ! $this->_data instanceof EE_Datetime) { |
|
58 | 58 | return ''; // get out cause we can only parse with the datetime object. |
59 | 59 | } |
60 | 60 | |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | |
93 | 93 | $URL = add_query_arg(array('ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()), site_url()); |
94 | 94 | |
95 | - return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>'; |
|
95 | + return '<a class="ee-ical" href="'.$URL.'">'.$link_text.'</a>'; |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | return ''; |
@@ -17,783 +17,783 @@ |
||
17 | 17 | class EE_Transaction_Shortcodes extends EE_Shortcodes |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc |
|
22 | - */ |
|
23 | - protected $_invoice_pm; |
|
24 | - |
|
25 | - |
|
26 | - protected function _init_props() |
|
27 | - { |
|
28 | - $this->label = esc_html__('Transaction Shortcodes', 'event_espresso'); |
|
29 | - $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso'); |
|
30 | - $this->_shortcodes = array( |
|
31 | - '[TXN_ID]' => esc_html__('The transaction id for the purchase.', 'event_espresso'), |
|
32 | - '[PAYMENT_URL]' => esc_html__( |
|
33 | - 'This is a link to make a payment for the event', |
|
34 | - 'event_espresso' |
|
35 | - ), |
|
36 | - '[PAYMENT_LINK_IF_NEEDED_*]' => esc_html__( |
|
37 | - 'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:', |
|
38 | - 'event_espresso' |
|
39 | - ) |
|
40 | - . '<ul>' |
|
41 | - . '<li>' |
|
42 | - . sprintf( |
|
43 | - esc_html__( |
|
44 | - '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").', |
|
45 | - 'event_espresso' |
|
46 | - ), |
|
47 | - '<strong>', |
|
48 | - '</strong>' |
|
49 | - ) |
|
50 | - . '</li>' |
|
51 | - . '<li>' |
|
52 | - . sprintf( |
|
53 | - esc_html__( |
|
54 | - '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)', |
|
55 | - 'event_espresso' |
|
56 | - ), |
|
57 | - '<strong>', |
|
58 | - '</strong>' |
|
59 | - ) |
|
60 | - . '</li>' |
|
61 | - . '<li>' |
|
62 | - . sprintf( |
|
63 | - esc_html__( |
|
64 | - '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").', |
|
65 | - 'event_espresso' |
|
66 | - ), |
|
67 | - '<strong>', |
|
68 | - '</strong>' |
|
69 | - ) |
|
70 | - . '</li>' |
|
71 | - . '</ul>', |
|
72 | - '[PAYMENT_DUE_DATE_*]' => esc_html__( |
|
73 | - 'This is a special dynamic shortcode that allows one to output a payment due date. It will only result in a date shown if there is money owing. Three parameters are available on this shortcode:', |
|
74 | - 'event_espresso' |
|
75 | - ) |
|
76 | - . '<ul>' |
|
77 | - . '<li>' |
|
78 | - . sprintf( |
|
79 | - esc_html__( |
|
80 | - '%sformat:%s This is used to indicate what format the date is in. Default is whatever is set as date formats for your website.', |
|
81 | - 'event_espresso' |
|
82 | - ), |
|
83 | - '<strong>', |
|
84 | - '</strong>' |
|
85 | - ) |
|
86 | - . '</li>' |
|
87 | - . '<li>' |
|
88 | - . sprintf( |
|
89 | - esc_html__( |
|
90 | - '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due. Defaults to 30.', |
|
91 | - 'event_espresso' |
|
92 | - ), |
|
93 | - '<strong>', |
|
94 | - '</strong>' |
|
95 | - ) |
|
96 | - . '</li>' |
|
97 | - . '<li>' |
|
98 | - . sprintf( |
|
99 | - esc_html__( |
|
100 | - '%sprefix_text:%s You can use this to indicate what text will prefix the date string. Defaults to "Payment in full due by:"', |
|
101 | - 'event_espresso' |
|
102 | - ), |
|
103 | - '<strong>', |
|
104 | - '</strong>' |
|
105 | - ) |
|
106 | - . '</li>', |
|
107 | - '[INVOICE_LINK]' => esc_html__( |
|
108 | - 'This is a full html link to the invoice', |
|
109 | - 'event_espresso' |
|
110 | - ), |
|
111 | - '[INVOICE_URL]' => esc_html__( |
|
112 | - 'This is just the url for the invoice', |
|
113 | - 'event_espresso' |
|
114 | - ), |
|
115 | - '[INVOICE_LOGO_URL]' => esc_html__( |
|
116 | - 'This returns the url for the logo uploaded via the invoice settings page.', |
|
117 | - 'event_espresso' |
|
118 | - ), |
|
119 | - '[INVOICE_LOGO]' => esc_html__( |
|
120 | - 'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.', |
|
121 | - 'event_espresso' |
|
122 | - ), |
|
123 | - '[INVOICE_PAYEE_NAME]' => esc_html__( |
|
124 | - 'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.', |
|
125 | - 'event_espresso' |
|
126 | - ), |
|
127 | - '[INVOICE_PAYEE_ADDRESS]' => esc_html__( |
|
128 | - 'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.', |
|
129 | - 'event_espresso' |
|
130 | - ), |
|
131 | - '[INVOICE_PAYMENT_INSTRUCTIONS]' => esc_html__( |
|
132 | - 'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page', |
|
133 | - 'event_espresso' |
|
134 | - ), |
|
135 | - '[INVOICE_PAYEE_EMAIL]' => esc_html__( |
|
136 | - 'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.', |
|
137 | - 'event_espresso' |
|
138 | - ), |
|
139 | - '[INVOICE_PAYEE_TAX_NUMBER_*]' => sprintf( |
|
140 | - esc_html__( |
|
141 | - 'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number. It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56. If you have no tax number in your settings, then no prefix will be output either.', |
|
142 | - 'event_espresso' |
|
143 | - ), |
|
144 | - '<code>', |
|
145 | - '</code>' |
|
146 | - ), |
|
147 | - '[TOTAL_COST]' => esc_html__('The total cost for the transaction', 'event_espresso'), |
|
148 | - '[TXN_STATUS]' => esc_html__( |
|
149 | - 'The transaction status for the transaction.', |
|
150 | - 'event_espresso' |
|
151 | - ), |
|
152 | - '[TXN_STATUS_ID]' => esc_html__( |
|
153 | - 'The ID representing the transaction status as saved in the db. This tends to be useful for including with css classes for styling certain statuses differently from others.', |
|
154 | - 'event_espresso' |
|
155 | - ), |
|
156 | - '[PAYMENT_STATUS]' => esc_html__( |
|
157 | - 'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.', |
|
158 | - 'event_espresso' |
|
159 | - ), |
|
160 | - '[PAYMENT_GATEWAY]' => esc_html__( |
|
161 | - 'The payment gateway used for the transaction', |
|
162 | - 'event_espresso' |
|
163 | - ), |
|
164 | - '[AMOUNT_PAID]' => esc_html__( |
|
165 | - 'The amount paid or refunded. This will only have a value if there was a payment or refund at the time of generating the message.', |
|
166 | - 'event_espresso' |
|
167 | - ), |
|
168 | - '[LAST_AMOUNT_PAID]' => esc_html__( |
|
169 | - 'This is the last payment or refund made on the transaction related to the message being generated.', |
|
170 | - 'event_espresso' |
|
171 | - ), |
|
172 | - '[TOTAL_AMOUNT_PAID]' => esc_html__( |
|
173 | - 'This parses to the total amount paid over all payments', |
|
174 | - 'event_espresso' |
|
175 | - ), |
|
176 | - '[TOTAL_OWING]' => esc_html__( |
|
177 | - 'The total owing on a transaction with no attributes.', |
|
178 | - 'event_espresso' |
|
179 | - ), |
|
180 | - '[TXN_SUBTOTAL]' => esc_html__('The subtotal for all txn line items.', 'event_espresso'), |
|
181 | - '[TXN_TAX_SUBTOTAL]' => esc_html__('The subtotal for all tax line items.', 'event_espresso'), |
|
182 | - '[OWING_STATUS_MESSAGE_*]' => esc_html__( |
|
183 | - 'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:', |
|
184 | - 'event_espresso' |
|
185 | - ) |
|
186 | - . '<p></ul>' |
|
187 | - . '<li><strong>still_owing</strong>:' |
|
188 | - . esc_html__( |
|
189 | - 'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:', |
|
190 | - 'event_espresso' |
|
191 | - ) |
|
192 | - . sprintf( |
|
193 | - esc_html__('%sPlease make a payment.%s', 'event_espresso'), |
|
194 | - '<a href="[PAYMENT_URL]" class="noPrint">', |
|
195 | - '</a>' |
|
196 | - ) |
|
197 | - . '</li>' |
|
198 | - . |
|
199 | - '<li><strong>none_owing</strong>:' |
|
200 | - . esc_html__( |
|
201 | - 'If the transaction is paid in full, then you can indicate how this gets displayed. Note, that it defaults to just be the total owing.', |
|
202 | - 'event_espresso' |
|
203 | - ) |
|
204 | - . '</li></ul></p>', |
|
205 | - '[TXN_TOTAL_TICKETS]' => esc_html__( |
|
206 | - 'The total number of all tickets purchased in a transaction', |
|
207 | - 'event_espresso' |
|
208 | - ), |
|
209 | - '[TKT_QTY_PURCHASED]' => sprintf( |
|
210 | - esc_html__( |
|
211 | - 'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s', |
|
212 | - 'event_espresso' |
|
213 | - ), |
|
214 | - '<strong>', |
|
215 | - '</strong>' |
|
216 | - ), |
|
217 | - '[TRANSACTION_ADMIN_URL]' => esc_html__( |
|
218 | - 'The url to the admin page for this transaction', |
|
219 | - 'event_espresso' |
|
220 | - ), |
|
221 | - '[RECEIPT_URL]' => esc_html__( |
|
222 | - 'This parses to the generated url for retrieving the receipt for the transaction', |
|
223 | - 'event_espresso' |
|
224 | - ), |
|
225 | - '[INVOICE_RECEIPT_SWITCHER_URL]' => esc_html__( |
|
226 | - 'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active then will parse to an empty string.', |
|
227 | - 'event_espresso' |
|
228 | - ), |
|
229 | - '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf( |
|
230 | - esc_html__( |
|
231 | - 'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.', |
|
232 | - 'event_espresso' |
|
233 | - ), |
|
234 | - '<code>[INVOICE_RECEIPT_SWITCHER_URL]', |
|
235 | - '</code>' |
|
236 | - ), |
|
237 | - '[LAST_PAYMENT_TRANSACTION_ID]' => esc_html__( |
|
238 | - 'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.', |
|
239 | - 'event_espresso' |
|
240 | - ), |
|
241 | - ); |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @param string $shortcode the shortcode to be parsed. |
|
247 | - * @return string parsed shortcode |
|
248 | - * @throws EE_Error |
|
249 | - * @throws InvalidArgumentException |
|
250 | - * @throws ReflectionException |
|
251 | - * @throws InvalidDataTypeException |
|
252 | - * @throws InvalidInterfaceException |
|
253 | - */ |
|
254 | - protected function _parser($shortcode) |
|
255 | - { |
|
256 | - // attempt to get the transaction. Since this is potentially used in more fields, we may have to look in the |
|
257 | - // _extra_data for the transaction. |
|
258 | - $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null; |
|
259 | - $transaction = ! $transaction instanceof EE_Transaction |
|
260 | - && is_array($this->_extra_data) |
|
261 | - && isset($this->_extra_data['data']) |
|
262 | - && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
263 | - ? $this->_extra_data['data']->txn |
|
264 | - : $transaction; |
|
265 | - // payment |
|
266 | - $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null; |
|
267 | - $payment = ! $payment instanceof EE_Payment |
|
268 | - && is_array($this->_extra_data) |
|
269 | - && isset($this->_extra_data['data']) |
|
270 | - && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment |
|
271 | - : $payment; |
|
272 | - if (! $transaction instanceof EE_Transaction) { |
|
273 | - return ''; |
|
274 | - } |
|
275 | - switch ($shortcode) { |
|
276 | - case '[TXN_ID]': |
|
277 | - return $transaction->ID(); |
|
278 | - break; |
|
279 | - case '[PAYMENT_URL]': |
|
280 | - $payment_url = $transaction->payment_overview_url(); |
|
281 | - return empty($payment_url) |
|
282 | - ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso') |
|
283 | - : $payment_url; |
|
284 | - break; |
|
285 | - case '[INVOICE_LINK]': |
|
286 | - $invoice_url = $transaction->invoice_url(); |
|
287 | - $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url; |
|
288 | - return sprintf( |
|
289 | - esc_html__('%sClick here for Invoice%s', 'event_espresso'), |
|
290 | - '<a href="' . $invoice_url . '">', |
|
291 | - '</a>' |
|
292 | - ); |
|
293 | - break; |
|
294 | - case '[INVOICE_URL]': |
|
295 | - $invoice_url = $transaction->invoice_url(); |
|
296 | - return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url; |
|
297 | - break; |
|
298 | - case '[INVOICE_LOGO_URL]': |
|
299 | - return $this->_get_invoice_logo(); |
|
300 | - break; |
|
301 | - case '[INVOICE_LOGO]': |
|
302 | - return $this->_get_invoice_logo(true); |
|
303 | - break; |
|
304 | - case '[INVOICE_PAYEE_NAME]': |
|
305 | - return $this->_get_invoice_payee_name(); |
|
306 | - break; |
|
307 | - case '[INVOICE_PAYEE_ADDRESS]': |
|
308 | - return $this->_get_invoice_payee_address(); |
|
309 | - break; |
|
310 | - case '[INVOICE_PAYMENT_INSTRUCTIONS]': |
|
311 | - return $this->_get_invoice_payment_instructions(); |
|
312 | - break; |
|
313 | - case '[INVOICE_PAYEE_EMAIL]': |
|
314 | - return $this->_get_invoice_payee_email(); |
|
315 | - break; |
|
316 | - case '[TOTAL_COST]': |
|
317 | - $total = $transaction->total(); |
|
318 | - return ! empty($total) ? EEH_Template::format_currency($total) : ''; |
|
319 | - break; |
|
320 | - case '[PAYMENT_STATUS]': |
|
321 | - $status = $transaction->pretty_status(); |
|
322 | - return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso'); |
|
323 | - break; /**/ |
|
324 | - // note the [payment_status] shortcode is kind of misleading because payment status might be different |
|
325 | - // from txn status so I'm adding this here for clarity. |
|
326 | - case '[TXN_STATUS]': |
|
327 | - $status = $transaction->pretty_status(); |
|
328 | - return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso'); |
|
329 | - break; |
|
330 | - case '[TXN_STATUS_ID]': |
|
331 | - return $transaction->status_ID(); |
|
332 | - break; |
|
333 | - case '[PAYMENT_GATEWAY]': |
|
334 | - return $this->_get_payment_gateway($transaction); |
|
335 | - break; |
|
336 | - case '[AMOUNT_PAID]': |
|
337 | - return $payment instanceof EE_Payment |
|
338 | - ? EEH_Template::format_currency($payment->amount()) |
|
339 | - : EEH_Template::format_currency(0); |
|
340 | - break; |
|
341 | - case '[LAST_AMOUNT_PAID]': |
|
342 | - $last_payment = $transaction->last_payment(); |
|
343 | - return $last_payment instanceof EE_Payment |
|
344 | - ? EEH_Template::format_currency($last_payment->amount()) |
|
345 | - : EEH_Template::format_currency(0); |
|
346 | - case '[TOTAL_AMOUNT_PAID]': |
|
347 | - return EEH_Template::format_currency($transaction->paid()); |
|
348 | - break; |
|
349 | - case '[TOTAL_OWING]': |
|
350 | - $total_owing = $transaction->remaining(); |
|
351 | - return EEH_Template::format_currency($total_owing); |
|
352 | - break; |
|
353 | - case '[TXN_SUBTOTAL]': |
|
354 | - return EEH_Template::format_currency($this->_get_subtotal()); |
|
355 | - break; |
|
356 | - case '[TXN_TAX_SUBTOTAL]': |
|
357 | - return EEH_Template::format_currency($this->_get_subtotal(true)); |
|
358 | - break; |
|
359 | - case '[TKT_QTY_PURCHASED]': |
|
360 | - case '[TXN_TOTAL_TICKETS]': |
|
361 | - return $this->_data->total_ticket_count; |
|
362 | - break; |
|
363 | - case '[TRANSACTION_ADMIN_URL]': |
|
364 | - require_once EE_CORE . 'admin/EE_Admin_Page.core.php'; |
|
365 | - $query_args = array( |
|
366 | - 'page' => 'espresso_transactions', |
|
367 | - 'action' => 'view_transaction', |
|
368 | - 'TXN_ID' => $transaction->ID(), |
|
369 | - ); |
|
370 | - $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')); |
|
371 | - return $url; |
|
372 | - break; |
|
373 | - case '[RECEIPT_URL]': |
|
374 | - // get primary_registration |
|
375 | - $reg = $this->_data->primary_reg_obj; |
|
376 | - if (! $reg instanceof EE_Registration) { |
|
377 | - return ''; |
|
378 | - } |
|
379 | - return $reg->receipt_url(); |
|
380 | - break; |
|
381 | - case '[INVOICE_RECEIPT_SWITCHER_URL]': |
|
382 | - return $this->_get_invoice_receipt_switcher(false); |
|
383 | - break; |
|
384 | - case '[INVOICE_RECEIPT_SWITCHER_BUTTON]': |
|
385 | - return $this->_get_invoice_receipt_switcher(); |
|
386 | - break; |
|
387 | - case '[LAST_PAYMENT_TRANSACTION_ID]': |
|
388 | - $id = ''; |
|
389 | - $payment = $payment instanceof EE_Payment && $payment->ID() !== 0 |
|
390 | - ? $payment |
|
391 | - : $transaction->last_payment(); |
|
392 | - if ($payment instanceof EE_Payment) { |
|
393 | - $id = $payment->txn_id_chq_nmbr(); |
|
394 | - } |
|
395 | - return $id; |
|
396 | - break; |
|
397 | - } |
|
398 | - if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) { |
|
399 | - return $this->_get_custom_total_owing($shortcode); |
|
400 | - } |
|
401 | - if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) { |
|
402 | - return $this->_get_invoice_payee_tax_number($shortcode); |
|
403 | - } |
|
404 | - if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) { |
|
405 | - return $this->_get_payment_link_if_needed($shortcode); |
|
406 | - } |
|
407 | - if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) { |
|
408 | - return $this->_get_payment_due_date($shortcode, $transaction); |
|
409 | - } |
|
410 | - return ''; |
|
411 | - } |
|
412 | - |
|
413 | - |
|
414 | - /** |
|
415 | - * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode |
|
416 | - * |
|
417 | - * @since 4.5.0 |
|
418 | - * @param string $shortcode the incoming shortcode |
|
419 | - * @return string parsed. |
|
420 | - * @throws EE_Error |
|
421 | - */ |
|
422 | - private function _get_custom_total_owing($shortcode) |
|
423 | - { |
|
424 | - $valid_shortcodes = array('transaction'); |
|
425 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
426 | - // ensure default is set. |
|
427 | - $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
428 | - $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction |
|
429 | - ? $addressee->txn->remaining() : 0; |
|
430 | - if ($total_owing > 0) { |
|
431 | - $owing_content = ! empty($attrs['still_owing']) |
|
432 | - ? $attrs['still_owing'] |
|
433 | - : sprintf( |
|
434 | - esc_html__('%sPlease make a payment.%s', 'event_espresso'), |
|
435 | - '<a href="[PAYMENT_URL]" class="noPrint">', |
|
436 | - '</a>' |
|
437 | - ); |
|
438 | - $owing_content = $this->_shortcode_helper->parse_message_template( |
|
439 | - $owing_content, |
|
440 | - $addressee, |
|
441 | - $valid_shortcodes, |
|
442 | - $this->_message_type, |
|
443 | - $this->_messenger, |
|
444 | - $this->_message |
|
445 | - ); |
|
446 | - } else { |
|
447 | - $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : ''; |
|
448 | - } |
|
449 | - return $owing_content; |
|
450 | - } |
|
451 | - |
|
452 | - |
|
453 | - /** |
|
454 | - * @param EE_Transaction $transaction |
|
455 | - * @return string |
|
456 | - * @throws EE_Error |
|
457 | - */ |
|
458 | - private function _get_payment_gateway($transaction) |
|
459 | - { |
|
460 | - if ($transaction instanceof EE_Transaction) { |
|
461 | - $pm = $transaction->payment_method(); |
|
462 | - } else { |
|
463 | - $pm = null; |
|
464 | - } |
|
465 | - return $pm instanceof EE_Payment_Method ? $pm->name() : ''; |
|
466 | - } |
|
467 | - |
|
468 | - |
|
469 | - /** |
|
470 | - * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page. If its |
|
471 | - * not present then the organization logo is used if its found (set on the organization settings page). |
|
472 | - * |
|
473 | - * @since 4.5.0 |
|
474 | - * @param bool $img_tags TRUE means to return with the img tag wrappers. False just returns the url to the image. |
|
475 | - * @return string url or html |
|
476 | - * @throws EE_Error |
|
477 | - * @throws InvalidArgumentException |
|
478 | - * @throws InvalidDataTypeException |
|
479 | - * @throws InvalidInterfaceException |
|
480 | - */ |
|
481 | - private function _get_invoice_logo($img_tags = false) |
|
482 | - { |
|
483 | - $invoice_logo_url = ''; |
|
484 | - // try to get the invoice payment method's logo for this transaction image first |
|
485 | - $pm = $this->_get_invoice_payment_method(); |
|
486 | - if ($pm instanceof EE_Payment_Method) { |
|
487 | - $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true); |
|
488 | - } |
|
489 | - if (empty($invoice_logo_url)) { |
|
490 | - $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url; |
|
491 | - } |
|
492 | - if (empty($invoice_logo_url)) { |
|
493 | - return ''; |
|
494 | - } |
|
495 | - if (! $img_tags) { |
|
496 | - return $invoice_logo_url; |
|
497 | - } |
|
498 | - // image tags have been requested. |
|
499 | - $image_size = getimagesize($invoice_logo_url); |
|
500 | - // if image is wider than 300px, set the width to 300 |
|
501 | - if ($image_size[0] > 300) { |
|
502 | - $image_width = 300; |
|
503 | - } else { |
|
504 | - $image_width = $image_size[0]; |
|
505 | - } |
|
506 | - return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />'; |
|
507 | - } |
|
508 | - |
|
509 | - |
|
510 | - /** |
|
511 | - * Used to retrieve the appropriate content for the invoice payee name shortcode |
|
512 | - * |
|
513 | - * @since 4.5.0 |
|
514 | - * @return string |
|
515 | - * @throws EE_Error |
|
516 | - * @throws InvalidArgumentException |
|
517 | - * @throws InvalidDataTypeException |
|
518 | - * @throws InvalidInterfaceException |
|
519 | - */ |
|
520 | - private function _get_invoice_payee_name() |
|
521 | - { |
|
522 | - $payee_name = null; |
|
523 | - $pm = $this->_get_invoice_payment_method(); |
|
524 | - if ($pm instanceof EE_Payment_Method) { |
|
525 | - $payee_name = $pm->get_extra_meta('pdf_payee_name', true); |
|
526 | - } |
|
527 | - $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name; |
|
528 | - return $payee_name; |
|
529 | - } |
|
530 | - |
|
531 | - |
|
532 | - /** |
|
533 | - * gets the default invoice payment method, but has a filter so it can be overridden |
|
534 | - * |
|
535 | - * @return EE_Payment_Method|null |
|
536 | - * @throws EE_Error |
|
537 | - * @throws InvalidArgumentException |
|
538 | - * @throws InvalidDataTypeException |
|
539 | - * @throws InvalidInterfaceException |
|
540 | - */ |
|
541 | - private function _get_invoice_payment_method() |
|
542 | - { |
|
543 | - if (! $this->_invoice_pm instanceof EE_Payment_Method) { |
|
544 | - $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null; |
|
545 | - $transaction = ! $transaction instanceof EE_Transaction |
|
546 | - && is_array($this->_extra_data) |
|
547 | - && isset($this->_extra_data['data']) |
|
548 | - && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
549 | - ? $this->_extra_data['data']->txn : $transaction; |
|
550 | - // get the invoice payment method, and remember it for the next call too |
|
551 | - $this->_invoice_pm = apply_filters( |
|
552 | - 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', |
|
553 | - EEM_Payment_Method::instance()->get_one_of_type('Invoice'), |
|
554 | - $transaction |
|
555 | - ); |
|
556 | - } |
|
557 | - return $this->_invoice_pm; |
|
558 | - } |
|
559 | - |
|
560 | - |
|
561 | - /** |
|
562 | - * Used to retrieve the appropriate content for the invoice payee email shortcode |
|
563 | - * |
|
564 | - * @since 4.5.0 |
|
565 | - * @return string |
|
566 | - * @throws EE_Error |
|
567 | - * @throws InvalidArgumentException |
|
568 | - * @throws InvalidDataTypeException |
|
569 | - * @throws InvalidInterfaceException |
|
570 | - */ |
|
571 | - private function _get_invoice_payee_email() |
|
572 | - { |
|
573 | - $payee_email = null; |
|
574 | - $pm = $this->_get_invoice_payment_method(); |
|
575 | - if ($pm instanceof EE_Payment_Method) { |
|
576 | - $payee_email = $pm->get_extra_meta('pdf_payee_email', true); |
|
577 | - } |
|
578 | - $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email') |
|
579 | - : $payee_email; |
|
580 | - return $payee_email; |
|
581 | - } |
|
582 | - |
|
583 | - |
|
584 | - /** |
|
585 | - * Used to retrieve the appropriate content for the invoice payee tax number shortcode |
|
586 | - * |
|
587 | - * @since 4.5.0 |
|
588 | - * @param string $shortcode |
|
589 | - * @return string |
|
590 | - * @throws EE_Error |
|
591 | - * @throws InvalidArgumentException |
|
592 | - * @throws InvalidDataTypeException |
|
593 | - * @throws InvalidInterfaceException |
|
594 | - */ |
|
595 | - private function _get_invoice_payee_tax_number($shortcode) |
|
596 | - { |
|
597 | - $payee_tax_number = null; |
|
598 | - $pm = $this->_get_invoice_payment_method(); |
|
599 | - if ($pm instanceof EE_Payment_Method) { |
|
600 | - $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true); |
|
601 | - } |
|
602 | - $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat |
|
603 | - : $payee_tax_number; |
|
604 | - if (empty($payee_tax_number)) { |
|
605 | - return ''; |
|
606 | - } |
|
607 | - // any attributes? |
|
608 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
609 | - // prefix? |
|
610 | - $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
|
611 | - return $prefix . $payee_tax_number; |
|
612 | - } |
|
613 | - |
|
614 | - |
|
615 | - /** |
|
616 | - * Used to retrieve the appropriate content for the invoice payee address shortcode. |
|
617 | - * |
|
618 | - * @since 4.5.0 |
|
619 | - * @return string |
|
620 | - * @throws EE_Error |
|
621 | - * @throws InvalidArgumentException |
|
622 | - * @throws ReflectionException |
|
623 | - * @throws InvalidDataTypeException |
|
624 | - * @throws InvalidInterfaceException |
|
625 | - */ |
|
626 | - private function _get_invoice_payee_address() |
|
627 | - { |
|
628 | - $payee_address = null; |
|
629 | - $pm = $this->_get_invoice_payment_method(); |
|
630 | - if ($pm instanceof EE_Payment_Method) { |
|
631 | - $payee_address = $pm->get_extra_meta('pdf_payee_address', true); |
|
632 | - } |
|
633 | - if (empty($payee_address)) { |
|
634 | - $organization = EE_Registry::instance()->CFG->organization; |
|
635 | - $payee_address = $organization->get_pretty('address_1') . '<br>'; |
|
636 | - $payee_address .= ! empty($organization->address_2) |
|
637 | - ? $organization->get_pretty('address_2') . '<br>' |
|
638 | - : ''; |
|
639 | - $payee_address .= $organization->get_pretty('city') . '<br>'; |
|
640 | - // state |
|
641 | - $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID); |
|
642 | - $payee_address .= $state instanceof EE_State ? $state->name() : ''; |
|
643 | - // Country |
|
644 | - $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : ''; |
|
645 | - $payee_address .= ! empty($organization->zip) ? $organization->zip : ''; |
|
646 | - } |
|
647 | - return $payee_address; |
|
648 | - } |
|
649 | - |
|
650 | - |
|
651 | - /** |
|
652 | - * Used to retrieve the appropriate content for the invoice payment instructions shortcode. |
|
653 | - * |
|
654 | - * @since 4.5.0 |
|
655 | - * @return string |
|
656 | - * @throws EE_Error |
|
657 | - * @throws InvalidArgumentException |
|
658 | - * @throws InvalidDataTypeException |
|
659 | - * @throws InvalidInterfaceException |
|
660 | - */ |
|
661 | - private function _get_invoice_payment_instructions() |
|
662 | - { |
|
663 | - $instructions = null; |
|
664 | - $pm = $this->_get_invoice_payment_method(); |
|
665 | - return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : ''; |
|
666 | - } |
|
667 | - |
|
668 | - |
|
669 | - /** |
|
670 | - * get invoice/receipt switch button or url. |
|
671 | - * |
|
672 | - * @param bool $button true (default) returns the html for a button, false just returns the url. |
|
673 | - * @return string |
|
674 | - * @throws EE_Error |
|
675 | - */ |
|
676 | - protected function _get_invoice_receipt_switcher($button = true) |
|
677 | - { |
|
678 | - $reg = $this->_data->primary_reg_obj; |
|
679 | - $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : ''; |
|
680 | - if (! $reg instanceof EE_Registration || empty($message_type)) { |
|
681 | - return ''; |
|
682 | - } |
|
683 | - $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false; |
|
684 | - $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type |
|
685 | - ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso'); |
|
686 | - $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label; |
|
687 | - $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url(); |
|
688 | - if (! $button) { |
|
689 | - return $switch_to_url; |
|
690 | - } |
|
691 | - if (! empty($switch_to_url)) { |
|
692 | - return ' |
|
20 | + /** |
|
21 | + * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc |
|
22 | + */ |
|
23 | + protected $_invoice_pm; |
|
24 | + |
|
25 | + |
|
26 | + protected function _init_props() |
|
27 | + { |
|
28 | + $this->label = esc_html__('Transaction Shortcodes', 'event_espresso'); |
|
29 | + $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso'); |
|
30 | + $this->_shortcodes = array( |
|
31 | + '[TXN_ID]' => esc_html__('The transaction id for the purchase.', 'event_espresso'), |
|
32 | + '[PAYMENT_URL]' => esc_html__( |
|
33 | + 'This is a link to make a payment for the event', |
|
34 | + 'event_espresso' |
|
35 | + ), |
|
36 | + '[PAYMENT_LINK_IF_NEEDED_*]' => esc_html__( |
|
37 | + 'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:', |
|
38 | + 'event_espresso' |
|
39 | + ) |
|
40 | + . '<ul>' |
|
41 | + . '<li>' |
|
42 | + . sprintf( |
|
43 | + esc_html__( |
|
44 | + '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").', |
|
45 | + 'event_espresso' |
|
46 | + ), |
|
47 | + '<strong>', |
|
48 | + '</strong>' |
|
49 | + ) |
|
50 | + . '</li>' |
|
51 | + . '<li>' |
|
52 | + . sprintf( |
|
53 | + esc_html__( |
|
54 | + '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)', |
|
55 | + 'event_espresso' |
|
56 | + ), |
|
57 | + '<strong>', |
|
58 | + '</strong>' |
|
59 | + ) |
|
60 | + . '</li>' |
|
61 | + . '<li>' |
|
62 | + . sprintf( |
|
63 | + esc_html__( |
|
64 | + '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").', |
|
65 | + 'event_espresso' |
|
66 | + ), |
|
67 | + '<strong>', |
|
68 | + '</strong>' |
|
69 | + ) |
|
70 | + . '</li>' |
|
71 | + . '</ul>', |
|
72 | + '[PAYMENT_DUE_DATE_*]' => esc_html__( |
|
73 | + 'This is a special dynamic shortcode that allows one to output a payment due date. It will only result in a date shown if there is money owing. Three parameters are available on this shortcode:', |
|
74 | + 'event_espresso' |
|
75 | + ) |
|
76 | + . '<ul>' |
|
77 | + . '<li>' |
|
78 | + . sprintf( |
|
79 | + esc_html__( |
|
80 | + '%sformat:%s This is used to indicate what format the date is in. Default is whatever is set as date formats for your website.', |
|
81 | + 'event_espresso' |
|
82 | + ), |
|
83 | + '<strong>', |
|
84 | + '</strong>' |
|
85 | + ) |
|
86 | + . '</li>' |
|
87 | + . '<li>' |
|
88 | + . sprintf( |
|
89 | + esc_html__( |
|
90 | + '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due. Defaults to 30.', |
|
91 | + 'event_espresso' |
|
92 | + ), |
|
93 | + '<strong>', |
|
94 | + '</strong>' |
|
95 | + ) |
|
96 | + . '</li>' |
|
97 | + . '<li>' |
|
98 | + . sprintf( |
|
99 | + esc_html__( |
|
100 | + '%sprefix_text:%s You can use this to indicate what text will prefix the date string. Defaults to "Payment in full due by:"', |
|
101 | + 'event_espresso' |
|
102 | + ), |
|
103 | + '<strong>', |
|
104 | + '</strong>' |
|
105 | + ) |
|
106 | + . '</li>', |
|
107 | + '[INVOICE_LINK]' => esc_html__( |
|
108 | + 'This is a full html link to the invoice', |
|
109 | + 'event_espresso' |
|
110 | + ), |
|
111 | + '[INVOICE_URL]' => esc_html__( |
|
112 | + 'This is just the url for the invoice', |
|
113 | + 'event_espresso' |
|
114 | + ), |
|
115 | + '[INVOICE_LOGO_URL]' => esc_html__( |
|
116 | + 'This returns the url for the logo uploaded via the invoice settings page.', |
|
117 | + 'event_espresso' |
|
118 | + ), |
|
119 | + '[INVOICE_LOGO]' => esc_html__( |
|
120 | + 'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.', |
|
121 | + 'event_espresso' |
|
122 | + ), |
|
123 | + '[INVOICE_PAYEE_NAME]' => esc_html__( |
|
124 | + 'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.', |
|
125 | + 'event_espresso' |
|
126 | + ), |
|
127 | + '[INVOICE_PAYEE_ADDRESS]' => esc_html__( |
|
128 | + 'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.', |
|
129 | + 'event_espresso' |
|
130 | + ), |
|
131 | + '[INVOICE_PAYMENT_INSTRUCTIONS]' => esc_html__( |
|
132 | + 'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page', |
|
133 | + 'event_espresso' |
|
134 | + ), |
|
135 | + '[INVOICE_PAYEE_EMAIL]' => esc_html__( |
|
136 | + 'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.', |
|
137 | + 'event_espresso' |
|
138 | + ), |
|
139 | + '[INVOICE_PAYEE_TAX_NUMBER_*]' => sprintf( |
|
140 | + esc_html__( |
|
141 | + 'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number. It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56. If you have no tax number in your settings, then no prefix will be output either.', |
|
142 | + 'event_espresso' |
|
143 | + ), |
|
144 | + '<code>', |
|
145 | + '</code>' |
|
146 | + ), |
|
147 | + '[TOTAL_COST]' => esc_html__('The total cost for the transaction', 'event_espresso'), |
|
148 | + '[TXN_STATUS]' => esc_html__( |
|
149 | + 'The transaction status for the transaction.', |
|
150 | + 'event_espresso' |
|
151 | + ), |
|
152 | + '[TXN_STATUS_ID]' => esc_html__( |
|
153 | + 'The ID representing the transaction status as saved in the db. This tends to be useful for including with css classes for styling certain statuses differently from others.', |
|
154 | + 'event_espresso' |
|
155 | + ), |
|
156 | + '[PAYMENT_STATUS]' => esc_html__( |
|
157 | + 'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.', |
|
158 | + 'event_espresso' |
|
159 | + ), |
|
160 | + '[PAYMENT_GATEWAY]' => esc_html__( |
|
161 | + 'The payment gateway used for the transaction', |
|
162 | + 'event_espresso' |
|
163 | + ), |
|
164 | + '[AMOUNT_PAID]' => esc_html__( |
|
165 | + 'The amount paid or refunded. This will only have a value if there was a payment or refund at the time of generating the message.', |
|
166 | + 'event_espresso' |
|
167 | + ), |
|
168 | + '[LAST_AMOUNT_PAID]' => esc_html__( |
|
169 | + 'This is the last payment or refund made on the transaction related to the message being generated.', |
|
170 | + 'event_espresso' |
|
171 | + ), |
|
172 | + '[TOTAL_AMOUNT_PAID]' => esc_html__( |
|
173 | + 'This parses to the total amount paid over all payments', |
|
174 | + 'event_espresso' |
|
175 | + ), |
|
176 | + '[TOTAL_OWING]' => esc_html__( |
|
177 | + 'The total owing on a transaction with no attributes.', |
|
178 | + 'event_espresso' |
|
179 | + ), |
|
180 | + '[TXN_SUBTOTAL]' => esc_html__('The subtotal for all txn line items.', 'event_espresso'), |
|
181 | + '[TXN_TAX_SUBTOTAL]' => esc_html__('The subtotal for all tax line items.', 'event_espresso'), |
|
182 | + '[OWING_STATUS_MESSAGE_*]' => esc_html__( |
|
183 | + 'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:', |
|
184 | + 'event_espresso' |
|
185 | + ) |
|
186 | + . '<p></ul>' |
|
187 | + . '<li><strong>still_owing</strong>:' |
|
188 | + . esc_html__( |
|
189 | + 'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:', |
|
190 | + 'event_espresso' |
|
191 | + ) |
|
192 | + . sprintf( |
|
193 | + esc_html__('%sPlease make a payment.%s', 'event_espresso'), |
|
194 | + '<a href="[PAYMENT_URL]" class="noPrint">', |
|
195 | + '</a>' |
|
196 | + ) |
|
197 | + . '</li>' |
|
198 | + . |
|
199 | + '<li><strong>none_owing</strong>:' |
|
200 | + . esc_html__( |
|
201 | + 'If the transaction is paid in full, then you can indicate how this gets displayed. Note, that it defaults to just be the total owing.', |
|
202 | + 'event_espresso' |
|
203 | + ) |
|
204 | + . '</li></ul></p>', |
|
205 | + '[TXN_TOTAL_TICKETS]' => esc_html__( |
|
206 | + 'The total number of all tickets purchased in a transaction', |
|
207 | + 'event_espresso' |
|
208 | + ), |
|
209 | + '[TKT_QTY_PURCHASED]' => sprintf( |
|
210 | + esc_html__( |
|
211 | + 'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s', |
|
212 | + 'event_espresso' |
|
213 | + ), |
|
214 | + '<strong>', |
|
215 | + '</strong>' |
|
216 | + ), |
|
217 | + '[TRANSACTION_ADMIN_URL]' => esc_html__( |
|
218 | + 'The url to the admin page for this transaction', |
|
219 | + 'event_espresso' |
|
220 | + ), |
|
221 | + '[RECEIPT_URL]' => esc_html__( |
|
222 | + 'This parses to the generated url for retrieving the receipt for the transaction', |
|
223 | + 'event_espresso' |
|
224 | + ), |
|
225 | + '[INVOICE_RECEIPT_SWITCHER_URL]' => esc_html__( |
|
226 | + 'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active then will parse to an empty string.', |
|
227 | + 'event_espresso' |
|
228 | + ), |
|
229 | + '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf( |
|
230 | + esc_html__( |
|
231 | + 'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.', |
|
232 | + 'event_espresso' |
|
233 | + ), |
|
234 | + '<code>[INVOICE_RECEIPT_SWITCHER_URL]', |
|
235 | + '</code>' |
|
236 | + ), |
|
237 | + '[LAST_PAYMENT_TRANSACTION_ID]' => esc_html__( |
|
238 | + 'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.', |
|
239 | + 'event_espresso' |
|
240 | + ), |
|
241 | + ); |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @param string $shortcode the shortcode to be parsed. |
|
247 | + * @return string parsed shortcode |
|
248 | + * @throws EE_Error |
|
249 | + * @throws InvalidArgumentException |
|
250 | + * @throws ReflectionException |
|
251 | + * @throws InvalidDataTypeException |
|
252 | + * @throws InvalidInterfaceException |
|
253 | + */ |
|
254 | + protected function _parser($shortcode) |
|
255 | + { |
|
256 | + // attempt to get the transaction. Since this is potentially used in more fields, we may have to look in the |
|
257 | + // _extra_data for the transaction. |
|
258 | + $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null; |
|
259 | + $transaction = ! $transaction instanceof EE_Transaction |
|
260 | + && is_array($this->_extra_data) |
|
261 | + && isset($this->_extra_data['data']) |
|
262 | + && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
263 | + ? $this->_extra_data['data']->txn |
|
264 | + : $transaction; |
|
265 | + // payment |
|
266 | + $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null; |
|
267 | + $payment = ! $payment instanceof EE_Payment |
|
268 | + && is_array($this->_extra_data) |
|
269 | + && isset($this->_extra_data['data']) |
|
270 | + && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment |
|
271 | + : $payment; |
|
272 | + if (! $transaction instanceof EE_Transaction) { |
|
273 | + return ''; |
|
274 | + } |
|
275 | + switch ($shortcode) { |
|
276 | + case '[TXN_ID]': |
|
277 | + return $transaction->ID(); |
|
278 | + break; |
|
279 | + case '[PAYMENT_URL]': |
|
280 | + $payment_url = $transaction->payment_overview_url(); |
|
281 | + return empty($payment_url) |
|
282 | + ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso') |
|
283 | + : $payment_url; |
|
284 | + break; |
|
285 | + case '[INVOICE_LINK]': |
|
286 | + $invoice_url = $transaction->invoice_url(); |
|
287 | + $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url; |
|
288 | + return sprintf( |
|
289 | + esc_html__('%sClick here for Invoice%s', 'event_espresso'), |
|
290 | + '<a href="' . $invoice_url . '">', |
|
291 | + '</a>' |
|
292 | + ); |
|
293 | + break; |
|
294 | + case '[INVOICE_URL]': |
|
295 | + $invoice_url = $transaction->invoice_url(); |
|
296 | + return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url; |
|
297 | + break; |
|
298 | + case '[INVOICE_LOGO_URL]': |
|
299 | + return $this->_get_invoice_logo(); |
|
300 | + break; |
|
301 | + case '[INVOICE_LOGO]': |
|
302 | + return $this->_get_invoice_logo(true); |
|
303 | + break; |
|
304 | + case '[INVOICE_PAYEE_NAME]': |
|
305 | + return $this->_get_invoice_payee_name(); |
|
306 | + break; |
|
307 | + case '[INVOICE_PAYEE_ADDRESS]': |
|
308 | + return $this->_get_invoice_payee_address(); |
|
309 | + break; |
|
310 | + case '[INVOICE_PAYMENT_INSTRUCTIONS]': |
|
311 | + return $this->_get_invoice_payment_instructions(); |
|
312 | + break; |
|
313 | + case '[INVOICE_PAYEE_EMAIL]': |
|
314 | + return $this->_get_invoice_payee_email(); |
|
315 | + break; |
|
316 | + case '[TOTAL_COST]': |
|
317 | + $total = $transaction->total(); |
|
318 | + return ! empty($total) ? EEH_Template::format_currency($total) : ''; |
|
319 | + break; |
|
320 | + case '[PAYMENT_STATUS]': |
|
321 | + $status = $transaction->pretty_status(); |
|
322 | + return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso'); |
|
323 | + break; /**/ |
|
324 | + // note the [payment_status] shortcode is kind of misleading because payment status might be different |
|
325 | + // from txn status so I'm adding this here for clarity. |
|
326 | + case '[TXN_STATUS]': |
|
327 | + $status = $transaction->pretty_status(); |
|
328 | + return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso'); |
|
329 | + break; |
|
330 | + case '[TXN_STATUS_ID]': |
|
331 | + return $transaction->status_ID(); |
|
332 | + break; |
|
333 | + case '[PAYMENT_GATEWAY]': |
|
334 | + return $this->_get_payment_gateway($transaction); |
|
335 | + break; |
|
336 | + case '[AMOUNT_PAID]': |
|
337 | + return $payment instanceof EE_Payment |
|
338 | + ? EEH_Template::format_currency($payment->amount()) |
|
339 | + : EEH_Template::format_currency(0); |
|
340 | + break; |
|
341 | + case '[LAST_AMOUNT_PAID]': |
|
342 | + $last_payment = $transaction->last_payment(); |
|
343 | + return $last_payment instanceof EE_Payment |
|
344 | + ? EEH_Template::format_currency($last_payment->amount()) |
|
345 | + : EEH_Template::format_currency(0); |
|
346 | + case '[TOTAL_AMOUNT_PAID]': |
|
347 | + return EEH_Template::format_currency($transaction->paid()); |
|
348 | + break; |
|
349 | + case '[TOTAL_OWING]': |
|
350 | + $total_owing = $transaction->remaining(); |
|
351 | + return EEH_Template::format_currency($total_owing); |
|
352 | + break; |
|
353 | + case '[TXN_SUBTOTAL]': |
|
354 | + return EEH_Template::format_currency($this->_get_subtotal()); |
|
355 | + break; |
|
356 | + case '[TXN_TAX_SUBTOTAL]': |
|
357 | + return EEH_Template::format_currency($this->_get_subtotal(true)); |
|
358 | + break; |
|
359 | + case '[TKT_QTY_PURCHASED]': |
|
360 | + case '[TXN_TOTAL_TICKETS]': |
|
361 | + return $this->_data->total_ticket_count; |
|
362 | + break; |
|
363 | + case '[TRANSACTION_ADMIN_URL]': |
|
364 | + require_once EE_CORE . 'admin/EE_Admin_Page.core.php'; |
|
365 | + $query_args = array( |
|
366 | + 'page' => 'espresso_transactions', |
|
367 | + 'action' => 'view_transaction', |
|
368 | + 'TXN_ID' => $transaction->ID(), |
|
369 | + ); |
|
370 | + $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')); |
|
371 | + return $url; |
|
372 | + break; |
|
373 | + case '[RECEIPT_URL]': |
|
374 | + // get primary_registration |
|
375 | + $reg = $this->_data->primary_reg_obj; |
|
376 | + if (! $reg instanceof EE_Registration) { |
|
377 | + return ''; |
|
378 | + } |
|
379 | + return $reg->receipt_url(); |
|
380 | + break; |
|
381 | + case '[INVOICE_RECEIPT_SWITCHER_URL]': |
|
382 | + return $this->_get_invoice_receipt_switcher(false); |
|
383 | + break; |
|
384 | + case '[INVOICE_RECEIPT_SWITCHER_BUTTON]': |
|
385 | + return $this->_get_invoice_receipt_switcher(); |
|
386 | + break; |
|
387 | + case '[LAST_PAYMENT_TRANSACTION_ID]': |
|
388 | + $id = ''; |
|
389 | + $payment = $payment instanceof EE_Payment && $payment->ID() !== 0 |
|
390 | + ? $payment |
|
391 | + : $transaction->last_payment(); |
|
392 | + if ($payment instanceof EE_Payment) { |
|
393 | + $id = $payment->txn_id_chq_nmbr(); |
|
394 | + } |
|
395 | + return $id; |
|
396 | + break; |
|
397 | + } |
|
398 | + if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) { |
|
399 | + return $this->_get_custom_total_owing($shortcode); |
|
400 | + } |
|
401 | + if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) { |
|
402 | + return $this->_get_invoice_payee_tax_number($shortcode); |
|
403 | + } |
|
404 | + if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) { |
|
405 | + return $this->_get_payment_link_if_needed($shortcode); |
|
406 | + } |
|
407 | + if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) { |
|
408 | + return $this->_get_payment_due_date($shortcode, $transaction); |
|
409 | + } |
|
410 | + return ''; |
|
411 | + } |
|
412 | + |
|
413 | + |
|
414 | + /** |
|
415 | + * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode |
|
416 | + * |
|
417 | + * @since 4.5.0 |
|
418 | + * @param string $shortcode the incoming shortcode |
|
419 | + * @return string parsed. |
|
420 | + * @throws EE_Error |
|
421 | + */ |
|
422 | + private function _get_custom_total_owing($shortcode) |
|
423 | + { |
|
424 | + $valid_shortcodes = array('transaction'); |
|
425 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
426 | + // ensure default is set. |
|
427 | + $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
428 | + $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction |
|
429 | + ? $addressee->txn->remaining() : 0; |
|
430 | + if ($total_owing > 0) { |
|
431 | + $owing_content = ! empty($attrs['still_owing']) |
|
432 | + ? $attrs['still_owing'] |
|
433 | + : sprintf( |
|
434 | + esc_html__('%sPlease make a payment.%s', 'event_espresso'), |
|
435 | + '<a href="[PAYMENT_URL]" class="noPrint">', |
|
436 | + '</a>' |
|
437 | + ); |
|
438 | + $owing_content = $this->_shortcode_helper->parse_message_template( |
|
439 | + $owing_content, |
|
440 | + $addressee, |
|
441 | + $valid_shortcodes, |
|
442 | + $this->_message_type, |
|
443 | + $this->_messenger, |
|
444 | + $this->_message |
|
445 | + ); |
|
446 | + } else { |
|
447 | + $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : ''; |
|
448 | + } |
|
449 | + return $owing_content; |
|
450 | + } |
|
451 | + |
|
452 | + |
|
453 | + /** |
|
454 | + * @param EE_Transaction $transaction |
|
455 | + * @return string |
|
456 | + * @throws EE_Error |
|
457 | + */ |
|
458 | + private function _get_payment_gateway($transaction) |
|
459 | + { |
|
460 | + if ($transaction instanceof EE_Transaction) { |
|
461 | + $pm = $transaction->payment_method(); |
|
462 | + } else { |
|
463 | + $pm = null; |
|
464 | + } |
|
465 | + return $pm instanceof EE_Payment_Method ? $pm->name() : ''; |
|
466 | + } |
|
467 | + |
|
468 | + |
|
469 | + /** |
|
470 | + * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page. If its |
|
471 | + * not present then the organization logo is used if its found (set on the organization settings page). |
|
472 | + * |
|
473 | + * @since 4.5.0 |
|
474 | + * @param bool $img_tags TRUE means to return with the img tag wrappers. False just returns the url to the image. |
|
475 | + * @return string url or html |
|
476 | + * @throws EE_Error |
|
477 | + * @throws InvalidArgumentException |
|
478 | + * @throws InvalidDataTypeException |
|
479 | + * @throws InvalidInterfaceException |
|
480 | + */ |
|
481 | + private function _get_invoice_logo($img_tags = false) |
|
482 | + { |
|
483 | + $invoice_logo_url = ''; |
|
484 | + // try to get the invoice payment method's logo for this transaction image first |
|
485 | + $pm = $this->_get_invoice_payment_method(); |
|
486 | + if ($pm instanceof EE_Payment_Method) { |
|
487 | + $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true); |
|
488 | + } |
|
489 | + if (empty($invoice_logo_url)) { |
|
490 | + $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url; |
|
491 | + } |
|
492 | + if (empty($invoice_logo_url)) { |
|
493 | + return ''; |
|
494 | + } |
|
495 | + if (! $img_tags) { |
|
496 | + return $invoice_logo_url; |
|
497 | + } |
|
498 | + // image tags have been requested. |
|
499 | + $image_size = getimagesize($invoice_logo_url); |
|
500 | + // if image is wider than 300px, set the width to 300 |
|
501 | + if ($image_size[0] > 300) { |
|
502 | + $image_width = 300; |
|
503 | + } else { |
|
504 | + $image_width = $image_size[0]; |
|
505 | + } |
|
506 | + return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />'; |
|
507 | + } |
|
508 | + |
|
509 | + |
|
510 | + /** |
|
511 | + * Used to retrieve the appropriate content for the invoice payee name shortcode |
|
512 | + * |
|
513 | + * @since 4.5.0 |
|
514 | + * @return string |
|
515 | + * @throws EE_Error |
|
516 | + * @throws InvalidArgumentException |
|
517 | + * @throws InvalidDataTypeException |
|
518 | + * @throws InvalidInterfaceException |
|
519 | + */ |
|
520 | + private function _get_invoice_payee_name() |
|
521 | + { |
|
522 | + $payee_name = null; |
|
523 | + $pm = $this->_get_invoice_payment_method(); |
|
524 | + if ($pm instanceof EE_Payment_Method) { |
|
525 | + $payee_name = $pm->get_extra_meta('pdf_payee_name', true); |
|
526 | + } |
|
527 | + $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name; |
|
528 | + return $payee_name; |
|
529 | + } |
|
530 | + |
|
531 | + |
|
532 | + /** |
|
533 | + * gets the default invoice payment method, but has a filter so it can be overridden |
|
534 | + * |
|
535 | + * @return EE_Payment_Method|null |
|
536 | + * @throws EE_Error |
|
537 | + * @throws InvalidArgumentException |
|
538 | + * @throws InvalidDataTypeException |
|
539 | + * @throws InvalidInterfaceException |
|
540 | + */ |
|
541 | + private function _get_invoice_payment_method() |
|
542 | + { |
|
543 | + if (! $this->_invoice_pm instanceof EE_Payment_Method) { |
|
544 | + $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null; |
|
545 | + $transaction = ! $transaction instanceof EE_Transaction |
|
546 | + && is_array($this->_extra_data) |
|
547 | + && isset($this->_extra_data['data']) |
|
548 | + && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
549 | + ? $this->_extra_data['data']->txn : $transaction; |
|
550 | + // get the invoice payment method, and remember it for the next call too |
|
551 | + $this->_invoice_pm = apply_filters( |
|
552 | + 'FHEE__EE_Transaction_Shortcodes__get_payment_method__default', |
|
553 | + EEM_Payment_Method::instance()->get_one_of_type('Invoice'), |
|
554 | + $transaction |
|
555 | + ); |
|
556 | + } |
|
557 | + return $this->_invoice_pm; |
|
558 | + } |
|
559 | + |
|
560 | + |
|
561 | + /** |
|
562 | + * Used to retrieve the appropriate content for the invoice payee email shortcode |
|
563 | + * |
|
564 | + * @since 4.5.0 |
|
565 | + * @return string |
|
566 | + * @throws EE_Error |
|
567 | + * @throws InvalidArgumentException |
|
568 | + * @throws InvalidDataTypeException |
|
569 | + * @throws InvalidInterfaceException |
|
570 | + */ |
|
571 | + private function _get_invoice_payee_email() |
|
572 | + { |
|
573 | + $payee_email = null; |
|
574 | + $pm = $this->_get_invoice_payment_method(); |
|
575 | + if ($pm instanceof EE_Payment_Method) { |
|
576 | + $payee_email = $pm->get_extra_meta('pdf_payee_email', true); |
|
577 | + } |
|
578 | + $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email') |
|
579 | + : $payee_email; |
|
580 | + return $payee_email; |
|
581 | + } |
|
582 | + |
|
583 | + |
|
584 | + /** |
|
585 | + * Used to retrieve the appropriate content for the invoice payee tax number shortcode |
|
586 | + * |
|
587 | + * @since 4.5.0 |
|
588 | + * @param string $shortcode |
|
589 | + * @return string |
|
590 | + * @throws EE_Error |
|
591 | + * @throws InvalidArgumentException |
|
592 | + * @throws InvalidDataTypeException |
|
593 | + * @throws InvalidInterfaceException |
|
594 | + */ |
|
595 | + private function _get_invoice_payee_tax_number($shortcode) |
|
596 | + { |
|
597 | + $payee_tax_number = null; |
|
598 | + $pm = $this->_get_invoice_payment_method(); |
|
599 | + if ($pm instanceof EE_Payment_Method) { |
|
600 | + $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true); |
|
601 | + } |
|
602 | + $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat |
|
603 | + : $payee_tax_number; |
|
604 | + if (empty($payee_tax_number)) { |
|
605 | + return ''; |
|
606 | + } |
|
607 | + // any attributes? |
|
608 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
609 | + // prefix? |
|
610 | + $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
|
611 | + return $prefix . $payee_tax_number; |
|
612 | + } |
|
613 | + |
|
614 | + |
|
615 | + /** |
|
616 | + * Used to retrieve the appropriate content for the invoice payee address shortcode. |
|
617 | + * |
|
618 | + * @since 4.5.0 |
|
619 | + * @return string |
|
620 | + * @throws EE_Error |
|
621 | + * @throws InvalidArgumentException |
|
622 | + * @throws ReflectionException |
|
623 | + * @throws InvalidDataTypeException |
|
624 | + * @throws InvalidInterfaceException |
|
625 | + */ |
|
626 | + private function _get_invoice_payee_address() |
|
627 | + { |
|
628 | + $payee_address = null; |
|
629 | + $pm = $this->_get_invoice_payment_method(); |
|
630 | + if ($pm instanceof EE_Payment_Method) { |
|
631 | + $payee_address = $pm->get_extra_meta('pdf_payee_address', true); |
|
632 | + } |
|
633 | + if (empty($payee_address)) { |
|
634 | + $organization = EE_Registry::instance()->CFG->organization; |
|
635 | + $payee_address = $organization->get_pretty('address_1') . '<br>'; |
|
636 | + $payee_address .= ! empty($organization->address_2) |
|
637 | + ? $organization->get_pretty('address_2') . '<br>' |
|
638 | + : ''; |
|
639 | + $payee_address .= $organization->get_pretty('city') . '<br>'; |
|
640 | + // state |
|
641 | + $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID); |
|
642 | + $payee_address .= $state instanceof EE_State ? $state->name() : ''; |
|
643 | + // Country |
|
644 | + $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : ''; |
|
645 | + $payee_address .= ! empty($organization->zip) ? $organization->zip : ''; |
|
646 | + } |
|
647 | + return $payee_address; |
|
648 | + } |
|
649 | + |
|
650 | + |
|
651 | + /** |
|
652 | + * Used to retrieve the appropriate content for the invoice payment instructions shortcode. |
|
653 | + * |
|
654 | + * @since 4.5.0 |
|
655 | + * @return string |
|
656 | + * @throws EE_Error |
|
657 | + * @throws InvalidArgumentException |
|
658 | + * @throws InvalidDataTypeException |
|
659 | + * @throws InvalidInterfaceException |
|
660 | + */ |
|
661 | + private function _get_invoice_payment_instructions() |
|
662 | + { |
|
663 | + $instructions = null; |
|
664 | + $pm = $this->_get_invoice_payment_method(); |
|
665 | + return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : ''; |
|
666 | + } |
|
667 | + |
|
668 | + |
|
669 | + /** |
|
670 | + * get invoice/receipt switch button or url. |
|
671 | + * |
|
672 | + * @param bool $button true (default) returns the html for a button, false just returns the url. |
|
673 | + * @return string |
|
674 | + * @throws EE_Error |
|
675 | + */ |
|
676 | + protected function _get_invoice_receipt_switcher($button = true) |
|
677 | + { |
|
678 | + $reg = $this->_data->primary_reg_obj; |
|
679 | + $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : ''; |
|
680 | + if (! $reg instanceof EE_Registration || empty($message_type)) { |
|
681 | + return ''; |
|
682 | + } |
|
683 | + $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false; |
|
684 | + $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type |
|
685 | + ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso'); |
|
686 | + $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label; |
|
687 | + $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url(); |
|
688 | + if (! $button) { |
|
689 | + return $switch_to_url; |
|
690 | + } |
|
691 | + if (! empty($switch_to_url)) { |
|
692 | + return ' |
|
693 | 693 | <form method="post" action="' . $switch_to_url . '" > |
694 | 694 | <input class="print_button" type="submit" value="' . $switch_to_label . '" /> |
695 | 695 | </form> |
696 | 696 | '; |
697 | - } |
|
698 | - return ''; |
|
699 | - } |
|
700 | - |
|
701 | - |
|
702 | - /** |
|
703 | - * This returns a subtotal. |
|
704 | - * |
|
705 | - * @param bool $tax if true then return the subtotal for tax otherwise return subtotal. |
|
706 | - * @return int |
|
707 | - * @throws EE_Error |
|
708 | - */ |
|
709 | - private function _get_subtotal($tax = false) |
|
710 | - { |
|
711 | - $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null; |
|
712 | - if (! $grand_total instanceof EE_Line_Item) { |
|
713 | - return 0; |
|
714 | - } |
|
715 | - return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total(); |
|
716 | - } |
|
717 | - |
|
718 | - |
|
719 | - /** |
|
720 | - * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode |
|
721 | - * |
|
722 | - * @since 4.7.0 |
|
723 | - * @param string $shortcode the incoming shortcode |
|
724 | - * @return string parsed. |
|
725 | - * @throws EE_Error |
|
726 | - */ |
|
727 | - private function _get_payment_link_if_needed($shortcode) |
|
728 | - { |
|
729 | - $valid_shortcodes = array('transaction'); |
|
730 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
731 | - // ensure default is set. |
|
732 | - $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
733 | - $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction |
|
734 | - ? $addressee->txn->remaining() : 0; |
|
735 | - if ($total_owing > 0) { |
|
736 | - $class = isset($attrs['class']) ? $attrs['class'] : 'callout'; |
|
737 | - $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.'; |
|
738 | - $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p'; |
|
739 | - $opening_tag = ! empty($container_tag) ? '<' . $container_tag : ''; |
|
740 | - $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag; |
|
741 | - $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag; |
|
742 | - $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : ''; |
|
743 | - $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag; |
|
744 | - // we need to re run this string through the parser to catch any shortcodes that are in it. |
|
745 | - $owing_content = $this->_shortcode_helper->parse_message_template( |
|
746 | - $content, |
|
747 | - $addressee, |
|
748 | - $valid_shortcodes, |
|
749 | - $this->_message_type, |
|
750 | - $this->_messenger, |
|
751 | - $this->_message |
|
752 | - ); |
|
753 | - } else { |
|
754 | - return ''; |
|
755 | - } |
|
756 | - return $owing_content; |
|
757 | - } |
|
758 | - |
|
759 | - |
|
760 | - /** |
|
761 | - * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode |
|
762 | - * |
|
763 | - * @since 4.8.28.rc.011 |
|
764 | - * @param string $shortcode The shortcode being parsed. |
|
765 | - * @param EE_Transaction $transaction |
|
766 | - * @return string |
|
767 | - * @throws EE_Error |
|
768 | - */ |
|
769 | - protected function _get_payment_due_date($shortcode, EE_Transaction $transaction) |
|
770 | - { |
|
771 | - // if transaction is paid in full then we can just return an empty string |
|
772 | - if ($transaction->remaining() === 0) { |
|
773 | - return ''; |
|
774 | - } |
|
775 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
776 | - $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format'); |
|
777 | - $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30; |
|
778 | - $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text'] |
|
779 | - : esc_html__('Payment in full due by: ', 'event_espresso'); |
|
780 | - $transaction_created = $transaction->get_DateTime_object('TXN_timestamp'); |
|
781 | - // setup date due: |
|
782 | - try { |
|
783 | - if ($transaction_created instanceof DateTime) { |
|
784 | - $date_due = $transaction_created->add( |
|
785 | - new DateInterval('P' . $days_until_due . 'D') |
|
786 | - )->format($format); |
|
787 | - } else { |
|
788 | - throw new Exception(); |
|
789 | - } |
|
790 | - } catch (Exception $e) { |
|
791 | - // format was likely invalid. |
|
792 | - $date_due = esc_html__( |
|
793 | - 'Unable to calculate date due, likely the format string is invalid.', |
|
794 | - 'event_espresso' |
|
795 | - ); |
|
796 | - } |
|
797 | - return $prefix_text . $date_due; |
|
798 | - } |
|
697 | + } |
|
698 | + return ''; |
|
699 | + } |
|
700 | + |
|
701 | + |
|
702 | + /** |
|
703 | + * This returns a subtotal. |
|
704 | + * |
|
705 | + * @param bool $tax if true then return the subtotal for tax otherwise return subtotal. |
|
706 | + * @return int |
|
707 | + * @throws EE_Error |
|
708 | + */ |
|
709 | + private function _get_subtotal($tax = false) |
|
710 | + { |
|
711 | + $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null; |
|
712 | + if (! $grand_total instanceof EE_Line_Item) { |
|
713 | + return 0; |
|
714 | + } |
|
715 | + return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total(); |
|
716 | + } |
|
717 | + |
|
718 | + |
|
719 | + /** |
|
720 | + * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode |
|
721 | + * |
|
722 | + * @since 4.7.0 |
|
723 | + * @param string $shortcode the incoming shortcode |
|
724 | + * @return string parsed. |
|
725 | + * @throws EE_Error |
|
726 | + */ |
|
727 | + private function _get_payment_link_if_needed($shortcode) |
|
728 | + { |
|
729 | + $valid_shortcodes = array('transaction'); |
|
730 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
731 | + // ensure default is set. |
|
732 | + $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
733 | + $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction |
|
734 | + ? $addressee->txn->remaining() : 0; |
|
735 | + if ($total_owing > 0) { |
|
736 | + $class = isset($attrs['class']) ? $attrs['class'] : 'callout'; |
|
737 | + $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.'; |
|
738 | + $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p'; |
|
739 | + $opening_tag = ! empty($container_tag) ? '<' . $container_tag : ''; |
|
740 | + $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag; |
|
741 | + $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag; |
|
742 | + $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : ''; |
|
743 | + $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag; |
|
744 | + // we need to re run this string through the parser to catch any shortcodes that are in it. |
|
745 | + $owing_content = $this->_shortcode_helper->parse_message_template( |
|
746 | + $content, |
|
747 | + $addressee, |
|
748 | + $valid_shortcodes, |
|
749 | + $this->_message_type, |
|
750 | + $this->_messenger, |
|
751 | + $this->_message |
|
752 | + ); |
|
753 | + } else { |
|
754 | + return ''; |
|
755 | + } |
|
756 | + return $owing_content; |
|
757 | + } |
|
758 | + |
|
759 | + |
|
760 | + /** |
|
761 | + * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode |
|
762 | + * |
|
763 | + * @since 4.8.28.rc.011 |
|
764 | + * @param string $shortcode The shortcode being parsed. |
|
765 | + * @param EE_Transaction $transaction |
|
766 | + * @return string |
|
767 | + * @throws EE_Error |
|
768 | + */ |
|
769 | + protected function _get_payment_due_date($shortcode, EE_Transaction $transaction) |
|
770 | + { |
|
771 | + // if transaction is paid in full then we can just return an empty string |
|
772 | + if ($transaction->remaining() === 0) { |
|
773 | + return ''; |
|
774 | + } |
|
775 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
776 | + $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format'); |
|
777 | + $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30; |
|
778 | + $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text'] |
|
779 | + : esc_html__('Payment in full due by: ', 'event_espresso'); |
|
780 | + $transaction_created = $transaction->get_DateTime_object('TXN_timestamp'); |
|
781 | + // setup date due: |
|
782 | + try { |
|
783 | + if ($transaction_created instanceof DateTime) { |
|
784 | + $date_due = $transaction_created->add( |
|
785 | + new DateInterval('P' . $days_until_due . 'D') |
|
786 | + )->format($format); |
|
787 | + } else { |
|
788 | + throw new Exception(); |
|
789 | + } |
|
790 | + } catch (Exception $e) { |
|
791 | + // format was likely invalid. |
|
792 | + $date_due = esc_html__( |
|
793 | + 'Unable to calculate date due, likely the format string is invalid.', |
|
794 | + 'event_espresso' |
|
795 | + ); |
|
796 | + } |
|
797 | + return $prefix_text . $date_due; |
|
798 | + } |
|
799 | 799 | } |
@@ -269,7 +269,7 @@ discard block |
||
269 | 269 | && isset($this->_extra_data['data']) |
270 | 270 | && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment |
271 | 271 | : $payment; |
272 | - if (! $transaction instanceof EE_Transaction) { |
|
272 | + if ( ! $transaction instanceof EE_Transaction) { |
|
273 | 273 | return ''; |
274 | 274 | } |
275 | 275 | switch ($shortcode) { |
@@ -287,7 +287,7 @@ discard block |
||
287 | 287 | $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url; |
288 | 288 | return sprintf( |
289 | 289 | esc_html__('%sClick here for Invoice%s', 'event_espresso'), |
290 | - '<a href="' . $invoice_url . '">', |
|
290 | + '<a href="'.$invoice_url.'">', |
|
291 | 291 | '</a>' |
292 | 292 | ); |
293 | 293 | break; |
@@ -361,7 +361,7 @@ discard block |
||
361 | 361 | return $this->_data->total_ticket_count; |
362 | 362 | break; |
363 | 363 | case '[TRANSACTION_ADMIN_URL]': |
364 | - require_once EE_CORE . 'admin/EE_Admin_Page.core.php'; |
|
364 | + require_once EE_CORE.'admin/EE_Admin_Page.core.php'; |
|
365 | 365 | $query_args = array( |
366 | 366 | 'page' => 'espresso_transactions', |
367 | 367 | 'action' => 'view_transaction', |
@@ -373,7 +373,7 @@ discard block |
||
373 | 373 | case '[RECEIPT_URL]': |
374 | 374 | // get primary_registration |
375 | 375 | $reg = $this->_data->primary_reg_obj; |
376 | - if (! $reg instanceof EE_Registration) { |
|
376 | + if ( ! $reg instanceof EE_Registration) { |
|
377 | 377 | return ''; |
378 | 378 | } |
379 | 379 | return $reg->receipt_url(); |
@@ -492,7 +492,7 @@ discard block |
||
492 | 492 | if (empty($invoice_logo_url)) { |
493 | 493 | return ''; |
494 | 494 | } |
495 | - if (! $img_tags) { |
|
495 | + if ( ! $img_tags) { |
|
496 | 496 | return $invoice_logo_url; |
497 | 497 | } |
498 | 498 | // image tags have been requested. |
@@ -503,7 +503,7 @@ discard block |
||
503 | 503 | } else { |
504 | 504 | $image_width = $image_size[0]; |
505 | 505 | } |
506 | - return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />'; |
|
506 | + return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />'; |
|
507 | 507 | } |
508 | 508 | |
509 | 509 | |
@@ -540,7 +540,7 @@ discard block |
||
540 | 540 | */ |
541 | 541 | private function _get_invoice_payment_method() |
542 | 542 | { |
543 | - if (! $this->_invoice_pm instanceof EE_Payment_Method) { |
|
543 | + if ( ! $this->_invoice_pm instanceof EE_Payment_Method) { |
|
544 | 544 | $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null; |
545 | 545 | $transaction = ! $transaction instanceof EE_Transaction |
546 | 546 | && is_array($this->_extra_data) |
@@ -608,7 +608,7 @@ discard block |
||
608 | 608 | $attrs = $this->_get_shortcode_attrs($shortcode); |
609 | 609 | // prefix? |
610 | 610 | $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
611 | - return $prefix . $payee_tax_number; |
|
611 | + return $prefix.$payee_tax_number; |
|
612 | 612 | } |
613 | 613 | |
614 | 614 | |
@@ -632,16 +632,16 @@ discard block |
||
632 | 632 | } |
633 | 633 | if (empty($payee_address)) { |
634 | 634 | $organization = EE_Registry::instance()->CFG->organization; |
635 | - $payee_address = $organization->get_pretty('address_1') . '<br>'; |
|
635 | + $payee_address = $organization->get_pretty('address_1').'<br>'; |
|
636 | 636 | $payee_address .= ! empty($organization->address_2) |
637 | - ? $organization->get_pretty('address_2') . '<br>' |
|
637 | + ? $organization->get_pretty('address_2').'<br>' |
|
638 | 638 | : ''; |
639 | - $payee_address .= $organization->get_pretty('city') . '<br>'; |
|
639 | + $payee_address .= $organization->get_pretty('city').'<br>'; |
|
640 | 640 | // state |
641 | 641 | $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID); |
642 | 642 | $payee_address .= $state instanceof EE_State ? $state->name() : ''; |
643 | 643 | // Country |
644 | - $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : ''; |
|
644 | + $payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : ''; |
|
645 | 645 | $payee_address .= ! empty($organization->zip) ? $organization->zip : ''; |
646 | 646 | } |
647 | 647 | return $payee_address; |
@@ -677,7 +677,7 @@ discard block |
||
677 | 677 | { |
678 | 678 | $reg = $this->_data->primary_reg_obj; |
679 | 679 | $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : ''; |
680 | - if (! $reg instanceof EE_Registration || empty($message_type)) { |
|
680 | + if ( ! $reg instanceof EE_Registration || empty($message_type)) { |
|
681 | 681 | return ''; |
682 | 682 | } |
683 | 683 | $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false; |
@@ -685,13 +685,13 @@ discard block |
||
685 | 685 | ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso'); |
686 | 686 | $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label; |
687 | 687 | $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url(); |
688 | - if (! $button) { |
|
688 | + if ( ! $button) { |
|
689 | 689 | return $switch_to_url; |
690 | 690 | } |
691 | - if (! empty($switch_to_url)) { |
|
691 | + if ( ! empty($switch_to_url)) { |
|
692 | 692 | return ' |
693 | - <form method="post" action="' . $switch_to_url . '" > |
|
694 | - <input class="print_button" type="submit" value="' . $switch_to_label . '" /> |
|
693 | + <form method="post" action="' . $switch_to_url.'" > |
|
694 | + <input class="print_button" type="submit" value="' . $switch_to_label.'" /> |
|
695 | 695 | </form> |
696 | 696 | '; |
697 | 697 | } |
@@ -709,7 +709,7 @@ discard block |
||
709 | 709 | private function _get_subtotal($tax = false) |
710 | 710 | { |
711 | 711 | $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null; |
712 | - if (! $grand_total instanceof EE_Line_Item) { |
|
712 | + if ( ! $grand_total instanceof EE_Line_Item) { |
|
713 | 713 | return 0; |
714 | 714 | } |
715 | 715 | return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total(); |
@@ -736,11 +736,11 @@ discard block |
||
736 | 736 | $class = isset($attrs['class']) ? $attrs['class'] : 'callout'; |
737 | 737 | $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.'; |
738 | 738 | $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p'; |
739 | - $opening_tag = ! empty($container_tag) ? '<' . $container_tag : ''; |
|
740 | - $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag; |
|
739 | + $opening_tag = ! empty($container_tag) ? '<'.$container_tag : ''; |
|
740 | + $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag; |
|
741 | 741 | $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag; |
742 | - $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : ''; |
|
743 | - $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag; |
|
742 | + $closing_tag = ! empty($container_tag) ? '</'.$container_tag.'>' : ''; |
|
743 | + $content = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag; |
|
744 | 744 | // we need to re run this string through the parser to catch any shortcodes that are in it. |
745 | 745 | $owing_content = $this->_shortcode_helper->parse_message_template( |
746 | 746 | $content, |
@@ -782,7 +782,7 @@ discard block |
||
782 | 782 | try { |
783 | 783 | if ($transaction_created instanceof DateTime) { |
784 | 784 | $date_due = $transaction_created->add( |
785 | - new DateInterval('P' . $days_until_due . 'D') |
|
785 | + new DateInterval('P'.$days_until_due.'D') |
|
786 | 786 | )->format($format); |
787 | 787 | } else { |
788 | 788 | throw new Exception(); |
@@ -794,6 +794,6 @@ discard block |
||
794 | 794 | 'event_espresso' |
795 | 795 | ); |
796 | 796 | } |
797 | - return $prefix_text . $date_due; |
|
797 | + return $prefix_text.$date_due; |
|
798 | 798 | } |
799 | 799 | } |
@@ -21,152 +21,152 @@ |
||
21 | 21 | class EE_Attendee_List_Shortcodes extends EE_Shortcodes |
22 | 22 | { |
23 | 23 | |
24 | - public function __construct() |
|
25 | - { |
|
26 | - parent::__construct(); |
|
27 | - } |
|
28 | - |
|
29 | - |
|
30 | - protected function _init_props() |
|
31 | - { |
|
32 | - $this->label = __('Attendee List Shortcodes', 'event_espresso'); |
|
33 | - $this->description = __('All shortcodes specific to attendee lists', 'event_espresso'); |
|
34 | - $this->_shortcodes = array( |
|
35 | - '[ATTENDEE_LIST]' => __('Will output a list of attendees', 'event_espresso'), |
|
36 | - ); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - protected function _parser($shortcode) |
|
41 | - { |
|
42 | - switch ($shortcode) { |
|
43 | - case '[ATTENDEE_LIST]': |
|
44 | - return $this->_get_attendee_list(); |
|
45 | - break; |
|
46 | - } |
|
47 | - return ''; |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * figure out what the incoming data is and then return the appropriate parsed value. |
|
53 | - * |
|
54 | - * @return string |
|
55 | - */ |
|
56 | - private function _get_attendee_list() |
|
57 | - { |
|
58 | - $this->_validate_list_requirements(); |
|
59 | - |
|
60 | - if ($this->_data['data'] instanceof EE_Messages_Addressee) { |
|
61 | - return $this->_get_attendee_list_for_main(); |
|
62 | - } elseif ($this->_data['data'] instanceof EE_Event) { |
|
63 | - return $this->_get_attendee_list_for_event(); |
|
64 | - } elseif ($this->_data['data'] instanceof EE_Ticket) { |
|
65 | - return $this->_get_registration_list_for_ticket(); |
|
66 | - } // prevent recursive loop |
|
67 | - else { |
|
68 | - return ''; |
|
69 | - } |
|
70 | - } |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * This returns the parsed attendee list for main template; |
|
75 | - */ |
|
76 | - private function _get_attendee_list_for_main() |
|
77 | - { |
|
78 | - $valid_shortcodes = array('attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'); |
|
79 | - $template = $this->_data['template']; |
|
80 | - $data = $this->_data['data']; |
|
81 | - $attnds = ''; |
|
82 | - |
|
83 | - |
|
84 | - // now we need to loop through the attendee list and send data to the EE_Parser helper. |
|
85 | - foreach ($data->reg_objs as $registration) { |
|
86 | - $attnds .= $this->_shortcode_helper->parse_attendee_list_template( |
|
87 | - $template, |
|
88 | - $registration, |
|
89 | - $valid_shortcodes, |
|
90 | - $this->_extra_data |
|
91 | - ); |
|
92 | - } |
|
93 | - |
|
94 | - return $attnds; |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * return parsed list of attendees for an event |
|
100 | - * |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - private function _get_attendee_list_for_event() |
|
104 | - { |
|
105 | - $valid_shortcodes = array('attendee', 'ticket_list', 'question_list', 'recipient_details'); |
|
106 | - $template = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list']) |
|
107 | - ? $this->_data['template']['attendee_list'] : $this->_extra_data['template']['attendee_list']; |
|
108 | - $event = $this->_data['data']; |
|
109 | - |
|
110 | - // let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion. |
|
111 | - $template = str_replace('[EVENT_LIST]', '', $template); |
|
112 | - |
|
113 | - // here we're setting up the attendees for the attendee_list template for THIS event. |
|
114 | - $att_result = ''; |
|
115 | - $registrations = $this->_get_registrations_from_event($event); |
|
116 | - |
|
117 | - // each attendee in this case should be an attendee object. |
|
118 | - foreach ($registrations as $registration) { |
|
119 | - $att_result .= $this->_shortcode_helper->parse_attendee_list_template( |
|
120 | - $template, |
|
121 | - $registration, |
|
122 | - $valid_shortcodes, |
|
123 | - $this->_extra_data |
|
124 | - ); |
|
125 | - } |
|
126 | - |
|
127 | - return $att_result; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * return parsed list of attendees for a ticket |
|
133 | - * |
|
134 | - * @return string |
|
135 | - */ |
|
136 | - private function _get_registration_list_for_ticket() |
|
137 | - { |
|
138 | - $valid_shortcodes = array('attendee', 'event_list', 'question_list', 'recipient_details'); |
|
139 | - $template = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list']) |
|
140 | - ? $this->_data['template']['attendee_list'] : $this->_extra_data['template']['attendee_list']; |
|
141 | - $ticket = $this->_data['data']; |
|
142 | - |
|
143 | - // let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion. |
|
144 | - $template = str_replace('[TICKET_LIST]', '', $template); |
|
145 | - $template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template); |
|
146 | - $template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template); |
|
147 | - |
|
148 | - // here we're setting up the attendees for the attendee_list template for THIS ticket. |
|
149 | - $att_result = ''; |
|
150 | - $registrations = isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
151 | - ) ]['reg_objs'] : array(); |
|
152 | - |
|
153 | - // each attendee in this case should be an attendee object. |
|
154 | - foreach ($registrations as $registration) { |
|
155 | - $att_result .= $this->_shortcode_helper->parse_attendee_list_template( |
|
156 | - $template, |
|
157 | - $registration, |
|
158 | - $valid_shortcodes, |
|
159 | - $this->_extra_data |
|
160 | - ); |
|
161 | - } |
|
162 | - |
|
163 | - return $att_result; |
|
164 | - } |
|
165 | - |
|
166 | - |
|
167 | - private function _get_registrations_from_event(EE_Event $event) |
|
168 | - { |
|
169 | - return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
170 | - ) ]['reg_objs'] : array(); |
|
171 | - } |
|
24 | + public function __construct() |
|
25 | + { |
|
26 | + parent::__construct(); |
|
27 | + } |
|
28 | + |
|
29 | + |
|
30 | + protected function _init_props() |
|
31 | + { |
|
32 | + $this->label = __('Attendee List Shortcodes', 'event_espresso'); |
|
33 | + $this->description = __('All shortcodes specific to attendee lists', 'event_espresso'); |
|
34 | + $this->_shortcodes = array( |
|
35 | + '[ATTENDEE_LIST]' => __('Will output a list of attendees', 'event_espresso'), |
|
36 | + ); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + protected function _parser($shortcode) |
|
41 | + { |
|
42 | + switch ($shortcode) { |
|
43 | + case '[ATTENDEE_LIST]': |
|
44 | + return $this->_get_attendee_list(); |
|
45 | + break; |
|
46 | + } |
|
47 | + return ''; |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * figure out what the incoming data is and then return the appropriate parsed value. |
|
53 | + * |
|
54 | + * @return string |
|
55 | + */ |
|
56 | + private function _get_attendee_list() |
|
57 | + { |
|
58 | + $this->_validate_list_requirements(); |
|
59 | + |
|
60 | + if ($this->_data['data'] instanceof EE_Messages_Addressee) { |
|
61 | + return $this->_get_attendee_list_for_main(); |
|
62 | + } elseif ($this->_data['data'] instanceof EE_Event) { |
|
63 | + return $this->_get_attendee_list_for_event(); |
|
64 | + } elseif ($this->_data['data'] instanceof EE_Ticket) { |
|
65 | + return $this->_get_registration_list_for_ticket(); |
|
66 | + } // prevent recursive loop |
|
67 | + else { |
|
68 | + return ''; |
|
69 | + } |
|
70 | + } |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * This returns the parsed attendee list for main template; |
|
75 | + */ |
|
76 | + private function _get_attendee_list_for_main() |
|
77 | + { |
|
78 | + $valid_shortcodes = array('attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'); |
|
79 | + $template = $this->_data['template']; |
|
80 | + $data = $this->_data['data']; |
|
81 | + $attnds = ''; |
|
82 | + |
|
83 | + |
|
84 | + // now we need to loop through the attendee list and send data to the EE_Parser helper. |
|
85 | + foreach ($data->reg_objs as $registration) { |
|
86 | + $attnds .= $this->_shortcode_helper->parse_attendee_list_template( |
|
87 | + $template, |
|
88 | + $registration, |
|
89 | + $valid_shortcodes, |
|
90 | + $this->_extra_data |
|
91 | + ); |
|
92 | + } |
|
93 | + |
|
94 | + return $attnds; |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * return parsed list of attendees for an event |
|
100 | + * |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + private function _get_attendee_list_for_event() |
|
104 | + { |
|
105 | + $valid_shortcodes = array('attendee', 'ticket_list', 'question_list', 'recipient_details'); |
|
106 | + $template = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list']) |
|
107 | + ? $this->_data['template']['attendee_list'] : $this->_extra_data['template']['attendee_list']; |
|
108 | + $event = $this->_data['data']; |
|
109 | + |
|
110 | + // let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion. |
|
111 | + $template = str_replace('[EVENT_LIST]', '', $template); |
|
112 | + |
|
113 | + // here we're setting up the attendees for the attendee_list template for THIS event. |
|
114 | + $att_result = ''; |
|
115 | + $registrations = $this->_get_registrations_from_event($event); |
|
116 | + |
|
117 | + // each attendee in this case should be an attendee object. |
|
118 | + foreach ($registrations as $registration) { |
|
119 | + $att_result .= $this->_shortcode_helper->parse_attendee_list_template( |
|
120 | + $template, |
|
121 | + $registration, |
|
122 | + $valid_shortcodes, |
|
123 | + $this->_extra_data |
|
124 | + ); |
|
125 | + } |
|
126 | + |
|
127 | + return $att_result; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * return parsed list of attendees for a ticket |
|
133 | + * |
|
134 | + * @return string |
|
135 | + */ |
|
136 | + private function _get_registration_list_for_ticket() |
|
137 | + { |
|
138 | + $valid_shortcodes = array('attendee', 'event_list', 'question_list', 'recipient_details'); |
|
139 | + $template = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list']) |
|
140 | + ? $this->_data['template']['attendee_list'] : $this->_extra_data['template']['attendee_list']; |
|
141 | + $ticket = $this->_data['data']; |
|
142 | + |
|
143 | + // let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion. |
|
144 | + $template = str_replace('[TICKET_LIST]', '', $template); |
|
145 | + $template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template); |
|
146 | + $template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template); |
|
147 | + |
|
148 | + // here we're setting up the attendees for the attendee_list template for THIS ticket. |
|
149 | + $att_result = ''; |
|
150 | + $registrations = isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
151 | + ) ]['reg_objs'] : array(); |
|
152 | + |
|
153 | + // each attendee in this case should be an attendee object. |
|
154 | + foreach ($registrations as $registration) { |
|
155 | + $att_result .= $this->_shortcode_helper->parse_attendee_list_template( |
|
156 | + $template, |
|
157 | + $registration, |
|
158 | + $valid_shortcodes, |
|
159 | + $this->_extra_data |
|
160 | + ); |
|
161 | + } |
|
162 | + |
|
163 | + return $att_result; |
|
164 | + } |
|
165 | + |
|
166 | + |
|
167 | + private function _get_registrations_from_event(EE_Event $event) |
|
168 | + { |
|
169 | + return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
170 | + ) ]['reg_objs'] : array(); |
|
171 | + } |
|
172 | 172 | } |
@@ -147,8 +147,8 @@ discard block |
||
147 | 147 | |
148 | 148 | // here we're setting up the attendees for the attendee_list template for THIS ticket. |
149 | 149 | $att_result = ''; |
150 | - $registrations = isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[ $ticket->ID( |
|
151 | - ) ]['reg_objs'] : array(); |
|
150 | + $registrations = isset($this->_extra_data['data']->tickets) ? $this->_extra_data['data']->tickets[$ticket->ID( |
|
151 | + )]['reg_objs'] : array(); |
|
152 | 152 | |
153 | 153 | // each attendee in this case should be an attendee object. |
154 | 154 | foreach ($registrations as $registration) { |
@@ -166,7 +166,7 @@ discard block |
||
166 | 166 | |
167 | 167 | private function _get_registrations_from_event(EE_Event $event) |
168 | 168 | { |
169 | - return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID( |
|
170 | - ) ]['reg_objs'] : array(); |
|
169 | + return isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID( |
|
170 | + )]['reg_objs'] : array(); |
|
171 | 171 | } |
172 | 172 | } |
@@ -19,139 +19,139 @@ |
||
19 | 19 | { |
20 | 20 | |
21 | 21 | |
22 | - public function __construct() |
|
23 | - { |
|
24 | - parent::__construct(); |
|
25 | - } |
|
26 | - |
|
27 | - |
|
28 | - protected function _init_props() |
|
29 | - { |
|
30 | - $this->label = esc_html__('Organization Shortcodes', 'event_espresso'); |
|
31 | - $this->description = esc_html__('All shortcodes specific to organization related data', 'event_espresso'); |
|
32 | - $this->_shortcodes = array( |
|
33 | - '[COMPANY]' => esc_html__('Event organization name', 'event_espresso'), |
|
34 | - '[CO_ADD1]' => esc_html__('Address 1 value for the organization', 'event_espresso'), |
|
35 | - '[CO_ADD2]' => esc_html__('Address 2 value for the organization', 'event_espresso'), |
|
36 | - '[CO_CITY]' => esc_html__('City the organization is in', 'event_espresso'), |
|
37 | - '[CO_STATE]' => esc_html__('State the organization is located in', 'event_espresso'), |
|
38 | - '[CO_ZIP]' => esc_html__('The zip code for the organization', 'event_espresso'), |
|
39 | - '[CO_LOGO]' => esc_html__('The logo image for the organization', 'event_espresso'), |
|
40 | - '[CO_EMAIL]' => esc_html__('The primary email address for the organization', 'event_espresso'), |
|
41 | - '[CO_PHONE]' => esc_html__('The phone number for the organization', 'event_espresso'), |
|
42 | - '[CO_LOGO_URL]' => esc_html__( |
|
43 | - 'Just the link to the image used as the logo for the organization', |
|
44 | - 'event_espresso' |
|
45 | - ), |
|
46 | - '[CO_FACEBOOK_URL]' => esc_html__('Link to organization Facebook page', 'event_espresso'), |
|
47 | - '[CO_TWITTER_URL]' => esc_html__('Link to organization Twitter page', 'event_espresso'), |
|
48 | - '[CO_PINTEREST_URL]' => esc_html__('Link to organization Pinterest page', 'event_espresso'), |
|
49 | - '[CO_GOOGLE_URL]' => esc_html__('Link to organization Google page', 'event_espresso'), |
|
50 | - '[CO_LINKEDIN_URL]' => esc_html__('Link to organization LinkedIn page', 'event_espresso'), |
|
51 | - '[CO_INSTAGRAM_URL]' => esc_html__('Link to organization Instagram page', 'event_espresso'), |
|
52 | - '[CO_TAX_NUMBER_*]' => sprintf( |
|
53 | - esc_html__( |
|
54 | - 'This is the shortcode used for displaying any tax number for the company. %1$sNote: This is a special dynamic shortcode.%2$s You can use the "prefix" parameter to indicate what the prefix for this tax number is. It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: [CO_TAX_NUMBER_* prefix="GST: "] and that will output: GST: 12345t56. Also take note that if you have NO number in your settings, the prefix is not output either.', |
|
55 | - 'event_espresso' |
|
56 | - ), |
|
57 | - '<strong>', |
|
58 | - '</strong>' |
|
59 | - ), |
|
60 | - ); |
|
61 | - } |
|
62 | - |
|
63 | - |
|
64 | - protected function _parser($shortcode) |
|
65 | - { |
|
66 | - |
|
67 | - switch ($shortcode) { |
|
68 | - case '[COMPANY]': |
|
69 | - return EE_Registry::instance()->CFG->organization->get_pretty('name'); |
|
70 | - break; |
|
71 | - |
|
72 | - case '[CO_ADD1]': |
|
73 | - return EE_Registry::instance()->CFG->organization->get_pretty('address_1'); |
|
74 | - break; |
|
75 | - |
|
76 | - case '[CO_ADD2]': |
|
77 | - return EE_Registry::instance()->CFG->organization->get_pretty('address_2'); |
|
78 | - break; |
|
79 | - |
|
80 | - case '[CO_CITY]': |
|
81 | - return EE_Registry::instance()->CFG->organization->get_pretty('city'); |
|
82 | - break; |
|
83 | - |
|
84 | - case '[CO_STATE]': |
|
85 | - $state = EE_Registry::instance()->load_model('State')->get_one_by_ID( |
|
86 | - EE_Registry::instance()->CFG->organization->STA_ID |
|
87 | - ); |
|
88 | - return $state->name(); |
|
89 | - break; |
|
90 | - |
|
91 | - case '[CO_ZIP]': |
|
92 | - return EE_Registry::instance()->CFG->organization->get_pretty('zip'); |
|
93 | - break; |
|
94 | - |
|
95 | - case '[CO_EMAIL]': |
|
96 | - return EE_Registry::instance()->CFG->organization->get_pretty('email'); |
|
97 | - break; |
|
98 | - |
|
99 | - case '[CO_PHONE]': |
|
100 | - return EE_Registry::instance()->CFG->organization->get_pretty('phone'); |
|
101 | - break; |
|
102 | - |
|
103 | - case '[CO_LOGO]': |
|
104 | - return '<img src="' |
|
105 | - . EE_Registry::instance()->CFG->organization->get_pretty( |
|
106 | - 'logo_url' |
|
107 | - ) . '" id="headerImage" />'; |
|
108 | - break; |
|
109 | - |
|
110 | - case '[CO_LOGO_URL]': |
|
111 | - return EE_Registry::instance()->CFG->organization->get_pretty('logo_url'); |
|
112 | - break; |
|
113 | - |
|
114 | - case '[CO_FACEBOOK_URL]': |
|
115 | - return EE_Registry::instance()->CFG->organization->get_pretty('facebook'); |
|
116 | - break; |
|
117 | - |
|
118 | - case '[CO_TWITTER_URL]': |
|
119 | - return EE_Registry::instance()->CFG->organization->get_pretty('twitter'); |
|
120 | - break; |
|
121 | - |
|
122 | - case '[CO_PINTEREST_URL]': |
|
123 | - return EE_Registry::instance()->CFG->organization->get_pretty('pinterest'); |
|
124 | - break; |
|
125 | - |
|
126 | - case '[CO_LINKEDIN_URL]': |
|
127 | - return EE_Registry::instance()->CFG->organization->get_pretty('linkedin'); |
|
128 | - break; |
|
129 | - |
|
130 | - case '[CO_GOOGLE_URL]': |
|
131 | - return EE_Registry::instance()->CFG->organization->get_pretty('google'); |
|
132 | - break; |
|
133 | - |
|
134 | - case '[CO_INSTAGRAM_URL]': |
|
135 | - return EE_Registry::instance()->CFG->organization->get_pretty('instagram'); |
|
136 | - break; |
|
137 | - } |
|
138 | - |
|
139 | - // also allow for parameter shortcode |
|
140 | - if (strpos($shortcode, '[CO_TAX_NUMBER_*') !== false) { |
|
141 | - // first see if there is any company tax number set and bail early if not |
|
142 | - $tax_number = EE_Registry::instance()->CFG->organization->vat; |
|
143 | - if (empty($tax_number)) { |
|
144 | - return ''; |
|
145 | - } |
|
146 | - |
|
147 | - // see if there are any attributes. |
|
148 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
149 | - |
|
150 | - // set custom attrs if present (or default) |
|
151 | - $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
|
152 | - return $prefix . $tax_number; |
|
153 | - } |
|
154 | - |
|
155 | - return ''; |
|
156 | - } |
|
22 | + public function __construct() |
|
23 | + { |
|
24 | + parent::__construct(); |
|
25 | + } |
|
26 | + |
|
27 | + |
|
28 | + protected function _init_props() |
|
29 | + { |
|
30 | + $this->label = esc_html__('Organization Shortcodes', 'event_espresso'); |
|
31 | + $this->description = esc_html__('All shortcodes specific to organization related data', 'event_espresso'); |
|
32 | + $this->_shortcodes = array( |
|
33 | + '[COMPANY]' => esc_html__('Event organization name', 'event_espresso'), |
|
34 | + '[CO_ADD1]' => esc_html__('Address 1 value for the organization', 'event_espresso'), |
|
35 | + '[CO_ADD2]' => esc_html__('Address 2 value for the organization', 'event_espresso'), |
|
36 | + '[CO_CITY]' => esc_html__('City the organization is in', 'event_espresso'), |
|
37 | + '[CO_STATE]' => esc_html__('State the organization is located in', 'event_espresso'), |
|
38 | + '[CO_ZIP]' => esc_html__('The zip code for the organization', 'event_espresso'), |
|
39 | + '[CO_LOGO]' => esc_html__('The logo image for the organization', 'event_espresso'), |
|
40 | + '[CO_EMAIL]' => esc_html__('The primary email address for the organization', 'event_espresso'), |
|
41 | + '[CO_PHONE]' => esc_html__('The phone number for the organization', 'event_espresso'), |
|
42 | + '[CO_LOGO_URL]' => esc_html__( |
|
43 | + 'Just the link to the image used as the logo for the organization', |
|
44 | + 'event_espresso' |
|
45 | + ), |
|
46 | + '[CO_FACEBOOK_URL]' => esc_html__('Link to organization Facebook page', 'event_espresso'), |
|
47 | + '[CO_TWITTER_URL]' => esc_html__('Link to organization Twitter page', 'event_espresso'), |
|
48 | + '[CO_PINTEREST_URL]' => esc_html__('Link to organization Pinterest page', 'event_espresso'), |
|
49 | + '[CO_GOOGLE_URL]' => esc_html__('Link to organization Google page', 'event_espresso'), |
|
50 | + '[CO_LINKEDIN_URL]' => esc_html__('Link to organization LinkedIn page', 'event_espresso'), |
|
51 | + '[CO_INSTAGRAM_URL]' => esc_html__('Link to organization Instagram page', 'event_espresso'), |
|
52 | + '[CO_TAX_NUMBER_*]' => sprintf( |
|
53 | + esc_html__( |
|
54 | + 'This is the shortcode used for displaying any tax number for the company. %1$sNote: This is a special dynamic shortcode.%2$s You can use the "prefix" parameter to indicate what the prefix for this tax number is. It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: [CO_TAX_NUMBER_* prefix="GST: "] and that will output: GST: 12345t56. Also take note that if you have NO number in your settings, the prefix is not output either.', |
|
55 | + 'event_espresso' |
|
56 | + ), |
|
57 | + '<strong>', |
|
58 | + '</strong>' |
|
59 | + ), |
|
60 | + ); |
|
61 | + } |
|
62 | + |
|
63 | + |
|
64 | + protected function _parser($shortcode) |
|
65 | + { |
|
66 | + |
|
67 | + switch ($shortcode) { |
|
68 | + case '[COMPANY]': |
|
69 | + return EE_Registry::instance()->CFG->organization->get_pretty('name'); |
|
70 | + break; |
|
71 | + |
|
72 | + case '[CO_ADD1]': |
|
73 | + return EE_Registry::instance()->CFG->organization->get_pretty('address_1'); |
|
74 | + break; |
|
75 | + |
|
76 | + case '[CO_ADD2]': |
|
77 | + return EE_Registry::instance()->CFG->organization->get_pretty('address_2'); |
|
78 | + break; |
|
79 | + |
|
80 | + case '[CO_CITY]': |
|
81 | + return EE_Registry::instance()->CFG->organization->get_pretty('city'); |
|
82 | + break; |
|
83 | + |
|
84 | + case '[CO_STATE]': |
|
85 | + $state = EE_Registry::instance()->load_model('State')->get_one_by_ID( |
|
86 | + EE_Registry::instance()->CFG->organization->STA_ID |
|
87 | + ); |
|
88 | + return $state->name(); |
|
89 | + break; |
|
90 | + |
|
91 | + case '[CO_ZIP]': |
|
92 | + return EE_Registry::instance()->CFG->organization->get_pretty('zip'); |
|
93 | + break; |
|
94 | + |
|
95 | + case '[CO_EMAIL]': |
|
96 | + return EE_Registry::instance()->CFG->organization->get_pretty('email'); |
|
97 | + break; |
|
98 | + |
|
99 | + case '[CO_PHONE]': |
|
100 | + return EE_Registry::instance()->CFG->organization->get_pretty('phone'); |
|
101 | + break; |
|
102 | + |
|
103 | + case '[CO_LOGO]': |
|
104 | + return '<img src="' |
|
105 | + . EE_Registry::instance()->CFG->organization->get_pretty( |
|
106 | + 'logo_url' |
|
107 | + ) . '" id="headerImage" />'; |
|
108 | + break; |
|
109 | + |
|
110 | + case '[CO_LOGO_URL]': |
|
111 | + return EE_Registry::instance()->CFG->organization->get_pretty('logo_url'); |
|
112 | + break; |
|
113 | + |
|
114 | + case '[CO_FACEBOOK_URL]': |
|
115 | + return EE_Registry::instance()->CFG->organization->get_pretty('facebook'); |
|
116 | + break; |
|
117 | + |
|
118 | + case '[CO_TWITTER_URL]': |
|
119 | + return EE_Registry::instance()->CFG->organization->get_pretty('twitter'); |
|
120 | + break; |
|
121 | + |
|
122 | + case '[CO_PINTEREST_URL]': |
|
123 | + return EE_Registry::instance()->CFG->organization->get_pretty('pinterest'); |
|
124 | + break; |
|
125 | + |
|
126 | + case '[CO_LINKEDIN_URL]': |
|
127 | + return EE_Registry::instance()->CFG->organization->get_pretty('linkedin'); |
|
128 | + break; |
|
129 | + |
|
130 | + case '[CO_GOOGLE_URL]': |
|
131 | + return EE_Registry::instance()->CFG->organization->get_pretty('google'); |
|
132 | + break; |
|
133 | + |
|
134 | + case '[CO_INSTAGRAM_URL]': |
|
135 | + return EE_Registry::instance()->CFG->organization->get_pretty('instagram'); |
|
136 | + break; |
|
137 | + } |
|
138 | + |
|
139 | + // also allow for parameter shortcode |
|
140 | + if (strpos($shortcode, '[CO_TAX_NUMBER_*') !== false) { |
|
141 | + // first see if there is any company tax number set and bail early if not |
|
142 | + $tax_number = EE_Registry::instance()->CFG->organization->vat; |
|
143 | + if (empty($tax_number)) { |
|
144 | + return ''; |
|
145 | + } |
|
146 | + |
|
147 | + // see if there are any attributes. |
|
148 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
149 | + |
|
150 | + // set custom attrs if present (or default) |
|
151 | + $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
|
152 | + return $prefix . $tax_number; |
|
153 | + } |
|
154 | + |
|
155 | + return ''; |
|
156 | + } |
|
157 | 157 | } |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | return '<img src="' |
105 | 105 | . EE_Registry::instance()->CFG->organization->get_pretty( |
106 | 106 | 'logo_url' |
107 | - ) . '" id="headerImage" />'; |
|
107 | + ).'" id="headerImage" />'; |
|
108 | 108 | break; |
109 | 109 | |
110 | 110 | case '[CO_LOGO_URL]': |
@@ -149,7 +149,7 @@ discard block |
||
149 | 149 | |
150 | 150 | // set custom attrs if present (or default) |
151 | 151 | $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso'); |
152 | - return $prefix . $tax_number; |
|
152 | + return $prefix.$tax_number; |
|
153 | 153 | } |
154 | 154 | |
155 | 155 | return ''; |
@@ -18,93 +18,93 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - protected function _init_props() |
|
22 | - { |
|
23 | - $this->label = __('Payment Shortcodes', 'event_espresso'); |
|
24 | - $this->description = __('All shortcodes specific to payments.', 'event_espresso'); |
|
25 | - $this->_shortcodes = array( |
|
26 | - '[PAYMENT_TIMESTAMP]' => __( |
|
27 | - 'Outputs the date of the payment (using the default date format).', |
|
28 | - 'event_espresso' |
|
29 | - ), |
|
30 | - '[PAYMENT_METHOD]' => __('Outputs a the payment method.', 'event_espresso'), |
|
31 | - '[PAYMENT_AMOUNT]' => __('Outputs the payment amount (with currency symbol).', 'event_espresso'), |
|
32 | - '[PAYMENT_GATEWAY]' => __('Outputs the gateway used for the payment.', 'event_espresso'), |
|
33 | - '[PAYMENT_GATEWAY_RESPONSE]' => __('Outputs the payment gateway response.', 'event_espresso'), |
|
34 | - '[PAYMENT_GATEWAY_TXN_ID]' => __( |
|
35 | - 'This will either be the gateway transaction ID, or the manual ID added with payment applied via the admin.', |
|
36 | - 'event_espresso' |
|
37 | - ), |
|
38 | - '[PAYMENT_PO_NUMBER]' => __('Purchase Order number (if present)', 'event_espresso'), |
|
39 | - '[PAYMENT_EXTRA_ACCOUNTING]' => __( |
|
40 | - 'Any extra accounting messages. Typically added with payments made via the admin.', |
|
41 | - 'event_espresso' |
|
42 | - ), |
|
43 | - '[PAYMENT_STATUS]' => __('The status of the payment.', 'event_espresso'), |
|
44 | - // '[PAYMENT_STATUS_WITH_ICONS]' => __('The status of the payment including icons representing the status.', 'event_espresso') |
|
45 | - ); |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - protected function _parser($shortcode) |
|
50 | - { |
|
51 | - // ensure that the incoming object is an EE_Payment object. If it isn't then bail early. |
|
52 | - if (! $this->_data instanceof EE_Payment) { |
|
53 | - return ''; |
|
54 | - } |
|
55 | - |
|
56 | - $payment = $this->_data; |
|
57 | - |
|
58 | - switch ($shortcode) { |
|
59 | - case '[PAYMENT_TIMESTAMP]': |
|
60 | - return $payment->timestamp(); |
|
61 | - break; |
|
62 | - |
|
63 | - case '[PAYMENT_METHOD]': |
|
64 | - // previously the column 'PAY_source' was known as 'PAY_method' |
|
65 | - return $payment->source(); |
|
66 | - break; |
|
67 | - |
|
68 | - case '[PAYMENT_AMOUNT]': |
|
69 | - return $payment->amount_no_code(); |
|
70 | - break; |
|
71 | - |
|
72 | - case '[PAYMENT_GATEWAY]': |
|
73 | - // previously teh column 'PMD_ID' was more-or-less 'PAY_gateway' |
|
74 | - if ($payment->payment_method() instanceof EE_Payment_Method) { |
|
75 | - return $payment->payment_method()->name(); |
|
76 | - } else { |
|
77 | - return __('Unknown', 'event_espresso'); |
|
78 | - } |
|
79 | - break; |
|
80 | - |
|
81 | - case '[PAYMENT_GATEWAY_RESPONSE]': |
|
82 | - return $payment->gateway_response(); |
|
83 | - break; |
|
84 | - |
|
85 | - case '[PAYMENT_GATEWAY_TXN_ID]': |
|
86 | - return $payment->txn_id_chq_nmbr(); |
|
87 | - break; |
|
88 | - |
|
89 | - case '[PAYMENT_PO_NUMBER]': |
|
90 | - return $payment->po_number(); |
|
91 | - break; |
|
92 | - |
|
93 | - case '[PAYMENT_EXTRA_ACCOUNTING]': |
|
94 | - return $payment->extra_accntng(); |
|
95 | - break; |
|
96 | - |
|
97 | - case '[PAYMENT_STATUS]': |
|
98 | - return $payment->pretty_status(); |
|
99 | - break; |
|
100 | - |
|
101 | - case '[PAYMENT_STATUS_WITH_ICONS]': |
|
102 | - return $payment->pretty_status(true); |
|
103 | - break; |
|
104 | - |
|
105 | - default: |
|
106 | - return ''; |
|
107 | - break; |
|
108 | - } |
|
109 | - } |
|
21 | + protected function _init_props() |
|
22 | + { |
|
23 | + $this->label = __('Payment Shortcodes', 'event_espresso'); |
|
24 | + $this->description = __('All shortcodes specific to payments.', 'event_espresso'); |
|
25 | + $this->_shortcodes = array( |
|
26 | + '[PAYMENT_TIMESTAMP]' => __( |
|
27 | + 'Outputs the date of the payment (using the default date format).', |
|
28 | + 'event_espresso' |
|
29 | + ), |
|
30 | + '[PAYMENT_METHOD]' => __('Outputs a the payment method.', 'event_espresso'), |
|
31 | + '[PAYMENT_AMOUNT]' => __('Outputs the payment amount (with currency symbol).', 'event_espresso'), |
|
32 | + '[PAYMENT_GATEWAY]' => __('Outputs the gateway used for the payment.', 'event_espresso'), |
|
33 | + '[PAYMENT_GATEWAY_RESPONSE]' => __('Outputs the payment gateway response.', 'event_espresso'), |
|
34 | + '[PAYMENT_GATEWAY_TXN_ID]' => __( |
|
35 | + 'This will either be the gateway transaction ID, or the manual ID added with payment applied via the admin.', |
|
36 | + 'event_espresso' |
|
37 | + ), |
|
38 | + '[PAYMENT_PO_NUMBER]' => __('Purchase Order number (if present)', 'event_espresso'), |
|
39 | + '[PAYMENT_EXTRA_ACCOUNTING]' => __( |
|
40 | + 'Any extra accounting messages. Typically added with payments made via the admin.', |
|
41 | + 'event_espresso' |
|
42 | + ), |
|
43 | + '[PAYMENT_STATUS]' => __('The status of the payment.', 'event_espresso'), |
|
44 | + // '[PAYMENT_STATUS_WITH_ICONS]' => __('The status of the payment including icons representing the status.', 'event_espresso') |
|
45 | + ); |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + protected function _parser($shortcode) |
|
50 | + { |
|
51 | + // ensure that the incoming object is an EE_Payment object. If it isn't then bail early. |
|
52 | + if (! $this->_data instanceof EE_Payment) { |
|
53 | + return ''; |
|
54 | + } |
|
55 | + |
|
56 | + $payment = $this->_data; |
|
57 | + |
|
58 | + switch ($shortcode) { |
|
59 | + case '[PAYMENT_TIMESTAMP]': |
|
60 | + return $payment->timestamp(); |
|
61 | + break; |
|
62 | + |
|
63 | + case '[PAYMENT_METHOD]': |
|
64 | + // previously the column 'PAY_source' was known as 'PAY_method' |
|
65 | + return $payment->source(); |
|
66 | + break; |
|
67 | + |
|
68 | + case '[PAYMENT_AMOUNT]': |
|
69 | + return $payment->amount_no_code(); |
|
70 | + break; |
|
71 | + |
|
72 | + case '[PAYMENT_GATEWAY]': |
|
73 | + // previously teh column 'PMD_ID' was more-or-less 'PAY_gateway' |
|
74 | + if ($payment->payment_method() instanceof EE_Payment_Method) { |
|
75 | + return $payment->payment_method()->name(); |
|
76 | + } else { |
|
77 | + return __('Unknown', 'event_espresso'); |
|
78 | + } |
|
79 | + break; |
|
80 | + |
|
81 | + case '[PAYMENT_GATEWAY_RESPONSE]': |
|
82 | + return $payment->gateway_response(); |
|
83 | + break; |
|
84 | + |
|
85 | + case '[PAYMENT_GATEWAY_TXN_ID]': |
|
86 | + return $payment->txn_id_chq_nmbr(); |
|
87 | + break; |
|
88 | + |
|
89 | + case '[PAYMENT_PO_NUMBER]': |
|
90 | + return $payment->po_number(); |
|
91 | + break; |
|
92 | + |
|
93 | + case '[PAYMENT_EXTRA_ACCOUNTING]': |
|
94 | + return $payment->extra_accntng(); |
|
95 | + break; |
|
96 | + |
|
97 | + case '[PAYMENT_STATUS]': |
|
98 | + return $payment->pretty_status(); |
|
99 | + break; |
|
100 | + |
|
101 | + case '[PAYMENT_STATUS_WITH_ICONS]': |
|
102 | + return $payment->pretty_status(true); |
|
103 | + break; |
|
104 | + |
|
105 | + default: |
|
106 | + return ''; |
|
107 | + break; |
|
108 | + } |
|
109 | + } |
|
110 | 110 | } |
@@ -49,7 +49,7 @@ |
||
49 | 49 | protected function _parser($shortcode) |
50 | 50 | { |
51 | 51 | // ensure that the incoming object is an EE_Payment object. If it isn't then bail early. |
52 | - if (! $this->_data instanceof EE_Payment) { |
|
52 | + if ( ! $this->_data instanceof EE_Payment) { |
|
53 | 53 | return ''; |
54 | 54 | } |
55 | 55 |
@@ -19,123 +19,123 @@ |
||
19 | 19 | { |
20 | 20 | |
21 | 21 | |
22 | - /** |
|
23 | - * Will hold the EE_Ticket if available |
|
24 | - * |
|
25 | - * @var EE_Ticket |
|
26 | - */ |
|
27 | - protected $_ticket; |
|
28 | - |
|
29 | - |
|
30 | - protected function _init_props() |
|
31 | - { |
|
32 | - $this->label = __('Ticket Shortcodes', 'event_espresso'); |
|
33 | - $this->description = __('All shortcodes specific to ticket related data', 'event_espresso'); |
|
34 | - $this->_shortcodes = array( |
|
35 | - '[TICKET_ID]' => __('Will be replaced by the ticket ID of a ticket', 'event_espresso'), |
|
36 | - '[TICKET_NAME]' => __('The name of the ticket', 'event_espresso'), |
|
37 | - '[TICKET_DESCRIPTION]' => __('The description of the ticket', 'event_espresso'), |
|
38 | - '[TICKET_PRICE]' => __('The price of the ticket', 'event_espresso'), |
|
39 | - '[TICKET_PRICE_WITH_TAXES]' => __( |
|
40 | - 'The price of the ticket including any taxes that might be on the ticket', |
|
41 | - 'event_espresso' |
|
42 | - ), |
|
43 | - '[TKT_QTY_PURCHASED]' => __( |
|
44 | - 'The total quantity of the current ticket in the list that has been purchased in this transaction', |
|
45 | - 'event_espresso' |
|
46 | - ), |
|
47 | - '[TKT_USES_*]' => __( |
|
48 | - 'This attribute based shortcode parses to show the number of uses the ticket has. The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite. Options are:', |
|
49 | - 'event_espresso' |
|
50 | - ) . |
|
51 | - '<p><ul>' . |
|
52 | - '<li><strong>symbol</strong>:' . __( |
|
53 | - 'This returns the ∞ symbol.', |
|
54 | - 'event_espresso' |
|
55 | - ) . '</li>' . |
|
56 | - '<li><strong>text</strong>:' . __( |
|
57 | - 'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.', |
|
58 | - 'event_espresso' |
|
59 | - ) . '</li>' . |
|
60 | - '<li><strong>{custom}</strong>:' . __( |
|
61 | - 'You can put anything you want as a string instead and that will be used. So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".', |
|
62 | - 'event_espresso' |
|
63 | - ) . '</li>' . |
|
64 | - '</ul></p>', |
|
65 | - ); |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - protected function _parser($shortcode) |
|
70 | - { |
|
71 | - |
|
72 | - $this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null; |
|
73 | - |
|
74 | - $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
75 | - $aee = ! $aee instanceof EE_Messages_Addressee && is_array( |
|
76 | - $this->_extra_data |
|
77 | - ) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
78 | - ? $this->_extra_data['data'] : $aee; |
|
79 | - |
|
80 | - |
|
81 | - // possible EE_Line_Item may be incoming data |
|
82 | - $this->_ticket = empty($this->_ticket) |
|
83 | - && $this->_data instanceof EE_Line_Item |
|
84 | - && $aee instanceof EE_Messages_Addressee |
|
85 | - && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']) |
|
86 | - && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket |
|
87 | - ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] |
|
88 | - : $this->_ticket; |
|
89 | - |
|
90 | - // if still no ticket, then let's see if there is a reg_obj. If there IS, then we'll try and grab the ticket from the reg_obj instead. |
|
91 | - if (empty($this->_ticket)) { |
|
92 | - $this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration |
|
93 | - ? $aee->reg_obj->ticket() : null; |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - // If there is no event object by now then get out. |
|
98 | - if (! $this->_ticket instanceof EE_Ticket) { |
|
99 | - return ''; |
|
100 | - } |
|
101 | - |
|
102 | - switch ($shortcode) { |
|
103 | - case '[TICKET_ID]': |
|
104 | - return $this->_ticket->ID(); |
|
105 | - break; |
|
106 | - |
|
107 | - case '[TICKET_NAME]': |
|
108 | - return $this->_ticket->get('TKT_name'); |
|
109 | - break; |
|
110 | - |
|
111 | - case '[TICKET_DESCRIPTION]': |
|
112 | - return $this->_ticket->get('TKT_description'); |
|
113 | - break; |
|
114 | - |
|
115 | - case '[TICKET_PRICE]': |
|
116 | - return EEH_Template::format_currency($this->_ticket->get('TKT_price')); |
|
117 | - break; |
|
118 | - |
|
119 | - case '[TICKET_PRICE_WITH_TAXES]': |
|
120 | - return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes()); |
|
121 | - break; |
|
122 | - |
|
123 | - case '[TKT_QTY_PURCHASED]': |
|
124 | - return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : ''; |
|
125 | - break; |
|
126 | - } |
|
127 | - |
|
128 | - if (strpos($shortcode, '[TKT_USES_*') !== false) { |
|
129 | - $attrs = $this->_get_shortcode_attrs($shortcode); |
|
130 | - $schema = empty($attrs['schema']) ? null : $attrs['schema']; |
|
131 | - return $this->_ticket->get_pretty('TKT_uses', $schema); |
|
132 | - } |
|
133 | - return ''; |
|
134 | - } |
|
135 | - |
|
136 | - |
|
137 | - public function get_ticket_set() |
|
138 | - { |
|
139 | - return $this->_ticket; |
|
140 | - } |
|
22 | + /** |
|
23 | + * Will hold the EE_Ticket if available |
|
24 | + * |
|
25 | + * @var EE_Ticket |
|
26 | + */ |
|
27 | + protected $_ticket; |
|
28 | + |
|
29 | + |
|
30 | + protected function _init_props() |
|
31 | + { |
|
32 | + $this->label = __('Ticket Shortcodes', 'event_espresso'); |
|
33 | + $this->description = __('All shortcodes specific to ticket related data', 'event_espresso'); |
|
34 | + $this->_shortcodes = array( |
|
35 | + '[TICKET_ID]' => __('Will be replaced by the ticket ID of a ticket', 'event_espresso'), |
|
36 | + '[TICKET_NAME]' => __('The name of the ticket', 'event_espresso'), |
|
37 | + '[TICKET_DESCRIPTION]' => __('The description of the ticket', 'event_espresso'), |
|
38 | + '[TICKET_PRICE]' => __('The price of the ticket', 'event_espresso'), |
|
39 | + '[TICKET_PRICE_WITH_TAXES]' => __( |
|
40 | + 'The price of the ticket including any taxes that might be on the ticket', |
|
41 | + 'event_espresso' |
|
42 | + ), |
|
43 | + '[TKT_QTY_PURCHASED]' => __( |
|
44 | + 'The total quantity of the current ticket in the list that has been purchased in this transaction', |
|
45 | + 'event_espresso' |
|
46 | + ), |
|
47 | + '[TKT_USES_*]' => __( |
|
48 | + 'This attribute based shortcode parses to show the number of uses the ticket has. The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite. Options are:', |
|
49 | + 'event_espresso' |
|
50 | + ) . |
|
51 | + '<p><ul>' . |
|
52 | + '<li><strong>symbol</strong>:' . __( |
|
53 | + 'This returns the ∞ symbol.', |
|
54 | + 'event_espresso' |
|
55 | + ) . '</li>' . |
|
56 | + '<li><strong>text</strong>:' . __( |
|
57 | + 'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.', |
|
58 | + 'event_espresso' |
|
59 | + ) . '</li>' . |
|
60 | + '<li><strong>{custom}</strong>:' . __( |
|
61 | + 'You can put anything you want as a string instead and that will be used. So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".', |
|
62 | + 'event_espresso' |
|
63 | + ) . '</li>' . |
|
64 | + '</ul></p>', |
|
65 | + ); |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + protected function _parser($shortcode) |
|
70 | + { |
|
71 | + |
|
72 | + $this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null; |
|
73 | + |
|
74 | + $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null; |
|
75 | + $aee = ! $aee instanceof EE_Messages_Addressee && is_array( |
|
76 | + $this->_extra_data |
|
77 | + ) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee |
|
78 | + ? $this->_extra_data['data'] : $aee; |
|
79 | + |
|
80 | + |
|
81 | + // possible EE_Line_Item may be incoming data |
|
82 | + $this->_ticket = empty($this->_ticket) |
|
83 | + && $this->_data instanceof EE_Line_Item |
|
84 | + && $aee instanceof EE_Messages_Addressee |
|
85 | + && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']) |
|
86 | + && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket |
|
87 | + ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] |
|
88 | + : $this->_ticket; |
|
89 | + |
|
90 | + // if still no ticket, then let's see if there is a reg_obj. If there IS, then we'll try and grab the ticket from the reg_obj instead. |
|
91 | + if (empty($this->_ticket)) { |
|
92 | + $this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration |
|
93 | + ? $aee->reg_obj->ticket() : null; |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + // If there is no event object by now then get out. |
|
98 | + if (! $this->_ticket instanceof EE_Ticket) { |
|
99 | + return ''; |
|
100 | + } |
|
101 | + |
|
102 | + switch ($shortcode) { |
|
103 | + case '[TICKET_ID]': |
|
104 | + return $this->_ticket->ID(); |
|
105 | + break; |
|
106 | + |
|
107 | + case '[TICKET_NAME]': |
|
108 | + return $this->_ticket->get('TKT_name'); |
|
109 | + break; |
|
110 | + |
|
111 | + case '[TICKET_DESCRIPTION]': |
|
112 | + return $this->_ticket->get('TKT_description'); |
|
113 | + break; |
|
114 | + |
|
115 | + case '[TICKET_PRICE]': |
|
116 | + return EEH_Template::format_currency($this->_ticket->get('TKT_price')); |
|
117 | + break; |
|
118 | + |
|
119 | + case '[TICKET_PRICE_WITH_TAXES]': |
|
120 | + return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes()); |
|
121 | + break; |
|
122 | + |
|
123 | + case '[TKT_QTY_PURCHASED]': |
|
124 | + return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : ''; |
|
125 | + break; |
|
126 | + } |
|
127 | + |
|
128 | + if (strpos($shortcode, '[TKT_USES_*') !== false) { |
|
129 | + $attrs = $this->_get_shortcode_attrs($shortcode); |
|
130 | + $schema = empty($attrs['schema']) ? null : $attrs['schema']; |
|
131 | + return $this->_ticket->get_pretty('TKT_uses', $schema); |
|
132 | + } |
|
133 | + return ''; |
|
134 | + } |
|
135 | + |
|
136 | + |
|
137 | + public function get_ticket_set() |
|
138 | + { |
|
139 | + return $this->_ticket; |
|
140 | + } |
|
141 | 141 | } |
@@ -47,20 +47,20 @@ discard block |
||
47 | 47 | '[TKT_USES_*]' => __( |
48 | 48 | 'This attribute based shortcode parses to show the number of uses the ticket has. The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite. Options are:', |
49 | 49 | 'event_espresso' |
50 | - ) . |
|
51 | - '<p><ul>' . |
|
52 | - '<li><strong>symbol</strong>:' . __( |
|
50 | + ). |
|
51 | + '<p><ul>'. |
|
52 | + '<li><strong>symbol</strong>:'.__( |
|
53 | 53 | 'This returns the ∞ symbol.', |
54 | 54 | 'event_espresso' |
55 | - ) . '</li>' . |
|
56 | - '<li><strong>text</strong>:' . __( |
|
55 | + ).'</li>'. |
|
56 | + '<li><strong>text</strong>:'.__( |
|
57 | 57 | 'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.', |
58 | 58 | 'event_espresso' |
59 | - ) . '</li>' . |
|
60 | - '<li><strong>{custom}</strong>:' . __( |
|
59 | + ).'</li>'. |
|
60 | + '<li><strong>{custom}</strong>:'.__( |
|
61 | 61 | 'You can put anything you want as a string instead and that will be used. So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".', |
62 | 62 | 'event_espresso' |
63 | - ) . '</li>' . |
|
63 | + ).'</li>'. |
|
64 | 64 | '</ul></p>', |
65 | 65 | ); |
66 | 66 | } |
@@ -82,9 +82,9 @@ discard block |
||
82 | 82 | $this->_ticket = empty($this->_ticket) |
83 | 83 | && $this->_data instanceof EE_Line_Item |
84 | 84 | && $aee instanceof EE_Messages_Addressee |
85 | - && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']) |
|
86 | - && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket |
|
87 | - ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] |
|
85 | + && ! empty($aee->line_items_with_children[$this->_data->ID()]['EE_Ticket']) |
|
86 | + && $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'] instanceof EE_Ticket |
|
87 | + ? $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'] |
|
88 | 88 | : $this->_ticket; |
89 | 89 | |
90 | 90 | // if still no ticket, then let's see if there is a reg_obj. If there IS, then we'll try and grab the ticket from the reg_obj instead. |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | |
96 | 96 | |
97 | 97 | // If there is no event object by now then get out. |
98 | - if (! $this->_ticket instanceof EE_Ticket) { |
|
98 | + if ( ! $this->_ticket instanceof EE_Ticket) { |
|
99 | 99 | return ''; |
100 | 100 | } |
101 | 101 | |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | break; |
122 | 122 | |
123 | 123 | case '[TKT_QTY_PURCHASED]': |
124 | - return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : ''; |
|
124 | + return $aee instanceof EE_Messages_Addressee ? $aee->tickets[$this->_ticket->ID()]['count'] : ''; |
|
125 | 125 | break; |
126 | 126 | } |
127 | 127 |