@@ -335,7 +335,7 @@ discard block |
||
335 | 335 | */ |
336 | 336 | public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null) |
337 | 337 | { |
338 | - if (! $this->ID()) { |
|
338 | + if ( ! $this->ID()) { |
|
339 | 339 | return array(); |
340 | 340 | } |
341 | 341 | $query_params = array(); |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | ), |
510 | 510 | $input_constructor_args |
511 | 511 | ); |
512 | - if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) { |
|
512 | + if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) { |
|
513 | 513 | $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID()); |
514 | 514 | } |
515 | 515 | // has this question been answered ? |
@@ -647,7 +647,7 @@ discard block |
||
647 | 647 | $this, |
648 | 648 | $input_constructor_args |
649 | 649 | ); |
650 | - if (! $default_input) { |
|
650 | + if ( ! $default_input) { |
|
651 | 651 | $default_input = new EE_Text_Input($input_constructor_args); |
652 | 652 | } |
653 | 653 | $result = $default_input; |
@@ -13,668 +13,668 @@ |
||
13 | 13 | */ |
14 | 14 | class EE_Question extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable |
15 | 15 | { |
16 | - /** |
|
17 | - * |
|
18 | - * @param array $props_n_values incoming values |
|
19 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
20 | - * used.) |
|
21 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
22 | - * date_format and the second value is the time format |
|
23 | - * @return EE_Question |
|
24 | - */ |
|
25 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
26 | - { |
|
27 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
28 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
29 | - } |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * @param array $props_n_values incoming values from the database |
|
34 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
35 | - * the website will be used. |
|
36 | - * @return EE_Question |
|
37 | - */ |
|
38 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
39 | - { |
|
40 | - return new self($props_n_values, true, $timezone); |
|
41 | - } |
|
42 | - |
|
43 | - |
|
44 | - /** |
|
45 | - * Set Question display text |
|
46 | - * |
|
47 | - * @access public |
|
48 | - * @param string $QST_display_text |
|
49 | - */ |
|
50 | - public function set_display_text($QST_display_text = '') |
|
51 | - { |
|
52 | - $this->set('QST_display_text', $QST_display_text); |
|
53 | - } |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * Set Question admin text |
|
58 | - * |
|
59 | - * @access public |
|
60 | - * @param string $QST_admin_label |
|
61 | - */ |
|
62 | - public function set_admin_label($QST_admin_label = '') |
|
63 | - { |
|
64 | - $this->set('QST_admin_label', $QST_admin_label); |
|
65 | - } |
|
66 | - |
|
67 | - |
|
68 | - /** |
|
69 | - * Set system name |
|
70 | - * |
|
71 | - * @access public |
|
72 | - * @param mixed $QST_system |
|
73 | - */ |
|
74 | - public function set_system_ID($QST_system = '') |
|
75 | - { |
|
76 | - $this->set('QST_system', $QST_system); |
|
77 | - } |
|
78 | - |
|
79 | - |
|
80 | - /** |
|
81 | - * Set question's type |
|
82 | - * |
|
83 | - * @access public |
|
84 | - * @param string $QST_type |
|
85 | - */ |
|
86 | - public function set_question_type($QST_type = '') |
|
87 | - { |
|
88 | - $this->set('QST_type', $QST_type); |
|
89 | - } |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * Sets whether this question must be answered when presented in a form |
|
94 | - * |
|
95 | - * @access public |
|
96 | - * @param bool $QST_required |
|
97 | - */ |
|
98 | - public function set_required($QST_required = false) |
|
99 | - { |
|
100 | - $this->set('QST_required', $QST_required); |
|
101 | - } |
|
102 | - |
|
103 | - |
|
104 | - /** |
|
105 | - * Set Question display text |
|
106 | - * |
|
107 | - * @access public |
|
108 | - * @param string $QST_required_text |
|
109 | - */ |
|
110 | - public function set_required_text($QST_required_text = '') |
|
111 | - { |
|
112 | - $this->set('QST_required_text', $QST_required_text); |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * Sets the order of this question when placed in a sequence of questions |
|
118 | - * |
|
119 | - * @access public |
|
120 | - * @param int $QST_order |
|
121 | - */ |
|
122 | - public function set_order($QST_order = 0) |
|
123 | - { |
|
124 | - $this->set('QST_order', $QST_order); |
|
125 | - } |
|
126 | - |
|
127 | - |
|
128 | - /** |
|
129 | - * Sets whether the question is admin-only |
|
130 | - * |
|
131 | - * @access public |
|
132 | - * @param bool $QST_admin_only |
|
133 | - */ |
|
134 | - public function set_admin_only($QST_admin_only = false) |
|
135 | - { |
|
136 | - $this->set('QST_admin_only', $QST_admin_only); |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * Sets the wordpress user ID on the question |
|
142 | - * |
|
143 | - * @access public |
|
144 | - * @param int $QST_wp_user |
|
145 | - */ |
|
146 | - public function set_wp_user($QST_wp_user = 1) |
|
147 | - { |
|
148 | - $this->set('QST_wp_user', $QST_wp_user); |
|
149 | - } |
|
150 | - |
|
151 | - |
|
152 | - /** |
|
153 | - * Sets whether the question has been deleted |
|
154 | - * (we use this boolean instead of actually |
|
155 | - * deleting it because when users delete this question |
|
156 | - * they really want to remove the question from future |
|
157 | - * forms, BUT keep their old answers which depend |
|
158 | - * on this record actually existing. |
|
159 | - * |
|
160 | - * @access public |
|
161 | - * @param bool $QST_deleted |
|
162 | - */ |
|
163 | - public function set_deleted($QST_deleted = false) |
|
164 | - { |
|
165 | - $this->set('QST_deleted', $QST_deleted); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * returns the text for displaying the question to users |
|
171 | - * |
|
172 | - * @access public |
|
173 | - * @return string |
|
174 | - */ |
|
175 | - public function display_text() |
|
176 | - { |
|
177 | - return $this->get('QST_display_text'); |
|
178 | - } |
|
179 | - |
|
180 | - |
|
181 | - /** |
|
182 | - * returns the text for the administrative label |
|
183 | - * |
|
184 | - * @access public |
|
185 | - * @return string |
|
186 | - */ |
|
187 | - public function admin_label() |
|
188 | - { |
|
189 | - return $this->get('QST_admin_label'); |
|
190 | - } |
|
191 | - |
|
192 | - |
|
193 | - /** |
|
194 | - * returns the attendee column name for this question |
|
195 | - * |
|
196 | - * @access public |
|
197 | - * @return string |
|
198 | - */ |
|
199 | - public function system_ID() |
|
200 | - { |
|
201 | - return $this->get('QST_system'); |
|
202 | - } |
|
203 | - |
|
204 | - |
|
205 | - /** |
|
206 | - * returns either a string of 'text', 'textfield', etc. |
|
207 | - * |
|
208 | - * @access public |
|
209 | - * @return boolean |
|
210 | - */ |
|
211 | - public function required() |
|
212 | - { |
|
213 | - return $this->get('QST_required'); |
|
214 | - } |
|
215 | - |
|
216 | - |
|
217 | - /** |
|
218 | - * returns the text which should be displayed when a user |
|
219 | - * doesn't answer this question in a form |
|
220 | - * |
|
221 | - * @access public |
|
222 | - * @return string |
|
223 | - */ |
|
224 | - public function required_text() |
|
225 | - { |
|
226 | - return $this->get('QST_required_text'); |
|
227 | - } |
|
228 | - |
|
229 | - |
|
230 | - /** |
|
231 | - * returns the type of this question |
|
232 | - * |
|
233 | - * @access public |
|
234 | - * @return string |
|
235 | - */ |
|
236 | - public function type() |
|
237 | - { |
|
238 | - return $this->get('QST_type'); |
|
239 | - } |
|
240 | - |
|
241 | - |
|
242 | - /** |
|
243 | - * returns an integer showing where this question should |
|
244 | - * be placed in a sequence of questions |
|
245 | - * |
|
246 | - * @access public |
|
247 | - * @return int |
|
248 | - */ |
|
249 | - public function order() |
|
250 | - { |
|
251 | - return $this->get('QST_order'); |
|
252 | - } |
|
253 | - |
|
254 | - |
|
255 | - /** |
|
256 | - * returns whether this question should only appears to admins, |
|
257 | - * or to everyone |
|
258 | - * |
|
259 | - * @access public |
|
260 | - * @return boolean |
|
261 | - */ |
|
262 | - public function admin_only() |
|
263 | - { |
|
264 | - return $this->get('QST_admin_only'); |
|
265 | - } |
|
266 | - |
|
267 | - |
|
268 | - /** |
|
269 | - * returns the id the wordpress user who created this question |
|
270 | - * |
|
271 | - * @access public |
|
272 | - * @return int |
|
273 | - */ |
|
274 | - public function wp_user() |
|
275 | - { |
|
276 | - return $this->get('QST_wp_user'); |
|
277 | - } |
|
278 | - |
|
279 | - |
|
280 | - /** |
|
281 | - * returns whether this question has been marked as 'deleted' |
|
282 | - * |
|
283 | - * @access public |
|
284 | - * @return boolean |
|
285 | - */ |
|
286 | - public function deleted() |
|
287 | - { |
|
288 | - return $this->get('QST_deleted'); |
|
289 | - } |
|
290 | - |
|
291 | - |
|
292 | - /** |
|
293 | - * Gets an array of related EE_Answer to this EE_Question |
|
294 | - * |
|
295 | - * @return EE_Answer[] |
|
296 | - */ |
|
297 | - public function answers() |
|
298 | - { |
|
299 | - return $this->get_many_related('Answer'); |
|
300 | - } |
|
301 | - |
|
302 | - |
|
303 | - /** |
|
304 | - * Boolean check for if there are answers on this question in th db |
|
305 | - * |
|
306 | - * @return boolean true = has answers, false = no answers. |
|
307 | - */ |
|
308 | - public function has_answers() |
|
309 | - { |
|
310 | - return $this->count_related('Answer') > 0 ? true : false; |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - /** |
|
315 | - * gets an array of EE_Question_Group which relate to this question |
|
316 | - * |
|
317 | - * @return EE_Question_Group[] |
|
318 | - */ |
|
319 | - public function question_groups() |
|
320 | - { |
|
321 | - return $this->get_many_related('Question_Group'); |
|
322 | - } |
|
323 | - |
|
324 | - |
|
325 | - /** |
|
326 | - * Returns all the options for this question. By default, it returns only the not-yet-deleted ones. |
|
327 | - * |
|
328 | - * @param boolean $notDeletedOptionsOnly 1 |
|
329 | - * whether to return ALL options, or only the ones which have |
|
330 | - * not yet been deleleted |
|
331 | - * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question, |
|
332 | - * we want to usually only show non-deleted options AND the |
|
333 | - * value that was selected for the answer, whether it was |
|
334 | - * trashed or not. |
|
335 | - * @return EE_Question_Option[] |
|
336 | - */ |
|
337 | - public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null) |
|
338 | - { |
|
339 | - if (! $this->ID()) { |
|
340 | - return array(); |
|
341 | - } |
|
342 | - $query_params = array(); |
|
343 | - if ($selected_value_to_always_include) { |
|
344 | - if (is_array($selected_value_to_always_include)) { |
|
345 | - $query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include); |
|
346 | - } else { |
|
347 | - $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include; |
|
348 | - } |
|
349 | - } |
|
350 | - if ($notDeletedOptionsOnly) { |
|
351 | - $query_params[0]['OR*options-query']['QSO_deleted'] = false; |
|
352 | - } |
|
353 | - // order by QSO_order |
|
354 | - $query_params['order_by'] = array('QSO_order' => 'ASC'); |
|
355 | - return $this->get_many_related('Question_Option', $query_params); |
|
356 | - } |
|
357 | - |
|
358 | - |
|
359 | - /** |
|
360 | - * returns an array of EE_Question_Options which relate to this question |
|
361 | - * |
|
362 | - * @return \EE_Question_Option[] |
|
363 | - */ |
|
364 | - public function temp_options() |
|
365 | - { |
|
366 | - return $this->_model_relations['Question_Option']; |
|
367 | - } |
|
368 | - |
|
369 | - |
|
370 | - /** |
|
371 | - * Adds an option for this question. Note: if the option were previously associated with a different |
|
372 | - * Question, that relationship will be overwritten. |
|
373 | - * |
|
374 | - * @param EE_Question_Option $option |
|
375 | - * @return boolean success |
|
376 | - */ |
|
377 | - public function add_option(EE_Question_Option $option) |
|
378 | - { |
|
379 | - return $this->_add_relation_to($option, 'Question_Option'); |
|
380 | - } |
|
381 | - |
|
382 | - |
|
383 | - /** |
|
384 | - * Adds an option directly to this question without saving to the db |
|
385 | - * |
|
386 | - * @param EE_Question_Option $option |
|
387 | - * @return boolean success |
|
388 | - */ |
|
389 | - public function add_temp_option(EE_Question_Option $option) |
|
390 | - { |
|
391 | - $this->_model_relations['Question_Option'][] = $option; |
|
392 | - return true; |
|
393 | - } |
|
394 | - |
|
395 | - |
|
396 | - /** |
|
397 | - * Marks the option as deleted. |
|
398 | - * |
|
399 | - * @param EE_Question_Option $option |
|
400 | - * @return boolean success |
|
401 | - */ |
|
402 | - public function remove_option(EE_Question_Option $option) |
|
403 | - { |
|
404 | - return $this->_remove_relation_to($option, 'Question_Option'); |
|
405 | - } |
|
406 | - |
|
407 | - |
|
408 | - /** |
|
409 | - * @return bool |
|
410 | - */ |
|
411 | - public function is_system_question() |
|
412 | - { |
|
413 | - $system_ID = $this->get('QST_system'); |
|
414 | - return ! empty($system_ID) ? true : false; |
|
415 | - } |
|
416 | - |
|
417 | - |
|
418 | - /** |
|
419 | - * The purpose of this method is set the question order this question order to be the max out of all questions |
|
420 | - * |
|
421 | - * @access public |
|
422 | - * @return void |
|
423 | - */ |
|
424 | - public function set_order_to_latest() |
|
425 | - { |
|
426 | - $latest_order = $this->get_model()->get_latest_question_order(); |
|
427 | - $latest_order++; |
|
428 | - $this->set('QST_order', $latest_order); |
|
429 | - } |
|
430 | - |
|
431 | - |
|
432 | - /** |
|
433 | - * Retrieves the list of allowed question types from the model. |
|
434 | - * |
|
435 | - * @return string[] |
|
436 | - */ |
|
437 | - private function _allowed_question_types() |
|
438 | - { |
|
439 | - $questionModel = $this->get_model(); |
|
440 | - /* @var $questionModel EEM_Question */ |
|
441 | - return $questionModel->allowed_question_types(); |
|
442 | - } |
|
443 | - |
|
444 | - /** |
|
445 | - * Duplicates this question and its question options |
|
446 | - * |
|
447 | - * @return \EE_Question |
|
448 | - */ |
|
449 | - public function duplicate($options = array()) |
|
450 | - { |
|
451 | - $new_question = clone $this; |
|
452 | - $new_question->set('QST_ID', null); |
|
453 | - $new_question->set_display_text(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text())); |
|
454 | - $new_question->set_admin_label(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->admin_label())); |
|
455 | - $new_question->set_system_ID(null); |
|
456 | - $new_question->set_wp_user(get_current_user_id()); |
|
457 | - // if we're duplicating a trashed question, assume we don't want the new one to be trashed |
|
458 | - $new_question->set_deleted(false); |
|
459 | - $success = $new_question->save(); |
|
460 | - if ($success) { |
|
461 | - // we don't totally want to duplicate the question options, because we want them to be for the NEW question |
|
462 | - foreach ($this->options() as $question_option) { |
|
463 | - $question_option->duplicate(array('QST_ID' => $new_question->ID())); |
|
464 | - } |
|
465 | - return $new_question; |
|
466 | - } else { |
|
467 | - return null; |
|
468 | - } |
|
469 | - } |
|
470 | - |
|
471 | - /** |
|
472 | - * Returns the question's maximum allowed response size |
|
473 | - * |
|
474 | - * @return int|float |
|
475 | - */ |
|
476 | - public function max() |
|
477 | - { |
|
478 | - return $this->get('QST_max'); |
|
479 | - } |
|
480 | - |
|
481 | - /** |
|
482 | - * Sets the question's maximum allowed response size |
|
483 | - * |
|
484 | - * @param int|float $new_max |
|
485 | - * @return void |
|
486 | - */ |
|
487 | - public function set_max($new_max) |
|
488 | - { |
|
489 | - $this->set('QST_max', $new_max); |
|
490 | - } |
|
491 | - |
|
492 | - |
|
493 | - /** |
|
494 | - * Creates a form input from this question which can be used in HTML forms |
|
495 | - * |
|
496 | - * @param EE_Registration $registration |
|
497 | - * @param EE_Answer $answer |
|
498 | - * @param array $input_constructor_args |
|
499 | - * @return EE_Form_Input_Base |
|
500 | - */ |
|
501 | - public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array()) |
|
502 | - { |
|
503 | - $identifier = $this->is_system_question() ? $this->system_ID() : $this->ID(); |
|
504 | - |
|
505 | - $input_constructor_args = array_merge( |
|
506 | - array( |
|
507 | - 'required' => $this->required() ? true : false, |
|
508 | - 'html_label_text' => $this->display_text(), |
|
509 | - 'required_validation_error_message' => $this->required_text(), |
|
510 | - ), |
|
511 | - $input_constructor_args |
|
512 | - ); |
|
513 | - if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) { |
|
514 | - $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID()); |
|
515 | - } |
|
516 | - // has this question been answered ? |
|
517 | - if ( |
|
518 | - $answer instanceof EE_Answer |
|
519 | - && $answer->value() !== '' |
|
520 | - ) { |
|
521 | - // answer gets htmlspecialchars called on it, undo that please |
|
522 | - // because the form input's display strategy may call esc_attr too |
|
523 | - // which also does html special characters |
|
524 | - $values_with_html_special_chars = $answer->value(); |
|
525 | - if (is_array($values_with_html_special_chars)) { |
|
526 | - $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars); |
|
527 | - } else { |
|
528 | - $default_value = htmlspecialchars_decode($values_with_html_special_chars); |
|
529 | - } |
|
530 | - $input_constructor_args['default'] = $default_value; |
|
531 | - } |
|
532 | - $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID()); |
|
533 | - if ( |
|
534 | - in_array( |
|
535 | - $this->type(), |
|
536 | - EEM_Question::instance()->questionTypesWithMaxLength(), |
|
537 | - true |
|
538 | - ) |
|
539 | - ) { |
|
540 | - $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy( |
|
541 | - null, |
|
542 | - min($max_max_for_question, $this->max()) |
|
543 | - ); |
|
544 | - } |
|
545 | - $input_constructor_args = apply_filters( |
|
546 | - 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args', |
|
547 | - $input_constructor_args, |
|
548 | - $registration, |
|
549 | - $this, |
|
550 | - $answer |
|
551 | - ); |
|
552 | - |
|
553 | - $result = null; |
|
554 | - switch ($this->type()) { |
|
555 | - // Text |
|
556 | - case EEM_Question::QST_type_text: |
|
557 | - $result = new EE_Text_Input($input_constructor_args); |
|
558 | - break; |
|
559 | - // Textarea |
|
560 | - case EEM_Question::QST_type_textarea: |
|
561 | - $result = new EE_Text_Area_Input($input_constructor_args); |
|
562 | - break; |
|
563 | - // Radio Buttons |
|
564 | - case EEM_Question::QST_type_radio: |
|
565 | - $result = new EE_Radio_Button_Input($this->options(), $input_constructor_args); |
|
566 | - break; |
|
567 | - // Dropdown |
|
568 | - case EEM_Question::QST_type_dropdown: |
|
569 | - $result = new EE_Select_Input($this->options(), $input_constructor_args); |
|
570 | - break; |
|
571 | - // State Dropdown |
|
572 | - case EEM_Question::QST_type_state: |
|
573 | - $state_options = apply_filters( |
|
574 | - 'FHEE__EE_Question__generate_form_input__state_options', |
|
575 | - null, |
|
576 | - $this, |
|
577 | - $registration, |
|
578 | - $answer |
|
579 | - ); |
|
580 | - $result = new EE_State_Select_Input($state_options, $input_constructor_args); |
|
581 | - break; |
|
582 | - // Country Dropdown |
|
583 | - case EEM_Question::QST_type_country: |
|
584 | - $country_options = apply_filters( |
|
585 | - 'FHEE__EE_Question__generate_form_input__country_options', |
|
586 | - null, |
|
587 | - $this, |
|
588 | - $registration, |
|
589 | - $answer |
|
590 | - ); |
|
591 | - $result = new EE_Country_Select_Input($country_options, $input_constructor_args); |
|
592 | - break; |
|
593 | - // Checkboxes |
|
594 | - case EEM_Question::QST_type_checkbox: |
|
595 | - $result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args); |
|
596 | - break; |
|
597 | - // Date |
|
598 | - case EEM_Question::QST_type_date: |
|
599 | - $result = new EE_Datepicker_Input($input_constructor_args); |
|
600 | - break; |
|
601 | - case EEM_Question::QST_type_html_textarea: |
|
602 | - $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy(); |
|
603 | - $result = new EE_Text_Area_Input($input_constructor_args); |
|
604 | - $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy'); |
|
605 | - break; |
|
606 | - case EEM_Question::QST_type_email: |
|
607 | - $result = new EE_Email_Input($input_constructor_args); |
|
608 | - break; |
|
609 | - // Email confirm |
|
610 | - case EEM_Question::QST_type_email_confirm: |
|
611 | - $result = new EE_Email_Confirm_Input($input_constructor_args); |
|
612 | - break; |
|
613 | - case EEM_Question::QST_type_us_phone: |
|
614 | - $result = new EE_Phone_Input($input_constructor_args); |
|
615 | - break; |
|
616 | - case EEM_Question::QST_type_int: |
|
617 | - $result = new EE_Integer_Input($input_constructor_args); |
|
618 | - break; |
|
619 | - case EEM_Question::QST_type_decimal: |
|
620 | - $result = new EE_Float_Input($input_constructor_args); |
|
621 | - break; |
|
622 | - case EEM_Question::QST_type_url: |
|
623 | - $input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy'); |
|
624 | - $result = new EE_Text_Input($input_constructor_args); |
|
625 | - break; |
|
626 | - case EEM_Question::QST_type_year: |
|
627 | - $result = new EE_Year_Input( |
|
628 | - $input_constructor_args, |
|
629 | - apply_filters( |
|
630 | - 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit', |
|
631 | - true, |
|
632 | - $this |
|
633 | - ), |
|
634 | - apply_filters( |
|
635 | - 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range', |
|
636 | - 100, |
|
637 | - $this |
|
638 | - ), |
|
639 | - apply_filters( |
|
640 | - 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range', |
|
641 | - 100, |
|
642 | - $this |
|
643 | - ) |
|
644 | - ); |
|
645 | - break; |
|
646 | - case EEM_Question::QST_type_multi_select: |
|
647 | - $result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args); |
|
648 | - break; |
|
649 | - // fallback |
|
650 | - default: |
|
651 | - $default_input = apply_filters( |
|
652 | - 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default', |
|
653 | - null, |
|
654 | - $this->type(), |
|
655 | - $this, |
|
656 | - $input_constructor_args |
|
657 | - ); |
|
658 | - if (! $default_input) { |
|
659 | - $default_input = new EE_Text_Input($input_constructor_args); |
|
660 | - } |
|
661 | - $result = $default_input; |
|
662 | - } |
|
663 | - return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer); |
|
664 | - } |
|
665 | - |
|
666 | - |
|
667 | - /** |
|
668 | - * Returns whether or not this question type should have question option entries |
|
669 | - * |
|
670 | - * @return bool |
|
671 | - */ |
|
672 | - public function should_have_question_options() |
|
673 | - { |
|
674 | - return in_array( |
|
675 | - $this->type(), |
|
676 | - $this->_model->question_types_with_options(), |
|
677 | - true |
|
678 | - ); |
|
679 | - } |
|
16 | + /** |
|
17 | + * |
|
18 | + * @param array $props_n_values incoming values |
|
19 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
20 | + * used.) |
|
21 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
22 | + * date_format and the second value is the time format |
|
23 | + * @return EE_Question |
|
24 | + */ |
|
25 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
26 | + { |
|
27 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
28 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
29 | + } |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * @param array $props_n_values incoming values from the database |
|
34 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
35 | + * the website will be used. |
|
36 | + * @return EE_Question |
|
37 | + */ |
|
38 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
39 | + { |
|
40 | + return new self($props_n_values, true, $timezone); |
|
41 | + } |
|
42 | + |
|
43 | + |
|
44 | + /** |
|
45 | + * Set Question display text |
|
46 | + * |
|
47 | + * @access public |
|
48 | + * @param string $QST_display_text |
|
49 | + */ |
|
50 | + public function set_display_text($QST_display_text = '') |
|
51 | + { |
|
52 | + $this->set('QST_display_text', $QST_display_text); |
|
53 | + } |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * Set Question admin text |
|
58 | + * |
|
59 | + * @access public |
|
60 | + * @param string $QST_admin_label |
|
61 | + */ |
|
62 | + public function set_admin_label($QST_admin_label = '') |
|
63 | + { |
|
64 | + $this->set('QST_admin_label', $QST_admin_label); |
|
65 | + } |
|
66 | + |
|
67 | + |
|
68 | + /** |
|
69 | + * Set system name |
|
70 | + * |
|
71 | + * @access public |
|
72 | + * @param mixed $QST_system |
|
73 | + */ |
|
74 | + public function set_system_ID($QST_system = '') |
|
75 | + { |
|
76 | + $this->set('QST_system', $QST_system); |
|
77 | + } |
|
78 | + |
|
79 | + |
|
80 | + /** |
|
81 | + * Set question's type |
|
82 | + * |
|
83 | + * @access public |
|
84 | + * @param string $QST_type |
|
85 | + */ |
|
86 | + public function set_question_type($QST_type = '') |
|
87 | + { |
|
88 | + $this->set('QST_type', $QST_type); |
|
89 | + } |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * Sets whether this question must be answered when presented in a form |
|
94 | + * |
|
95 | + * @access public |
|
96 | + * @param bool $QST_required |
|
97 | + */ |
|
98 | + public function set_required($QST_required = false) |
|
99 | + { |
|
100 | + $this->set('QST_required', $QST_required); |
|
101 | + } |
|
102 | + |
|
103 | + |
|
104 | + /** |
|
105 | + * Set Question display text |
|
106 | + * |
|
107 | + * @access public |
|
108 | + * @param string $QST_required_text |
|
109 | + */ |
|
110 | + public function set_required_text($QST_required_text = '') |
|
111 | + { |
|
112 | + $this->set('QST_required_text', $QST_required_text); |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * Sets the order of this question when placed in a sequence of questions |
|
118 | + * |
|
119 | + * @access public |
|
120 | + * @param int $QST_order |
|
121 | + */ |
|
122 | + public function set_order($QST_order = 0) |
|
123 | + { |
|
124 | + $this->set('QST_order', $QST_order); |
|
125 | + } |
|
126 | + |
|
127 | + |
|
128 | + /** |
|
129 | + * Sets whether the question is admin-only |
|
130 | + * |
|
131 | + * @access public |
|
132 | + * @param bool $QST_admin_only |
|
133 | + */ |
|
134 | + public function set_admin_only($QST_admin_only = false) |
|
135 | + { |
|
136 | + $this->set('QST_admin_only', $QST_admin_only); |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * Sets the wordpress user ID on the question |
|
142 | + * |
|
143 | + * @access public |
|
144 | + * @param int $QST_wp_user |
|
145 | + */ |
|
146 | + public function set_wp_user($QST_wp_user = 1) |
|
147 | + { |
|
148 | + $this->set('QST_wp_user', $QST_wp_user); |
|
149 | + } |
|
150 | + |
|
151 | + |
|
152 | + /** |
|
153 | + * Sets whether the question has been deleted |
|
154 | + * (we use this boolean instead of actually |
|
155 | + * deleting it because when users delete this question |
|
156 | + * they really want to remove the question from future |
|
157 | + * forms, BUT keep their old answers which depend |
|
158 | + * on this record actually existing. |
|
159 | + * |
|
160 | + * @access public |
|
161 | + * @param bool $QST_deleted |
|
162 | + */ |
|
163 | + public function set_deleted($QST_deleted = false) |
|
164 | + { |
|
165 | + $this->set('QST_deleted', $QST_deleted); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * returns the text for displaying the question to users |
|
171 | + * |
|
172 | + * @access public |
|
173 | + * @return string |
|
174 | + */ |
|
175 | + public function display_text() |
|
176 | + { |
|
177 | + return $this->get('QST_display_text'); |
|
178 | + } |
|
179 | + |
|
180 | + |
|
181 | + /** |
|
182 | + * returns the text for the administrative label |
|
183 | + * |
|
184 | + * @access public |
|
185 | + * @return string |
|
186 | + */ |
|
187 | + public function admin_label() |
|
188 | + { |
|
189 | + return $this->get('QST_admin_label'); |
|
190 | + } |
|
191 | + |
|
192 | + |
|
193 | + /** |
|
194 | + * returns the attendee column name for this question |
|
195 | + * |
|
196 | + * @access public |
|
197 | + * @return string |
|
198 | + */ |
|
199 | + public function system_ID() |
|
200 | + { |
|
201 | + return $this->get('QST_system'); |
|
202 | + } |
|
203 | + |
|
204 | + |
|
205 | + /** |
|
206 | + * returns either a string of 'text', 'textfield', etc. |
|
207 | + * |
|
208 | + * @access public |
|
209 | + * @return boolean |
|
210 | + */ |
|
211 | + public function required() |
|
212 | + { |
|
213 | + return $this->get('QST_required'); |
|
214 | + } |
|
215 | + |
|
216 | + |
|
217 | + /** |
|
218 | + * returns the text which should be displayed when a user |
|
219 | + * doesn't answer this question in a form |
|
220 | + * |
|
221 | + * @access public |
|
222 | + * @return string |
|
223 | + */ |
|
224 | + public function required_text() |
|
225 | + { |
|
226 | + return $this->get('QST_required_text'); |
|
227 | + } |
|
228 | + |
|
229 | + |
|
230 | + /** |
|
231 | + * returns the type of this question |
|
232 | + * |
|
233 | + * @access public |
|
234 | + * @return string |
|
235 | + */ |
|
236 | + public function type() |
|
237 | + { |
|
238 | + return $this->get('QST_type'); |
|
239 | + } |
|
240 | + |
|
241 | + |
|
242 | + /** |
|
243 | + * returns an integer showing where this question should |
|
244 | + * be placed in a sequence of questions |
|
245 | + * |
|
246 | + * @access public |
|
247 | + * @return int |
|
248 | + */ |
|
249 | + public function order() |
|
250 | + { |
|
251 | + return $this->get('QST_order'); |
|
252 | + } |
|
253 | + |
|
254 | + |
|
255 | + /** |
|
256 | + * returns whether this question should only appears to admins, |
|
257 | + * or to everyone |
|
258 | + * |
|
259 | + * @access public |
|
260 | + * @return boolean |
|
261 | + */ |
|
262 | + public function admin_only() |
|
263 | + { |
|
264 | + return $this->get('QST_admin_only'); |
|
265 | + } |
|
266 | + |
|
267 | + |
|
268 | + /** |
|
269 | + * returns the id the wordpress user who created this question |
|
270 | + * |
|
271 | + * @access public |
|
272 | + * @return int |
|
273 | + */ |
|
274 | + public function wp_user() |
|
275 | + { |
|
276 | + return $this->get('QST_wp_user'); |
|
277 | + } |
|
278 | + |
|
279 | + |
|
280 | + /** |
|
281 | + * returns whether this question has been marked as 'deleted' |
|
282 | + * |
|
283 | + * @access public |
|
284 | + * @return boolean |
|
285 | + */ |
|
286 | + public function deleted() |
|
287 | + { |
|
288 | + return $this->get('QST_deleted'); |
|
289 | + } |
|
290 | + |
|
291 | + |
|
292 | + /** |
|
293 | + * Gets an array of related EE_Answer to this EE_Question |
|
294 | + * |
|
295 | + * @return EE_Answer[] |
|
296 | + */ |
|
297 | + public function answers() |
|
298 | + { |
|
299 | + return $this->get_many_related('Answer'); |
|
300 | + } |
|
301 | + |
|
302 | + |
|
303 | + /** |
|
304 | + * Boolean check for if there are answers on this question in th db |
|
305 | + * |
|
306 | + * @return boolean true = has answers, false = no answers. |
|
307 | + */ |
|
308 | + public function has_answers() |
|
309 | + { |
|
310 | + return $this->count_related('Answer') > 0 ? true : false; |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + /** |
|
315 | + * gets an array of EE_Question_Group which relate to this question |
|
316 | + * |
|
317 | + * @return EE_Question_Group[] |
|
318 | + */ |
|
319 | + public function question_groups() |
|
320 | + { |
|
321 | + return $this->get_many_related('Question_Group'); |
|
322 | + } |
|
323 | + |
|
324 | + |
|
325 | + /** |
|
326 | + * Returns all the options for this question. By default, it returns only the not-yet-deleted ones. |
|
327 | + * |
|
328 | + * @param boolean $notDeletedOptionsOnly 1 |
|
329 | + * whether to return ALL options, or only the ones which have |
|
330 | + * not yet been deleleted |
|
331 | + * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question, |
|
332 | + * we want to usually only show non-deleted options AND the |
|
333 | + * value that was selected for the answer, whether it was |
|
334 | + * trashed or not. |
|
335 | + * @return EE_Question_Option[] |
|
336 | + */ |
|
337 | + public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null) |
|
338 | + { |
|
339 | + if (! $this->ID()) { |
|
340 | + return array(); |
|
341 | + } |
|
342 | + $query_params = array(); |
|
343 | + if ($selected_value_to_always_include) { |
|
344 | + if (is_array($selected_value_to_always_include)) { |
|
345 | + $query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include); |
|
346 | + } else { |
|
347 | + $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include; |
|
348 | + } |
|
349 | + } |
|
350 | + if ($notDeletedOptionsOnly) { |
|
351 | + $query_params[0]['OR*options-query']['QSO_deleted'] = false; |
|
352 | + } |
|
353 | + // order by QSO_order |
|
354 | + $query_params['order_by'] = array('QSO_order' => 'ASC'); |
|
355 | + return $this->get_many_related('Question_Option', $query_params); |
|
356 | + } |
|
357 | + |
|
358 | + |
|
359 | + /** |
|
360 | + * returns an array of EE_Question_Options which relate to this question |
|
361 | + * |
|
362 | + * @return \EE_Question_Option[] |
|
363 | + */ |
|
364 | + public function temp_options() |
|
365 | + { |
|
366 | + return $this->_model_relations['Question_Option']; |
|
367 | + } |
|
368 | + |
|
369 | + |
|
370 | + /** |
|
371 | + * Adds an option for this question. Note: if the option were previously associated with a different |
|
372 | + * Question, that relationship will be overwritten. |
|
373 | + * |
|
374 | + * @param EE_Question_Option $option |
|
375 | + * @return boolean success |
|
376 | + */ |
|
377 | + public function add_option(EE_Question_Option $option) |
|
378 | + { |
|
379 | + return $this->_add_relation_to($option, 'Question_Option'); |
|
380 | + } |
|
381 | + |
|
382 | + |
|
383 | + /** |
|
384 | + * Adds an option directly to this question without saving to the db |
|
385 | + * |
|
386 | + * @param EE_Question_Option $option |
|
387 | + * @return boolean success |
|
388 | + */ |
|
389 | + public function add_temp_option(EE_Question_Option $option) |
|
390 | + { |
|
391 | + $this->_model_relations['Question_Option'][] = $option; |
|
392 | + return true; |
|
393 | + } |
|
394 | + |
|
395 | + |
|
396 | + /** |
|
397 | + * Marks the option as deleted. |
|
398 | + * |
|
399 | + * @param EE_Question_Option $option |
|
400 | + * @return boolean success |
|
401 | + */ |
|
402 | + public function remove_option(EE_Question_Option $option) |
|
403 | + { |
|
404 | + return $this->_remove_relation_to($option, 'Question_Option'); |
|
405 | + } |
|
406 | + |
|
407 | + |
|
408 | + /** |
|
409 | + * @return bool |
|
410 | + */ |
|
411 | + public function is_system_question() |
|
412 | + { |
|
413 | + $system_ID = $this->get('QST_system'); |
|
414 | + return ! empty($system_ID) ? true : false; |
|
415 | + } |
|
416 | + |
|
417 | + |
|
418 | + /** |
|
419 | + * The purpose of this method is set the question order this question order to be the max out of all questions |
|
420 | + * |
|
421 | + * @access public |
|
422 | + * @return void |
|
423 | + */ |
|
424 | + public function set_order_to_latest() |
|
425 | + { |
|
426 | + $latest_order = $this->get_model()->get_latest_question_order(); |
|
427 | + $latest_order++; |
|
428 | + $this->set('QST_order', $latest_order); |
|
429 | + } |
|
430 | + |
|
431 | + |
|
432 | + /** |
|
433 | + * Retrieves the list of allowed question types from the model. |
|
434 | + * |
|
435 | + * @return string[] |
|
436 | + */ |
|
437 | + private function _allowed_question_types() |
|
438 | + { |
|
439 | + $questionModel = $this->get_model(); |
|
440 | + /* @var $questionModel EEM_Question */ |
|
441 | + return $questionModel->allowed_question_types(); |
|
442 | + } |
|
443 | + |
|
444 | + /** |
|
445 | + * Duplicates this question and its question options |
|
446 | + * |
|
447 | + * @return \EE_Question |
|
448 | + */ |
|
449 | + public function duplicate($options = array()) |
|
450 | + { |
|
451 | + $new_question = clone $this; |
|
452 | + $new_question->set('QST_ID', null); |
|
453 | + $new_question->set_display_text(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->display_text())); |
|
454 | + $new_question->set_admin_label(sprintf(esc_html__('%s **Duplicate**', 'event_espresso'), $this->admin_label())); |
|
455 | + $new_question->set_system_ID(null); |
|
456 | + $new_question->set_wp_user(get_current_user_id()); |
|
457 | + // if we're duplicating a trashed question, assume we don't want the new one to be trashed |
|
458 | + $new_question->set_deleted(false); |
|
459 | + $success = $new_question->save(); |
|
460 | + if ($success) { |
|
461 | + // we don't totally want to duplicate the question options, because we want them to be for the NEW question |
|
462 | + foreach ($this->options() as $question_option) { |
|
463 | + $question_option->duplicate(array('QST_ID' => $new_question->ID())); |
|
464 | + } |
|
465 | + return $new_question; |
|
466 | + } else { |
|
467 | + return null; |
|
468 | + } |
|
469 | + } |
|
470 | + |
|
471 | + /** |
|
472 | + * Returns the question's maximum allowed response size |
|
473 | + * |
|
474 | + * @return int|float |
|
475 | + */ |
|
476 | + public function max() |
|
477 | + { |
|
478 | + return $this->get('QST_max'); |
|
479 | + } |
|
480 | + |
|
481 | + /** |
|
482 | + * Sets the question's maximum allowed response size |
|
483 | + * |
|
484 | + * @param int|float $new_max |
|
485 | + * @return void |
|
486 | + */ |
|
487 | + public function set_max($new_max) |
|
488 | + { |
|
489 | + $this->set('QST_max', $new_max); |
|
490 | + } |
|
491 | + |
|
492 | + |
|
493 | + /** |
|
494 | + * Creates a form input from this question which can be used in HTML forms |
|
495 | + * |
|
496 | + * @param EE_Registration $registration |
|
497 | + * @param EE_Answer $answer |
|
498 | + * @param array $input_constructor_args |
|
499 | + * @return EE_Form_Input_Base |
|
500 | + */ |
|
501 | + public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array()) |
|
502 | + { |
|
503 | + $identifier = $this->is_system_question() ? $this->system_ID() : $this->ID(); |
|
504 | + |
|
505 | + $input_constructor_args = array_merge( |
|
506 | + array( |
|
507 | + 'required' => $this->required() ? true : false, |
|
508 | + 'html_label_text' => $this->display_text(), |
|
509 | + 'required_validation_error_message' => $this->required_text(), |
|
510 | + ), |
|
511 | + $input_constructor_args |
|
512 | + ); |
|
513 | + if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) { |
|
514 | + $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID()); |
|
515 | + } |
|
516 | + // has this question been answered ? |
|
517 | + if ( |
|
518 | + $answer instanceof EE_Answer |
|
519 | + && $answer->value() !== '' |
|
520 | + ) { |
|
521 | + // answer gets htmlspecialchars called on it, undo that please |
|
522 | + // because the form input's display strategy may call esc_attr too |
|
523 | + // which also does html special characters |
|
524 | + $values_with_html_special_chars = $answer->value(); |
|
525 | + if (is_array($values_with_html_special_chars)) { |
|
526 | + $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars); |
|
527 | + } else { |
|
528 | + $default_value = htmlspecialchars_decode($values_with_html_special_chars); |
|
529 | + } |
|
530 | + $input_constructor_args['default'] = $default_value; |
|
531 | + } |
|
532 | + $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID()); |
|
533 | + if ( |
|
534 | + in_array( |
|
535 | + $this->type(), |
|
536 | + EEM_Question::instance()->questionTypesWithMaxLength(), |
|
537 | + true |
|
538 | + ) |
|
539 | + ) { |
|
540 | + $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy( |
|
541 | + null, |
|
542 | + min($max_max_for_question, $this->max()) |
|
543 | + ); |
|
544 | + } |
|
545 | + $input_constructor_args = apply_filters( |
|
546 | + 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args', |
|
547 | + $input_constructor_args, |
|
548 | + $registration, |
|
549 | + $this, |
|
550 | + $answer |
|
551 | + ); |
|
552 | + |
|
553 | + $result = null; |
|
554 | + switch ($this->type()) { |
|
555 | + // Text |
|
556 | + case EEM_Question::QST_type_text: |
|
557 | + $result = new EE_Text_Input($input_constructor_args); |
|
558 | + break; |
|
559 | + // Textarea |
|
560 | + case EEM_Question::QST_type_textarea: |
|
561 | + $result = new EE_Text_Area_Input($input_constructor_args); |
|
562 | + break; |
|
563 | + // Radio Buttons |
|
564 | + case EEM_Question::QST_type_radio: |
|
565 | + $result = new EE_Radio_Button_Input($this->options(), $input_constructor_args); |
|
566 | + break; |
|
567 | + // Dropdown |
|
568 | + case EEM_Question::QST_type_dropdown: |
|
569 | + $result = new EE_Select_Input($this->options(), $input_constructor_args); |
|
570 | + break; |
|
571 | + // State Dropdown |
|
572 | + case EEM_Question::QST_type_state: |
|
573 | + $state_options = apply_filters( |
|
574 | + 'FHEE__EE_Question__generate_form_input__state_options', |
|
575 | + null, |
|
576 | + $this, |
|
577 | + $registration, |
|
578 | + $answer |
|
579 | + ); |
|
580 | + $result = new EE_State_Select_Input($state_options, $input_constructor_args); |
|
581 | + break; |
|
582 | + // Country Dropdown |
|
583 | + case EEM_Question::QST_type_country: |
|
584 | + $country_options = apply_filters( |
|
585 | + 'FHEE__EE_Question__generate_form_input__country_options', |
|
586 | + null, |
|
587 | + $this, |
|
588 | + $registration, |
|
589 | + $answer |
|
590 | + ); |
|
591 | + $result = new EE_Country_Select_Input($country_options, $input_constructor_args); |
|
592 | + break; |
|
593 | + // Checkboxes |
|
594 | + case EEM_Question::QST_type_checkbox: |
|
595 | + $result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args); |
|
596 | + break; |
|
597 | + // Date |
|
598 | + case EEM_Question::QST_type_date: |
|
599 | + $result = new EE_Datepicker_Input($input_constructor_args); |
|
600 | + break; |
|
601 | + case EEM_Question::QST_type_html_textarea: |
|
602 | + $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy(); |
|
603 | + $result = new EE_Text_Area_Input($input_constructor_args); |
|
604 | + $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy'); |
|
605 | + break; |
|
606 | + case EEM_Question::QST_type_email: |
|
607 | + $result = new EE_Email_Input($input_constructor_args); |
|
608 | + break; |
|
609 | + // Email confirm |
|
610 | + case EEM_Question::QST_type_email_confirm: |
|
611 | + $result = new EE_Email_Confirm_Input($input_constructor_args); |
|
612 | + break; |
|
613 | + case EEM_Question::QST_type_us_phone: |
|
614 | + $result = new EE_Phone_Input($input_constructor_args); |
|
615 | + break; |
|
616 | + case EEM_Question::QST_type_int: |
|
617 | + $result = new EE_Integer_Input($input_constructor_args); |
|
618 | + break; |
|
619 | + case EEM_Question::QST_type_decimal: |
|
620 | + $result = new EE_Float_Input($input_constructor_args); |
|
621 | + break; |
|
622 | + case EEM_Question::QST_type_url: |
|
623 | + $input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy'); |
|
624 | + $result = new EE_Text_Input($input_constructor_args); |
|
625 | + break; |
|
626 | + case EEM_Question::QST_type_year: |
|
627 | + $result = new EE_Year_Input( |
|
628 | + $input_constructor_args, |
|
629 | + apply_filters( |
|
630 | + 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit', |
|
631 | + true, |
|
632 | + $this |
|
633 | + ), |
|
634 | + apply_filters( |
|
635 | + 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range', |
|
636 | + 100, |
|
637 | + $this |
|
638 | + ), |
|
639 | + apply_filters( |
|
640 | + 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range', |
|
641 | + 100, |
|
642 | + $this |
|
643 | + ) |
|
644 | + ); |
|
645 | + break; |
|
646 | + case EEM_Question::QST_type_multi_select: |
|
647 | + $result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args); |
|
648 | + break; |
|
649 | + // fallback |
|
650 | + default: |
|
651 | + $default_input = apply_filters( |
|
652 | + 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default', |
|
653 | + null, |
|
654 | + $this->type(), |
|
655 | + $this, |
|
656 | + $input_constructor_args |
|
657 | + ); |
|
658 | + if (! $default_input) { |
|
659 | + $default_input = new EE_Text_Input($input_constructor_args); |
|
660 | + } |
|
661 | + $result = $default_input; |
|
662 | + } |
|
663 | + return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer); |
|
664 | + } |
|
665 | + |
|
666 | + |
|
667 | + /** |
|
668 | + * Returns whether or not this question type should have question option entries |
|
669 | + * |
|
670 | + * @return bool |
|
671 | + */ |
|
672 | + public function should_have_question_options() |
|
673 | + { |
|
674 | + return in_array( |
|
675 | + $this->type(), |
|
676 | + $this->_model->question_types_with_options(), |
|
677 | + true |
|
678 | + ); |
|
679 | + } |
|
680 | 680 | } |
@@ -285,7 +285,7 @@ |
||
285 | 285 | */ |
286 | 286 | public function pretty_price() |
287 | 287 | { |
288 | - return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%'; |
|
288 | + return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount').'%'; |
|
289 | 289 | } |
290 | 290 | |
291 | 291 |
@@ -9,289 +9,289 @@ |
||
9 | 9 | */ |
10 | 10 | class EE_Price extends EE_Soft_Delete_Base_Class |
11 | 11 | { |
12 | - /** |
|
13 | - * @param array $props_n_values incoming values |
|
14 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
15 | - * used.) |
|
16 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
17 | - * date_format and the second value is the time format |
|
18 | - * @return EE_Price |
|
19 | - */ |
|
20 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
21 | - { |
|
22 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
23 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
24 | - } |
|
25 | - |
|
26 | - |
|
27 | - /** |
|
28 | - * @param array $props_n_values incoming values from the database |
|
29 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
30 | - * the website will be used. |
|
31 | - * @return EE_Price |
|
32 | - */ |
|
33 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
34 | - { |
|
35 | - return new self($props_n_values, true, $timezone); |
|
36 | - } |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * Set Price type ID |
|
41 | - * |
|
42 | - * @access public |
|
43 | - * @param int $PRT_ID |
|
44 | - */ |
|
45 | - public function set_type($PRT_ID = 0) |
|
46 | - { |
|
47 | - $this->set('PRT_ID', $PRT_ID); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - /** |
|
52 | - * Set Price Amount |
|
53 | - * |
|
54 | - * @access public |
|
55 | - * @param float $PRC_amount |
|
56 | - */ |
|
57 | - public function set_amount($PRC_amount = 0.00) |
|
58 | - { |
|
59 | - $this->set('PRC_amount', $PRC_amount); |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * Set Price Name |
|
65 | - * |
|
66 | - * @access public |
|
67 | - * @param string $PRC_name |
|
68 | - */ |
|
69 | - public function set_name($PRC_name = '') |
|
70 | - { |
|
71 | - $this->set('PRC_name', $PRC_name); |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * Set Price Description |
|
77 | - * |
|
78 | - * @access public |
|
79 | - * @param string $PRC_desc |
|
80 | - */ |
|
81 | - public function set_description($PRC_desc = '') |
|
82 | - { |
|
83 | - $this->Set('PRC_desc', $PRC_desc); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * set is_default |
|
89 | - * |
|
90 | - * @access public |
|
91 | - * @param bool $PRC_is_default |
|
92 | - */ |
|
93 | - public function set_is_default($PRC_is_default = false) |
|
94 | - { |
|
95 | - $this->set('PRC_is_default', $PRC_is_default); |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * set deleted |
|
101 | - * |
|
102 | - * @access public |
|
103 | - * @param bool $PRC_deleted |
|
104 | - */ |
|
105 | - public function set_deleted($PRC_deleted = null) |
|
106 | - { |
|
107 | - $this->set('PRC_deleted', $PRC_deleted); |
|
108 | - } |
|
109 | - |
|
110 | - |
|
111 | - /** |
|
112 | - * get Price type |
|
113 | - * |
|
114 | - * @access public |
|
115 | - * @return int |
|
116 | - */ |
|
117 | - public function type() |
|
118 | - { |
|
119 | - return $this->get('PRT_ID'); |
|
120 | - } |
|
121 | - |
|
122 | - |
|
123 | - /** |
|
124 | - * get Price Amount |
|
125 | - * |
|
126 | - * @access public |
|
127 | - * @return float |
|
128 | - */ |
|
129 | - public function amount() |
|
130 | - { |
|
131 | - return $this->get('PRC_amount'); |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - /** |
|
136 | - * get Price Name |
|
137 | - * |
|
138 | - * @access public |
|
139 | - * @return string |
|
140 | - */ |
|
141 | - public function name() |
|
142 | - { |
|
143 | - return $this->get('PRC_name'); |
|
144 | - } |
|
145 | - |
|
146 | - |
|
147 | - /** |
|
148 | - * get Price description |
|
149 | - * |
|
150 | - * @access public |
|
151 | - * @return string |
|
152 | - */ |
|
153 | - public function desc() |
|
154 | - { |
|
155 | - return $this->get('PRC_desc'); |
|
156 | - } |
|
157 | - |
|
158 | - |
|
159 | - /** |
|
160 | - * get overrides |
|
161 | - * |
|
162 | - * @access public |
|
163 | - * @return int |
|
164 | - */ |
|
165 | - public function overrides() |
|
166 | - { |
|
167 | - return $this->get('PRC_overrides'); |
|
168 | - } |
|
169 | - |
|
170 | - |
|
171 | - /** |
|
172 | - * get order |
|
173 | - * |
|
174 | - * @access public |
|
175 | - * @return int |
|
176 | - */ |
|
177 | - public function order() |
|
178 | - { |
|
179 | - return $this->get('PRC_order'); |
|
180 | - } |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * get the author of the price |
|
185 | - * |
|
186 | - * @since 4.5.0 |
|
187 | - * |
|
188 | - * @return int |
|
189 | - */ |
|
190 | - public function wp_user() |
|
191 | - { |
|
192 | - return $this->get('PRC_wp_user'); |
|
193 | - } |
|
194 | - |
|
195 | - |
|
196 | - /** |
|
197 | - * get is_default |
|
198 | - * |
|
199 | - * @access public |
|
200 | - * @return bool |
|
201 | - */ |
|
202 | - public function is_default() |
|
203 | - { |
|
204 | - return $this->get('PRC_is_default'); |
|
205 | - } |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * get deleted |
|
210 | - * |
|
211 | - * @access public |
|
212 | - * @return bool |
|
213 | - */ |
|
214 | - public function deleted() |
|
215 | - { |
|
216 | - return $this->get('PRC_deleted'); |
|
217 | - } |
|
218 | - |
|
219 | - |
|
220 | - /** |
|
221 | - * @return bool |
|
222 | - */ |
|
223 | - public function parent() |
|
224 | - { |
|
225 | - return $this->get('PRC_parent'); |
|
226 | - } |
|
227 | - |
|
228 | - |
|
229 | - // some helper methods for getting info on the price_type for this price |
|
230 | - |
|
231 | - /** |
|
232 | - * return whether the price is a base price or not |
|
233 | - * |
|
234 | - * @return boolean |
|
235 | - */ |
|
236 | - public function is_base_price() |
|
237 | - { |
|
238 | - $price_type = $this->type_obj(); |
|
239 | - return $price_type->base_type() === 1; |
|
240 | - } |
|
241 | - |
|
242 | - |
|
243 | - /** |
|
244 | - * |
|
245 | - * @return EE_Price_Type |
|
246 | - */ |
|
247 | - public function type_obj() |
|
248 | - { |
|
249 | - return $this->get_first_related('Price_Type'); |
|
250 | - } |
|
251 | - |
|
252 | - |
|
253 | - /** |
|
254 | - * Simply indicates whether this price increases or decreases the total |
|
255 | - * |
|
256 | - * @return boolean true = discount, otherwise adds to the total |
|
257 | - */ |
|
258 | - public function is_discount() |
|
259 | - { |
|
260 | - $price_type = $this->type_obj(); |
|
261 | - return $price_type->is_discount(); |
|
262 | - } |
|
263 | - |
|
264 | - |
|
265 | - /** |
|
266 | - * whether the price is a percentage or not |
|
267 | - * |
|
268 | - * @return boolean |
|
269 | - */ |
|
270 | - public function is_percent() |
|
271 | - { |
|
272 | - $price_type = $this->type_obj(); |
|
273 | - return $price_type->get('PRT_is_percent'); |
|
274 | - } |
|
275 | - |
|
276 | - |
|
277 | - /** |
|
278 | - * return pretty price dependant on whether its a dollar or percent. |
|
279 | - * |
|
280 | - * @since 4.4.0 |
|
281 | - * |
|
282 | - * @return string |
|
283 | - */ |
|
284 | - public function pretty_price() |
|
285 | - { |
|
286 | - return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%'; |
|
287 | - } |
|
288 | - |
|
289 | - |
|
290 | - /** |
|
291 | - * @return mixed |
|
292 | - */ |
|
293 | - public function get_price_without_currency_symbol() |
|
294 | - { |
|
295 | - return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount')); |
|
296 | - } |
|
12 | + /** |
|
13 | + * @param array $props_n_values incoming values |
|
14 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
15 | + * used.) |
|
16 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
17 | + * date_format and the second value is the time format |
|
18 | + * @return EE_Price |
|
19 | + */ |
|
20 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
21 | + { |
|
22 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
23 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
24 | + } |
|
25 | + |
|
26 | + |
|
27 | + /** |
|
28 | + * @param array $props_n_values incoming values from the database |
|
29 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
30 | + * the website will be used. |
|
31 | + * @return EE_Price |
|
32 | + */ |
|
33 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
34 | + { |
|
35 | + return new self($props_n_values, true, $timezone); |
|
36 | + } |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * Set Price type ID |
|
41 | + * |
|
42 | + * @access public |
|
43 | + * @param int $PRT_ID |
|
44 | + */ |
|
45 | + public function set_type($PRT_ID = 0) |
|
46 | + { |
|
47 | + $this->set('PRT_ID', $PRT_ID); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + /** |
|
52 | + * Set Price Amount |
|
53 | + * |
|
54 | + * @access public |
|
55 | + * @param float $PRC_amount |
|
56 | + */ |
|
57 | + public function set_amount($PRC_amount = 0.00) |
|
58 | + { |
|
59 | + $this->set('PRC_amount', $PRC_amount); |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * Set Price Name |
|
65 | + * |
|
66 | + * @access public |
|
67 | + * @param string $PRC_name |
|
68 | + */ |
|
69 | + public function set_name($PRC_name = '') |
|
70 | + { |
|
71 | + $this->set('PRC_name', $PRC_name); |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * Set Price Description |
|
77 | + * |
|
78 | + * @access public |
|
79 | + * @param string $PRC_desc |
|
80 | + */ |
|
81 | + public function set_description($PRC_desc = '') |
|
82 | + { |
|
83 | + $this->Set('PRC_desc', $PRC_desc); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * set is_default |
|
89 | + * |
|
90 | + * @access public |
|
91 | + * @param bool $PRC_is_default |
|
92 | + */ |
|
93 | + public function set_is_default($PRC_is_default = false) |
|
94 | + { |
|
95 | + $this->set('PRC_is_default', $PRC_is_default); |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * set deleted |
|
101 | + * |
|
102 | + * @access public |
|
103 | + * @param bool $PRC_deleted |
|
104 | + */ |
|
105 | + public function set_deleted($PRC_deleted = null) |
|
106 | + { |
|
107 | + $this->set('PRC_deleted', $PRC_deleted); |
|
108 | + } |
|
109 | + |
|
110 | + |
|
111 | + /** |
|
112 | + * get Price type |
|
113 | + * |
|
114 | + * @access public |
|
115 | + * @return int |
|
116 | + */ |
|
117 | + public function type() |
|
118 | + { |
|
119 | + return $this->get('PRT_ID'); |
|
120 | + } |
|
121 | + |
|
122 | + |
|
123 | + /** |
|
124 | + * get Price Amount |
|
125 | + * |
|
126 | + * @access public |
|
127 | + * @return float |
|
128 | + */ |
|
129 | + public function amount() |
|
130 | + { |
|
131 | + return $this->get('PRC_amount'); |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + /** |
|
136 | + * get Price Name |
|
137 | + * |
|
138 | + * @access public |
|
139 | + * @return string |
|
140 | + */ |
|
141 | + public function name() |
|
142 | + { |
|
143 | + return $this->get('PRC_name'); |
|
144 | + } |
|
145 | + |
|
146 | + |
|
147 | + /** |
|
148 | + * get Price description |
|
149 | + * |
|
150 | + * @access public |
|
151 | + * @return string |
|
152 | + */ |
|
153 | + public function desc() |
|
154 | + { |
|
155 | + return $this->get('PRC_desc'); |
|
156 | + } |
|
157 | + |
|
158 | + |
|
159 | + /** |
|
160 | + * get overrides |
|
161 | + * |
|
162 | + * @access public |
|
163 | + * @return int |
|
164 | + */ |
|
165 | + public function overrides() |
|
166 | + { |
|
167 | + return $this->get('PRC_overrides'); |
|
168 | + } |
|
169 | + |
|
170 | + |
|
171 | + /** |
|
172 | + * get order |
|
173 | + * |
|
174 | + * @access public |
|
175 | + * @return int |
|
176 | + */ |
|
177 | + public function order() |
|
178 | + { |
|
179 | + return $this->get('PRC_order'); |
|
180 | + } |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * get the author of the price |
|
185 | + * |
|
186 | + * @since 4.5.0 |
|
187 | + * |
|
188 | + * @return int |
|
189 | + */ |
|
190 | + public function wp_user() |
|
191 | + { |
|
192 | + return $this->get('PRC_wp_user'); |
|
193 | + } |
|
194 | + |
|
195 | + |
|
196 | + /** |
|
197 | + * get is_default |
|
198 | + * |
|
199 | + * @access public |
|
200 | + * @return bool |
|
201 | + */ |
|
202 | + public function is_default() |
|
203 | + { |
|
204 | + return $this->get('PRC_is_default'); |
|
205 | + } |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * get deleted |
|
210 | + * |
|
211 | + * @access public |
|
212 | + * @return bool |
|
213 | + */ |
|
214 | + public function deleted() |
|
215 | + { |
|
216 | + return $this->get('PRC_deleted'); |
|
217 | + } |
|
218 | + |
|
219 | + |
|
220 | + /** |
|
221 | + * @return bool |
|
222 | + */ |
|
223 | + public function parent() |
|
224 | + { |
|
225 | + return $this->get('PRC_parent'); |
|
226 | + } |
|
227 | + |
|
228 | + |
|
229 | + // some helper methods for getting info on the price_type for this price |
|
230 | + |
|
231 | + /** |
|
232 | + * return whether the price is a base price or not |
|
233 | + * |
|
234 | + * @return boolean |
|
235 | + */ |
|
236 | + public function is_base_price() |
|
237 | + { |
|
238 | + $price_type = $this->type_obj(); |
|
239 | + return $price_type->base_type() === 1; |
|
240 | + } |
|
241 | + |
|
242 | + |
|
243 | + /** |
|
244 | + * |
|
245 | + * @return EE_Price_Type |
|
246 | + */ |
|
247 | + public function type_obj() |
|
248 | + { |
|
249 | + return $this->get_first_related('Price_Type'); |
|
250 | + } |
|
251 | + |
|
252 | + |
|
253 | + /** |
|
254 | + * Simply indicates whether this price increases or decreases the total |
|
255 | + * |
|
256 | + * @return boolean true = discount, otherwise adds to the total |
|
257 | + */ |
|
258 | + public function is_discount() |
|
259 | + { |
|
260 | + $price_type = $this->type_obj(); |
|
261 | + return $price_type->is_discount(); |
|
262 | + } |
|
263 | + |
|
264 | + |
|
265 | + /** |
|
266 | + * whether the price is a percentage or not |
|
267 | + * |
|
268 | + * @return boolean |
|
269 | + */ |
|
270 | + public function is_percent() |
|
271 | + { |
|
272 | + $price_type = $this->type_obj(); |
|
273 | + return $price_type->get('PRT_is_percent'); |
|
274 | + } |
|
275 | + |
|
276 | + |
|
277 | + /** |
|
278 | + * return pretty price dependant on whether its a dollar or percent. |
|
279 | + * |
|
280 | + * @since 4.4.0 |
|
281 | + * |
|
282 | + * @return string |
|
283 | + */ |
|
284 | + public function pretty_price() |
|
285 | + { |
|
286 | + return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%'; |
|
287 | + } |
|
288 | + |
|
289 | + |
|
290 | + /** |
|
291 | + * @return mixed |
|
292 | + */ |
|
293 | + public function get_price_without_currency_symbol() |
|
294 | + { |
|
295 | + return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount')); |
|
296 | + } |
|
297 | 297 | } |
@@ -44,7 +44,7 @@ |
||
44 | 44 | { |
45 | 45 | $id = $this->get('STS_ID'); |
46 | 46 | $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema); |
47 | - return $code[ $id ]; |
|
47 | + return $code[$id]; |
|
48 | 48 | } |
49 | 49 | |
50 | 50 |
@@ -11,142 +11,142 @@ |
||
11 | 11 | */ |
12 | 12 | class EE_Status extends EE_Base_Class |
13 | 13 | { |
14 | - /** |
|
15 | - * @param array $props_n_values |
|
16 | - * @return EE_Status |
|
17 | - */ |
|
18 | - public static function new_instance($props_n_values = array()) |
|
19 | - { |
|
20 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
21 | - return $has_object ? $has_object : new self($props_n_values); |
|
22 | - } |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * @param array $props_n_values |
|
27 | - * @return EE_Status |
|
28 | - */ |
|
29 | - public static function new_instance_from_db($props_n_values = array()) |
|
30 | - { |
|
31 | - return new self($props_n_values, true); |
|
32 | - } |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * Gets code |
|
37 | - * |
|
38 | - * @param bool $plural |
|
39 | - * @param string $schema |
|
40 | - * @return string |
|
41 | - */ |
|
42 | - public function code($plural = false, $schema = 'upper') |
|
43 | - { |
|
44 | - $id = $this->get('STS_ID'); |
|
45 | - $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema); |
|
46 | - return $code[ $id ]; |
|
47 | - } |
|
48 | - |
|
49 | - |
|
50 | - /** |
|
51 | - * Sets code |
|
52 | - * |
|
53 | - * @param string $code |
|
54 | - * @return boolean |
|
55 | - */ |
|
56 | - public function set_code($code) |
|
57 | - { |
|
58 | - $this->set('STS_code', $code); |
|
59 | - } |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * Gets desc |
|
64 | - * |
|
65 | - * @return string |
|
66 | - */ |
|
67 | - public function desc() |
|
68 | - { |
|
69 | - return $this->get('STS_desc'); |
|
70 | - } |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * Sets desc |
|
75 | - * |
|
76 | - * @param string $desc |
|
77 | - * @return boolean |
|
78 | - */ |
|
79 | - public function set_desc($desc) |
|
80 | - { |
|
81 | - $this->set('STS_desc', $desc); |
|
82 | - } |
|
83 | - |
|
84 | - |
|
85 | - /** |
|
86 | - * Gets type |
|
87 | - * |
|
88 | - * @return string |
|
89 | - */ |
|
90 | - public function type() |
|
91 | - { |
|
92 | - return $this->get('STS_type'); |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * Sets type |
|
98 | - * |
|
99 | - * @param string $type |
|
100 | - * @return boolean |
|
101 | - */ |
|
102 | - public function set_type($type) |
|
103 | - { |
|
104 | - $this->set('STS_type', $type); |
|
105 | - } |
|
106 | - |
|
107 | - |
|
108 | - /** |
|
109 | - * Gets can_edit |
|
110 | - * |
|
111 | - * @return boolean |
|
112 | - */ |
|
113 | - public function can_edit() |
|
114 | - { |
|
115 | - return $this->get('STS_can_edit'); |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * Sets can_edit |
|
121 | - * |
|
122 | - * @param boolean $can_edit |
|
123 | - * @return boolean |
|
124 | - */ |
|
125 | - public function set_can_edit($can_edit) |
|
126 | - { |
|
127 | - $this->set('STS_can_edit', $can_edit); |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * Gets open |
|
133 | - * |
|
134 | - * @return boolean |
|
135 | - */ |
|
136 | - public function open() |
|
137 | - { |
|
138 | - return $this->get('STS_open'); |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * Sets open |
|
144 | - * |
|
145 | - * @param boolean $open |
|
146 | - * @return boolean |
|
147 | - */ |
|
148 | - public function set_open($open) |
|
149 | - { |
|
150 | - $this->set('STS_open', $open); |
|
151 | - } |
|
14 | + /** |
|
15 | + * @param array $props_n_values |
|
16 | + * @return EE_Status |
|
17 | + */ |
|
18 | + public static function new_instance($props_n_values = array()) |
|
19 | + { |
|
20 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
21 | + return $has_object ? $has_object : new self($props_n_values); |
|
22 | + } |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * @param array $props_n_values |
|
27 | + * @return EE_Status |
|
28 | + */ |
|
29 | + public static function new_instance_from_db($props_n_values = array()) |
|
30 | + { |
|
31 | + return new self($props_n_values, true); |
|
32 | + } |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * Gets code |
|
37 | + * |
|
38 | + * @param bool $plural |
|
39 | + * @param string $schema |
|
40 | + * @return string |
|
41 | + */ |
|
42 | + public function code($plural = false, $schema = 'upper') |
|
43 | + { |
|
44 | + $id = $this->get('STS_ID'); |
|
45 | + $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema); |
|
46 | + return $code[ $id ]; |
|
47 | + } |
|
48 | + |
|
49 | + |
|
50 | + /** |
|
51 | + * Sets code |
|
52 | + * |
|
53 | + * @param string $code |
|
54 | + * @return boolean |
|
55 | + */ |
|
56 | + public function set_code($code) |
|
57 | + { |
|
58 | + $this->set('STS_code', $code); |
|
59 | + } |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * Gets desc |
|
64 | + * |
|
65 | + * @return string |
|
66 | + */ |
|
67 | + public function desc() |
|
68 | + { |
|
69 | + return $this->get('STS_desc'); |
|
70 | + } |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * Sets desc |
|
75 | + * |
|
76 | + * @param string $desc |
|
77 | + * @return boolean |
|
78 | + */ |
|
79 | + public function set_desc($desc) |
|
80 | + { |
|
81 | + $this->set('STS_desc', $desc); |
|
82 | + } |
|
83 | + |
|
84 | + |
|
85 | + /** |
|
86 | + * Gets type |
|
87 | + * |
|
88 | + * @return string |
|
89 | + */ |
|
90 | + public function type() |
|
91 | + { |
|
92 | + return $this->get('STS_type'); |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * Sets type |
|
98 | + * |
|
99 | + * @param string $type |
|
100 | + * @return boolean |
|
101 | + */ |
|
102 | + public function set_type($type) |
|
103 | + { |
|
104 | + $this->set('STS_type', $type); |
|
105 | + } |
|
106 | + |
|
107 | + |
|
108 | + /** |
|
109 | + * Gets can_edit |
|
110 | + * |
|
111 | + * @return boolean |
|
112 | + */ |
|
113 | + public function can_edit() |
|
114 | + { |
|
115 | + return $this->get('STS_can_edit'); |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * Sets can_edit |
|
121 | + * |
|
122 | + * @param boolean $can_edit |
|
123 | + * @return boolean |
|
124 | + */ |
|
125 | + public function set_can_edit($can_edit) |
|
126 | + { |
|
127 | + $this->set('STS_can_edit', $can_edit); |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * Gets open |
|
133 | + * |
|
134 | + * @return boolean |
|
135 | + */ |
|
136 | + public function open() |
|
137 | + { |
|
138 | + return $this->get('STS_open'); |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * Sets open |
|
144 | + * |
|
145 | + * @param boolean $open |
|
146 | + * @return boolean |
|
147 | + */ |
|
148 | + public function set_open($open) |
|
149 | + { |
|
150 | + $this->set('STS_open', $open); |
|
151 | + } |
|
152 | 152 | } |
@@ -23,7 +23,7 @@ |
||
23 | 23 | */ |
24 | 24 | protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
25 | 25 | { |
26 | - if (! isset($fieldValues['slug'])) { |
|
26 | + if ( ! isset($fieldValues['slug'])) { |
|
27 | 27 | $fieldValues['slug'] = $fieldValues['name']; |
28 | 28 | } |
29 | 29 | parent::__construct($fieldValues, $bydb, $timezone); |
@@ -11,87 +11,87 @@ |
||
11 | 11 | */ |
12 | 12 | class EE_Term extends EE_Base_Class |
13 | 13 | { |
14 | - public $post_type; |
|
14 | + public $post_type; |
|
15 | 15 | |
16 | - /** |
|
17 | - * Sets some dynamic defaults |
|
18 | - * |
|
19 | - * @param array $fieldValues |
|
20 | - * @param bool $bydb |
|
21 | - * @param string $timezone |
|
22 | - */ |
|
23 | - protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
24 | - { |
|
25 | - if (! isset($fieldValues['slug'])) { |
|
26 | - $fieldValues['slug'] = $fieldValues['name']; |
|
27 | - } |
|
28 | - parent::__construct($fieldValues, $bydb, $timezone); |
|
29 | - } |
|
16 | + /** |
|
17 | + * Sets some dynamic defaults |
|
18 | + * |
|
19 | + * @param array $fieldValues |
|
20 | + * @param bool $bydb |
|
21 | + * @param string $timezone |
|
22 | + */ |
|
23 | + protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
24 | + { |
|
25 | + if (! isset($fieldValues['slug'])) { |
|
26 | + $fieldValues['slug'] = $fieldValues['name']; |
|
27 | + } |
|
28 | + parent::__construct($fieldValues, $bydb, $timezone); |
|
29 | + } |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * @param array $props_n_values |
|
34 | - * @return EE_Term|mixed |
|
35 | - */ |
|
36 | - public static function new_instance($props_n_values = array()) |
|
37 | - { |
|
38 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
39 | - return $has_object ? $has_object : new self($props_n_values); |
|
40 | - } |
|
32 | + /** |
|
33 | + * @param array $props_n_values |
|
34 | + * @return EE_Term|mixed |
|
35 | + */ |
|
36 | + public static function new_instance($props_n_values = array()) |
|
37 | + { |
|
38 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__); |
|
39 | + return $has_object ? $has_object : new self($props_n_values); |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * @param array $props_n_values |
|
45 | - * @return EE_Term |
|
46 | - */ |
|
47 | - public static function new_instance_from_db($props_n_values = array()) |
|
48 | - { |
|
49 | - return new self($props_n_values, true); |
|
50 | - } |
|
43 | + /** |
|
44 | + * @param array $props_n_values |
|
45 | + * @return EE_Term |
|
46 | + */ |
|
47 | + public static function new_instance_from_db($props_n_values = array()) |
|
48 | + { |
|
49 | + return new self($props_n_values, true); |
|
50 | + } |
|
51 | 51 | |
52 | 52 | |
53 | - /** |
|
54 | - * Gets name |
|
55 | - * |
|
56 | - * @return string |
|
57 | - */ |
|
58 | - public function name() |
|
59 | - { |
|
60 | - return $this->get('name'); |
|
61 | - } |
|
53 | + /** |
|
54 | + * Gets name |
|
55 | + * |
|
56 | + * @return string |
|
57 | + */ |
|
58 | + public function name() |
|
59 | + { |
|
60 | + return $this->get('name'); |
|
61 | + } |
|
62 | 62 | |
63 | 63 | |
64 | - /** |
|
65 | - * Sets name |
|
66 | - * |
|
67 | - * @param string $name |
|
68 | - * @return boolean |
|
69 | - */ |
|
70 | - public function set_name($name) |
|
71 | - { |
|
72 | - $this->set('name', $name); |
|
73 | - } |
|
64 | + /** |
|
65 | + * Sets name |
|
66 | + * |
|
67 | + * @param string $name |
|
68 | + * @return boolean |
|
69 | + */ |
|
70 | + public function set_name($name) |
|
71 | + { |
|
72 | + $this->set('name', $name); |
|
73 | + } |
|
74 | 74 | |
75 | 75 | |
76 | - /** |
|
77 | - * Gets slug |
|
78 | - * |
|
79 | - * @return string |
|
80 | - */ |
|
81 | - public function slug() |
|
82 | - { |
|
83 | - return $this->get('slug'); |
|
84 | - } |
|
76 | + /** |
|
77 | + * Gets slug |
|
78 | + * |
|
79 | + * @return string |
|
80 | + */ |
|
81 | + public function slug() |
|
82 | + { |
|
83 | + return $this->get('slug'); |
|
84 | + } |
|
85 | 85 | |
86 | 86 | |
87 | - /** |
|
88 | - * Sets slug |
|
89 | - * |
|
90 | - * @param string $slug |
|
91 | - * @return boolean |
|
92 | - */ |
|
93 | - public function set_slug($slug) |
|
94 | - { |
|
95 | - $this->set('slug', $slug); |
|
96 | - } |
|
87 | + /** |
|
88 | + * Sets slug |
|
89 | + * |
|
90 | + * @param string $slug |
|
91 | + * @return boolean |
|
92 | + */ |
|
93 | + public function set_slug($slug) |
|
94 | + { |
|
95 | + $this->set('slug', $slug); |
|
96 | + } |
|
97 | 97 | } |
@@ -192,7 +192,7 @@ |
||
192 | 192 | { |
193 | 193 | $model_name_of_related_obj = $this->OBJ_type(); |
194 | 194 | $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
195 | - if (! $is_model_name) { |
|
195 | + if ( ! $is_model_name) { |
|
196 | 196 | return null; |
197 | 197 | } else { |
198 | 198 | return $this->get_first_related($model_name_of_related_obj); |
@@ -10,217 +10,217 @@ |
||
10 | 10 | */ |
11 | 11 | class EE_Change_Log extends EE_Base_Class |
12 | 12 | { |
13 | - /** |
|
14 | - * @param array $props_n_values incoming values |
|
15 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
16 | - * used.) |
|
17 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
18 | - * date_format and the second value is the time format |
|
19 | - * @return EE_Change_Log |
|
20 | - * @throws EE_Error |
|
21 | - */ |
|
22 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
23 | - { |
|
24 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
25 | - return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
26 | - } |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * @param array $props_n_values incoming values from the database |
|
31 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
32 | - * the website will be used. |
|
33 | - * @return EE_Change_Log |
|
34 | - */ |
|
35 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
36 | - { |
|
37 | - return new self($props_n_values, true, $timezone); |
|
38 | - } |
|
39 | - |
|
40 | - /** |
|
41 | - * Gets message |
|
42 | - * |
|
43 | - * @return mixed |
|
44 | - * @throws EE_Error |
|
45 | - */ |
|
46 | - public function message() |
|
47 | - { |
|
48 | - return $this->get('LOG_message'); |
|
49 | - } |
|
50 | - |
|
51 | - /** |
|
52 | - * Sets message |
|
53 | - * |
|
54 | - * @param mixed $message |
|
55 | - * @throws EE_Error |
|
56 | - */ |
|
57 | - public function set_message($message) |
|
58 | - { |
|
59 | - $this->set('LOG_message', $message); |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Gets time |
|
64 | - * |
|
65 | - * @return string |
|
66 | - * @throws EE_Error |
|
67 | - */ |
|
68 | - public function time() |
|
69 | - { |
|
70 | - return $this->get('LOG_time'); |
|
71 | - } |
|
72 | - |
|
73 | - /** |
|
74 | - * Sets time |
|
75 | - * |
|
76 | - * @param string $time |
|
77 | - * @throws EE_Error |
|
78 | - */ |
|
79 | - public function set_time($time) |
|
80 | - { |
|
81 | - $this->set('LOG_time', $time); |
|
82 | - } |
|
83 | - |
|
84 | - /** |
|
85 | - * Gets log_type |
|
86 | - * |
|
87 | - * @return string |
|
88 | - * @throws EE_Error |
|
89 | - */ |
|
90 | - public function log_type() |
|
91 | - { |
|
92 | - return $this->get('LOG_type'); |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * Return the localized log type label. |
|
98 | - * |
|
99 | - * @return string |
|
100 | - * @throws EE_Error |
|
101 | - */ |
|
102 | - public function log_type_label() |
|
103 | - { |
|
104 | - return EEM_Change_Log::get_pretty_label_for_type($this->log_type()); |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Sets log_type |
|
109 | - * |
|
110 | - * @param string $log_type |
|
111 | - * @throws EE_Error |
|
112 | - */ |
|
113 | - public function set_log_type($log_type) |
|
114 | - { |
|
115 | - $this->set('LOG_type', $log_type); |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * Gets type of the model object related to this log |
|
120 | - * |
|
121 | - * @return string |
|
122 | - * @throws EE_Error |
|
123 | - */ |
|
124 | - public function OBJ_type() |
|
125 | - { |
|
126 | - return $this->get('OBJ_type'); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Sets type |
|
131 | - * |
|
132 | - * @param string $type |
|
133 | - * @throws EE_Error |
|
134 | - */ |
|
135 | - public function set_OBJ_type($type) |
|
136 | - { |
|
137 | - $this->set('OBJ_type', $type); |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Gets OBJ_ID (the ID of the item related to this log) |
|
142 | - * |
|
143 | - * @return mixed |
|
144 | - * @throws EE_Error |
|
145 | - */ |
|
146 | - public function OBJ_ID() |
|
147 | - { |
|
148 | - return $this->get('OBJ_ID'); |
|
149 | - } |
|
150 | - |
|
151 | - /** |
|
152 | - * Sets OBJ_ID |
|
153 | - * |
|
154 | - * @param mixed $OBJ_ID |
|
155 | - * @throws EE_Error |
|
156 | - */ |
|
157 | - public function set_OBJ_ID($OBJ_ID) |
|
158 | - { |
|
159 | - $this->set('OBJ_ID', $OBJ_ID); |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Gets wp_user |
|
164 | - * |
|
165 | - * @return int |
|
166 | - * @throws EE_Error |
|
167 | - */ |
|
168 | - public function wp_user() |
|
169 | - { |
|
170 | - return $this->get('LOG_wp_user'); |
|
171 | - } |
|
172 | - |
|
173 | - /** |
|
174 | - * Sets wp_user |
|
175 | - * |
|
176 | - * @param int $wp_user_id |
|
177 | - * @throws EE_Error |
|
178 | - */ |
|
179 | - public function set_wp_user($wp_user_id) |
|
180 | - { |
|
181 | - $this->set('LOG_wp_user', $wp_user_id); |
|
182 | - } |
|
183 | - |
|
184 | - /** |
|
185 | - * Gets the model object attached to this log |
|
186 | - * |
|
187 | - * @return EE_Base_Class |
|
188 | - * @throws EE_Error |
|
189 | - */ |
|
190 | - public function object() |
|
191 | - { |
|
192 | - $model_name_of_related_obj = $this->OBJ_type(); |
|
193 | - $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
|
194 | - if (! $is_model_name) { |
|
195 | - return null; |
|
196 | - } else { |
|
197 | - return $this->get_first_related($model_name_of_related_obj); |
|
198 | - } |
|
199 | - } |
|
200 | - |
|
201 | - /** |
|
202 | - * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using |
|
203 | - * _add_relation_to because you don't have to specify what type of model you're |
|
204 | - * associating it with |
|
205 | - * |
|
206 | - * @param EE_Base_Class $object |
|
207 | - * @param boolean $save |
|
208 | - * @return bool if $save=true, NULL is $save=false |
|
209 | - * @throws EE_Error |
|
210 | - */ |
|
211 | - public function set_object($object, $save = true) |
|
212 | - { |
|
213 | - if ($object instanceof EE_Base_Class) { |
|
214 | - $this->set_OBJ_type($object->get_model()->get_this_model_name()); |
|
215 | - $this->set_OBJ_ID($object->ID()); |
|
216 | - } else { |
|
217 | - $this->set_OBJ_type(null); |
|
218 | - $this->set_OBJ_ID(null); |
|
219 | - } |
|
220 | - if ($save) { |
|
221 | - return $this->save(); |
|
222 | - } else { |
|
223 | - return null; |
|
224 | - } |
|
225 | - } |
|
13 | + /** |
|
14 | + * @param array $props_n_values incoming values |
|
15 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
16 | + * used.) |
|
17 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
18 | + * date_format and the second value is the time format |
|
19 | + * @return EE_Change_Log |
|
20 | + * @throws EE_Error |
|
21 | + */ |
|
22 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
23 | + { |
|
24 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
25 | + return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats); |
|
26 | + } |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * @param array $props_n_values incoming values from the database |
|
31 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
32 | + * the website will be used. |
|
33 | + * @return EE_Change_Log |
|
34 | + */ |
|
35 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
36 | + { |
|
37 | + return new self($props_n_values, true, $timezone); |
|
38 | + } |
|
39 | + |
|
40 | + /** |
|
41 | + * Gets message |
|
42 | + * |
|
43 | + * @return mixed |
|
44 | + * @throws EE_Error |
|
45 | + */ |
|
46 | + public function message() |
|
47 | + { |
|
48 | + return $this->get('LOG_message'); |
|
49 | + } |
|
50 | + |
|
51 | + /** |
|
52 | + * Sets message |
|
53 | + * |
|
54 | + * @param mixed $message |
|
55 | + * @throws EE_Error |
|
56 | + */ |
|
57 | + public function set_message($message) |
|
58 | + { |
|
59 | + $this->set('LOG_message', $message); |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Gets time |
|
64 | + * |
|
65 | + * @return string |
|
66 | + * @throws EE_Error |
|
67 | + */ |
|
68 | + public function time() |
|
69 | + { |
|
70 | + return $this->get('LOG_time'); |
|
71 | + } |
|
72 | + |
|
73 | + /** |
|
74 | + * Sets time |
|
75 | + * |
|
76 | + * @param string $time |
|
77 | + * @throws EE_Error |
|
78 | + */ |
|
79 | + public function set_time($time) |
|
80 | + { |
|
81 | + $this->set('LOG_time', $time); |
|
82 | + } |
|
83 | + |
|
84 | + /** |
|
85 | + * Gets log_type |
|
86 | + * |
|
87 | + * @return string |
|
88 | + * @throws EE_Error |
|
89 | + */ |
|
90 | + public function log_type() |
|
91 | + { |
|
92 | + return $this->get('LOG_type'); |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * Return the localized log type label. |
|
98 | + * |
|
99 | + * @return string |
|
100 | + * @throws EE_Error |
|
101 | + */ |
|
102 | + public function log_type_label() |
|
103 | + { |
|
104 | + return EEM_Change_Log::get_pretty_label_for_type($this->log_type()); |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Sets log_type |
|
109 | + * |
|
110 | + * @param string $log_type |
|
111 | + * @throws EE_Error |
|
112 | + */ |
|
113 | + public function set_log_type($log_type) |
|
114 | + { |
|
115 | + $this->set('LOG_type', $log_type); |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * Gets type of the model object related to this log |
|
120 | + * |
|
121 | + * @return string |
|
122 | + * @throws EE_Error |
|
123 | + */ |
|
124 | + public function OBJ_type() |
|
125 | + { |
|
126 | + return $this->get('OBJ_type'); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Sets type |
|
131 | + * |
|
132 | + * @param string $type |
|
133 | + * @throws EE_Error |
|
134 | + */ |
|
135 | + public function set_OBJ_type($type) |
|
136 | + { |
|
137 | + $this->set('OBJ_type', $type); |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Gets OBJ_ID (the ID of the item related to this log) |
|
142 | + * |
|
143 | + * @return mixed |
|
144 | + * @throws EE_Error |
|
145 | + */ |
|
146 | + public function OBJ_ID() |
|
147 | + { |
|
148 | + return $this->get('OBJ_ID'); |
|
149 | + } |
|
150 | + |
|
151 | + /** |
|
152 | + * Sets OBJ_ID |
|
153 | + * |
|
154 | + * @param mixed $OBJ_ID |
|
155 | + * @throws EE_Error |
|
156 | + */ |
|
157 | + public function set_OBJ_ID($OBJ_ID) |
|
158 | + { |
|
159 | + $this->set('OBJ_ID', $OBJ_ID); |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Gets wp_user |
|
164 | + * |
|
165 | + * @return int |
|
166 | + * @throws EE_Error |
|
167 | + */ |
|
168 | + public function wp_user() |
|
169 | + { |
|
170 | + return $this->get('LOG_wp_user'); |
|
171 | + } |
|
172 | + |
|
173 | + /** |
|
174 | + * Sets wp_user |
|
175 | + * |
|
176 | + * @param int $wp_user_id |
|
177 | + * @throws EE_Error |
|
178 | + */ |
|
179 | + public function set_wp_user($wp_user_id) |
|
180 | + { |
|
181 | + $this->set('LOG_wp_user', $wp_user_id); |
|
182 | + } |
|
183 | + |
|
184 | + /** |
|
185 | + * Gets the model object attached to this log |
|
186 | + * |
|
187 | + * @return EE_Base_Class |
|
188 | + * @throws EE_Error |
|
189 | + */ |
|
190 | + public function object() |
|
191 | + { |
|
192 | + $model_name_of_related_obj = $this->OBJ_type(); |
|
193 | + $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj); |
|
194 | + if (! $is_model_name) { |
|
195 | + return null; |
|
196 | + } else { |
|
197 | + return $this->get_first_related($model_name_of_related_obj); |
|
198 | + } |
|
199 | + } |
|
200 | + |
|
201 | + /** |
|
202 | + * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using |
|
203 | + * _add_relation_to because you don't have to specify what type of model you're |
|
204 | + * associating it with |
|
205 | + * |
|
206 | + * @param EE_Base_Class $object |
|
207 | + * @param boolean $save |
|
208 | + * @return bool if $save=true, NULL is $save=false |
|
209 | + * @throws EE_Error |
|
210 | + */ |
|
211 | + public function set_object($object, $save = true) |
|
212 | + { |
|
213 | + if ($object instanceof EE_Base_Class) { |
|
214 | + $this->set_OBJ_type($object->get_model()->get_this_model_name()); |
|
215 | + $this->set_OBJ_ID($object->ID()); |
|
216 | + } else { |
|
217 | + $this->set_OBJ_type(null); |
|
218 | + $this->set_OBJ_ID(null); |
|
219 | + } |
|
220 | + if ($save) { |
|
221 | + return $this->save(); |
|
222 | + } else { |
|
223 | + return null; |
|
224 | + } |
|
225 | + } |
|
226 | 226 | } |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | public function process(EEI_Line_Item $line_item) |
33 | 33 | { |
34 | 34 | $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
35 | - if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
35 | + if ( ! $non_zero_line_item instanceof EEI_Line_Item) { |
|
36 | 36 | return null; |
37 | 37 | } |
38 | 38 | // if this is an event subtotal, we want to only include it if it |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | foreach ($line_item->children() as $child_line_item) { |
43 | 43 | $code = $child_line_item->code(); |
44 | 44 | $child_line_item = $this->process($child_line_item); |
45 | - if (! $child_line_item instanceof EEI_Line_Item) { |
|
45 | + if ( ! $child_line_item instanceof EEI_Line_Item) { |
|
46 | 46 | $line_item->delete_child_line_item($code); |
47 | 47 | continue; |
48 | 48 | } |
@@ -13,99 +13,99 @@ |
||
13 | 13 | */ |
14 | 14 | class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base |
15 | 15 | { |
16 | - /** |
|
17 | - * EE_Non_Zero_Line_Item_Filter constructor. |
|
18 | - */ |
|
19 | - public function __construct() |
|
20 | - { |
|
21 | - } |
|
16 | + /** |
|
17 | + * EE_Non_Zero_Line_Item_Filter constructor. |
|
18 | + */ |
|
19 | + public function __construct() |
|
20 | + { |
|
21 | + } |
|
22 | 22 | |
23 | 23 | |
24 | - /** |
|
25 | - * Creates a duplicate of the line item tree, except only includes billable items |
|
26 | - * and the portion of line items attributed to billable things |
|
27 | - * |
|
28 | - * @param EEI_Line_Item $line_item |
|
29 | - * @return EEI_Line_Item |
|
30 | - */ |
|
31 | - public function process(EEI_Line_Item $line_item) |
|
32 | - { |
|
33 | - $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
|
34 | - if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
35 | - return null; |
|
36 | - } |
|
37 | - // if this is an event subtotal, we want to only include it if it |
|
38 | - // has a non-zero total and at least one ticket line item child |
|
39 | - if ($line_item->children()) { |
|
40 | - $ticket_or_subtotals_with_tkt_children_count = 0; |
|
41 | - foreach ($line_item->children() as $child_line_item) { |
|
42 | - $code = $child_line_item->code(); |
|
43 | - $child_line_item = $this->process($child_line_item); |
|
44 | - if (! $child_line_item instanceof EEI_Line_Item) { |
|
45 | - $line_item->delete_child_line_item($code); |
|
46 | - continue; |
|
47 | - } |
|
48 | - if ( |
|
49 | - ( |
|
50 | - $child_line_item instanceof EEI_Line_Item |
|
51 | - && $child_line_item->type() === EEM_Line_Item::type_sub_total |
|
52 | - ) |
|
53 | - || ( |
|
54 | - $child_line_item instanceof EEI_Line_Item |
|
55 | - && $child_line_item->type() === EEM_Line_Item::type_line_item |
|
56 | - && $child_line_item->OBJ_type() === 'Ticket' |
|
57 | - ) |
|
58 | - ) { |
|
59 | - $ticket_or_subtotals_with_tkt_children_count++; |
|
60 | - } |
|
61 | - } |
|
62 | - // if this is an event subtotal with NO ticket children |
|
63 | - // we basically want to ignore it |
|
64 | - return $this->_filter_zero_subtotal_line_item( |
|
65 | - $non_zero_line_item, |
|
66 | - $ticket_or_subtotals_with_tkt_children_count |
|
67 | - ); |
|
68 | - } |
|
69 | - return $non_zero_line_item; |
|
70 | - } |
|
24 | + /** |
|
25 | + * Creates a duplicate of the line item tree, except only includes billable items |
|
26 | + * and the portion of line items attributed to billable things |
|
27 | + * |
|
28 | + * @param EEI_Line_Item $line_item |
|
29 | + * @return EEI_Line_Item |
|
30 | + */ |
|
31 | + public function process(EEI_Line_Item $line_item) |
|
32 | + { |
|
33 | + $non_zero_line_item = $this->_filter_zero_line_item($line_item); |
|
34 | + if (! $non_zero_line_item instanceof EEI_Line_Item) { |
|
35 | + return null; |
|
36 | + } |
|
37 | + // if this is an event subtotal, we want to only include it if it |
|
38 | + // has a non-zero total and at least one ticket line item child |
|
39 | + if ($line_item->children()) { |
|
40 | + $ticket_or_subtotals_with_tkt_children_count = 0; |
|
41 | + foreach ($line_item->children() as $child_line_item) { |
|
42 | + $code = $child_line_item->code(); |
|
43 | + $child_line_item = $this->process($child_line_item); |
|
44 | + if (! $child_line_item instanceof EEI_Line_Item) { |
|
45 | + $line_item->delete_child_line_item($code); |
|
46 | + continue; |
|
47 | + } |
|
48 | + if ( |
|
49 | + ( |
|
50 | + $child_line_item instanceof EEI_Line_Item |
|
51 | + && $child_line_item->type() === EEM_Line_Item::type_sub_total |
|
52 | + ) |
|
53 | + || ( |
|
54 | + $child_line_item instanceof EEI_Line_Item |
|
55 | + && $child_line_item->type() === EEM_Line_Item::type_line_item |
|
56 | + && $child_line_item->OBJ_type() === 'Ticket' |
|
57 | + ) |
|
58 | + ) { |
|
59 | + $ticket_or_subtotals_with_tkt_children_count++; |
|
60 | + } |
|
61 | + } |
|
62 | + // if this is an event subtotal with NO ticket children |
|
63 | + // we basically want to ignore it |
|
64 | + return $this->_filter_zero_subtotal_line_item( |
|
65 | + $non_zero_line_item, |
|
66 | + $ticket_or_subtotals_with_tkt_children_count |
|
67 | + ); |
|
68 | + } |
|
69 | + return $non_zero_line_item; |
|
70 | + } |
|
71 | 71 | |
72 | 72 | |
73 | - /** |
|
74 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
75 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
76 | - * |
|
77 | - * @param EEI_Line_Item $line_item |
|
78 | - * @return EEI_Line_Item |
|
79 | - */ |
|
80 | - protected function _filter_zero_line_item(EEI_Line_Item $line_item) |
|
81 | - { |
|
82 | - if ( |
|
83 | - $line_item->type() === EEM_Line_Item::type_line_item |
|
84 | - && $line_item->OBJ_type() === 'Ticket' |
|
85 | - && (int) $line_item->quantity() === 0 |
|
86 | - ) { |
|
87 | - return null; |
|
88 | - } |
|
89 | - return $line_item; |
|
90 | - } |
|
73 | + /** |
|
74 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
75 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
76 | + * |
|
77 | + * @param EEI_Line_Item $line_item |
|
78 | + * @return EEI_Line_Item |
|
79 | + */ |
|
80 | + protected function _filter_zero_line_item(EEI_Line_Item $line_item) |
|
81 | + { |
|
82 | + if ( |
|
83 | + $line_item->type() === EEM_Line_Item::type_line_item |
|
84 | + && $line_item->OBJ_type() === 'Ticket' |
|
85 | + && (int) $line_item->quantity() === 0 |
|
86 | + ) { |
|
87 | + return null; |
|
88 | + } |
|
89 | + return $line_item; |
|
90 | + } |
|
91 | 91 | |
92 | 92 | |
93 | - /** |
|
94 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
95 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
96 | - * |
|
97 | - * @param EEI_Line_Item $line_item |
|
98 | - * @param int $ticket_children |
|
99 | - * @return EEI_Line_Item |
|
100 | - */ |
|
101 | - protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0) |
|
102 | - { |
|
103 | - if ( |
|
104 | - (int) $ticket_children === 0 |
|
105 | - && $line_item->type() === EEM_Line_Item::type_sub_total |
|
106 | - ) { |
|
107 | - return null; |
|
108 | - } |
|
109 | - return $line_item; |
|
110 | - } |
|
93 | + /** |
|
94 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
95 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
96 | + * |
|
97 | + * @param EEI_Line_Item $line_item |
|
98 | + * @param int $ticket_children |
|
99 | + * @return EEI_Line_Item |
|
100 | + */ |
|
101 | + protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0) |
|
102 | + { |
|
103 | + if ( |
|
104 | + (int) $ticket_children === 0 |
|
105 | + && $line_item->type() === EEM_Line_Item::type_sub_total |
|
106 | + ) { |
|
107 | + return null; |
|
108 | + } |
|
109 | + return $line_item; |
|
110 | + } |
|
111 | 111 | } |
@@ -69,13 +69,13 @@ discard block |
||
69 | 69 | // SplPriorityQueue doesn't play nice with multiple items having the same priority |
70 | 70 | // so if the incoming priority is already occupied, then let's increment it by one, |
71 | 71 | // and then pass everything back into this method and try again with the new priority |
72 | - if (isset($this->priorities[ $priority ])) { |
|
72 | + if (isset($this->priorities[$priority])) { |
|
73 | 73 | $priority++; |
74 | 74 | $this->add_template_part($name, $label, $template, $priority); |
75 | 75 | return; |
76 | 76 | } |
77 | 77 | // kk now we can mark this priority as being occupied |
78 | - $this->priorities[ $priority ] = true; |
|
78 | + $this->priorities[$priority] = true; |
|
79 | 79 | // create the template part and add to the queue |
80 | 80 | $this->template_parts->insert( |
81 | 81 | new EE_Template_Part($name, $label, $template, $priority), |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | $this->template_parts->next(); |
111 | 111 | } |
112 | 112 | // now simply add our three strings of content together |
113 | - return $this->before_event_content . $this->event_content . $this->after_event_content; |
|
113 | + return $this->before_event_content.$this->event_content.$this->after_event_content; |
|
114 | 114 | } |
115 | 115 | |
116 | 116 | |
@@ -169,10 +169,10 @@ discard block |
||
169 | 169 | // loop through template parts and add template content |
170 | 170 | while ($this->template_parts->valid()) { |
171 | 171 | $event_archive_display_order .= EEH_HTML::li( |
172 | - EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') . |
|
173 | - EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') . |
|
172 | + EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2'). |
|
173 | + EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2'). |
|
174 | 174 | $this->template_parts->current()->label(), |
175 | - $list_item_css_id_prefix . $this->template_parts->current()->name(), |
|
175 | + $list_item_css_id_prefix.$this->template_parts->current()->name(), |
|
176 | 176 | $list_item_css_class |
177 | 177 | ); |
178 | 178 | $this->template_parts->next(); |
@@ -13,195 +13,195 @@ |
||
13 | 13 | */ |
14 | 14 | class EE_Template_Part_Manager |
15 | 15 | { |
16 | - /** |
|
17 | - * @param EE_Template_Part_PriorityQueue $template_parts |
|
18 | - */ |
|
19 | - protected $template_parts; |
|
20 | - |
|
21 | - /** |
|
22 | - * @param array $priorities |
|
23 | - */ |
|
24 | - protected $priorities = array(); |
|
25 | - |
|
26 | - /** |
|
27 | - * @param int $event_desc_priority |
|
28 | - */ |
|
29 | - protected $event_desc_priority; |
|
30 | - |
|
31 | - /** |
|
32 | - * @param string $before_event_content |
|
33 | - */ |
|
34 | - protected $before_event_content; |
|
35 | - |
|
36 | - /** |
|
37 | - * @param string $event_content |
|
38 | - */ |
|
39 | - protected $event_content; |
|
40 | - |
|
41 | - /** |
|
42 | - * @param string $after_event_content |
|
43 | - */ |
|
44 | - protected $after_event_content; |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * class constructor |
|
49 | - */ |
|
50 | - public function __construct() |
|
51 | - { |
|
52 | - $this->template_parts = new EE_Template_Part_PriorityQueue(); |
|
53 | - } |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * add_template_part |
|
58 | - * |
|
59 | - * used for setting the details about a particular template part |
|
60 | - * |
|
61 | - * @param string $name - just a simple string identifier - do NOT use 'event' |
|
62 | - * @param string $label - template part label displayed in admin |
|
63 | - * @param string $template - name or path of template to be used by EEH_Template::locate_template() |
|
64 | - * @param int $priority - order in which template parts should be applied |
|
65 | - */ |
|
66 | - public function add_template_part($name, $label, $template, $priority) |
|
67 | - { |
|
68 | - // SplPriorityQueue doesn't play nice with multiple items having the same priority |
|
69 | - // so if the incoming priority is already occupied, then let's increment it by one, |
|
70 | - // and then pass everything back into this method and try again with the new priority |
|
71 | - if (isset($this->priorities[ $priority ])) { |
|
72 | - $priority++; |
|
73 | - $this->add_template_part($name, $label, $template, $priority); |
|
74 | - return; |
|
75 | - } |
|
76 | - // kk now we can mark this priority as being occupied |
|
77 | - $this->priorities[ $priority ] = true; |
|
78 | - // create the template part and add to the queue |
|
79 | - $this->template_parts->insert( |
|
80 | - new EE_Template_Part($name, $label, $template, $priority), |
|
81 | - $priority |
|
82 | - ); |
|
83 | - if ($name === 'event') { |
|
84 | - $this->event_desc_priority = $priority; |
|
85 | - } |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * apply_template_part_filters |
|
91 | - * |
|
92 | - * adds template parts to the supplied content |
|
93 | - * according to the details set when the template parts were added |
|
94 | - * |
|
95 | - * @access public |
|
96 | - * @param string $content |
|
97 | - * @return string |
|
98 | - */ |
|
99 | - public function apply_template_part_filters($content = '') |
|
100 | - { |
|
101 | - $this->template_parts->rewind(); |
|
102 | - // loop through template parts and position content |
|
103 | - while ($this->template_parts->valid()) { |
|
104 | - $this->_position_template_part( |
|
105 | - $content, |
|
106 | - $this->template_parts->current()->template(), |
|
107 | - $this->template_parts->current()->priority() |
|
108 | - ); |
|
109 | - $this->template_parts->next(); |
|
110 | - } |
|
111 | - // now simply add our three strings of content together |
|
112 | - return $this->before_event_content . $this->event_content . $this->after_event_content; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * position_template_part |
|
118 | - * |
|
119 | - * based on the priority of the incoming template part |
|
120 | - * relative to the known event description template part priority, |
|
121 | - * this method will assign template parts to one of the following: |
|
122 | - * $this->before_event_content |
|
123 | - * $this->event_content |
|
124 | - * $this->after_event_content |
|
125 | - * |
|
126 | - * @access protected |
|
127 | - * @param string $content |
|
128 | - * @param string $template |
|
129 | - * @param int $priority |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - protected function _position_template_part($content, $template, $priority) |
|
133 | - { |
|
134 | - // Event Description content is the actual incoming content itself |
|
135 | - if ($priority === $this->event_desc_priority) { |
|
136 | - $this->event_content = $content; |
|
137 | - } elseif ($priority < $this->event_desc_priority) { |
|
138 | - // everything BEFORE the Event Description |
|
139 | - $this->before_event_content .= EEH_Template::locate_template($template); |
|
140 | - } elseif ($priority > $this->event_desc_priority) { |
|
141 | - // everything AFTER the Event Description |
|
142 | - $this->after_event_content .= EEH_Template::locate_template($template); |
|
143 | - } |
|
144 | - } |
|
145 | - |
|
146 | - |
|
147 | - /** |
|
148 | - * generate_sortable_list_of_template_parts |
|
149 | - * |
|
150 | - * creates an HTML list (<ul>) with list items (<li>) for each template part, |
|
151 | - * in a format that can be used as a sortable list in the admin |
|
152 | - * |
|
153 | - * @access public |
|
154 | - * @param string $list_css_id |
|
155 | - * @param string $list_css_class |
|
156 | - * @param string $list_item_css_class |
|
157 | - * @param string $list_item_css_id_prefix |
|
158 | - * @return string |
|
159 | - */ |
|
160 | - public function generate_sortable_list_of_template_parts( |
|
161 | - $list_css_id = '', |
|
162 | - $list_css_class = '', |
|
163 | - $list_item_css_class = '', |
|
164 | - $list_item_css_id_prefix = '' |
|
165 | - ) { |
|
166 | - $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class); |
|
167 | - $this->template_parts->rewind(); |
|
168 | - // loop through template parts and add template content |
|
169 | - while ($this->template_parts->valid()) { |
|
170 | - $event_archive_display_order .= EEH_HTML::li( |
|
171 | - EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') . |
|
172 | - EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') . |
|
173 | - $this->template_parts->current()->label(), |
|
174 | - $list_item_css_id_prefix . $this->template_parts->current()->name(), |
|
175 | - $list_item_css_class |
|
176 | - ); |
|
177 | - $this->template_parts->next(); |
|
178 | - } |
|
179 | - $event_archive_display_order .= EEH_HTML::ulx(); |
|
180 | - return $event_archive_display_order; |
|
181 | - } |
|
182 | - |
|
183 | - |
|
184 | - /** |
|
185 | - * display_template_parts |
|
186 | - * |
|
187 | - * just for debugging purposes |
|
188 | - * |
|
189 | - * @access public |
|
190 | - * @return void |
|
191 | - */ |
|
192 | - public function display_template_parts() |
|
193 | - { |
|
194 | - if (WP_DEBUG) { |
|
195 | - $this->template_parts->rewind(); |
|
196 | - while ($this->template_parts->valid()) { |
|
197 | - EEH_Debug_Tools::printr( |
|
198 | - $this->template_parts->current(), |
|
199 | - 'template_part', |
|
200 | - __FILE__, |
|
201 | - __LINE__ |
|
202 | - ); |
|
203 | - $this->template_parts->next(); |
|
204 | - } |
|
205 | - } |
|
206 | - } |
|
16 | + /** |
|
17 | + * @param EE_Template_Part_PriorityQueue $template_parts |
|
18 | + */ |
|
19 | + protected $template_parts; |
|
20 | + |
|
21 | + /** |
|
22 | + * @param array $priorities |
|
23 | + */ |
|
24 | + protected $priorities = array(); |
|
25 | + |
|
26 | + /** |
|
27 | + * @param int $event_desc_priority |
|
28 | + */ |
|
29 | + protected $event_desc_priority; |
|
30 | + |
|
31 | + /** |
|
32 | + * @param string $before_event_content |
|
33 | + */ |
|
34 | + protected $before_event_content; |
|
35 | + |
|
36 | + /** |
|
37 | + * @param string $event_content |
|
38 | + */ |
|
39 | + protected $event_content; |
|
40 | + |
|
41 | + /** |
|
42 | + * @param string $after_event_content |
|
43 | + */ |
|
44 | + protected $after_event_content; |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * class constructor |
|
49 | + */ |
|
50 | + public function __construct() |
|
51 | + { |
|
52 | + $this->template_parts = new EE_Template_Part_PriorityQueue(); |
|
53 | + } |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * add_template_part |
|
58 | + * |
|
59 | + * used for setting the details about a particular template part |
|
60 | + * |
|
61 | + * @param string $name - just a simple string identifier - do NOT use 'event' |
|
62 | + * @param string $label - template part label displayed in admin |
|
63 | + * @param string $template - name or path of template to be used by EEH_Template::locate_template() |
|
64 | + * @param int $priority - order in which template parts should be applied |
|
65 | + */ |
|
66 | + public function add_template_part($name, $label, $template, $priority) |
|
67 | + { |
|
68 | + // SplPriorityQueue doesn't play nice with multiple items having the same priority |
|
69 | + // so if the incoming priority is already occupied, then let's increment it by one, |
|
70 | + // and then pass everything back into this method and try again with the new priority |
|
71 | + if (isset($this->priorities[ $priority ])) { |
|
72 | + $priority++; |
|
73 | + $this->add_template_part($name, $label, $template, $priority); |
|
74 | + return; |
|
75 | + } |
|
76 | + // kk now we can mark this priority as being occupied |
|
77 | + $this->priorities[ $priority ] = true; |
|
78 | + // create the template part and add to the queue |
|
79 | + $this->template_parts->insert( |
|
80 | + new EE_Template_Part($name, $label, $template, $priority), |
|
81 | + $priority |
|
82 | + ); |
|
83 | + if ($name === 'event') { |
|
84 | + $this->event_desc_priority = $priority; |
|
85 | + } |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * apply_template_part_filters |
|
91 | + * |
|
92 | + * adds template parts to the supplied content |
|
93 | + * according to the details set when the template parts were added |
|
94 | + * |
|
95 | + * @access public |
|
96 | + * @param string $content |
|
97 | + * @return string |
|
98 | + */ |
|
99 | + public function apply_template_part_filters($content = '') |
|
100 | + { |
|
101 | + $this->template_parts->rewind(); |
|
102 | + // loop through template parts and position content |
|
103 | + while ($this->template_parts->valid()) { |
|
104 | + $this->_position_template_part( |
|
105 | + $content, |
|
106 | + $this->template_parts->current()->template(), |
|
107 | + $this->template_parts->current()->priority() |
|
108 | + ); |
|
109 | + $this->template_parts->next(); |
|
110 | + } |
|
111 | + // now simply add our three strings of content together |
|
112 | + return $this->before_event_content . $this->event_content . $this->after_event_content; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * position_template_part |
|
118 | + * |
|
119 | + * based on the priority of the incoming template part |
|
120 | + * relative to the known event description template part priority, |
|
121 | + * this method will assign template parts to one of the following: |
|
122 | + * $this->before_event_content |
|
123 | + * $this->event_content |
|
124 | + * $this->after_event_content |
|
125 | + * |
|
126 | + * @access protected |
|
127 | + * @param string $content |
|
128 | + * @param string $template |
|
129 | + * @param int $priority |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + protected function _position_template_part($content, $template, $priority) |
|
133 | + { |
|
134 | + // Event Description content is the actual incoming content itself |
|
135 | + if ($priority === $this->event_desc_priority) { |
|
136 | + $this->event_content = $content; |
|
137 | + } elseif ($priority < $this->event_desc_priority) { |
|
138 | + // everything BEFORE the Event Description |
|
139 | + $this->before_event_content .= EEH_Template::locate_template($template); |
|
140 | + } elseif ($priority > $this->event_desc_priority) { |
|
141 | + // everything AFTER the Event Description |
|
142 | + $this->after_event_content .= EEH_Template::locate_template($template); |
|
143 | + } |
|
144 | + } |
|
145 | + |
|
146 | + |
|
147 | + /** |
|
148 | + * generate_sortable_list_of_template_parts |
|
149 | + * |
|
150 | + * creates an HTML list (<ul>) with list items (<li>) for each template part, |
|
151 | + * in a format that can be used as a sortable list in the admin |
|
152 | + * |
|
153 | + * @access public |
|
154 | + * @param string $list_css_id |
|
155 | + * @param string $list_css_class |
|
156 | + * @param string $list_item_css_class |
|
157 | + * @param string $list_item_css_id_prefix |
|
158 | + * @return string |
|
159 | + */ |
|
160 | + public function generate_sortable_list_of_template_parts( |
|
161 | + $list_css_id = '', |
|
162 | + $list_css_class = '', |
|
163 | + $list_item_css_class = '', |
|
164 | + $list_item_css_id_prefix = '' |
|
165 | + ) { |
|
166 | + $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class); |
|
167 | + $this->template_parts->rewind(); |
|
168 | + // loop through template parts and add template content |
|
169 | + while ($this->template_parts->valid()) { |
|
170 | + $event_archive_display_order .= EEH_HTML::li( |
|
171 | + EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') . |
|
172 | + EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') . |
|
173 | + $this->template_parts->current()->label(), |
|
174 | + $list_item_css_id_prefix . $this->template_parts->current()->name(), |
|
175 | + $list_item_css_class |
|
176 | + ); |
|
177 | + $this->template_parts->next(); |
|
178 | + } |
|
179 | + $event_archive_display_order .= EEH_HTML::ulx(); |
|
180 | + return $event_archive_display_order; |
|
181 | + } |
|
182 | + |
|
183 | + |
|
184 | + /** |
|
185 | + * display_template_parts |
|
186 | + * |
|
187 | + * just for debugging purposes |
|
188 | + * |
|
189 | + * @access public |
|
190 | + * @return void |
|
191 | + */ |
|
192 | + public function display_template_parts() |
|
193 | + { |
|
194 | + if (WP_DEBUG) { |
|
195 | + $this->template_parts->rewind(); |
|
196 | + while ($this->template_parts->valid()) { |
|
197 | + EEH_Debug_Tools::printr( |
|
198 | + $this->template_parts->current(), |
|
199 | + 'template_part', |
|
200 | + __FILE__, |
|
201 | + __LINE__ |
|
202 | + ); |
|
203 | + $this->template_parts->next(); |
|
204 | + } |
|
205 | + } |
|
206 | + } |
|
207 | 207 | } |
@@ -75,7 +75,7 @@ |
||
75 | 75 | if ($transaction->ID()) { |
76 | 76 | $info['TXN_status'] = $transaction->status_ID(); |
77 | 77 | $info['TXN_reg_steps'] = $transaction->reg_steps(); |
78 | - $index = 'EE_Transaction: ' . $transaction->ID(); |
|
78 | + $index = 'EE_Transaction: '.$transaction->ID(); |
|
79 | 79 | EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index); |
80 | 80 | } |
81 | 81 | } |
@@ -13,71 +13,71 @@ |
||
13 | 13 | */ |
14 | 14 | class EE_Processor_Base |
15 | 15 | { |
16 | - /** |
|
17 | - * Used to indicate whether current request is for an IPN or not. |
|
18 | - * |
|
19 | - * @var bool |
|
20 | - */ |
|
21 | - protected static $IPN = false; |
|
16 | + /** |
|
17 | + * Used to indicate whether current request is for an IPN or not. |
|
18 | + * |
|
19 | + * @var bool |
|
20 | + */ |
|
21 | + protected static $IPN = false; |
|
22 | 22 | |
23 | - /** |
|
24 | - * Used to indicate whether SPCO is being revisited by registrant or not. |
|
25 | - * |
|
26 | - * @var bool |
|
27 | - */ |
|
28 | - protected $_revisit = false; |
|
23 | + /** |
|
24 | + * Used to indicate whether SPCO is being revisited by registrant or not. |
|
25 | + * |
|
26 | + * @var bool |
|
27 | + */ |
|
28 | + protected $_revisit = false; |
|
29 | 29 | |
30 | 30 | |
31 | - /** |
|
32 | - * @param boolean $IPN |
|
33 | - */ |
|
34 | - public static function set_IPN($IPN) |
|
35 | - { |
|
36 | - self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN); |
|
37 | - } |
|
31 | + /** |
|
32 | + * @param boolean $IPN |
|
33 | + */ |
|
34 | + public static function set_IPN($IPN) |
|
35 | + { |
|
36 | + self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN); |
|
37 | + } |
|
38 | 38 | |
39 | 39 | |
40 | - /** |
|
41 | - * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not. |
|
42 | - * |
|
43 | - * @param bool $revisit |
|
44 | - * @return void |
|
45 | - */ |
|
46 | - public function set_revisit($revisit = false) |
|
47 | - { |
|
48 | - $this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN); |
|
49 | - } |
|
40 | + /** |
|
41 | + * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not. |
|
42 | + * |
|
43 | + * @param bool $revisit |
|
44 | + * @return void |
|
45 | + */ |
|
46 | + public function set_revisit($revisit = false) |
|
47 | + { |
|
48 | + $this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN); |
|
49 | + } |
|
50 | 50 | |
51 | 51 | |
52 | - /** |
|
53 | - * debug |
|
54 | - * |
|
55 | - * @param string $class |
|
56 | - * @param string $func |
|
57 | - * @param string $line |
|
58 | - * @param \EE_Transaction $transaction |
|
59 | - * @param array $info |
|
60 | - * @param bool $display_request |
|
61 | - */ |
|
62 | - protected function log( |
|
63 | - $class = '', |
|
64 | - $func = '', |
|
65 | - $line = '', |
|
66 | - EE_Transaction $transaction, |
|
67 | - $info = array(), |
|
68 | - $display_request = false |
|
69 | - ) { |
|
70 | - if (WP_DEBUG && false) { |
|
71 | - if ($transaction instanceof EE_Transaction) { |
|
72 | - // don't serialize objects |
|
73 | - $info = EEH_Debug_Tools::strip_objects($info); |
|
74 | - if ($transaction->ID()) { |
|
75 | - $info['TXN_status'] = $transaction->status_ID(); |
|
76 | - $info['TXN_reg_steps'] = $transaction->reg_steps(); |
|
77 | - $index = 'EE_Transaction: ' . $transaction->ID(); |
|
78 | - EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index); |
|
79 | - } |
|
80 | - } |
|
81 | - } |
|
82 | - } |
|
52 | + /** |
|
53 | + * debug |
|
54 | + * |
|
55 | + * @param string $class |
|
56 | + * @param string $func |
|
57 | + * @param string $line |
|
58 | + * @param \EE_Transaction $transaction |
|
59 | + * @param array $info |
|
60 | + * @param bool $display_request |
|
61 | + */ |
|
62 | + protected function log( |
|
63 | + $class = '', |
|
64 | + $func = '', |
|
65 | + $line = '', |
|
66 | + EE_Transaction $transaction, |
|
67 | + $info = array(), |
|
68 | + $display_request = false |
|
69 | + ) { |
|
70 | + if (WP_DEBUG && false) { |
|
71 | + if ($transaction instanceof EE_Transaction) { |
|
72 | + // don't serialize objects |
|
73 | + $info = EEH_Debug_Tools::strip_objects($info); |
|
74 | + if ($transaction->ID()) { |
|
75 | + $info['TXN_status'] = $transaction->status_ID(); |
|
76 | + $info['TXN_reg_steps'] = $transaction->reg_steps(); |
|
77 | + $index = 'EE_Transaction: ' . $transaction->ID(); |
|
78 | + EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index); |
|
79 | + } |
|
80 | + } |
|
81 | + } |
|
82 | + } |
|
83 | 83 | } |
@@ -57,7 +57,7 @@ |
||
57 | 57 | 'That\'s it for the tour! At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons. There are help tours available on all Event Espresso Admin pages. If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!', |
58 | 58 | 'event_espresso' |
59 | 59 | ), |
60 | - '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">', |
|
60 | + '<a href="'.EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')).'">', |
|
61 | 61 | '</a>' |
62 | 62 | ) |
63 | 63 | . '</p>'; |
@@ -14,51 +14,51 @@ |
||
14 | 14 | */ |
15 | 15 | class EE_Help_Tour_final_stop extends EE_Help_Tour |
16 | 16 | { |
17 | - protected function _set_tour_properties() |
|
18 | - { |
|
19 | - $this->_label = esc_html__('Final Stop Tour', 'event_espresso'); |
|
20 | - $this->_slug = 'final-stop-tour'; |
|
21 | - } |
|
17 | + protected function _set_tour_properties() |
|
18 | + { |
|
19 | + $this->_label = esc_html__('Final Stop Tour', 'event_espresso'); |
|
20 | + $this->_slug = 'final-stop-tour'; |
|
21 | + } |
|
22 | 22 | |
23 | 23 | |
24 | - protected function _set_tour_stops() |
|
25 | - { |
|
26 | - $this->_stops = array( |
|
27 | - 10 => array( |
|
28 | - 'id' => 'contextual-help-link', |
|
29 | - 'content' => $this->_end(), |
|
30 | - 'button_text' => esc_html__('Quit', 'event_espresso'), |
|
31 | - 'options' => array( |
|
32 | - 'tipLocation' => 'left', |
|
33 | - 'tipAdjustmentY' => -20, |
|
34 | - 'tipAdjustmentX' => 10, |
|
35 | - ), |
|
36 | - ), |
|
37 | - ); |
|
38 | - } |
|
24 | + protected function _set_tour_stops() |
|
25 | + { |
|
26 | + $this->_stops = array( |
|
27 | + 10 => array( |
|
28 | + 'id' => 'contextual-help-link', |
|
29 | + 'content' => $this->_end(), |
|
30 | + 'button_text' => esc_html__('Quit', 'event_espresso'), |
|
31 | + 'options' => array( |
|
32 | + 'tipLocation' => 'left', |
|
33 | + 'tipAdjustmentY' => -20, |
|
34 | + 'tipAdjustmentX' => 10, |
|
35 | + ), |
|
36 | + ), |
|
37 | + ); |
|
38 | + } |
|
39 | 39 | |
40 | 40 | |
41 | - /** |
|
42 | - * This is the default last stop for all tours that is displayed at the end of a tour OR when a tour is exited for |
|
43 | - * the first time. |
|
44 | - * |
|
45 | - * @return string |
|
46 | - */ |
|
47 | - protected function _end() |
|
48 | - { |
|
49 | - $query_args = array( |
|
50 | - 'action' => 'admin_option_settings', |
|
51 | - 'page' => 'espresso_general_settings', |
|
52 | - ); |
|
53 | - return '<p>' |
|
54 | - . sprintf( |
|
55 | - esc_html__( |
|
56 | - 'That\'s it for the tour! At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons. There are help tours available on all Event Espresso Admin pages. If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!', |
|
57 | - 'event_espresso' |
|
58 | - ), |
|
59 | - '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">', |
|
60 | - '</a>' |
|
61 | - ) |
|
62 | - . '</p>'; |
|
63 | - } |
|
41 | + /** |
|
42 | + * This is the default last stop for all tours that is displayed at the end of a tour OR when a tour is exited for |
|
43 | + * the first time. |
|
44 | + * |
|
45 | + * @return string |
|
46 | + */ |
|
47 | + protected function _end() |
|
48 | + { |
|
49 | + $query_args = array( |
|
50 | + 'action' => 'admin_option_settings', |
|
51 | + 'page' => 'espresso_general_settings', |
|
52 | + ); |
|
53 | + return '<p>' |
|
54 | + . sprintf( |
|
55 | + esc_html__( |
|
56 | + 'That\'s it for the tour! At any time you can restart a tour by clicking on this help dropdown and then clicking one of the Tour buttons. There are help tours available on all Event Espresso Admin pages. If you want to turn off help tours for all pages, %sgo here%s. All the best with your events!', |
|
57 | + 'event_espresso' |
|
58 | + ), |
|
59 | + '<a href="' . EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php')) . '">', |
|
60 | + '</a>' |
|
61 | + ) |
|
62 | + . '</p>'; |
|
63 | + } |
|
64 | 64 | } |