@@ -19,53 +19,53 @@ |
||
19 | 19 | */ |
20 | 20 | class SettingsForm extends PayPalSettingsForm |
21 | 21 | { |
22 | - /** |
|
23 | - * SettingsForm constructor. |
|
24 | - * |
|
25 | - * @param array $options_array |
|
26 | - * @param string $help_tab_link |
|
27 | - * @throws InvalidDataTypeException |
|
28 | - * @throws InvalidInterfaceException |
|
29 | - * @throws InvalidArgumentException |
|
30 | - */ |
|
31 | - public function __construct(array $options_array = array(), $help_tab_link = '') |
|
32 | - { |
|
33 | - $options_array = array_replace_recursive( |
|
34 | - array( |
|
35 | - 'extra_meta_inputs' => array( |
|
36 | - 'request_shipping_addr' => new EE_Yes_No_Input( |
|
37 | - array( |
|
38 | - 'html_label_text' => sprintf( |
|
39 | - esc_html__('Request Shipping Address %s', 'event_espresso'), |
|
40 | - $help_tab_link |
|
41 | - ), |
|
42 | - 'html_help_text' => esc_html__( |
|
43 | - // @codingStandardsIgnoreStart |
|
44 | - 'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.', |
|
45 | - // @codingStandardsIgnoreEnd |
|
46 | - 'event_espresso' |
|
47 | - ), |
|
48 | - 'required' => true, |
|
49 | - 'default' => false, |
|
50 | - ) |
|
51 | - ), |
|
52 | - 'image_url' => new EE_Admin_File_Uploader_Input( |
|
53 | - array( |
|
54 | - 'html_label_text' => sprintf( |
|
55 | - esc_html__('Image URL %s', 'event_espresso'), |
|
56 | - $help_tab_link |
|
57 | - ), |
|
58 | - 'html_help_text' => esc_html__( |
|
59 | - 'Used for your business/personal logo on the PayPal page', |
|
60 | - 'event_espresso' |
|
61 | - ), |
|
62 | - 'required' => false, |
|
63 | - ) |
|
64 | - ), |
|
65 | - ) |
|
66 | - ), |
|
67 | - $options_array |
|
68 | - ); |
|
69 | - parent::__construct($options_array, $help_tab_link); |
|
70 | - } |
|
22 | + /** |
|
23 | + * SettingsForm constructor. |
|
24 | + * |
|
25 | + * @param array $options_array |
|
26 | + * @param string $help_tab_link |
|
27 | + * @throws InvalidDataTypeException |
|
28 | + * @throws InvalidInterfaceException |
|
29 | + * @throws InvalidArgumentException |
|
30 | + */ |
|
31 | + public function __construct(array $options_array = array(), $help_tab_link = '') |
|
32 | + { |
|
33 | + $options_array = array_replace_recursive( |
|
34 | + array( |
|
35 | + 'extra_meta_inputs' => array( |
|
36 | + 'request_shipping_addr' => new EE_Yes_No_Input( |
|
37 | + array( |
|
38 | + 'html_label_text' => sprintf( |
|
39 | + esc_html__('Request Shipping Address %s', 'event_espresso'), |
|
40 | + $help_tab_link |
|
41 | + ), |
|
42 | + 'html_help_text' => esc_html__( |
|
43 | + // @codingStandardsIgnoreStart |
|
44 | + 'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.', |
|
45 | + // @codingStandardsIgnoreEnd |
|
46 | + 'event_espresso' |
|
47 | + ), |
|
48 | + 'required' => true, |
|
49 | + 'default' => false, |
|
50 | + ) |
|
51 | + ), |
|
52 | + 'image_url' => new EE_Admin_File_Uploader_Input( |
|
53 | + array( |
|
54 | + 'html_label_text' => sprintf( |
|
55 | + esc_html__('Image URL %s', 'event_espresso'), |
|
56 | + $help_tab_link |
|
57 | + ), |
|
58 | + 'html_help_text' => esc_html__( |
|
59 | + 'Used for your business/personal logo on the PayPal page', |
|
60 | + 'event_espresso' |
|
61 | + ), |
|
62 | + 'required' => false, |
|
63 | + ) |
|
64 | + ), |
|
65 | + ) |
|
66 | + ), |
|
67 | + $options_array |
|
68 | + ); |
|
69 | + parent::__construct($options_array, $help_tab_link); |
|
70 | + } |
|
71 | 71 | } |
@@ -324,8 +324,8 @@ discard block |
||
324 | 324 | ); |
325 | 325 | $query = $wpdb->prepare( |
326 | 326 | 'DELETE li |
327 | - FROM ' . $this->table() . ' li |
|
328 | - LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
|
327 | + FROM ' . $this->table().' li |
|
328 | + LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID |
|
329 | 329 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
330 | 330 | // use GMT time because that's what TXN_timestamps are in |
331 | 331 | date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
@@ -598,7 +598,7 @@ discard block |
||
598 | 598 | */ |
599 | 599 | public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
600 | 600 | { |
601 | - if (! absint($timestamp)) { |
|
601 | + if ( ! absint($timestamp)) { |
|
602 | 602 | /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
603 | 603 | $session_lifespan = LoaderFactory::getLoader()->getShared( |
604 | 604 | 'EventEspresso\core\domain\values\session\SessionLifespan' |
@@ -27,616 +27,616 @@ |
||
27 | 27 | */ |
28 | 28 | class EEM_Line_Item extends EEM_Base |
29 | 29 | { |
30 | - /** |
|
31 | - * Tax sub-total is just the total of all the taxes, which should be children |
|
32 | - * of this line item. There should only ever be one tax sub-total, and it should |
|
33 | - * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
34 | - */ |
|
35 | - const type_tax_sub_total = 'tax-sub-total'; |
|
36 | - |
|
37 | - /** |
|
38 | - * Tax line items indicate a tax applied to all the taxable line items. |
|
39 | - * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
40 | - * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
41 | - */ |
|
42 | - const type_tax = 'tax'; |
|
43 | - |
|
44 | - /** |
|
45 | - * Indicating individual items purchased, or discounts or surcharges. |
|
46 | - * The sum of all the regular line items plus the tax items should equal the grand total. |
|
47 | - * Possible children are sub-line-items and cancellations. |
|
48 | - * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
49 | - * LIN_totals. Its LIN_percent = 0. |
|
50 | - * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
51 | - * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
52 | - */ |
|
53 | - const type_line_item = 'line-item'; |
|
54 | - |
|
55 | - /** |
|
56 | - * Line item indicating all the factors that make a single line item. |
|
57 | - * Sub-line items should have NO children line items. |
|
58 | - * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
59 | - * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
60 | - * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
61 | - * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
62 | - * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
63 | - */ |
|
64 | - const type_sub_line_item = 'sub-item'; |
|
65 | - |
|
66 | - /** |
|
67 | - * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item. |
|
68 | - * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
69 | - * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
70 | - */ |
|
71 | - const type_sub_tax = 'sub-tax'; |
|
72 | - |
|
73 | - /** |
|
74 | - * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
75 | - * Direct children should be event subtotals. |
|
76 | - * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
77 | - */ |
|
78 | - const type_sub_total = 'sub-total'; |
|
79 | - |
|
80 | - /** |
|
81 | - * Line item for the grand total of an order. |
|
82 | - * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
83 | - * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
84 | - * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
85 | - */ |
|
86 | - const type_total = 'total'; |
|
87 | - |
|
88 | - /** |
|
89 | - * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
90 | - * should be created, indicating the quantity that were cancelled |
|
91 | - * (because a line item could have a quantity of 1, and its cancellation item |
|
92 | - * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
93 | - * cancelled, and only one remains). |
|
94 | - * When items are refunded, a cancellation line item should be made, which points |
|
95 | - * to teh payment model object which actually refunded the payment. |
|
96 | - * Cancellations should NOT have any children line items; the should NOT affect |
|
97 | - * any calculations, and are only meant as a record that cancellations have occurred. |
|
98 | - * Their LIN_percent should be 0. |
|
99 | - */ |
|
100 | - const type_cancellation = 'cancellation'; |
|
101 | - |
|
102 | - // various line item object types |
|
103 | - const OBJ_TYPE_EVENT = 'Event'; |
|
104 | - |
|
105 | - const OBJ_TYPE_PRICE = 'Price'; |
|
106 | - |
|
107 | - const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
108 | - |
|
109 | - const OBJ_TYPE_TICKET = 'Ticket'; |
|
110 | - |
|
111 | - const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
112 | - |
|
113 | - /** |
|
114 | - * @var EEM_Line_Item $_instance |
|
115 | - */ |
|
116 | - protected static $_instance; |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * private constructor to prevent direct creation |
|
121 | - * |
|
122 | - * @Constructor |
|
123 | - * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
124 | - * (and any incoming timezone data that gets saved). |
|
125 | - * Note this just sends the timezone info to the date time model field objects. |
|
126 | - * Default is NULL |
|
127 | - * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
128 | - * @throws EE_Error |
|
129 | - * @throws InvalidArgumentException |
|
130 | - */ |
|
131 | - protected function __construct($timezone) |
|
132 | - { |
|
133 | - $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
134 | - $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
135 | - |
|
136 | - $this->_tables = array( |
|
137 | - 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
138 | - ); |
|
139 | - $line_items_can_be_for = apply_filters( |
|
140 | - 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
141 | - array('Ticket', 'Price', 'Event') |
|
142 | - ); |
|
143 | - $this->_fields = array( |
|
144 | - 'Line_Item' => array( |
|
145 | - 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
146 | - 'LIN_ID', |
|
147 | - esc_html__('ID', 'event_espresso') |
|
148 | - ), |
|
149 | - 'LIN_code' => new EE_Slug_Field( |
|
150 | - 'LIN_code', |
|
151 | - esc_html__('Code for index into Cart', 'event_espresso'), |
|
152 | - true |
|
153 | - ), |
|
154 | - 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
155 | - 'TXN_ID', |
|
156 | - esc_html__('Transaction ID', 'event_espresso'), |
|
157 | - true, |
|
158 | - null, |
|
159 | - 'Transaction' |
|
160 | - ), |
|
161 | - 'LIN_name' => new EE_Full_HTML_Field( |
|
162 | - 'LIN_name', |
|
163 | - esc_html__('Line Item Name', 'event_espresso'), |
|
164 | - false, |
|
165 | - '' |
|
166 | - ), |
|
167 | - 'LIN_desc' => new EE_Full_HTML_Field( |
|
168 | - 'LIN_desc', |
|
169 | - esc_html__('Line Item Description', 'event_espresso'), |
|
170 | - true |
|
171 | - ), |
|
172 | - 'LIN_unit_price' => new EE_Money_Field( |
|
173 | - 'LIN_unit_price', |
|
174 | - esc_html__('Unit Price', 'event_espresso'), |
|
175 | - false, |
|
176 | - 0 |
|
177 | - ), |
|
178 | - 'LIN_percent' => new EE_Float_Field( |
|
179 | - 'LIN_percent', |
|
180 | - esc_html__('Percent', 'event_espresso'), |
|
181 | - false, |
|
182 | - 0 |
|
183 | - ), |
|
184 | - 'LIN_is_taxable' => new EE_Boolean_Field( |
|
185 | - 'LIN_is_taxable', |
|
186 | - esc_html__('Taxable', 'event_espresso'), |
|
187 | - false, |
|
188 | - false |
|
189 | - ), |
|
190 | - 'LIN_order' => new EE_Integer_Field( |
|
191 | - 'LIN_order', |
|
192 | - esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
193 | - false, |
|
194 | - 1 |
|
195 | - ), |
|
196 | - 'LIN_total' => new EE_Money_Field( |
|
197 | - 'LIN_total', |
|
198 | - esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'), |
|
199 | - false, |
|
200 | - 0 |
|
201 | - ), |
|
202 | - 'LIN_pretax' => new EE_Money_Field( |
|
203 | - 'LIN_pretax', |
|
204 | - esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'), |
|
205 | - false, |
|
206 | - 0 |
|
207 | - ), |
|
208 | - 'LIN_quantity' => new EE_Integer_Field( |
|
209 | - 'LIN_quantity', |
|
210 | - esc_html__('Quantity', 'event_espresso'), |
|
211 | - true, |
|
212 | - 1 |
|
213 | - ), |
|
214 | - 'LIN_parent' => new EE_Integer_Field( |
|
215 | - 'LIN_parent', |
|
216 | - esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
217 | - true, |
|
218 | - null |
|
219 | - ), |
|
220 | - 'LIN_type' => new EE_Enum_Text_Field( |
|
221 | - 'LIN_type', |
|
222 | - esc_html__('Type', 'event_espresso'), |
|
223 | - false, |
|
224 | - 'line-item', |
|
225 | - array( |
|
226 | - self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
227 | - self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
228 | - self::type_sub_tax => esc_html__('Sub-Tax', 'event_espresso'), |
|
229 | - self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
230 | - self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
231 | - self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
232 | - self::type_total => esc_html__('Total', 'event_espresso'), |
|
233 | - self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
234 | - ) |
|
235 | - ), |
|
236 | - 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
237 | - 'OBJ_ID', |
|
238 | - esc_html__('ID of Item purchased.', 'event_espresso'), |
|
239 | - true, |
|
240 | - null, |
|
241 | - $line_items_can_be_for |
|
242 | - ), |
|
243 | - 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
244 | - 'OBJ_type', |
|
245 | - esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
246 | - true, |
|
247 | - null, |
|
248 | - $line_items_can_be_for |
|
249 | - ), |
|
250 | - 'LIN_timestamp' => new EE_Datetime_Field( |
|
251 | - 'LIN_timestamp', |
|
252 | - esc_html__('When the line item was created', 'event_espresso'), |
|
253 | - false, |
|
254 | - EE_Datetime_Field::now, |
|
255 | - $timezone |
|
256 | - ), |
|
257 | - ), |
|
258 | - ); |
|
259 | - $this->_model_relations = array( |
|
260 | - 'Transaction' => new EE_Belongs_To_Relation(), |
|
261 | - 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
262 | - 'Price' => new EE_Belongs_To_Any_Relation(), |
|
263 | - 'Event' => new EE_Belongs_To_Any_Relation(), |
|
264 | - ); |
|
265 | - $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
266 | - $this->_caps_slug = 'transactions'; |
|
267 | - parent::__construct($timezone); |
|
268 | - } |
|
269 | - |
|
270 | - |
|
271 | - /** |
|
272 | - * Gets all the line items for this transaction of the given type |
|
273 | - * |
|
274 | - * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
275 | - * @param EE_Transaction|int $transaction |
|
276 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
277 | - * @throws EE_Error |
|
278 | - * @throws InvalidArgumentException |
|
279 | - * @throws InvalidDataTypeException |
|
280 | - * @throws InvalidInterfaceException |
|
281 | - */ |
|
282 | - public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
283 | - { |
|
284 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
285 | - return $this->get_all(array( |
|
286 | - array( |
|
287 | - 'LIN_type' => $line_item_type, |
|
288 | - 'TXN_ID' => $transaction, |
|
289 | - ), |
|
290 | - )); |
|
291 | - } |
|
292 | - |
|
293 | - |
|
294 | - /** |
|
295 | - * Gets all line items unrelated to tickets that are normal line items |
|
296 | - * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
297 | - * |
|
298 | - * @param EE_Transaction|int $transaction |
|
299 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
300 | - * @throws EE_Error |
|
301 | - * @throws InvalidArgumentException |
|
302 | - * @throws InvalidDataTypeException |
|
303 | - * @throws InvalidInterfaceException |
|
304 | - */ |
|
305 | - public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
306 | - { |
|
307 | - $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
308 | - return $this->get_all(array( |
|
309 | - array( |
|
310 | - 'LIN_type' => self::type_line_item, |
|
311 | - 'TXN_ID' => $transaction, |
|
312 | - 'OR' => array( |
|
313 | - 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
314 | - 'OBJ_type*null' => array('IS_NULL'), |
|
315 | - ), |
|
316 | - ), |
|
317 | - )); |
|
318 | - } |
|
319 | - |
|
320 | - |
|
321 | - /** |
|
322 | - * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
323 | - * This needs to be very efficient |
|
324 | - * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when |
|
325 | - * deleting and joining tables like this. |
|
326 | - * |
|
327 | - * @return int count of how many deleted |
|
328 | - * @throws EE_Error |
|
329 | - * @throws InvalidArgumentException |
|
330 | - * @throws InvalidDataTypeException |
|
331 | - * @throws InvalidInterfaceException |
|
332 | - */ |
|
333 | - public function delete_line_items_with_no_transaction() |
|
334 | - { |
|
335 | - /** @type WPDB $wpdb */ |
|
336 | - global $wpdb; |
|
337 | - $time_to_leave_alone = apply_filters( |
|
338 | - 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
339 | - WEEK_IN_SECONDS |
|
340 | - ); |
|
341 | - $query = $wpdb->prepare( |
|
342 | - 'DELETE li |
|
30 | + /** |
|
31 | + * Tax sub-total is just the total of all the taxes, which should be children |
|
32 | + * of this line item. There should only ever be one tax sub-total, and it should |
|
33 | + * be a direct child of. Its quantity and LIN_unit_price = 1. |
|
34 | + */ |
|
35 | + const type_tax_sub_total = 'tax-sub-total'; |
|
36 | + |
|
37 | + /** |
|
38 | + * Tax line items indicate a tax applied to all the taxable line items. |
|
39 | + * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
40 | + * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
41 | + */ |
|
42 | + const type_tax = 'tax'; |
|
43 | + |
|
44 | + /** |
|
45 | + * Indicating individual items purchased, or discounts or surcharges. |
|
46 | + * The sum of all the regular line items plus the tax items should equal the grand total. |
|
47 | + * Possible children are sub-line-items and cancellations. |
|
48 | + * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children |
|
49 | + * LIN_totals. Its LIN_percent = 0. |
|
50 | + * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1). |
|
51 | + * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1. |
|
52 | + */ |
|
53 | + const type_line_item = 'line-item'; |
|
54 | + |
|
55 | + /** |
|
56 | + * Line item indicating all the factors that make a single line item. |
|
57 | + * Sub-line items should have NO children line items. |
|
58 | + * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's |
|
59 | + * contribution towards the price of ONE of their parent items, and its LIN_total should be |
|
60 | + * = LIN_quantity * LIN_unit_price. Its LIN_percent = 0. |
|
61 | + * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should |
|
62 | + * = LIN_percent / 100 * sum of lower-priority sibling line items.. |
|
63 | + */ |
|
64 | + const type_sub_line_item = 'sub-item'; |
|
65 | + |
|
66 | + /** |
|
67 | + * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item. |
|
68 | + * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal |
|
69 | + * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1. |
|
70 | + */ |
|
71 | + const type_sub_tax = 'sub-tax'; |
|
72 | + |
|
73 | + /** |
|
74 | + * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal). |
|
75 | + * Direct children should be event subtotals. |
|
76 | + * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals. |
|
77 | + */ |
|
78 | + const type_sub_total = 'sub-total'; |
|
79 | + |
|
80 | + /** |
|
81 | + * Line item for the grand total of an order. |
|
82 | + * Its direct children should be tax subtotals and (pre-tax) subtotals, |
|
83 | + * and possibly a regular line item indicating a transaction-wide discount/surcharge. |
|
84 | + * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount. |
|
85 | + */ |
|
86 | + const type_total = 'total'; |
|
87 | + |
|
88 | + /** |
|
89 | + * When a line item is cancelled, a sub-line-item of type 'cancellation' |
|
90 | + * should be created, indicating the quantity that were cancelled |
|
91 | + * (because a line item could have a quantity of 1, and its cancellation item |
|
92 | + * could be for 3, indicating that originally 4 were purchased, but 3 have been |
|
93 | + * cancelled, and only one remains). |
|
94 | + * When items are refunded, a cancellation line item should be made, which points |
|
95 | + * to teh payment model object which actually refunded the payment. |
|
96 | + * Cancellations should NOT have any children line items; the should NOT affect |
|
97 | + * any calculations, and are only meant as a record that cancellations have occurred. |
|
98 | + * Their LIN_percent should be 0. |
|
99 | + */ |
|
100 | + const type_cancellation = 'cancellation'; |
|
101 | + |
|
102 | + // various line item object types |
|
103 | + const OBJ_TYPE_EVENT = 'Event'; |
|
104 | + |
|
105 | + const OBJ_TYPE_PRICE = 'Price'; |
|
106 | + |
|
107 | + const OBJ_TYPE_PROMOTION = 'Promotion'; |
|
108 | + |
|
109 | + const OBJ_TYPE_TICKET = 'Ticket'; |
|
110 | + |
|
111 | + const OBJ_TYPE_TRANSACTION = 'Transaction'; |
|
112 | + |
|
113 | + /** |
|
114 | + * @var EEM_Line_Item $_instance |
|
115 | + */ |
|
116 | + protected static $_instance; |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * private constructor to prevent direct creation |
|
121 | + * |
|
122 | + * @Constructor |
|
123 | + * @param string $timezone string representing the timezone we want to set for returned Date Time Strings |
|
124 | + * (and any incoming timezone data that gets saved). |
|
125 | + * Note this just sends the timezone info to the date time model field objects. |
|
126 | + * Default is NULL |
|
127 | + * (and will be assumed using the set timezone in the 'timezone_string' wp option) |
|
128 | + * @throws EE_Error |
|
129 | + * @throws InvalidArgumentException |
|
130 | + */ |
|
131 | + protected function __construct($timezone) |
|
132 | + { |
|
133 | + $this->singular_item = esc_html__('Line Item', 'event_espresso'); |
|
134 | + $this->plural_item = esc_html__('Line Items', 'event_espresso'); |
|
135 | + |
|
136 | + $this->_tables = array( |
|
137 | + 'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'), |
|
138 | + ); |
|
139 | + $line_items_can_be_for = apply_filters( |
|
140 | + 'FHEE__EEM_Line_Item__line_items_can_be_for', |
|
141 | + array('Ticket', 'Price', 'Event') |
|
142 | + ); |
|
143 | + $this->_fields = array( |
|
144 | + 'Line_Item' => array( |
|
145 | + 'LIN_ID' => new EE_Primary_Key_Int_Field( |
|
146 | + 'LIN_ID', |
|
147 | + esc_html__('ID', 'event_espresso') |
|
148 | + ), |
|
149 | + 'LIN_code' => new EE_Slug_Field( |
|
150 | + 'LIN_code', |
|
151 | + esc_html__('Code for index into Cart', 'event_espresso'), |
|
152 | + true |
|
153 | + ), |
|
154 | + 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
155 | + 'TXN_ID', |
|
156 | + esc_html__('Transaction ID', 'event_espresso'), |
|
157 | + true, |
|
158 | + null, |
|
159 | + 'Transaction' |
|
160 | + ), |
|
161 | + 'LIN_name' => new EE_Full_HTML_Field( |
|
162 | + 'LIN_name', |
|
163 | + esc_html__('Line Item Name', 'event_espresso'), |
|
164 | + false, |
|
165 | + '' |
|
166 | + ), |
|
167 | + 'LIN_desc' => new EE_Full_HTML_Field( |
|
168 | + 'LIN_desc', |
|
169 | + esc_html__('Line Item Description', 'event_espresso'), |
|
170 | + true |
|
171 | + ), |
|
172 | + 'LIN_unit_price' => new EE_Money_Field( |
|
173 | + 'LIN_unit_price', |
|
174 | + esc_html__('Unit Price', 'event_espresso'), |
|
175 | + false, |
|
176 | + 0 |
|
177 | + ), |
|
178 | + 'LIN_percent' => new EE_Float_Field( |
|
179 | + 'LIN_percent', |
|
180 | + esc_html__('Percent', 'event_espresso'), |
|
181 | + false, |
|
182 | + 0 |
|
183 | + ), |
|
184 | + 'LIN_is_taxable' => new EE_Boolean_Field( |
|
185 | + 'LIN_is_taxable', |
|
186 | + esc_html__('Taxable', 'event_espresso'), |
|
187 | + false, |
|
188 | + false |
|
189 | + ), |
|
190 | + 'LIN_order' => new EE_Integer_Field( |
|
191 | + 'LIN_order', |
|
192 | + esc_html__('Order of Application towards total of parent', 'event_espresso'), |
|
193 | + false, |
|
194 | + 1 |
|
195 | + ), |
|
196 | + 'LIN_total' => new EE_Money_Field( |
|
197 | + 'LIN_total', |
|
198 | + esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'), |
|
199 | + false, |
|
200 | + 0 |
|
201 | + ), |
|
202 | + 'LIN_pretax' => new EE_Money_Field( |
|
203 | + 'LIN_pretax', |
|
204 | + esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'), |
|
205 | + false, |
|
206 | + 0 |
|
207 | + ), |
|
208 | + 'LIN_quantity' => new EE_Integer_Field( |
|
209 | + 'LIN_quantity', |
|
210 | + esc_html__('Quantity', 'event_espresso'), |
|
211 | + true, |
|
212 | + 1 |
|
213 | + ), |
|
214 | + 'LIN_parent' => new EE_Integer_Field( |
|
215 | + 'LIN_parent', |
|
216 | + esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'), |
|
217 | + true, |
|
218 | + null |
|
219 | + ), |
|
220 | + 'LIN_type' => new EE_Enum_Text_Field( |
|
221 | + 'LIN_type', |
|
222 | + esc_html__('Type', 'event_espresso'), |
|
223 | + false, |
|
224 | + 'line-item', |
|
225 | + array( |
|
226 | + self::type_line_item => esc_html__('Line Item', 'event_espresso'), |
|
227 | + self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'), |
|
228 | + self::type_sub_tax => esc_html__('Sub-Tax', 'event_espresso'), |
|
229 | + self::type_sub_total => esc_html__('Subtotal', 'event_espresso'), |
|
230 | + self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'), |
|
231 | + self::type_tax => esc_html__('Tax', 'event_espresso'), |
|
232 | + self::type_total => esc_html__('Total', 'event_espresso'), |
|
233 | + self::type_cancellation => esc_html__('Cancellation', 'event_espresso'), |
|
234 | + ) |
|
235 | + ), |
|
236 | + 'OBJ_ID' => new EE_Foreign_Key_Int_Field( |
|
237 | + 'OBJ_ID', |
|
238 | + esc_html__('ID of Item purchased.', 'event_espresso'), |
|
239 | + true, |
|
240 | + null, |
|
241 | + $line_items_can_be_for |
|
242 | + ), |
|
243 | + 'OBJ_type' => new EE_Any_Foreign_Model_Name_Field( |
|
244 | + 'OBJ_type', |
|
245 | + esc_html__('Model Name this Line Item is for', 'event_espresso'), |
|
246 | + true, |
|
247 | + null, |
|
248 | + $line_items_can_be_for |
|
249 | + ), |
|
250 | + 'LIN_timestamp' => new EE_Datetime_Field( |
|
251 | + 'LIN_timestamp', |
|
252 | + esc_html__('When the line item was created', 'event_espresso'), |
|
253 | + false, |
|
254 | + EE_Datetime_Field::now, |
|
255 | + $timezone |
|
256 | + ), |
|
257 | + ), |
|
258 | + ); |
|
259 | + $this->_model_relations = array( |
|
260 | + 'Transaction' => new EE_Belongs_To_Relation(), |
|
261 | + 'Ticket' => new EE_Belongs_To_Any_Relation(), |
|
262 | + 'Price' => new EE_Belongs_To_Any_Relation(), |
|
263 | + 'Event' => new EE_Belongs_To_Any_Relation(), |
|
264 | + ); |
|
265 | + $this->_model_chain_to_wp_user = 'Transaction.Registration.Event'; |
|
266 | + $this->_caps_slug = 'transactions'; |
|
267 | + parent::__construct($timezone); |
|
268 | + } |
|
269 | + |
|
270 | + |
|
271 | + /** |
|
272 | + * Gets all the line items for this transaction of the given type |
|
273 | + * |
|
274 | + * @param string $line_item_type like one of EEM_Line_Item::type_* |
|
275 | + * @param EE_Transaction|int $transaction |
|
276 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
277 | + * @throws EE_Error |
|
278 | + * @throws InvalidArgumentException |
|
279 | + * @throws InvalidDataTypeException |
|
280 | + * @throws InvalidInterfaceException |
|
281 | + */ |
|
282 | + public function get_all_of_type_for_transaction($line_item_type, $transaction) |
|
283 | + { |
|
284 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
285 | + return $this->get_all(array( |
|
286 | + array( |
|
287 | + 'LIN_type' => $line_item_type, |
|
288 | + 'TXN_ID' => $transaction, |
|
289 | + ), |
|
290 | + )); |
|
291 | + } |
|
292 | + |
|
293 | + |
|
294 | + /** |
|
295 | + * Gets all line items unrelated to tickets that are normal line items |
|
296 | + * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category) |
|
297 | + * |
|
298 | + * @param EE_Transaction|int $transaction |
|
299 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
300 | + * @throws EE_Error |
|
301 | + * @throws InvalidArgumentException |
|
302 | + * @throws InvalidDataTypeException |
|
303 | + * @throws InvalidInterfaceException |
|
304 | + */ |
|
305 | + public function get_all_non_ticket_line_items_for_transaction($transaction) |
|
306 | + { |
|
307 | + $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction); |
|
308 | + return $this->get_all(array( |
|
309 | + array( |
|
310 | + 'LIN_type' => self::type_line_item, |
|
311 | + 'TXN_ID' => $transaction, |
|
312 | + 'OR' => array( |
|
313 | + 'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET), |
|
314 | + 'OBJ_type*null' => array('IS_NULL'), |
|
315 | + ), |
|
316 | + ), |
|
317 | + )); |
|
318 | + } |
|
319 | + |
|
320 | + |
|
321 | + /** |
|
322 | + * Deletes line items with no transaction who have passed the transaction cutoff time. |
|
323 | + * This needs to be very efficient |
|
324 | + * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when |
|
325 | + * deleting and joining tables like this. |
|
326 | + * |
|
327 | + * @return int count of how many deleted |
|
328 | + * @throws EE_Error |
|
329 | + * @throws InvalidArgumentException |
|
330 | + * @throws InvalidDataTypeException |
|
331 | + * @throws InvalidInterfaceException |
|
332 | + */ |
|
333 | + public function delete_line_items_with_no_transaction() |
|
334 | + { |
|
335 | + /** @type WPDB $wpdb */ |
|
336 | + global $wpdb; |
|
337 | + $time_to_leave_alone = apply_filters( |
|
338 | + 'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', |
|
339 | + WEEK_IN_SECONDS |
|
340 | + ); |
|
341 | + $query = $wpdb->prepare( |
|
342 | + 'DELETE li |
|
343 | 343 | FROM ' . $this->table() . ' li |
344 | 344 | LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID |
345 | 345 | WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s', |
346 | - // use GMT time because that's what TXN_timestamps are in |
|
347 | - date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
348 | - ); |
|
349 | - return $wpdb->query($query); |
|
350 | - } |
|
351 | - |
|
352 | - |
|
353 | - /** |
|
354 | - * get_line_item_for_transaction_object |
|
355 | - * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
356 | - * |
|
357 | - * @param int $TXN_ID |
|
358 | - * @param EE_Base_Class $object |
|
359 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
360 | - * @throws EE_Error |
|
361 | - * @throws InvalidArgumentException |
|
362 | - * @throws InvalidDataTypeException |
|
363 | - * @throws InvalidInterfaceException |
|
364 | - * @throws ReflectionException |
|
365 | - */ |
|
366 | - public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
367 | - { |
|
368 | - return $this->get_all(array( |
|
369 | - array( |
|
370 | - 'TXN_ID' => $TXN_ID, |
|
371 | - 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
372 | - 'OBJ_ID' => $object->ID(), |
|
373 | - ), |
|
374 | - )); |
|
375 | - } |
|
376 | - |
|
377 | - |
|
378 | - /** |
|
379 | - * get_object_line_items_for_transaction |
|
380 | - * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
381 | - * |
|
382 | - * @param int $TXN_ID |
|
383 | - * @param string $OBJ_type |
|
384 | - * @param array $OBJ_IDs |
|
385 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
386 | - * @throws EE_Error |
|
387 | - */ |
|
388 | - public function get_object_line_items_for_transaction( |
|
389 | - $TXN_ID, |
|
390 | - $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
391 | - $OBJ_IDs = array() |
|
392 | - ) { |
|
393 | - $query_params = array( |
|
394 | - 'OBJ_type' => $OBJ_type, |
|
395 | - // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
396 | - 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
397 | - ); |
|
398 | - if ($TXN_ID) { |
|
399 | - $query_params['TXN_ID'] = $TXN_ID; |
|
400 | - } |
|
401 | - return $this->get_all(array($query_params)); |
|
402 | - } |
|
403 | - |
|
404 | - |
|
405 | - /** |
|
406 | - * get_all_ticket_line_items_for_transaction |
|
407 | - * |
|
408 | - * @param EE_Transaction $transaction |
|
409 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
410 | - * @throws EE_Error |
|
411 | - * @throws InvalidArgumentException |
|
412 | - * @throws InvalidDataTypeException |
|
413 | - * @throws InvalidInterfaceException |
|
414 | - * @throws ReflectionException |
|
415 | - */ |
|
416 | - public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
417 | - { |
|
418 | - return $this->get_all(array( |
|
419 | - array( |
|
420 | - 'TXN_ID' => $transaction->ID(), |
|
421 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
422 | - ), |
|
423 | - )); |
|
424 | - } |
|
425 | - |
|
426 | - |
|
427 | - /** |
|
428 | - * get_ticket_line_item_for_transaction |
|
429 | - * |
|
430 | - * @param int $TXN_ID |
|
431 | - * @param int $TKT_ID |
|
432 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
433 | - * @throws EE_Error |
|
434 | - * @throws InvalidArgumentException |
|
435 | - * @throws InvalidDataTypeException |
|
436 | - * @throws InvalidInterfaceException |
|
437 | - */ |
|
438 | - public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
439 | - { |
|
440 | - return $this->get_one(array( |
|
441 | - array( |
|
442 | - 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
443 | - 'OBJ_ID' => $TKT_ID, |
|
444 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
445 | - ), |
|
446 | - )); |
|
447 | - } |
|
448 | - |
|
449 | - |
|
450 | - /** |
|
451 | - * get_existing_promotion_line_item |
|
452 | - * searches the cart for existing line items for the specified promotion |
|
453 | - * |
|
454 | - * @since 1.0.0 |
|
455 | - * @param EE_Line_Item $parent_line_item |
|
456 | - * @param EE_Promotion $promotion |
|
457 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
458 | - * @throws EE_Error |
|
459 | - * @throws InvalidArgumentException |
|
460 | - * @throws InvalidDataTypeException |
|
461 | - * @throws InvalidInterfaceException |
|
462 | - * @throws ReflectionException |
|
463 | - */ |
|
464 | - public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
465 | - { |
|
466 | - return $this->get_one(array( |
|
467 | - array( |
|
468 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
469 | - 'LIN_parent' => $parent_line_item->ID(), |
|
470 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
471 | - 'OBJ_ID' => $promotion->ID(), |
|
472 | - ), |
|
473 | - )); |
|
474 | - } |
|
475 | - |
|
476 | - |
|
477 | - /** |
|
478 | - * get_all_promotion_line_items |
|
479 | - * searches the cart for any and all existing promotion line items |
|
480 | - * |
|
481 | - * @since 1.0.0 |
|
482 | - * @param EE_Line_Item $parent_line_item |
|
483 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
484 | - * @throws EE_Error |
|
485 | - * @throws InvalidArgumentException |
|
486 | - * @throws InvalidDataTypeException |
|
487 | - * @throws InvalidInterfaceException |
|
488 | - * @throws ReflectionException |
|
489 | - */ |
|
490 | - public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
491 | - { |
|
492 | - return $this->get_all(array( |
|
493 | - array( |
|
494 | - 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
495 | - 'LIN_parent' => $parent_line_item->ID(), |
|
496 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
497 | - ), |
|
498 | - )); |
|
499 | - } |
|
500 | - |
|
501 | - |
|
502 | - /** |
|
503 | - * Gets the registration's corresponding line item. |
|
504 | - * Note: basically does NOT support having multiple line items for a single ticket, |
|
505 | - * which would happen if some of the registrations had a price modifier while others didn't. |
|
506 | - * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
507 | - * |
|
508 | - * @param EE_Registration $registration |
|
509 | - * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
510 | - * @throws EE_Error |
|
511 | - */ |
|
512 | - public function get_line_item_for_registration(EE_Registration $registration) |
|
513 | - { |
|
514 | - return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
515 | - } |
|
516 | - |
|
517 | - |
|
518 | - /** |
|
519 | - * Gets the query params used to retrieve a specific line item for the given registration |
|
520 | - * |
|
521 | - * @param EE_Registration $registration |
|
522 | - * @param array $original_query_params any extra query params you'd like to be merged with |
|
523 | - * @return array @see |
|
524 | - * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
525 | - * @throws EE_Error |
|
526 | - */ |
|
527 | - public function line_item_for_registration_query_params( |
|
528 | - EE_Registration $registration, |
|
529 | - $original_query_params = array() |
|
530 | - ) { |
|
531 | - return array_replace_recursive($original_query_params, array( |
|
532 | - array( |
|
533 | - 'OBJ_ID' => $registration->ticket_ID(), |
|
534 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
535 | - 'TXN_ID' => $registration->transaction_ID(), |
|
536 | - ), |
|
537 | - )); |
|
538 | - } |
|
539 | - |
|
540 | - |
|
541 | - /** |
|
542 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
543 | - * @throws InvalidInterfaceException |
|
544 | - * @throws InvalidDataTypeException |
|
545 | - * @throws EE_Error |
|
546 | - * @throws InvalidArgumentException |
|
547 | - */ |
|
548 | - public function get_total_line_items_with_no_transaction() |
|
549 | - { |
|
550 | - return $this->get_total_line_items_for_carts(); |
|
551 | - } |
|
552 | - |
|
553 | - |
|
554 | - /** |
|
555 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
556 | - * @throws InvalidInterfaceException |
|
557 | - * @throws InvalidDataTypeException |
|
558 | - * @throws EE_Error |
|
559 | - * @throws InvalidArgumentException |
|
560 | - */ |
|
561 | - public function get_total_line_items_for_active_carts() |
|
562 | - { |
|
563 | - return $this->get_total_line_items_for_carts(false); |
|
564 | - } |
|
565 | - |
|
566 | - |
|
567 | - /** |
|
568 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
569 | - * @throws InvalidInterfaceException |
|
570 | - * @throws InvalidDataTypeException |
|
571 | - * @throws EE_Error |
|
572 | - * @throws InvalidArgumentException |
|
573 | - */ |
|
574 | - public function get_total_line_items_for_expired_carts() |
|
575 | - { |
|
576 | - return $this->get_total_line_items_for_carts(true); |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - /** |
|
581 | - * Returns an array of grand total line items where the TXN_ID is 0. |
|
582 | - * If $expired is set to true, then only line items for expired sessions will be returned. |
|
583 | - * If $expired is set to false, then only line items for active sessions will be returned. |
|
584 | - * |
|
585 | - * @param null $expired |
|
586 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
587 | - * @throws EE_Error |
|
588 | - * @throws InvalidArgumentException |
|
589 | - * @throws InvalidDataTypeException |
|
590 | - * @throws InvalidInterfaceException |
|
591 | - */ |
|
592 | - private function get_total_line_items_for_carts($expired = null) |
|
593 | - { |
|
594 | - $where_params = array( |
|
595 | - 'TXN_ID' => 0, |
|
596 | - 'LIN_type' => 'total', |
|
597 | - ); |
|
598 | - if ($expired !== null) { |
|
599 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
600 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
601 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
602 | - ); |
|
603 | - $where_params['LIN_timestamp'] = array( |
|
604 | - $expired ? '<=' : '>', |
|
605 | - $session_lifespan->expiration(), |
|
606 | - ); |
|
607 | - } |
|
608 | - return $this->get_all(array($where_params)); |
|
609 | - } |
|
610 | - |
|
611 | - |
|
612 | - /** |
|
613 | - * Returns an array of ticket total line items where the TXN_ID is 0 |
|
614 | - * AND the timestamp is older than the session lifespan. |
|
615 | - * |
|
616 | - * @param int $timestamp |
|
617 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
618 | - * @throws EE_Error |
|
619 | - * @throws InvalidArgumentException |
|
620 | - * @throws InvalidDataTypeException |
|
621 | - * @throws InvalidInterfaceException |
|
622 | - */ |
|
623 | - public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
624 | - { |
|
625 | - if (! absint($timestamp)) { |
|
626 | - /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
627 | - $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
628 | - 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
629 | - ); |
|
630 | - $timestamp = $session_lifespan->expiration(); |
|
631 | - } |
|
632 | - return $this->get_all( |
|
633 | - array( |
|
634 | - array( |
|
635 | - 'TXN_ID' => 0, |
|
636 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
637 | - 'LIN_timestamp' => array('<=', $timestamp), |
|
638 | - ), |
|
639 | - ) |
|
640 | - ); |
|
641 | - } |
|
346 | + // use GMT time because that's what TXN_timestamps are in |
|
347 | + date('Y-m-d H:i:s', time() - $time_to_leave_alone) |
|
348 | + ); |
|
349 | + return $wpdb->query($query); |
|
350 | + } |
|
351 | + |
|
352 | + |
|
353 | + /** |
|
354 | + * get_line_item_for_transaction_object |
|
355 | + * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket |
|
356 | + * |
|
357 | + * @param int $TXN_ID |
|
358 | + * @param EE_Base_Class $object |
|
359 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
360 | + * @throws EE_Error |
|
361 | + * @throws InvalidArgumentException |
|
362 | + * @throws InvalidDataTypeException |
|
363 | + * @throws InvalidInterfaceException |
|
364 | + * @throws ReflectionException |
|
365 | + */ |
|
366 | + public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) |
|
367 | + { |
|
368 | + return $this->get_all(array( |
|
369 | + array( |
|
370 | + 'TXN_ID' => $TXN_ID, |
|
371 | + 'OBJ_type' => str_replace('EE_', '', get_class($object)), |
|
372 | + 'OBJ_ID' => $object->ID(), |
|
373 | + ), |
|
374 | + )); |
|
375 | + } |
|
376 | + |
|
377 | + |
|
378 | + /** |
|
379 | + * get_object_line_items_for_transaction |
|
380 | + * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs |
|
381 | + * |
|
382 | + * @param int $TXN_ID |
|
383 | + * @param string $OBJ_type |
|
384 | + * @param array $OBJ_IDs |
|
385 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
386 | + * @throws EE_Error |
|
387 | + */ |
|
388 | + public function get_object_line_items_for_transaction( |
|
389 | + $TXN_ID, |
|
390 | + $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT, |
|
391 | + $OBJ_IDs = array() |
|
392 | + ) { |
|
393 | + $query_params = array( |
|
394 | + 'OBJ_type' => $OBJ_type, |
|
395 | + // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query |
|
396 | + 'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs, |
|
397 | + ); |
|
398 | + if ($TXN_ID) { |
|
399 | + $query_params['TXN_ID'] = $TXN_ID; |
|
400 | + } |
|
401 | + return $this->get_all(array($query_params)); |
|
402 | + } |
|
403 | + |
|
404 | + |
|
405 | + /** |
|
406 | + * get_all_ticket_line_items_for_transaction |
|
407 | + * |
|
408 | + * @param EE_Transaction $transaction |
|
409 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
410 | + * @throws EE_Error |
|
411 | + * @throws InvalidArgumentException |
|
412 | + * @throws InvalidDataTypeException |
|
413 | + * @throws InvalidInterfaceException |
|
414 | + * @throws ReflectionException |
|
415 | + */ |
|
416 | + public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) |
|
417 | + { |
|
418 | + return $this->get_all(array( |
|
419 | + array( |
|
420 | + 'TXN_ID' => $transaction->ID(), |
|
421 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
422 | + ), |
|
423 | + )); |
|
424 | + } |
|
425 | + |
|
426 | + |
|
427 | + /** |
|
428 | + * get_ticket_line_item_for_transaction |
|
429 | + * |
|
430 | + * @param int $TXN_ID |
|
431 | + * @param int $TKT_ID |
|
432 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
433 | + * @throws EE_Error |
|
434 | + * @throws InvalidArgumentException |
|
435 | + * @throws InvalidDataTypeException |
|
436 | + * @throws InvalidInterfaceException |
|
437 | + */ |
|
438 | + public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) |
|
439 | + { |
|
440 | + return $this->get_one(array( |
|
441 | + array( |
|
442 | + 'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID), |
|
443 | + 'OBJ_ID' => $TKT_ID, |
|
444 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
445 | + ), |
|
446 | + )); |
|
447 | + } |
|
448 | + |
|
449 | + |
|
450 | + /** |
|
451 | + * get_existing_promotion_line_item |
|
452 | + * searches the cart for existing line items for the specified promotion |
|
453 | + * |
|
454 | + * @since 1.0.0 |
|
455 | + * @param EE_Line_Item $parent_line_item |
|
456 | + * @param EE_Promotion $promotion |
|
457 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
458 | + * @throws EE_Error |
|
459 | + * @throws InvalidArgumentException |
|
460 | + * @throws InvalidDataTypeException |
|
461 | + * @throws InvalidInterfaceException |
|
462 | + * @throws ReflectionException |
|
463 | + */ |
|
464 | + public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) |
|
465 | + { |
|
466 | + return $this->get_one(array( |
|
467 | + array( |
|
468 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
469 | + 'LIN_parent' => $parent_line_item->ID(), |
|
470 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
471 | + 'OBJ_ID' => $promotion->ID(), |
|
472 | + ), |
|
473 | + )); |
|
474 | + } |
|
475 | + |
|
476 | + |
|
477 | + /** |
|
478 | + * get_all_promotion_line_items |
|
479 | + * searches the cart for any and all existing promotion line items |
|
480 | + * |
|
481 | + * @since 1.0.0 |
|
482 | + * @param EE_Line_Item $parent_line_item |
|
483 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
484 | + * @throws EE_Error |
|
485 | + * @throws InvalidArgumentException |
|
486 | + * @throws InvalidDataTypeException |
|
487 | + * @throws InvalidInterfaceException |
|
488 | + * @throws ReflectionException |
|
489 | + */ |
|
490 | + public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) |
|
491 | + { |
|
492 | + return $this->get_all(array( |
|
493 | + array( |
|
494 | + 'TXN_ID' => $parent_line_item->TXN_ID(), |
|
495 | + 'LIN_parent' => $parent_line_item->ID(), |
|
496 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PROMOTION, |
|
497 | + ), |
|
498 | + )); |
|
499 | + } |
|
500 | + |
|
501 | + |
|
502 | + /** |
|
503 | + * Gets the registration's corresponding line item. |
|
504 | + * Note: basically does NOT support having multiple line items for a single ticket, |
|
505 | + * which would happen if some of the registrations had a price modifier while others didn't. |
|
506 | + * In order to support that, we'd probably need a LIN_ID on registrations or something. |
|
507 | + * |
|
508 | + * @param EE_Registration $registration |
|
509 | + * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL |
|
510 | + * @throws EE_Error |
|
511 | + */ |
|
512 | + public function get_line_item_for_registration(EE_Registration $registration) |
|
513 | + { |
|
514 | + return $this->get_one($this->line_item_for_registration_query_params($registration)); |
|
515 | + } |
|
516 | + |
|
517 | + |
|
518 | + /** |
|
519 | + * Gets the query params used to retrieve a specific line item for the given registration |
|
520 | + * |
|
521 | + * @param EE_Registration $registration |
|
522 | + * @param array $original_query_params any extra query params you'd like to be merged with |
|
523 | + * @return array @see |
|
524 | + * https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
525 | + * @throws EE_Error |
|
526 | + */ |
|
527 | + public function line_item_for_registration_query_params( |
|
528 | + EE_Registration $registration, |
|
529 | + $original_query_params = array() |
|
530 | + ) { |
|
531 | + return array_replace_recursive($original_query_params, array( |
|
532 | + array( |
|
533 | + 'OBJ_ID' => $registration->ticket_ID(), |
|
534 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
535 | + 'TXN_ID' => $registration->transaction_ID(), |
|
536 | + ), |
|
537 | + )); |
|
538 | + } |
|
539 | + |
|
540 | + |
|
541 | + /** |
|
542 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
543 | + * @throws InvalidInterfaceException |
|
544 | + * @throws InvalidDataTypeException |
|
545 | + * @throws EE_Error |
|
546 | + * @throws InvalidArgumentException |
|
547 | + */ |
|
548 | + public function get_total_line_items_with_no_transaction() |
|
549 | + { |
|
550 | + return $this->get_total_line_items_for_carts(); |
|
551 | + } |
|
552 | + |
|
553 | + |
|
554 | + /** |
|
555 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
556 | + * @throws InvalidInterfaceException |
|
557 | + * @throws InvalidDataTypeException |
|
558 | + * @throws EE_Error |
|
559 | + * @throws InvalidArgumentException |
|
560 | + */ |
|
561 | + public function get_total_line_items_for_active_carts() |
|
562 | + { |
|
563 | + return $this->get_total_line_items_for_carts(false); |
|
564 | + } |
|
565 | + |
|
566 | + |
|
567 | + /** |
|
568 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
569 | + * @throws InvalidInterfaceException |
|
570 | + * @throws InvalidDataTypeException |
|
571 | + * @throws EE_Error |
|
572 | + * @throws InvalidArgumentException |
|
573 | + */ |
|
574 | + public function get_total_line_items_for_expired_carts() |
|
575 | + { |
|
576 | + return $this->get_total_line_items_for_carts(true); |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + /** |
|
581 | + * Returns an array of grand total line items where the TXN_ID is 0. |
|
582 | + * If $expired is set to true, then only line items for expired sessions will be returned. |
|
583 | + * If $expired is set to false, then only line items for active sessions will be returned. |
|
584 | + * |
|
585 | + * @param null $expired |
|
586 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
587 | + * @throws EE_Error |
|
588 | + * @throws InvalidArgumentException |
|
589 | + * @throws InvalidDataTypeException |
|
590 | + * @throws InvalidInterfaceException |
|
591 | + */ |
|
592 | + private function get_total_line_items_for_carts($expired = null) |
|
593 | + { |
|
594 | + $where_params = array( |
|
595 | + 'TXN_ID' => 0, |
|
596 | + 'LIN_type' => 'total', |
|
597 | + ); |
|
598 | + if ($expired !== null) { |
|
599 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
600 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
601 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
602 | + ); |
|
603 | + $where_params['LIN_timestamp'] = array( |
|
604 | + $expired ? '<=' : '>', |
|
605 | + $session_lifespan->expiration(), |
|
606 | + ); |
|
607 | + } |
|
608 | + return $this->get_all(array($where_params)); |
|
609 | + } |
|
610 | + |
|
611 | + |
|
612 | + /** |
|
613 | + * Returns an array of ticket total line items where the TXN_ID is 0 |
|
614 | + * AND the timestamp is older than the session lifespan. |
|
615 | + * |
|
616 | + * @param int $timestamp |
|
617 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
618 | + * @throws EE_Error |
|
619 | + * @throws InvalidArgumentException |
|
620 | + * @throws InvalidDataTypeException |
|
621 | + * @throws InvalidInterfaceException |
|
622 | + */ |
|
623 | + public function getTicketLineItemsForExpiredCarts($timestamp = 0) |
|
624 | + { |
|
625 | + if (! absint($timestamp)) { |
|
626 | + /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */ |
|
627 | + $session_lifespan = LoaderFactory::getLoader()->getShared( |
|
628 | + 'EventEspresso\core\domain\values\session\SessionLifespan' |
|
629 | + ); |
|
630 | + $timestamp = $session_lifespan->expiration(); |
|
631 | + } |
|
632 | + return $this->get_all( |
|
633 | + array( |
|
634 | + array( |
|
635 | + 'TXN_ID' => 0, |
|
636 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
637 | + 'LIN_timestamp' => array('<=', $timestamp), |
|
638 | + ), |
|
639 | + ) |
|
640 | + ); |
|
641 | + } |
|
642 | 642 | } |
@@ -1,8 +1,8 @@ |
||
1 | 1 | <div class="padding"> |
2 | 2 | <p><?php |
3 | - printf( |
|
4 | - esc_html__('Check out the %1$sroadmap for Event Espresso%2$s.', 'event_espresso'), |
|
5 | - '<a href="https://trello.com/b/zg9DCIpe/event-espresso-public-roadmap" target="_blank" rel="noopener noreferrer">', |
|
6 | - '</a>' |
|
7 | - ); ?></p> |
|
3 | + printf( |
|
4 | + esc_html__('Check out the %1$sroadmap for Event Espresso%2$s.', 'event_espresso'), |
|
5 | + '<a href="https://trello.com/b/zg9DCIpe/event-espresso-public-roadmap" target="_blank" rel="noopener noreferrer">', |
|
6 | + '</a>' |
|
7 | + ); ?></p> |
|
8 | 8 | </div> |
9 | 9 | \ No newline at end of file |
@@ -1,93 +1,93 @@ |
||
1 | 1 | <div class="padding"> |
2 | 2 | <?php esc_html_e( |
3 | - 'If you want to integrate with Event Espresso or participate in building code, then you are in the right place. The following resources can help you get started.', |
|
4 | - 'event_espresso' |
|
5 | - ); ?> |
|
3 | + 'If you want to integrate with Event Espresso or participate in building code, then you are in the right place. The following resources can help you get started.', |
|
4 | + 'event_espresso' |
|
5 | + ); ?> |
|
6 | 6 | <h2><?php esc_html_e('Developer Resources', 'event_espresso'); ?></h2> |
7 | 7 | <ul> |
8 | 8 | <li> |
9 | 9 | <?php printf( |
10 | - esc_html__('%1$sEvent Espresso 4 Developer Documentation%2$s', 'event_espresso'), |
|
11 | - '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs#getting-started-with-the-ee-developer-docs" target="_blank" rel="noopener noreferrer">', |
|
12 | - '</a>' |
|
13 | - ); ?></li> |
|
10 | + esc_html__('%1$sEvent Espresso 4 Developer Documentation%2$s', 'event_espresso'), |
|
11 | + '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs#getting-started-with-the-ee-developer-docs" target="_blank" rel="noopener noreferrer">', |
|
12 | + '</a>' |
|
13 | + ); ?></li> |
|
14 | 14 | <li> |
15 | 15 | <?php printf( |
16 | - esc_html__('%1$sEvent Espresso 4 Developer News%2$s', 'event_espresso'), |
|
17 | - '<a href="http://developer.eventespresso.com/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
18 | - '</a>' |
|
19 | - ); ?></li> |
|
16 | + esc_html__('%1$sEvent Espresso 4 Developer News%2$s', 'event_espresso'), |
|
17 | + '<a href="http://developer.eventespresso.com/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
18 | + '</a>' |
|
19 | + ); ?></li> |
|
20 | 20 | <li> |
21 | 21 | <?php printf( |
22 | - esc_html__('%1$sApply%2$s to be listed as an %3$sEvent Espresso Professional%2$s', 'event_espresso'), |
|
23 | - '<a href="https://eventespresso.com/developers/event-espresso-pros-application/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
24 | - '</a>', |
|
25 | - '<a href="https://eventespresso.com/developers/event-espresso-pros/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">' |
|
26 | - ); ?></li> |
|
22 | + esc_html__('%1$sApply%2$s to be listed as an %3$sEvent Espresso Professional%2$s', 'event_espresso'), |
|
23 | + '<a href="https://eventespresso.com/developers/event-espresso-pros-application/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
24 | + '</a>', |
|
25 | + '<a href="https://eventespresso.com/developers/event-espresso-pros/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">' |
|
26 | + ); ?></li> |
|
27 | 27 | </ul> |
28 | 28 | |
29 | 29 | <h2><?php esc_html_e('Event Espresso 4 Articles for Developers', 'event_espresso'); ?></h2> |
30 | 30 | <ul> |
31 | 31 | <li> |
32 | 32 | <?php printf( |
33 | - esc_html__('%1$sCustom Post Types Usage%2$s', 'event_espresso'), |
|
34 | - '<a href="https://eventespresso.com/2014/02/epsresso-brewery-custom-post-types-event-espresso/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
35 | - '</a>' |
|
36 | - ); ?></li> |
|
33 | + esc_html__('%1$sCustom Post Types Usage%2$s', 'event_espresso'), |
|
34 | + '<a href="https://eventespresso.com/2014/02/epsresso-brewery-custom-post-types-event-espresso/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
35 | + '</a>' |
|
36 | + ); ?></li> |
|
37 | 37 | <li> |
38 | 38 | <?php printf( |
39 | - esc_html__('%1$sTheme Development%2$s', 'event_espresso'), |
|
40 | - '<a href="https://eventespresso.com/2014/02/developers-corner-theming-event-espresso-4/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
41 | - '</a>' |
|
42 | - ); ?></li> |
|
39 | + esc_html__('%1$sTheme Development%2$s', 'event_espresso'), |
|
40 | + '<a href="https://eventespresso.com/2014/02/developers-corner-theming-event-espresso-4/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
41 | + '</a>' |
|
42 | + ); ?></li> |
|
43 | 43 | <li> |
44 | 44 | <?php printf( |
45 | - esc_html__('%1$sCapability System%2$s', 'event_espresso'), |
|
46 | - '<a href="http://developer.eventespresso.com/docs/ee-capability-system-overview/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
47 | - '</a>' |
|
48 | - ); ?></li> |
|
45 | + esc_html__('%1$sCapability System%2$s', 'event_espresso'), |
|
46 | + '<a href="http://developer.eventespresso.com/docs/ee-capability-system-overview/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
47 | + '</a>' |
|
48 | + ); ?></li> |
|
49 | 49 | <li> |
50 | 50 | <?php printf( |
51 | - esc_html__('%1$sPayment Method Development%2$s', 'event_espresso'), |
|
52 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/L--Payment-Methods-and-Gateways/creating-a-payment-method.md" target="_blank" rel="noopener noreferrer">', |
|
53 | - '</a>' |
|
54 | - ); ?></li> |
|
51 | + esc_html__('%1$sPayment Method Development%2$s', 'event_espresso'), |
|
52 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/L--Payment-Methods-and-Gateways/creating-a-payment-method.md" target="_blank" rel="noopener noreferrer">', |
|
53 | + '</a>' |
|
54 | + ); ?></li> |
|
55 | 55 | <li> |
56 | 56 | <?php printf( |
57 | - esc_html__('%1$sMessages System in Event Espresso 4%2$s', 'event_espresso'), |
|
58 | - '<a href="https://eventespresso.com/2014/03/messages-systemyour-tool-getting-word/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
59 | - '</a>' |
|
60 | - ); ?></li> |
|
57 | + esc_html__('%1$sMessages System in Event Espresso 4%2$s', 'event_espresso'), |
|
58 | + '<a href="https://eventespresso.com/2014/03/messages-systemyour-tool-getting-word/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
59 | + '</a>' |
|
60 | + ); ?></li> |
|
61 | 61 | <li> |
62 | 62 | <?php printf( |
63 | - esc_html__( |
|
64 | - '%1$sDatabase Model System%2$s (used for interfacing with EE4 data via WordPress plugins and server side querying)', |
|
65 | - 'event_espresso' |
|
66 | - ), |
|
67 | - '<a href="http://developer.eventespresso.com/docs/using-ee4-model-objects/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
68 | - '</a>' |
|
69 | - ); ?></li> |
|
63 | + esc_html__( |
|
64 | + '%1$sDatabase Model System%2$s (used for interfacing with EE4 data via WordPress plugins and server side querying)', |
|
65 | + 'event_espresso' |
|
66 | + ), |
|
67 | + '<a href="http://developer.eventespresso.com/docs/using-ee4-model-objects/?ee_ver=ee4&utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=ee_support_page&utm_content=developers_tab" target="_blank">', |
|
68 | + '</a>' |
|
69 | + ); ?></li> |
|
70 | 70 | </ul> |
71 | 71 | |
72 | 72 | <h2><?php esc_html_e('REST API Resources', 'event_espresso'); ?></h2> |
73 | 73 | <ul> |
74 | 74 | <li> |
75 | 75 | <?php printf( |
76 | - esc_html__('%1$sREST API: Introduction%2$s', 'event_espresso'), |
|
77 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-introduction.md" target="_blank" rel="noopener noreferrer">', |
|
78 | - '</a>' |
|
79 | - ); ?></li> |
|
76 | + esc_html__('%1$sREST API: Introduction%2$s', 'event_espresso'), |
|
77 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-introduction.md" target="_blank" rel="noopener noreferrer">', |
|
78 | + '</a>' |
|
79 | + ); ?></li> |
|
80 | 80 | <li> |
81 | 81 | <?php printf( |
82 | - esc_html__('%1$sREST API: Reading Data%2$s', 'event_espresso'), |
|
83 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-reading-data.md" target="_blank" rel="noopener noreferrer">', |
|
84 | - '</a>' |
|
85 | - ); ?></li> |
|
82 | + esc_html__('%1$sREST API: Reading Data%2$s', 'event_espresso'), |
|
83 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/C--REST-API/ee4-rest-api-reading-data.md" target="_blank" rel="noopener noreferrer">', |
|
84 | + '</a>' |
|
85 | + ); ?></li> |
|
86 | 86 | <li> |
87 | 87 | <?php printf( |
88 | - esc_html__('%1$sBuilding an EE4 Add-on Using the REST API%2$s', 'event_espresso'), |
|
89 | - '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/T--Tutorials/building-an-ee4-addon-that-uses-angular-js-and-the-ee4-json-rest-api.md" target="_blank" rel="noopener noreferrer">', |
|
90 | - '</a>' |
|
91 | - ); ?></li> |
|
88 | + esc_html__('%1$sBuilding an EE4 Add-on Using the REST API%2$s', 'event_espresso'), |
|
89 | + '<a href="https://github.com/eventespresso/event-espresso-core/blob/master/docs/T--Tutorials/building-an-ee4-addon-that-uses-angular-js-and-the-ee4-json-rest-api.md" target="_blank" rel="noopener noreferrer">', |
|
90 | + '</a>' |
|
91 | + ); ?></li> |
|
92 | 92 | </ul> |
93 | 93 | </div> |
94 | 94 | \ No newline at end of file |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | */ |
94 | 94 | public function getType() |
95 | 95 | { |
96 | - if (!$this->type) { |
|
96 | + if ( ! $this->type) { |
|
97 | 97 | $this->type = $this->determineType(); |
98 | 98 | } |
99 | 99 | return $this->type; |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | */ |
106 | 106 | protected function determineType() |
107 | 107 | { |
108 | - if (!$this->getTmpFile()) { |
|
108 | + if ( ! $this->getTmpFile()) { |
|
109 | 109 | return ''; |
110 | 110 | } |
111 | 111 | $finfo = new finfo(FILEINFO_MIME_TYPE); |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | */ |
120 | 120 | public function getExtension() |
121 | 121 | { |
122 | - if (!$this->extension) { |
|
122 | + if ( ! $this->extension) { |
|
123 | 123 | $this->extension = $this->determineExtension(); |
124 | 124 | } |
125 | 125 | return $this->extension; |
@@ -19,164 +19,164 @@ |
||
19 | 19 | */ |
20 | 20 | class FileSubmission implements FileSubmissionInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * @var string original name on the client machine |
|
24 | - */ |
|
25 | - protected $name; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var string mime type |
|
29 | - */ |
|
30 | - protected $type; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string file extension |
|
34 | - */ |
|
35 | - protected $extension; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var int in bytes |
|
39 | - */ |
|
40 | - protected $size; |
|
41 | - |
|
42 | - /** |
|
43 | - * @var string local filepath to the temporary file |
|
44 | - */ |
|
45 | - protected $tmp_file; |
|
46 | - |
|
47 | - /** |
|
48 | - * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
49 | - * although those aren't expected. |
|
50 | - */ |
|
51 | - protected $error_code; |
|
52 | - |
|
53 | - /** |
|
54 | - * FileSubmission constructor. |
|
55 | - * @param $name |
|
56 | - * @param $tmp_file |
|
57 | - * @param $size |
|
58 | - * @param null $error_code |
|
59 | - * @throws InvalidArgumentException |
|
60 | - */ |
|
61 | - public function __construct($name, $tmp_file, $size, $error_code = null) |
|
62 | - { |
|
63 | - $this->name = basename($name); |
|
64 | - $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
65 | - if (in_array($scheme, ['http', 'https'])) { |
|
66 | - // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
67 | - throw new InvalidArgumentException( |
|
68 | - sprintf( |
|
69 | - // @codingStandardsIgnoreStart |
|
70 | - esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
71 | - // @codingStandardsIgnoreEnd |
|
72 | - $scheme, |
|
73 | - $tmp_file |
|
74 | - ) |
|
75 | - ); |
|
76 | - } |
|
77 | - $this->tmp_file = (string) $tmp_file; |
|
78 | - $this->size = (int) $size; |
|
79 | - $this->error_code = (int) $error_code; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * @return string |
|
84 | - */ |
|
85 | - public function getName() |
|
86 | - { |
|
87 | - return $this->name; |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Gets the file's mime type |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - public function getType() |
|
95 | - { |
|
96 | - if (!$this->type) { |
|
97 | - $this->type = $this->determineType(); |
|
98 | - } |
|
99 | - return $this->type; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @since 4.9.80.p |
|
104 | - * @return string |
|
105 | - */ |
|
106 | - protected function determineType() |
|
107 | - { |
|
108 | - if (!$this->getTmpFile()) { |
|
109 | - return ''; |
|
110 | - } |
|
111 | - $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
112 | - return $finfo->file($this->getTmpFile()); |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Gets the file's extension. |
|
117 | - * @since 4.9.80.p |
|
118 | - * @return string |
|
119 | - */ |
|
120 | - public function getExtension() |
|
121 | - { |
|
122 | - if (!$this->extension) { |
|
123 | - $this->extension = $this->determineExtension(); |
|
124 | - } |
|
125 | - return $this->extension; |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * Determine's the file's extension given the temporary file. |
|
130 | - * @since 4.9.80.p |
|
131 | - * @return string |
|
132 | - */ |
|
133 | - protected function determineExtension() |
|
134 | - { |
|
135 | - $position_of_period = strrpos($this->getName(), '.'); |
|
136 | - if ($position_of_period === false) { |
|
137 | - return ''; |
|
138 | - } |
|
139 | - return mb_substr( |
|
140 | - $this->getName(), |
|
141 | - $position_of_period + 1 |
|
142 | - ); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Gets the size of the file |
|
147 | - * @return int |
|
148 | - */ |
|
149 | - public function getSize() |
|
150 | - { |
|
151 | - return $this->size; |
|
152 | - } |
|
153 | - |
|
154 | - /** |
|
155 | - * Gets the path to the temporary file which was uploaded. |
|
156 | - * @return string |
|
157 | - */ |
|
158 | - public function getTmpFile() |
|
159 | - { |
|
160 | - return $this->tmp_file; |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * @since 4.9.80.p |
|
165 | - * @return string |
|
166 | - */ |
|
167 | - public function __toString() |
|
168 | - { |
|
169 | - return $this->getName(); |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Gets the error code PHP reported for the file upload. |
|
174 | - * @return string |
|
175 | - */ |
|
176 | - public function getErrorCode() |
|
177 | - { |
|
178 | - return $this->error_code; |
|
179 | - } |
|
22 | + /** |
|
23 | + * @var string original name on the client machine |
|
24 | + */ |
|
25 | + protected $name; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var string mime type |
|
29 | + */ |
|
30 | + protected $type; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string file extension |
|
34 | + */ |
|
35 | + protected $extension; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var int in bytes |
|
39 | + */ |
|
40 | + protected $size; |
|
41 | + |
|
42 | + /** |
|
43 | + * @var string local filepath to the temporary file |
|
44 | + */ |
|
45 | + protected $tmp_file; |
|
46 | + |
|
47 | + /** |
|
48 | + * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
49 | + * although those aren't expected. |
|
50 | + */ |
|
51 | + protected $error_code; |
|
52 | + |
|
53 | + /** |
|
54 | + * FileSubmission constructor. |
|
55 | + * @param $name |
|
56 | + * @param $tmp_file |
|
57 | + * @param $size |
|
58 | + * @param null $error_code |
|
59 | + * @throws InvalidArgumentException |
|
60 | + */ |
|
61 | + public function __construct($name, $tmp_file, $size, $error_code = null) |
|
62 | + { |
|
63 | + $this->name = basename($name); |
|
64 | + $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
65 | + if (in_array($scheme, ['http', 'https'])) { |
|
66 | + // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
67 | + throw new InvalidArgumentException( |
|
68 | + sprintf( |
|
69 | + // @codingStandardsIgnoreStart |
|
70 | + esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
71 | + // @codingStandardsIgnoreEnd |
|
72 | + $scheme, |
|
73 | + $tmp_file |
|
74 | + ) |
|
75 | + ); |
|
76 | + } |
|
77 | + $this->tmp_file = (string) $tmp_file; |
|
78 | + $this->size = (int) $size; |
|
79 | + $this->error_code = (int) $error_code; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * @return string |
|
84 | + */ |
|
85 | + public function getName() |
|
86 | + { |
|
87 | + return $this->name; |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Gets the file's mime type |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + public function getType() |
|
95 | + { |
|
96 | + if (!$this->type) { |
|
97 | + $this->type = $this->determineType(); |
|
98 | + } |
|
99 | + return $this->type; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @since 4.9.80.p |
|
104 | + * @return string |
|
105 | + */ |
|
106 | + protected function determineType() |
|
107 | + { |
|
108 | + if (!$this->getTmpFile()) { |
|
109 | + return ''; |
|
110 | + } |
|
111 | + $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
112 | + return $finfo->file($this->getTmpFile()); |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Gets the file's extension. |
|
117 | + * @since 4.9.80.p |
|
118 | + * @return string |
|
119 | + */ |
|
120 | + public function getExtension() |
|
121 | + { |
|
122 | + if (!$this->extension) { |
|
123 | + $this->extension = $this->determineExtension(); |
|
124 | + } |
|
125 | + return $this->extension; |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * Determine's the file's extension given the temporary file. |
|
130 | + * @since 4.9.80.p |
|
131 | + * @return string |
|
132 | + */ |
|
133 | + protected function determineExtension() |
|
134 | + { |
|
135 | + $position_of_period = strrpos($this->getName(), '.'); |
|
136 | + if ($position_of_period === false) { |
|
137 | + return ''; |
|
138 | + } |
|
139 | + return mb_substr( |
|
140 | + $this->getName(), |
|
141 | + $position_of_period + 1 |
|
142 | + ); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Gets the size of the file |
|
147 | + * @return int |
|
148 | + */ |
|
149 | + public function getSize() |
|
150 | + { |
|
151 | + return $this->size; |
|
152 | + } |
|
153 | + |
|
154 | + /** |
|
155 | + * Gets the path to the temporary file which was uploaded. |
|
156 | + * @return string |
|
157 | + */ |
|
158 | + public function getTmpFile() |
|
159 | + { |
|
160 | + return $this->tmp_file; |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * @since 4.9.80.p |
|
165 | + * @return string |
|
166 | + */ |
|
167 | + public function __toString() |
|
168 | + { |
|
169 | + return $this->getName(); |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Gets the error code PHP reported for the file upload. |
|
174 | + * @return string |
|
175 | + */ |
|
176 | + public function getErrorCode() |
|
177 | + { |
|
178 | + return $this->error_code; |
|
179 | + } |
|
180 | 180 | } |
181 | 181 | // End of file FileSubmission.php |
182 | 182 | // Location: EventEspresso\core\services\request\files/FileSubmission.php |
@@ -42,10 +42,10 @@ discard block |
||
42 | 42 | // is carelessly registering an older version of Select2 on admin pages that don't even belong to them |
43 | 43 | wp_deregister_script('select2'); |
44 | 44 | wp_deregister_style('select2'); |
45 | - wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true); |
|
46 | - wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
47 | - wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true); |
|
48 | - wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
45 | + wp_register_script('select2', EE_GLOBAL_ASSETS_URL.'scripts/select2.min.js', array(), '4.0.2', true); |
|
46 | + wp_register_style('select2', EE_GLOBAL_ASSETS_URL.'css/select2.min.css', array(), '4.0.2', 'all'); |
|
47 | + wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL.'scripts/form_section_select2_init.js', array('select2'), '1.0.0', true); |
|
48 | + wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL.'css/select2.min.css', array(), '4.0.2', 'all'); |
|
49 | 49 | } |
50 | 50 | |
51 | 51 | /** |
@@ -74,10 +74,10 @@ discard block |
||
74 | 74 | public function get_other_js_data($other_js_data = array()) |
75 | 75 | { |
76 | 76 | $other_js_data = parent::get_other_js_data($other_js_data); |
77 | - if (! isset($other_js_data['select2s'])) { |
|
77 | + if ( ! isset($other_js_data['select2s'])) { |
|
78 | 78 | $other_js_data['select2s'] = array(); |
79 | 79 | } |
80 | - $other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args(); |
|
80 | + $other_js_data['select2s'][$this->_input->html_id()] = $this->get_js_args(); |
|
81 | 81 | return $other_js_data; |
82 | 82 | } |
83 | 83 |
@@ -15,80 +15,80 @@ |
||
15 | 15 | */ |
16 | 16 | class EE_Select2_Display_Strategy extends EE_Select_Display_Strategy |
17 | 17 | { |
18 | - /** |
|
19 | - * Arguments that will be passed into the select2 javascript constructor |
|
20 | - * @var array |
|
21 | - */ |
|
22 | - protected $_select2_js_args = array(); |
|
18 | + /** |
|
19 | + * Arguments that will be passed into the select2 javascript constructor |
|
20 | + * @var array |
|
21 | + */ |
|
22 | + protected $_select2_js_args = array(); |
|
23 | 23 | |
24 | - /** |
|
25 | - * |
|
26 | - * @param array $select2_js_args pass in the EXACT array of JS arguments you want |
|
27 | - * to pass into the select2 js/html input. See https://select2.github.io |
|
28 | - */ |
|
29 | - public function __construct($select2_js_args = array()) |
|
30 | - { |
|
31 | - $this->_select2_js_args = $select2_js_args; |
|
32 | - parent::__construct(); |
|
33 | - } |
|
24 | + /** |
|
25 | + * |
|
26 | + * @param array $select2_js_args pass in the EXACT array of JS arguments you want |
|
27 | + * to pass into the select2 js/html input. See https://select2.github.io |
|
28 | + */ |
|
29 | + public function __construct($select2_js_args = array()) |
|
30 | + { |
|
31 | + $this->_select2_js_args = $select2_js_args; |
|
32 | + parent::__construct(); |
|
33 | + } |
|
34 | 34 | |
35 | - /** |
|
36 | - * enqueues the select2 initializing js (which depends on the select2 js) and |
|
37 | - * the select2 css |
|
38 | - */ |
|
39 | - public function enqueue_js() |
|
40 | - { |
|
41 | - // need to first deregister the select2 script in case some other plugin **cough cough Toolset Types cough** |
|
42 | - // is carelessly registering an older version of Select2 on admin pages that don't even belong to them |
|
43 | - wp_deregister_script('select2'); |
|
44 | - wp_deregister_style('select2'); |
|
45 | - wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true); |
|
46 | - wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
47 | - wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true); |
|
48 | - wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
49 | - } |
|
35 | + /** |
|
36 | + * enqueues the select2 initializing js (which depends on the select2 js) and |
|
37 | + * the select2 css |
|
38 | + */ |
|
39 | + public function enqueue_js() |
|
40 | + { |
|
41 | + // need to first deregister the select2 script in case some other plugin **cough cough Toolset Types cough** |
|
42 | + // is carelessly registering an older version of Select2 on admin pages that don't even belong to them |
|
43 | + wp_deregister_script('select2'); |
|
44 | + wp_deregister_style('select2'); |
|
45 | + wp_register_script('select2', EE_GLOBAL_ASSETS_URL . 'scripts/select2.min.js', array(), '4.0.2', true); |
|
46 | + wp_register_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
47 | + wp_enqueue_script('form_section_select2_init', EE_GLOBAL_ASSETS_URL . 'scripts/form_section_select2_init.js', array( 'select2' ), '1.0.0', true); |
|
48 | + wp_enqueue_style('select2', EE_GLOBAL_ASSETS_URL . 'css/select2.min.css', array(), '4.0.2', 'all'); |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * Gets the javascript args which will be localized and passed into the select2 js/html input |
|
53 | - * @return array |
|
54 | - */ |
|
55 | - public function get_js_args() |
|
56 | - { |
|
57 | - return $this->_select2_js_args; |
|
58 | - } |
|
51 | + /** |
|
52 | + * Gets the javascript args which will be localized and passed into the select2 js/html input |
|
53 | + * @return array |
|
54 | + */ |
|
55 | + public function get_js_args() |
|
56 | + { |
|
57 | + return $this->_select2_js_args; |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * Sets the exact js args which will be passed into the select2 js/html input |
|
62 | - * @param array $js_args |
|
63 | - */ |
|
64 | - public function set_js_args($js_args) |
|
65 | - { |
|
66 | - $this->_select2_js_args = $js_args; |
|
67 | - } |
|
60 | + /** |
|
61 | + * Sets the exact js args which will be passed into the select2 js/html input |
|
62 | + * @param array $js_args |
|
63 | + */ |
|
64 | + public function set_js_args($js_args) |
|
65 | + { |
|
66 | + $this->_select2_js_args = $js_args; |
|
67 | + } |
|
68 | 68 | |
69 | - /** |
|
70 | - * Adds select2 data for localization |
|
71 | - * @param array $other_js_data |
|
72 | - * @return array |
|
73 | - */ |
|
74 | - public function get_other_js_data($other_js_data = array()) |
|
75 | - { |
|
76 | - $other_js_data = parent::get_other_js_data($other_js_data); |
|
77 | - if (! isset($other_js_data['select2s'])) { |
|
78 | - $other_js_data['select2s'] = array(); |
|
79 | - } |
|
80 | - $other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args(); |
|
81 | - return $other_js_data; |
|
82 | - } |
|
69 | + /** |
|
70 | + * Adds select2 data for localization |
|
71 | + * @param array $other_js_data |
|
72 | + * @return array |
|
73 | + */ |
|
74 | + public function get_other_js_data($other_js_data = array()) |
|
75 | + { |
|
76 | + $other_js_data = parent::get_other_js_data($other_js_data); |
|
77 | + if (! isset($other_js_data['select2s'])) { |
|
78 | + $other_js_data['select2s'] = array(); |
|
79 | + } |
|
80 | + $other_js_data['select2s'][ $this->_input->html_id() ] = $this->get_js_args(); |
|
81 | + return $other_js_data; |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * Overrides standard attributes array to add the CSS class "ee-select2" |
|
86 | - * @return array |
|
87 | - */ |
|
88 | - protected function _standard_attributes_array() |
|
89 | - { |
|
90 | - $standard_attributes = parent::_standard_attributes_array(); |
|
91 | - $standard_attributes['class'] .= ' ee-select2'; |
|
92 | - return $standard_attributes; |
|
93 | - } |
|
84 | + /** |
|
85 | + * Overrides standard attributes array to add the CSS class "ee-select2" |
|
86 | + * @return array |
|
87 | + */ |
|
88 | + protected function _standard_attributes_array() |
|
89 | + { |
|
90 | + $standard_attributes = parent::_standard_attributes_array(); |
|
91 | + $standard_attributes['class'] .= ' ee-select2'; |
|
92 | + return $standard_attributes; |
|
93 | + } |
|
94 | 94 | } |
@@ -10,11 +10,11 @@ |
||
10 | 10 | */ |
11 | 11 | class EE_File_Input_Display_Strategy extends EE_Text_Input_Display_Strategy |
12 | 12 | { |
13 | - /** |
|
14 | - * Override's parent to just set the type. May someday support other arguments. |
|
15 | - */ |
|
16 | - public function __construct() |
|
17 | - { |
|
18 | - parent::__construct('file'); |
|
19 | - } |
|
13 | + /** |
|
14 | + * Override's parent to just set the type. May someday support other arguments. |
|
15 | + */ |
|
16 | + public function __construct() |
|
17 | + { |
|
18 | + parent::__construct('file'); |
|
19 | + } |
|
20 | 20 | } |
@@ -55,7 +55,7 @@ |
||
55 | 55 | esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
56 | 56 | implode(', ', $this->allowed_file_extensions) |
57 | 57 | ), |
58 | - '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
58 | + '~.*\.('.implode('|', $this->allowed_file_extensions).')$~' |
|
59 | 59 | ) |
60 | 60 | ); |
61 | 61 | parent::__construct($options); |
@@ -19,86 +19,86 @@ |
||
19 | 19 | */ |
20 | 20 | class EE_File_Input extends EE_Form_Input_Base |
21 | 21 | { |
22 | - /** |
|
23 | - * @var array |
|
24 | - */ |
|
25 | - protected $allowed_file_extensions; |
|
22 | + /** |
|
23 | + * @var array |
|
24 | + */ |
|
25 | + protected $allowed_file_extensions; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @var array |
|
29 | - */ |
|
30 | - protected $allowed_mime_types; |
|
27 | + /** |
|
28 | + * @var array |
|
29 | + */ |
|
30 | + protected $allowed_mime_types; |
|
31 | 31 | |
32 | - /** |
|
33 | - * @param array $options |
|
34 | - * @throws InvalidArgumentException |
|
35 | - */ |
|
36 | - public function __construct($options = array()) |
|
37 | - { |
|
38 | - if (isset($options['allowed_file_extensions'])) { |
|
39 | - $this->allowed_file_extensions = (array) $options['allowed_file_extensions']; |
|
40 | - } else { |
|
41 | - $this->allowed_file_extensions = ['csv']; |
|
42 | - } |
|
43 | - if (isset($options['allowed_mime_types'])) { |
|
44 | - $this->allowed_mime_types = (array) $options['allowed_file_extensions']; |
|
45 | - } else { |
|
46 | - $this->allowed_mime_types = ['text/csv']; |
|
47 | - } |
|
32 | + /** |
|
33 | + * @param array $options |
|
34 | + * @throws InvalidArgumentException |
|
35 | + */ |
|
36 | + public function __construct($options = array()) |
|
37 | + { |
|
38 | + if (isset($options['allowed_file_extensions'])) { |
|
39 | + $this->allowed_file_extensions = (array) $options['allowed_file_extensions']; |
|
40 | + } else { |
|
41 | + $this->allowed_file_extensions = ['csv']; |
|
42 | + } |
|
43 | + if (isset($options['allowed_mime_types'])) { |
|
44 | + $this->allowed_mime_types = (array) $options['allowed_file_extensions']; |
|
45 | + } else { |
|
46 | + $this->allowed_mime_types = ['text/csv']; |
|
47 | + } |
|
48 | 48 | |
49 | - $this->_set_display_strategy(new EE_File_Input_Display_Strategy()); |
|
50 | - $this->_set_normalization_strategy(new EE_File_Normalization()); |
|
51 | - $this->add_validation_strategy( |
|
52 | - new EE_Text_Validation_Strategy( |
|
53 | - sprintf( |
|
54 | - // translators: %1$s is a list of allowed file extensions. |
|
55 | - esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
|
56 | - implode(', ', $this->allowed_file_extensions) |
|
57 | - ), |
|
58 | - '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
59 | - ) |
|
60 | - ); |
|
61 | - parent::__construct($options); |
|
49 | + $this->_set_display_strategy(new EE_File_Input_Display_Strategy()); |
|
50 | + $this->_set_normalization_strategy(new EE_File_Normalization()); |
|
51 | + $this->add_validation_strategy( |
|
52 | + new EE_Text_Validation_Strategy( |
|
53 | + sprintf( |
|
54 | + // translators: %1$s is a list of allowed file extensions. |
|
55 | + esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'), |
|
56 | + implode(', ', $this->allowed_file_extensions) |
|
57 | + ), |
|
58 | + '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~' |
|
59 | + ) |
|
60 | + ); |
|
61 | + parent::__construct($options); |
|
62 | 62 | |
63 | 63 | // It would be great to add this HTML attribute, but jQuery validate chokes on it. |
64 | - $this->set_other_html_attributes( |
|
65 | - $this->other_html_attributes() |
|
66 | - . ' extension="' |
|
67 | - . implode( |
|
68 | - ',', |
|
69 | - $this->allowed_file_extensions |
|
70 | - ) |
|
71 | - . '"' |
|
72 | - ); |
|
73 | - } |
|
64 | + $this->set_other_html_attributes( |
|
65 | + $this->other_html_attributes() |
|
66 | + . ' extension="' |
|
67 | + . implode( |
|
68 | + ',', |
|
69 | + $this->allowed_file_extensions |
|
70 | + ) |
|
71 | + . '"' |
|
72 | + ); |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for |
|
77 | - * this input. |
|
78 | - * @since 4.9.80.p |
|
79 | - * @param array $req_data |
|
80 | - * @return FileSubmissionInterface |
|
81 | - * @throws InvalidArgumentException |
|
82 | - * @throws InvalidDataTypeException |
|
83 | - * @throws InvalidInterfaceException |
|
84 | - */ |
|
85 | - public function find_form_data_for_this_section($req_data) |
|
86 | - { |
|
87 | - // ignore $req_data. Files are in the files data handler. |
|
88 | - $fileDataHandler = LoaderFactory::getLoader()->getShared( |
|
89 | - 'EventEspresso\core\services\request\files\FilesDataHandler' |
|
90 | - ); |
|
91 | - return $fileDataHandler->getFileObject($this->html_name()); |
|
92 | - } |
|
75 | + /** |
|
76 | + * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for |
|
77 | + * this input. |
|
78 | + * @since 4.9.80.p |
|
79 | + * @param array $req_data |
|
80 | + * @return FileSubmissionInterface |
|
81 | + * @throws InvalidArgumentException |
|
82 | + * @throws InvalidDataTypeException |
|
83 | + * @throws InvalidInterfaceException |
|
84 | + */ |
|
85 | + public function find_form_data_for_this_section($req_data) |
|
86 | + { |
|
87 | + // ignore $req_data. Files are in the files data handler. |
|
88 | + $fileDataHandler = LoaderFactory::getLoader()->getShared( |
|
89 | + 'EventEspresso\core\services\request\files\FilesDataHandler' |
|
90 | + ); |
|
91 | + return $fileDataHandler->getFileObject($this->html_name()); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Don't transform the file submission object into a string, thanks. |
|
96 | - * |
|
97 | - * @param string $value |
|
98 | - * @return null|string |
|
99 | - */ |
|
100 | - protected function _sanitize($value) |
|
101 | - { |
|
102 | - return $value; |
|
103 | - } |
|
94 | + /** |
|
95 | + * Don't transform the file submission object into a string, thanks. |
|
96 | + * |
|
97 | + * @param string $value |
|
98 | + * @return null|string |
|
99 | + */ |
|
100 | + protected function _sanitize($value) |
|
101 | + { |
|
102 | + return $value; |
|
103 | + } |
|
104 | 104 | } |
@@ -70,7 +70,7 @@ |
||
70 | 70 | { |
71 | 71 | global $wpdb; |
72 | 72 | $start_at_record = $this->count_records_migrated(); |
73 | - $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | + $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} ".$wpdb->prepare( |
|
74 | 74 | "LIMIT %d, %d", |
75 | 75 | $start_at_record, |
76 | 76 | $limit |
@@ -15,89 +15,89 @@ |
||
15 | 15 | */ |
16 | 16 | abstract class EE_Data_Migration_Script_Stage_Table extends EE_Data_Migration_Script_Stage |
17 | 17 | { |
18 | - protected $_old_table; |
|
18 | + protected $_old_table; |
|
19 | 19 | |
20 | - /** |
|
21 | - * @var string The columns to select. May be overridden for children. |
|
22 | - */ |
|
23 | - protected $select_expression = '*'; |
|
20 | + /** |
|
21 | + * @var string The columns to select. May be overridden for children. |
|
22 | + */ |
|
23 | + protected $select_expression = '*'; |
|
24 | 24 | |
25 | - /** |
|
26 | - * Set in the constructor to add this sql to both the counting query in |
|
27 | - * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and |
|
28 | - * EE_Data_Migration_Script_Stage_Table::_get_rows(). |
|
29 | - * Eg "where column_name like '%some_value%'" |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $_extra_where_sql; |
|
25 | + /** |
|
26 | + * Set in the constructor to add this sql to both the counting query in |
|
27 | + * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and |
|
28 | + * EE_Data_Migration_Script_Stage_Table::_get_rows(). |
|
29 | + * Eg "where column_name like '%some_value%'" |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $_extra_where_sql; |
|
34 | 34 | |
35 | 35 | |
36 | - /** |
|
37 | - * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property |
|
38 | - * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that |
|
39 | - * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the |
|
40 | - * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees |
|
41 | - * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at |
|
42 | - * very least we MUST report/return 50 items migrated) |
|
43 | - * |
|
44 | - * @param int $num_items |
|
45 | - * @return int number of items ACTUALLY migrated |
|
46 | - */ |
|
47 | - public function _migration_step($num_items = 50) |
|
48 | - { |
|
49 | - $rows = $this->_get_rows($num_items); |
|
50 | - $items_actually_migrated = 0; |
|
51 | - foreach ($rows as $old_row) { |
|
52 | - $this->_migrate_old_row($old_row); |
|
53 | - $items_actually_migrated++; |
|
54 | - } |
|
55 | - if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
56 | - $this->set_completed(); |
|
57 | - } |
|
58 | - return $items_actually_migrated; |
|
59 | - } |
|
36 | + /** |
|
37 | + * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property |
|
38 | + * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that |
|
39 | + * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the |
|
40 | + * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees |
|
41 | + * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at |
|
42 | + * very least we MUST report/return 50 items migrated) |
|
43 | + * |
|
44 | + * @param int $num_items |
|
45 | + * @return int number of items ACTUALLY migrated |
|
46 | + */ |
|
47 | + public function _migration_step($num_items = 50) |
|
48 | + { |
|
49 | + $rows = $this->_get_rows($num_items); |
|
50 | + $items_actually_migrated = 0; |
|
51 | + foreach ($rows as $old_row) { |
|
52 | + $this->_migrate_old_row($old_row); |
|
53 | + $items_actually_migrated++; |
|
54 | + } |
|
55 | + if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
56 | + $this->set_completed(); |
|
57 | + } |
|
58 | + return $items_actually_migrated; |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * Gets the rows for each migration stage from the old table |
|
63 | - * |
|
64 | - * @global wpdb $wpdb |
|
65 | - * @param int $limit |
|
66 | - * @return array of arrays like $wpdb->get_results($sql, ARRAY_A) |
|
67 | - */ |
|
68 | - protected function _get_rows($limit) |
|
69 | - { |
|
70 | - global $wpdb; |
|
71 | - $start_at_record = $this->count_records_migrated(); |
|
72 | - $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | - "LIMIT %d, %d", |
|
74 | - $start_at_record, |
|
75 | - $limit |
|
76 | - ); |
|
77 | - return $wpdb->get_results($query, ARRAY_A); |
|
78 | - } |
|
61 | + /** |
|
62 | + * Gets the rows for each migration stage from the old table |
|
63 | + * |
|
64 | + * @global wpdb $wpdb |
|
65 | + * @param int $limit |
|
66 | + * @return array of arrays like $wpdb->get_results($sql, ARRAY_A) |
|
67 | + */ |
|
68 | + protected function _get_rows($limit) |
|
69 | + { |
|
70 | + global $wpdb; |
|
71 | + $start_at_record = $this->count_records_migrated(); |
|
72 | + $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare( |
|
73 | + "LIMIT %d, %d", |
|
74 | + $start_at_record, |
|
75 | + $limit |
|
76 | + ); |
|
77 | + return $wpdb->get_results($query, ARRAY_A); |
|
78 | + } |
|
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * Counts the records to migrate; the public version may cache it |
|
83 | - * |
|
84 | - * @return int |
|
85 | - */ |
|
86 | - public function _count_records_to_migrate() |
|
87 | - { |
|
88 | - global $wpdb; |
|
89 | - $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}"; |
|
90 | - $count = $wpdb->get_var($query); |
|
91 | - return $count; |
|
92 | - } |
|
81 | + /** |
|
82 | + * Counts the records to migrate; the public version may cache it |
|
83 | + * |
|
84 | + * @return int |
|
85 | + */ |
|
86 | + public function _count_records_to_migrate() |
|
87 | + { |
|
88 | + global $wpdb; |
|
89 | + $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}"; |
|
90 | + $count = $wpdb->get_var($query); |
|
91 | + return $count; |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * takes care of migrating this particular row from the OLD table to whatever its |
|
96 | - * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a |
|
97 | - * fatal error which prevents all future migrations, throw an exception describing it |
|
98 | - * |
|
99 | - * @param array $old_row an associative array where keys are column names and values are their values. |
|
100 | - * @return null |
|
101 | - */ |
|
102 | - abstract protected function _migrate_old_row($old_row); |
|
94 | + /** |
|
95 | + * takes care of migrating this particular row from the OLD table to whatever its |
|
96 | + * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a |
|
97 | + * fatal error which prevents all future migrations, throw an exception describing it |
|
98 | + * |
|
99 | + * @param array $old_row an associative array where keys are column names and values are their values. |
|
100 | + * @return null |
|
101 | + */ |
|
102 | + abstract protected function _migrate_old_row($old_row); |
|
103 | 103 | } |