@@ -10,19 +10,19 @@ discard block |
||
10 | 10 | ?> |
11 | 11 | <div id="admin-side-mbox-primary-registrant-dv" class="admin-side-mbox-dv"> |
12 | 12 | <?php |
13 | - if (! empty($no_attendee_message)) : ?> |
|
13 | + if (! empty($no_attendee_message)) : ?> |
|
14 | 14 | <p class="clearfix"> |
15 | 15 | <?php echo $no_attendee_message; ?> |
16 | 16 | </p> |
17 | 17 | </div> <!-- end #admin-side-mbox-primary-registrant-dv --> |
18 | 18 | <?php |
19 | - else : ?> |
|
19 | + else : ?> |
|
20 | 20 | <p class="clearfix"> |
21 | 21 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
22 | 22 | <?php esc_html_e( |
23 | - 'Name', |
|
24 | - 'event_espresso' |
|
25 | - ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?> |
|
23 | + 'Name', |
|
24 | + 'event_espresso' |
|
25 | + ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?> |
|
26 | 26 | </p> |
27 | 27 | <p class="clearfix"> |
28 | 28 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a |
@@ -31,9 +31,9 @@ discard block |
||
31 | 31 | <p class="clearfix"> |
32 | 32 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
33 | 33 | <?php esc_html_e( |
34 | - 'Phone #', |
|
35 | - 'event_espresso' |
|
36 | - ); ?> |
|
34 | + 'Phone #', |
|
35 | + 'event_espresso' |
|
36 | + ); ?> |
|
37 | 37 | </span> |
38 | 38 | <?php if (! empty($prime_reg_phone)) : ?> |
39 | 39 | <a href="tel:<?php echo $phone; ?>"> |
@@ -50,22 +50,22 @@ discard block |
||
50 | 50 | </div> <!-- end #admin-side-mbox-primary-registrant-dv --> |
51 | 51 | |
52 | 52 | <?php |
53 | - /** only show if logged in user has access */ |
|
54 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
55 | - 'ee_edit_contact', |
|
56 | - 'view_or_edit_contact_button', |
|
57 | - $ATT_ID |
|
58 | - ) |
|
59 | - ) : ?> |
|
53 | + /** only show if logged in user has access */ |
|
54 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
55 | + 'ee_edit_contact', |
|
56 | + 'view_or_edit_contact_button', |
|
57 | + $ATT_ID |
|
58 | + ) |
|
59 | + ) : ?> |
|
60 | 60 | <p style="text-align:right;"> |
61 | 61 | <a class="button button-small" href="<?php echo $edit_attendee_url; ?>" |
62 | 62 | title="<?php esc_attr_e('View details for this contact.', 'event_espresso'); ?>"> |
63 | 63 | <span class="ee-icon ee-icon-user-edit"></span> |
64 | 64 | <?php _e( |
65 | - 'View / Edit this Contact', |
|
66 | - 'event_espresso' |
|
67 | - ); ?> |
|
65 | + 'View / Edit this Contact', |
|
66 | + 'event_espresso' |
|
67 | + ); ?> |
|
68 | 68 | </a> |
69 | 69 | </p> |
70 | 70 | <?php endif; |
71 | - endif; |
|
71 | + endif; |
@@ -10,7 +10,7 @@ discard block |
||
10 | 10 | ?> |
11 | 11 | <div id="admin-side-mbox-primary-registrant-dv" class="admin-side-mbox-dv"> |
12 | 12 | <?php |
13 | - if (! empty($no_attendee_message)) : ?> |
|
13 | + if ( ! empty($no_attendee_message)) : ?> |
|
14 | 14 | <p class="clearfix"> |
15 | 15 | <?php echo $no_attendee_message; ?> |
16 | 16 | </p> |
@@ -22,7 +22,7 @@ discard block |
||
22 | 22 | <?php esc_html_e( |
23 | 23 | 'Name', |
24 | 24 | 'event_espresso' |
25 | - ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?> |
|
25 | + ); ?></span><?php echo $prime_reg_fname.' '.$prime_reg_lname; ?> |
|
26 | 26 | </p> |
27 | 27 | <p class="clearfix"> |
28 | 28 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | 'event_espresso' |
36 | 36 | ); ?> |
37 | 37 | </span> |
38 | - <?php if (! empty($prime_reg_phone)) : ?> |
|
38 | + <?php if ( ! empty($prime_reg_phone)) : ?> |
|
39 | 39 | <a href="tel:<?php echo $phone; ?>"> |
40 | 40 | <?php echo $prime_reg_phone; ?> |
41 | 41 | </a> |
@@ -16,13 +16,16 @@ |
||
16 | 16 | </p> |
17 | 17 | </div> <!-- end #admin-side-mbox-primary-registrant-dv --> |
18 | 18 | <?php |
19 | - else : ?> |
|
19 | + else { |
|
20 | + : ?> |
|
20 | 21 | <p class="clearfix"> |
21 | 22 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
22 | 23 | <?php esc_html_e( |
23 | 24 | 'Name', |
24 | 25 | 'event_espresso' |
25 | - ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?> |
|
26 | + ); |
|
27 | + } |
|
28 | + ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?> |
|
26 | 29 | </p> |
27 | 30 | <p class="clearfix"> |
28 | 31 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a |
@@ -2,7 +2,7 @@ discard block |
||
2 | 2 | <p class="clearfix"> |
3 | 3 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
4 | 4 | <?php esc_html_e('Name', 'event_espresso'); ?> |
5 | - </span><?php echo $fname . ' ' . $lname; ?> |
|
5 | + </span><?php echo $fname.' '.$lname; ?> |
|
6 | 6 | </p> |
7 | 7 | <p class="clearfix"> |
8 | 8 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
@@ -16,7 +16,7 @@ discard block |
||
16 | 16 | <span class="admin-side-mbox-label-spn lt-grey-txt float-left"> |
17 | 17 | <?php esc_html_e('Phone #', 'event_espresso'); ?> |
18 | 18 | </span> |
19 | - <?php if (! empty($phone)) : ?> |
|
19 | + <?php if ( ! empty($phone)) : ?> |
|
20 | 20 | <a href="tel:<?php echo $phone; ?>"> |
21 | 21 | <?php echo $phone; ?> |
22 | 22 | </a> |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | title="<?php echo esc_attr($att_edit_label); ?>"> |
47 | 47 | <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?> |
48 | 48 | </a> |
49 | - <?php if (! empty($create_link)) : ?> |
|
49 | + <?php if ( ! empty($create_link)) : ?> |
|
50 | 50 | <a class="button button-small" href="<?php echo $create_link; ?>" |
51 | 51 | title="<?php |
52 | 52 | esc_attr_e( |
@@ -26,159 +26,159 @@ |
||
26 | 26 | |
27 | 27 | class EE_DMS_4_1_0_checkins extends EE_Data_Migration_Script_Stage_Table |
28 | 28 | { |
29 | - private $_new_table; |
|
30 | - public function __construct() |
|
31 | - { |
|
32 | - global $wpdb; |
|
33 | - $this->_pretty_name = esc_html__('Checkins', 'event_espresso'); |
|
34 | - $this->_old_table = $wpdb->prefix."events_attendee"; |
|
35 | - $this->_extra_where_sql = 'AS att |
|
29 | + private $_new_table; |
|
30 | + public function __construct() |
|
31 | + { |
|
32 | + global $wpdb; |
|
33 | + $this->_pretty_name = esc_html__('Checkins', 'event_espresso'); |
|
34 | + $this->_old_table = $wpdb->prefix."events_attendee"; |
|
35 | + $this->_extra_where_sql = 'AS att |
|
36 | 36 | INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id |
37 | 37 | WHERE e.event_status!="D"'; |
38 | - $this->_new_table = $wpdb->prefix."esp_checkin"; |
|
39 | - parent::__construct(); |
|
40 | - } |
|
41 | - protected function _migrate_old_row($old_row) |
|
42 | - { |
|
43 | - global $wpdb; |
|
44 | - $new_reg_table = $wpdb->prefix."esp_registration"; |
|
38 | + $this->_new_table = $wpdb->prefix."esp_checkin"; |
|
39 | + parent::__construct(); |
|
40 | + } |
|
41 | + protected function _migrate_old_row($old_row) |
|
42 | + { |
|
43 | + global $wpdb; |
|
44 | + $new_reg_table = $wpdb->prefix."esp_registration"; |
|
45 | 45 | |
46 | - $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ; |
|
46 | + $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ; |
|
47 | 47 | |
48 | - $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table); |
|
49 | - if (! $new_registrations_for_attendee) { |
|
50 | - $new_registrations_for_attendee = array(); |
|
51 | - } |
|
52 | - $new_datetime = $this->_try_to_find_datetime($old_row); |
|
48 | + $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table); |
|
49 | + if (! $new_registrations_for_attendee) { |
|
50 | + $new_registrations_for_attendee = array(); |
|
51 | + } |
|
52 | + $new_datetime = $this->_try_to_find_datetime($old_row); |
|
53 | 53 | |
54 | - // make sure registrations array is numerically indexed starting at 0 (it probably already is) |
|
55 | - $new_registrations_for_attendee = array_values($new_registrations_for_attendee); |
|
56 | - $new_checkin_ids = array(); |
|
57 | - for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) { |
|
58 | - $new_reg_id = $new_registrations_for_attendee[ $i ]; |
|
59 | - if (! $new_reg_id) { |
|
60 | - $this->add_error(sprintf( |
|
61 | - esc_html__( |
|
62 | - /* translators: %1$s database row represented in JSON, %2$s number of registrations to check-in |
|
54 | + // make sure registrations array is numerically indexed starting at 0 (it probably already is) |
|
55 | + $new_registrations_for_attendee = array_values($new_registrations_for_attendee); |
|
56 | + $new_checkin_ids = array(); |
|
57 | + for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) { |
|
58 | + $new_reg_id = $new_registrations_for_attendee[ $i ]; |
|
59 | + if (! $new_reg_id) { |
|
60 | + $this->add_error(sprintf( |
|
61 | + esc_html__( |
|
62 | + /* translators: %1$s database row represented in JSON, %2$s number of registrations to check-in |
|
63 | 63 | * %3$s number of registrations for the attendee, %4$s new registration rows represented in JSON |
64 | 64 | */ |
65 | - // @codingStandardsIgnoreStart |
|
66 | - 'It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)', |
|
67 | - // @codingStandardsIgnoreEnd |
|
68 | - 'event_espresso' |
|
69 | - ), |
|
70 | - $this->_json_encode($old_row), |
|
71 | - abs($num_to_checkin_at_this_time), |
|
72 | - count($new_registrations_for_attendee), |
|
73 | - $this->_json_encode($new_registrations_for_attendee) |
|
74 | - )); |
|
75 | - break; |
|
76 | - } |
|
77 | - $existing_checkin_record = $wpdb->get_var( |
|
78 | - $wpdb->prepare( |
|
79 | - "SELECT CHK_ID FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1", |
|
80 | - $new_reg_id |
|
81 | - ) |
|
82 | - ); |
|
83 | - if (! $existing_checkin_record) { |
|
84 | - $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime); |
|
85 | - if ($new_id) { |
|
86 | - $new_checkin_ids[]= $new_id; |
|
87 | - } |
|
88 | - } |
|
89 | - } |
|
90 | - if ($new_checkin_ids) { |
|
91 | - $this->get_migration_script()->set_mapping( |
|
92 | - $this->_old_table, |
|
93 | - $old_row['id'], |
|
94 | - $this->_new_table, |
|
95 | - $new_checkin_ids |
|
96 | - ); |
|
97 | - } |
|
98 | - } |
|
65 | + // @codingStandardsIgnoreStart |
|
66 | + 'It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)', |
|
67 | + // @codingStandardsIgnoreEnd |
|
68 | + 'event_espresso' |
|
69 | + ), |
|
70 | + $this->_json_encode($old_row), |
|
71 | + abs($num_to_checkin_at_this_time), |
|
72 | + count($new_registrations_for_attendee), |
|
73 | + $this->_json_encode($new_registrations_for_attendee) |
|
74 | + )); |
|
75 | + break; |
|
76 | + } |
|
77 | + $existing_checkin_record = $wpdb->get_var( |
|
78 | + $wpdb->prepare( |
|
79 | + "SELECT CHK_ID FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1", |
|
80 | + $new_reg_id |
|
81 | + ) |
|
82 | + ); |
|
83 | + if (! $existing_checkin_record) { |
|
84 | + $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime); |
|
85 | + if ($new_id) { |
|
86 | + $new_checkin_ids[]= $new_id; |
|
87 | + } |
|
88 | + } |
|
89 | + } |
|
90 | + if ($new_checkin_ids) { |
|
91 | + $this->get_migration_script()->set_mapping( |
|
92 | + $this->_old_table, |
|
93 | + $old_row['id'], |
|
94 | + $this->_new_table, |
|
95 | + $new_checkin_ids |
|
96 | + ); |
|
97 | + } |
|
98 | + } |
|
99 | 99 | |
100 | 100 | |
101 | - /** |
|
102 | - * Tries to find the new datetime the Check-in was for, based on the attendee row |
|
103 | - * (because we know the attendee was for an event as a specific time, and we know |
|
104 | - * the event's OLD ID...) |
|
105 | - * @global type $wpdb |
|
106 | - * @param array $old_attendee_row |
|
107 | - * @return array row of datetime from DB |
|
108 | - */ |
|
109 | - private function _try_to_find_datetime($old_attendee) |
|
110 | - { |
|
111 | - global $wpdb; |
|
101 | + /** |
|
102 | + * Tries to find the new datetime the Check-in was for, based on the attendee row |
|
103 | + * (because we know the attendee was for an event as a specific time, and we know |
|
104 | + * the event's OLD ID...) |
|
105 | + * @global type $wpdb |
|
106 | + * @param array $old_attendee_row |
|
107 | + * @return array row of datetime from DB |
|
108 | + */ |
|
109 | + private function _try_to_find_datetime($old_attendee) |
|
110 | + { |
|
111 | + global $wpdb; |
|
112 | 112 | |
113 | - $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts); |
|
114 | - if (! $new_event_id) { |
|
115 | - $this->add_error( |
|
116 | - sprintf( |
|
117 | - esc_html__( |
|
118 | - /* translators: 1: original event ID, 2: original attendee database row */ |
|
119 | - // @codingStandardsIgnoreStart |
|
120 | - 'Could not find new event ID with old event ID %1$d, on attendee row %2$s; and because of that couldn\'t find the correct datetime for Check-in', |
|
121 | - // @codingStandardsIgnoreEnd |
|
122 | - 'event_espresso' |
|
123 | - ), |
|
124 | - $old_attendee['event_id'], |
|
125 | - $this->_json_encode($old_attendee) |
|
126 | - ) |
|
127 | - ); |
|
128 | - return 0; |
|
129 | - } |
|
130 | - $old_att_start_date = $old_attendee['start_date']; |
|
131 | - $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']); |
|
132 | - $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00"); |
|
113 | + $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts); |
|
114 | + if (! $new_event_id) { |
|
115 | + $this->add_error( |
|
116 | + sprintf( |
|
117 | + esc_html__( |
|
118 | + /* translators: 1: original event ID, 2: original attendee database row */ |
|
119 | + // @codingStandardsIgnoreStart |
|
120 | + 'Could not find new event ID with old event ID %1$d, on attendee row %2$s; and because of that couldn\'t find the correct datetime for Check-in', |
|
121 | + // @codingStandardsIgnoreEnd |
|
122 | + 'event_espresso' |
|
123 | + ), |
|
124 | + $old_attendee['event_id'], |
|
125 | + $this->_json_encode($old_attendee) |
|
126 | + ) |
|
127 | + ); |
|
128 | + return 0; |
|
129 | + } |
|
130 | + $old_att_start_date = $old_attendee['start_date']; |
|
131 | + $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']); |
|
132 | + $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00"); |
|
133 | 133 | |
134 | - $datetime_table = $wpdb->prefix."esp_datetime"; |
|
135 | - // add all conditions to an array from which we can SHIFT conditions off in order to widen our search |
|
136 | - // the most important condition should be last, as it will be array_shift'ed off last |
|
137 | - $conditions = array( |
|
138 | - $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match? |
|
139 | - $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match? |
|
140 | - ); |
|
141 | - // start running queries, widening search each time by removing a condition |
|
142 | - $datetime_found = null; |
|
143 | - do { |
|
144 | - $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1"; |
|
145 | - $datetime_found = $wpdb->get_row($full_query, ARRAY_A); |
|
146 | - array_shift($conditions); |
|
147 | - } while (! $datetime_found && $conditions); |
|
148 | - return $datetime_found; |
|
149 | - } |
|
134 | + $datetime_table = $wpdb->prefix."esp_datetime"; |
|
135 | + // add all conditions to an array from which we can SHIFT conditions off in order to widen our search |
|
136 | + // the most important condition should be last, as it will be array_shift'ed off last |
|
137 | + $conditions = array( |
|
138 | + $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match? |
|
139 | + $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match? |
|
140 | + ); |
|
141 | + // start running queries, widening search each time by removing a condition |
|
142 | + $datetime_found = null; |
|
143 | + do { |
|
144 | + $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1"; |
|
145 | + $datetime_found = $wpdb->get_row($full_query, ARRAY_A); |
|
146 | + array_shift($conditions); |
|
147 | + } while (! $datetime_found && $conditions); |
|
148 | + return $datetime_found; |
|
149 | + } |
|
150 | 150 | |
151 | - /** |
|
152 | - * Adds a new Check-in/checkout record according for $new_reg_id,$new_datetime_id,$checking_in, and $timestmap |
|
153 | - * @param int $new_reg_id |
|
154 | - * @param int $new_datetime_id |
|
155 | - * @param string $timestamp mysql datetime |
|
156 | - * @return int new Check-in id |
|
157 | - */ |
|
158 | - private function _insert_checkin_record($new_reg_id, $new_datetime) |
|
159 | - { |
|
160 | - global $wpdb; |
|
151 | + /** |
|
152 | + * Adds a new Check-in/checkout record according for $new_reg_id,$new_datetime_id,$checking_in, and $timestmap |
|
153 | + * @param int $new_reg_id |
|
154 | + * @param int $new_datetime_id |
|
155 | + * @param string $timestamp mysql datetime |
|
156 | + * @return int new Check-in id |
|
157 | + */ |
|
158 | + private function _insert_checkin_record($new_reg_id, $new_datetime) |
|
159 | + { |
|
160 | + global $wpdb; |
|
161 | 161 | |
162 | 162 | |
163 | - // ok we can actually do what we set out to do: add a checkin/checkout record |
|
164 | - $cols_n_values = array( |
|
165 | - 'REG_ID'=>$new_reg_id, |
|
166 | - 'DTT_ID'=>$new_datetime['DTT_ID'], |
|
167 | - 'CHK_in'=>true, |
|
168 | - 'CHK_timestamp'=>$new_datetime['DTT_EVT_start'] |
|
169 | - ); |
|
170 | - $datatypes = array( |
|
171 | - '%d',// REG_ID |
|
172 | - '%d',// DTT_ID |
|
173 | - '%d',// CHK_in |
|
174 | - '%s',// CHK_timestamp |
|
175 | - ); |
|
176 | - $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes); |
|
177 | - if (! $success) { |
|
178 | - $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes)); |
|
179 | - return 0; |
|
180 | - } |
|
181 | - $new_id = $wpdb->insert_id; |
|
182 | - return $new_id; |
|
183 | - } |
|
163 | + // ok we can actually do what we set out to do: add a checkin/checkout record |
|
164 | + $cols_n_values = array( |
|
165 | + 'REG_ID'=>$new_reg_id, |
|
166 | + 'DTT_ID'=>$new_datetime['DTT_ID'], |
|
167 | + 'CHK_in'=>true, |
|
168 | + 'CHK_timestamp'=>$new_datetime['DTT_EVT_start'] |
|
169 | + ); |
|
170 | + $datatypes = array( |
|
171 | + '%d',// REG_ID |
|
172 | + '%d',// DTT_ID |
|
173 | + '%d',// CHK_in |
|
174 | + '%s',// CHK_timestamp |
|
175 | + ); |
|
176 | + $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes); |
|
177 | + if (! $success) { |
|
178 | + $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes)); |
|
179 | + return 0; |
|
180 | + } |
|
181 | + $new_id = $wpdb->insert_id; |
|
182 | + return $new_id; |
|
183 | + } |
|
184 | 184 | } |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | $this->_pretty_name = esc_html__('Checkins', 'event_espresso'); |
34 | 34 | $this->_old_table = $wpdb->prefix."events_attendee"; |
35 | 35 | $this->_extra_where_sql = 'AS att |
36 | - INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id |
|
36 | + INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id |
|
37 | 37 | WHERE e.event_status!="D"'; |
38 | 38 | $this->_new_table = $wpdb->prefix."esp_checkin"; |
39 | 39 | parent::__construct(); |
@@ -43,10 +43,10 @@ discard block |
||
43 | 43 | global $wpdb; |
44 | 44 | $new_reg_table = $wpdb->prefix."esp_registration"; |
45 | 45 | |
46 | - $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ; |
|
46 | + $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']), intval($old_row['checked_in']))); |
|
47 | 47 | |
48 | 48 | $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table); |
49 | - if (! $new_registrations_for_attendee) { |
|
49 | + if ( ! $new_registrations_for_attendee) { |
|
50 | 50 | $new_registrations_for_attendee = array(); |
51 | 51 | } |
52 | 52 | $new_datetime = $this->_try_to_find_datetime($old_row); |
@@ -54,9 +54,9 @@ discard block |
||
54 | 54 | // make sure registrations array is numerically indexed starting at 0 (it probably already is) |
55 | 55 | $new_registrations_for_attendee = array_values($new_registrations_for_attendee); |
56 | 56 | $new_checkin_ids = array(); |
57 | - for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) { |
|
58 | - $new_reg_id = $new_registrations_for_attendee[ $i ]; |
|
59 | - if (! $new_reg_id) { |
|
57 | + for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) { |
|
58 | + $new_reg_id = $new_registrations_for_attendee[$i]; |
|
59 | + if ( ! $new_reg_id) { |
|
60 | 60 | $this->add_error(sprintf( |
61 | 61 | esc_html__( |
62 | 62 | /* translators: %1$s database row represented in JSON, %2$s number of registrations to check-in |
@@ -80,10 +80,10 @@ discard block |
||
80 | 80 | $new_reg_id |
81 | 81 | ) |
82 | 82 | ); |
83 | - if (! $existing_checkin_record) { |
|
83 | + if ( ! $existing_checkin_record) { |
|
84 | 84 | $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime); |
85 | 85 | if ($new_id) { |
86 | - $new_checkin_ids[]= $new_id; |
|
86 | + $new_checkin_ids[] = $new_id; |
|
87 | 87 | } |
88 | 88 | } |
89 | 89 | } |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | global $wpdb; |
112 | 112 | |
113 | 113 | $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts); |
114 | - if (! $new_event_id) { |
|
114 | + if ( ! $new_event_id) { |
|
115 | 115 | $this->add_error( |
116 | 116 | sprintf( |
117 | 117 | esc_html__( |
@@ -135,8 +135,8 @@ discard block |
||
135 | 135 | // add all conditions to an array from which we can SHIFT conditions off in order to widen our search |
136 | 136 | // the most important condition should be last, as it will be array_shift'ed off last |
137 | 137 | $conditions = array( |
138 | - $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match? |
|
139 | - $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match? |
|
138 | + $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match? |
|
139 | + $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match? |
|
140 | 140 | ); |
141 | 141 | // start running queries, widening search each time by removing a condition |
142 | 142 | $datetime_found = null; |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1"; |
145 | 145 | $datetime_found = $wpdb->get_row($full_query, ARRAY_A); |
146 | 146 | array_shift($conditions); |
147 | - } while (! $datetime_found && $conditions); |
|
147 | + }while ( ! $datetime_found && $conditions); |
|
148 | 148 | return $datetime_found; |
149 | 149 | } |
150 | 150 | |
@@ -168,13 +168,13 @@ discard block |
||
168 | 168 | 'CHK_timestamp'=>$new_datetime['DTT_EVT_start'] |
169 | 169 | ); |
170 | 170 | $datatypes = array( |
171 | - '%d',// REG_ID |
|
172 | - '%d',// DTT_ID |
|
173 | - '%d',// CHK_in |
|
174 | - '%s',// CHK_timestamp |
|
171 | + '%d', // REG_ID |
|
172 | + '%d', // DTT_ID |
|
173 | + '%d', // CHK_in |
|
174 | + '%s', // CHK_timestamp |
|
175 | 175 | ); |
176 | 176 | $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes); |
177 | - if (! $success) { |
|
177 | + if ( ! $success) { |
|
178 | 178 | $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes)); |
179 | 179 | return 0; |
180 | 180 | } |
@@ -21,2045 +21,2045 @@ |
||
21 | 21 | class EEH_Line_Item |
22 | 22 | { |
23 | 23 | |
24 | - /** |
|
25 | - * Adds a simple item (unrelated to any other model object) to the provided PARENT line item. |
|
26 | - * Does NOT automatically re-calculate the line item totals or update the related transaction. |
|
27 | - * You should call recalculate_total_including_taxes() on the grant total line item after this |
|
28 | - * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
29 | - * to keep the registration final prices in-sync with the transaction's total. |
|
30 | - * |
|
31 | - * @param EE_Line_Item $parent_line_item |
|
32 | - * @param string $name |
|
33 | - * @param float $unit_price |
|
34 | - * @param string $description |
|
35 | - * @param int $quantity |
|
36 | - * @param boolean $taxable |
|
37 | - * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
38 | - * @return boolean success |
|
39 | - * @throws EE_Error |
|
40 | - * @throws InvalidArgumentException |
|
41 | - * @throws InvalidDataTypeException |
|
42 | - * @throws InvalidInterfaceException |
|
43 | - * @throws ReflectionException |
|
44 | - */ |
|
45 | - public static function add_unrelated_item( |
|
46 | - EE_Line_Item $parent_line_item, |
|
47 | - $name, |
|
48 | - $unit_price, |
|
49 | - $description = '', |
|
50 | - $quantity = 1, |
|
51 | - $taxable = false, |
|
52 | - $code = null |
|
53 | - ) { |
|
54 | - $items_subtotal = self::get_pre_tax_subtotal($parent_line_item); |
|
55 | - $line_item = EE_Line_Item::new_instance(array( |
|
56 | - 'LIN_name' => $name, |
|
57 | - 'LIN_desc' => $description, |
|
58 | - 'LIN_unit_price' => $unit_price, |
|
59 | - 'LIN_quantity' => $quantity, |
|
60 | - 'LIN_percent' => null, |
|
61 | - 'LIN_is_taxable' => $taxable, |
|
62 | - 'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0, |
|
63 | - 'LIN_total' => (float) $unit_price * (int) $quantity, |
|
64 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
65 | - 'LIN_code' => $code, |
|
66 | - )); |
|
67 | - $line_item = apply_filters( |
|
68 | - 'FHEE__EEH_Line_Item__add_unrelated_item__line_item', |
|
69 | - $line_item, |
|
70 | - $parent_line_item |
|
71 | - ); |
|
72 | - return self::add_item($parent_line_item, $line_item); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
78 | - * in the correct spot in the line item tree. Does not automatically |
|
79 | - * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's |
|
80 | - * registrations' final prices (which should probably change because of this). |
|
81 | - * You should call recalculate_total_including_taxes() on the grand total line item, then |
|
82 | - * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices() |
|
83 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
84 | - * |
|
85 | - * @param EE_Line_Item $parent_line_item |
|
86 | - * @param string $name |
|
87 | - * @param float $percentage_amount |
|
88 | - * @param string $description |
|
89 | - * @param boolean $taxable |
|
90 | - * @return boolean success |
|
91 | - * @throws EE_Error |
|
92 | - */ |
|
93 | - public static function add_percentage_based_item( |
|
94 | - EE_Line_Item $parent_line_item, |
|
95 | - $name, |
|
96 | - $percentage_amount, |
|
97 | - $description = '', |
|
98 | - $taxable = false |
|
99 | - ) { |
|
100 | - $line_item = EE_Line_Item::new_instance(array( |
|
101 | - 'LIN_name' => $name, |
|
102 | - 'LIN_desc' => $description, |
|
103 | - 'LIN_unit_price' => 0, |
|
104 | - 'LIN_percent' => $percentage_amount, |
|
105 | - 'LIN_quantity' => 1, |
|
106 | - 'LIN_is_taxable' => $taxable, |
|
107 | - 'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)), |
|
108 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
109 | - 'LIN_parent' => $parent_line_item->ID(), |
|
110 | - )); |
|
111 | - $line_item = apply_filters( |
|
112 | - 'FHEE__EEH_Line_Item__add_percentage_based_item__line_item', |
|
113 | - $line_item |
|
114 | - ); |
|
115 | - return $parent_line_item->add_child_line_item($line_item, false); |
|
116 | - } |
|
117 | - |
|
118 | - |
|
119 | - /** |
|
120 | - * Returns the new line item created by adding a purchase of the ticket |
|
121 | - * ensures that ticket line item is saved, and that cart total has been recalculated. |
|
122 | - * If this ticket has already been purchased, just increments its count. |
|
123 | - * Automatically re-calculates the line item totals and updates the related transaction. But |
|
124 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
125 | - * should probably change because of this). |
|
126 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
127 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
128 | - * |
|
129 | - * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total |
|
130 | - * @param EE_Ticket $ticket |
|
131 | - * @param int $qty |
|
132 | - * @return EE_Line_Item |
|
133 | - * @throws EE_Error |
|
134 | - * @throws InvalidArgumentException |
|
135 | - * @throws InvalidDataTypeException |
|
136 | - * @throws InvalidInterfaceException |
|
137 | - * @throws ReflectionException |
|
138 | - */ |
|
139 | - public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
140 | - { |
|
141 | - if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
142 | - throw new EE_Error( |
|
143 | - sprintf( |
|
144 | - esc_html__( |
|
145 | - 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', |
|
146 | - 'event_espresso' |
|
147 | - ), |
|
148 | - $ticket->ID(), |
|
149 | - $total_line_item->ID() |
|
150 | - ) |
|
151 | - ); |
|
152 | - } |
|
153 | - // either increment the qty for an existing ticket |
|
154 | - $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty); |
|
155 | - // or add a new one |
|
156 | - if (! $line_item instanceof EE_Line_Item) { |
|
157 | - $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty); |
|
158 | - } |
|
159 | - $total_line_item->recalculate_total_including_taxes(); |
|
160 | - return $line_item; |
|
161 | - } |
|
162 | - |
|
163 | - |
|
164 | - /** |
|
165 | - * Returns the new line item created by adding a purchase of the ticket |
|
166 | - * |
|
167 | - * @param EE_Line_Item $total_line_item |
|
168 | - * @param EE_Ticket $ticket |
|
169 | - * @param int $qty |
|
170 | - * @return EE_Line_Item |
|
171 | - * @throws EE_Error |
|
172 | - * @throws InvalidArgumentException |
|
173 | - * @throws InvalidDataTypeException |
|
174 | - * @throws InvalidInterfaceException |
|
175 | - * @throws ReflectionException |
|
176 | - */ |
|
177 | - public static function increment_ticket_qty_if_already_in_cart( |
|
178 | - EE_Line_Item $total_line_item, |
|
179 | - EE_Ticket $ticket, |
|
180 | - $qty = 1 |
|
181 | - ) { |
|
182 | - $line_item = null; |
|
183 | - if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) { |
|
184 | - $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item); |
|
185 | - foreach ((array) $ticket_line_items as $ticket_line_item) { |
|
186 | - if ($ticket_line_item instanceof EE_Line_Item |
|
187 | - && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID() |
|
188 | - ) { |
|
189 | - $line_item = $ticket_line_item; |
|
190 | - break; |
|
191 | - } |
|
192 | - } |
|
193 | - } |
|
194 | - if ($line_item instanceof EE_Line_Item) { |
|
195 | - EEH_Line_Item::increment_quantity($line_item, $qty); |
|
196 | - return $line_item; |
|
197 | - } |
|
198 | - return null; |
|
199 | - } |
|
200 | - |
|
201 | - |
|
202 | - /** |
|
203 | - * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
204 | - * Does NOT save or recalculate other line items totals |
|
205 | - * |
|
206 | - * @param EE_Line_Item $line_item |
|
207 | - * @param int $qty |
|
208 | - * @return void |
|
209 | - * @throws EE_Error |
|
210 | - * @throws InvalidArgumentException |
|
211 | - * @throws InvalidDataTypeException |
|
212 | - * @throws InvalidInterfaceException |
|
213 | - * @throws ReflectionException |
|
214 | - */ |
|
215 | - public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) |
|
216 | - { |
|
217 | - if (! $line_item->is_percent()) { |
|
218 | - $qty += $line_item->quantity(); |
|
219 | - $line_item->set_quantity($qty); |
|
220 | - $line_item->set_total($line_item->unit_price() * $qty); |
|
221 | - $line_item->save(); |
|
222 | - } |
|
223 | - foreach ($line_item->children() as $child) { |
|
224 | - if ($child->is_sub_line_item()) { |
|
225 | - EEH_Line_Item::update_quantity($child, $qty); |
|
226 | - } |
|
227 | - } |
|
228 | - } |
|
229 | - |
|
230 | - |
|
231 | - /** |
|
232 | - * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
233 | - * Does NOT save or recalculate other line items totals |
|
234 | - * |
|
235 | - * @param EE_Line_Item $line_item |
|
236 | - * @param int $qty |
|
237 | - * @return void |
|
238 | - * @throws EE_Error |
|
239 | - * @throws InvalidArgumentException |
|
240 | - * @throws InvalidDataTypeException |
|
241 | - * @throws InvalidInterfaceException |
|
242 | - * @throws ReflectionException |
|
243 | - */ |
|
244 | - public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) |
|
245 | - { |
|
246 | - if (! $line_item->is_percent()) { |
|
247 | - $qty = $line_item->quantity() - $qty; |
|
248 | - $qty = max($qty, 0); |
|
249 | - $line_item->set_quantity($qty); |
|
250 | - $line_item->set_total($line_item->unit_price() * $qty); |
|
251 | - $line_item->save(); |
|
252 | - } |
|
253 | - foreach ($line_item->children() as $child) { |
|
254 | - if ($child->is_sub_line_item()) { |
|
255 | - EEH_Line_Item::update_quantity($child, $qty); |
|
256 | - } |
|
257 | - } |
|
258 | - } |
|
259 | - |
|
260 | - |
|
261 | - /** |
|
262 | - * Updates the line item and its children's quantities to the specified number. |
|
263 | - * Does NOT save them or recalculate totals. |
|
264 | - * |
|
265 | - * @param EE_Line_Item $line_item |
|
266 | - * @param int $new_quantity |
|
267 | - * @throws EE_Error |
|
268 | - * @throws InvalidArgumentException |
|
269 | - * @throws InvalidDataTypeException |
|
270 | - * @throws InvalidInterfaceException |
|
271 | - * @throws ReflectionException |
|
272 | - */ |
|
273 | - public static function update_quantity(EE_Line_Item $line_item, $new_quantity) |
|
274 | - { |
|
275 | - if (! $line_item->is_percent()) { |
|
276 | - $line_item->set_quantity($new_quantity); |
|
277 | - $line_item->set_total($line_item->unit_price() * $new_quantity); |
|
278 | - $line_item->save(); |
|
279 | - } |
|
280 | - foreach ($line_item->children() as $child) { |
|
281 | - if ($child->is_sub_line_item()) { |
|
282 | - EEH_Line_Item::update_quantity($child, $new_quantity); |
|
283 | - } |
|
284 | - } |
|
285 | - } |
|
286 | - |
|
287 | - |
|
288 | - /** |
|
289 | - * Returns the new line item created by adding a purchase of the ticket |
|
290 | - * |
|
291 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
292 | - * @param EE_Ticket $ticket |
|
293 | - * @param int $qty |
|
294 | - * @return EE_Line_Item |
|
295 | - * @throws EE_Error |
|
296 | - * @throws InvalidArgumentException |
|
297 | - * @throws InvalidDataTypeException |
|
298 | - * @throws InvalidInterfaceException |
|
299 | - * @throws ReflectionException |
|
300 | - */ |
|
301 | - public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
302 | - { |
|
303 | - $datetimes = $ticket->datetimes(); |
|
304 | - $first_datetime = reset($datetimes); |
|
305 | - $first_datetime_name = esc_html__('Event', 'event_espresso'); |
|
306 | - if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) { |
|
307 | - $first_datetime_name = $first_datetime->event()->name(); |
|
308 | - } |
|
309 | - $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name); |
|
310 | - // get event subtotal line |
|
311 | - $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket); |
|
312 | - // add $ticket to cart |
|
313 | - $line_item = EE_Line_Item::new_instance(array( |
|
314 | - 'LIN_name' => $ticket->name(), |
|
315 | - 'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event, |
|
316 | - 'LIN_unit_price' => $ticket->price(), |
|
317 | - 'LIN_quantity' => $qty, |
|
318 | - 'LIN_is_taxable' => $ticket->taxable(), |
|
319 | - 'LIN_order' => count($events_sub_total->children()), |
|
320 | - 'LIN_total' => $ticket->price() * $qty, |
|
321 | - 'LIN_type' => EEM_Line_Item::type_line_item, |
|
322 | - 'OBJ_ID' => $ticket->ID(), |
|
323 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
324 | - )); |
|
325 | - $line_item = apply_filters( |
|
326 | - 'FHEE__EEH_Line_Item__create_ticket_line_item__line_item', |
|
327 | - $line_item |
|
328 | - ); |
|
329 | - $events_sub_total->add_child_line_item($line_item); |
|
330 | - // now add the sub-line items |
|
331 | - $running_total_for_ticket = 0; |
|
332 | - foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) { |
|
333 | - $sign = $price->is_discount() ? -1 : 1; |
|
334 | - $price_total = $price->is_percent() |
|
335 | - ? $running_total_for_ticket * $price->amount() / 100 |
|
336 | - : $price->amount() * $qty; |
|
337 | - $sub_line_item = EE_Line_Item::new_instance(array( |
|
338 | - 'LIN_name' => $price->name(), |
|
339 | - 'LIN_desc' => $price->desc(), |
|
340 | - 'LIN_quantity' => $price->is_percent() ? null : $qty, |
|
341 | - 'LIN_is_taxable' => false, |
|
342 | - 'LIN_order' => $price->order(), |
|
343 | - 'LIN_total' => $sign * $price_total, |
|
344 | - 'LIN_type' => EEM_Line_Item::type_sub_line_item, |
|
345 | - 'OBJ_ID' => $price->ID(), |
|
346 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
347 | - )); |
|
348 | - $sub_line_item = apply_filters( |
|
349 | - 'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item', |
|
350 | - $sub_line_item |
|
351 | - ); |
|
352 | - if ($price->is_percent()) { |
|
353 | - $sub_line_item->set_percent($sign * $price->amount()); |
|
354 | - } else { |
|
355 | - $sub_line_item->set_unit_price($sign * $price->amount()); |
|
356 | - } |
|
357 | - $running_total_for_ticket += $price_total; |
|
358 | - $line_item->add_child_line_item($sub_line_item); |
|
359 | - } |
|
360 | - return $line_item; |
|
361 | - } |
|
362 | - |
|
363 | - |
|
364 | - /** |
|
365 | - * Adds the specified item under the pre-tax-sub-total line item. Automatically |
|
366 | - * re-calculates the line item totals and updates the related transaction. But |
|
367 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
368 | - * should probably change because of this). |
|
369 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
370 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
371 | - * |
|
372 | - * @param EE_Line_Item $total_line_item |
|
373 | - * @param EE_Line_Item $item to be added |
|
374 | - * @return boolean |
|
375 | - * @throws EE_Error |
|
376 | - * @throws InvalidArgumentException |
|
377 | - * @throws InvalidDataTypeException |
|
378 | - * @throws InvalidInterfaceException |
|
379 | - * @throws ReflectionException |
|
380 | - */ |
|
381 | - public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) |
|
382 | - { |
|
383 | - $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item); |
|
384 | - if ($pre_tax_subtotal instanceof EE_Line_Item) { |
|
385 | - $success = $pre_tax_subtotal->add_child_line_item($item); |
|
386 | - } else { |
|
387 | - return false; |
|
388 | - } |
|
389 | - $total_line_item->recalculate_total_including_taxes(); |
|
390 | - return $success; |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * cancels an existing ticket line item, |
|
396 | - * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item. |
|
397 | - * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
398 | - * |
|
399 | - * @param EE_Line_Item $ticket_line_item |
|
400 | - * @param int $qty |
|
401 | - * @return bool success |
|
402 | - * @throws EE_Error |
|
403 | - * @throws InvalidArgumentException |
|
404 | - * @throws InvalidDataTypeException |
|
405 | - * @throws InvalidInterfaceException |
|
406 | - * @throws ReflectionException |
|
407 | - */ |
|
408 | - public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
409 | - { |
|
410 | - // validate incoming line_item |
|
411 | - if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
412 | - throw new EE_Error( |
|
413 | - sprintf( |
|
414 | - esc_html__( |
|
415 | - 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
416 | - 'event_espresso' |
|
417 | - ), |
|
418 | - $ticket_line_item->type() |
|
419 | - ) |
|
420 | - ); |
|
421 | - } |
|
422 | - if ($ticket_line_item->quantity() < $qty) { |
|
423 | - throw new EE_Error( |
|
424 | - sprintf( |
|
425 | - esc_html__( |
|
426 | - 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', |
|
427 | - 'event_espresso' |
|
428 | - ), |
|
429 | - $qty, |
|
430 | - $ticket_line_item->quantity() |
|
431 | - ) |
|
432 | - ); |
|
433 | - } |
|
434 | - // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this |
|
435 | - $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty); |
|
436 | - foreach ($ticket_line_item->children() as $child_line_item) { |
|
437 | - if ($child_line_item->is_sub_line_item() |
|
438 | - && ! $child_line_item->is_percent() |
|
439 | - && ! $child_line_item->is_cancellation() |
|
440 | - ) { |
|
441 | - $child_line_item->set_quantity($child_line_item->quantity() - $qty); |
|
442 | - } |
|
443 | - } |
|
444 | - // get cancellation sub line item |
|
445 | - $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
446 | - $ticket_line_item, |
|
447 | - EEM_Line_Item::type_cancellation |
|
448 | - ); |
|
449 | - $cancellation_line_item = reset($cancellation_line_item); |
|
450 | - // verify that this ticket was indeed previously cancelled |
|
451 | - if ($cancellation_line_item instanceof EE_Line_Item) { |
|
452 | - // increment cancelled quantity |
|
453 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty); |
|
454 | - } else { |
|
455 | - // create cancellation sub line item |
|
456 | - $cancellation_line_item = EE_Line_Item::new_instance(array( |
|
457 | - 'LIN_name' => esc_html__('Cancellation', 'event_espresso'), |
|
458 | - 'LIN_desc' => sprintf( |
|
459 | - esc_html_x( |
|
460 | - 'Cancelled %1$s : %2$s', |
|
461 | - 'Cancelled Ticket Name : 2015-01-01 11:11', |
|
462 | - 'event_espresso' |
|
463 | - ), |
|
464 | - $ticket_line_item->name(), |
|
465 | - current_time(get_option('date_format') . ' ' . get_option('time_format')) |
|
466 | - ), |
|
467 | - 'LIN_unit_price' => 0, // $ticket_line_item->unit_price() |
|
468 | - 'LIN_quantity' => $qty, |
|
469 | - 'LIN_is_taxable' => $ticket_line_item->is_taxable(), |
|
470 | - 'LIN_order' => count($ticket_line_item->children()), |
|
471 | - 'LIN_total' => 0, // $ticket_line_item->unit_price() |
|
472 | - 'LIN_type' => EEM_Line_Item::type_cancellation, |
|
473 | - )); |
|
474 | - $ticket_line_item->add_child_line_item($cancellation_line_item); |
|
475 | - } |
|
476 | - if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
477 | - // decrement parent line item quantity |
|
478 | - $event_line_item = $ticket_line_item->parent(); |
|
479 | - if ($event_line_item instanceof EE_Line_Item |
|
480 | - && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
481 | - ) { |
|
482 | - $event_line_item->set_quantity($event_line_item->quantity() - $qty); |
|
483 | - $event_line_item->save(); |
|
484 | - } |
|
485 | - EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
486 | - return true; |
|
487 | - } |
|
488 | - return false; |
|
489 | - } |
|
490 | - |
|
491 | - |
|
492 | - /** |
|
493 | - * reinstates (un-cancels?) a previously canceled ticket line item, |
|
494 | - * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item. |
|
495 | - * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
496 | - * |
|
497 | - * @param EE_Line_Item $ticket_line_item |
|
498 | - * @param int $qty |
|
499 | - * @return bool success |
|
500 | - * @throws EE_Error |
|
501 | - * @throws InvalidArgumentException |
|
502 | - * @throws InvalidDataTypeException |
|
503 | - * @throws InvalidInterfaceException |
|
504 | - * @throws ReflectionException |
|
505 | - */ |
|
506 | - public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
507 | - { |
|
508 | - // validate incoming line_item |
|
509 | - if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
510 | - throw new EE_Error( |
|
511 | - sprintf( |
|
512 | - esc_html__( |
|
513 | - 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
514 | - 'event_espresso' |
|
515 | - ), |
|
516 | - $ticket_line_item->type() |
|
517 | - ) |
|
518 | - ); |
|
519 | - } |
|
520 | - // get cancellation sub line item |
|
521 | - $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
522 | - $ticket_line_item, |
|
523 | - EEM_Line_Item::type_cancellation |
|
524 | - ); |
|
525 | - $cancellation_line_item = reset($cancellation_line_item); |
|
526 | - // verify that this ticket was indeed previously cancelled |
|
527 | - if (! $cancellation_line_item instanceof EE_Line_Item) { |
|
528 | - return false; |
|
529 | - } |
|
530 | - if ($cancellation_line_item->quantity() > $qty) { |
|
531 | - // decrement cancelled quantity |
|
532 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
533 | - } elseif ($cancellation_line_item->quantity() === $qty) { |
|
534 | - // decrement cancelled quantity in case anyone still has the object kicking around |
|
535 | - $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
536 | - // delete because quantity will end up as 0 |
|
537 | - $cancellation_line_item->delete(); |
|
538 | - // and attempt to destroy the object, |
|
539 | - // even though PHP won't actually destroy it until it needs the memory |
|
540 | - unset($cancellation_line_item); |
|
541 | - } else { |
|
542 | - // what ?!?! negative quantity ?!?! |
|
543 | - throw new EE_Error( |
|
544 | - sprintf( |
|
545 | - esc_html__( |
|
546 | - 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.', |
|
547 | - 'event_espresso' |
|
548 | - ), |
|
549 | - $qty, |
|
550 | - $cancellation_line_item->quantity() |
|
551 | - ) |
|
552 | - ); |
|
553 | - } |
|
554 | - // increment ticket quantity |
|
555 | - $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty); |
|
556 | - if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
557 | - // increment parent line item quantity |
|
558 | - $event_line_item = $ticket_line_item->parent(); |
|
559 | - if ($event_line_item instanceof EE_Line_Item |
|
560 | - && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
561 | - ) { |
|
562 | - $event_line_item->set_quantity($event_line_item->quantity() + $qty); |
|
563 | - } |
|
564 | - EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
565 | - return true; |
|
566 | - } |
|
567 | - return false; |
|
568 | - } |
|
569 | - |
|
570 | - |
|
571 | - /** |
|
572 | - * calls EEH_Line_Item::find_transaction_grand_total_for_line_item() |
|
573 | - * then EE_Line_Item::recalculate_total_including_taxes() on the result |
|
574 | - * |
|
575 | - * @param EE_Line_Item $line_item |
|
576 | - * @return float |
|
577 | - * @throws EE_Error |
|
578 | - * @throws InvalidArgumentException |
|
579 | - * @throws InvalidDataTypeException |
|
580 | - * @throws InvalidInterfaceException |
|
581 | - * @throws ReflectionException |
|
582 | - */ |
|
583 | - public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) |
|
584 | - { |
|
585 | - $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item); |
|
586 | - return $grand_total_line_item->recalculate_total_including_taxes(); |
|
587 | - } |
|
588 | - |
|
589 | - |
|
590 | - /** |
|
591 | - * Gets the line item which contains the subtotal of all the items |
|
592 | - * |
|
593 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
594 | - * @return EE_Line_Item |
|
595 | - * @throws EE_Error |
|
596 | - * @throws InvalidArgumentException |
|
597 | - * @throws InvalidDataTypeException |
|
598 | - * @throws InvalidInterfaceException |
|
599 | - * @throws ReflectionException |
|
600 | - */ |
|
601 | - public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) |
|
602 | - { |
|
603 | - $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal'); |
|
604 | - return $pre_tax_subtotal instanceof EE_Line_Item |
|
605 | - ? $pre_tax_subtotal |
|
606 | - : self::create_pre_tax_subtotal($total_line_item); |
|
607 | - } |
|
608 | - |
|
609 | - |
|
610 | - /** |
|
611 | - * Gets the line item for the taxes subtotal |
|
612 | - * |
|
613 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
614 | - * @return EE_Line_Item |
|
615 | - * @throws EE_Error |
|
616 | - * @throws InvalidArgumentException |
|
617 | - * @throws InvalidDataTypeException |
|
618 | - * @throws InvalidInterfaceException |
|
619 | - * @throws ReflectionException |
|
620 | - */ |
|
621 | - public static function get_taxes_subtotal(EE_Line_Item $total_line_item) |
|
622 | - { |
|
623 | - $taxes = $total_line_item->get_child_line_item('taxes'); |
|
624 | - return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item); |
|
625 | - } |
|
626 | - |
|
627 | - |
|
628 | - /** |
|
629 | - * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object |
|
630 | - * |
|
631 | - * @param EE_Line_Item $line_item |
|
632 | - * @param EE_Transaction $transaction |
|
633 | - * @return void |
|
634 | - * @throws EE_Error |
|
635 | - * @throws InvalidArgumentException |
|
636 | - * @throws InvalidDataTypeException |
|
637 | - * @throws InvalidInterfaceException |
|
638 | - * @throws ReflectionException |
|
639 | - */ |
|
640 | - public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null) |
|
641 | - { |
|
642 | - if ($transaction) { |
|
643 | - /** @type EEM_Transaction $EEM_Transaction */ |
|
644 | - $EEM_Transaction = EE_Registry::instance()->load_model('Transaction'); |
|
645 | - $TXN_ID = $EEM_Transaction->ensure_is_ID($transaction); |
|
646 | - $line_item->set_TXN_ID($TXN_ID); |
|
647 | - } |
|
648 | - } |
|
649 | - |
|
650 | - |
|
651 | - /** |
|
652 | - * Creates a new default total line item for the transaction, |
|
653 | - * and its tickets subtotal and taxes subtotal line items (and adds the |
|
654 | - * existing taxes as children of the taxes subtotal line item) |
|
655 | - * |
|
656 | - * @param EE_Transaction $transaction |
|
657 | - * @return EE_Line_Item of type total |
|
658 | - * @throws EE_Error |
|
659 | - * @throws InvalidArgumentException |
|
660 | - * @throws InvalidDataTypeException |
|
661 | - * @throws InvalidInterfaceException |
|
662 | - * @throws ReflectionException |
|
663 | - */ |
|
664 | - public static function create_total_line_item($transaction = null) |
|
665 | - { |
|
666 | - $total_line_item = EE_Line_Item::new_instance(array( |
|
667 | - 'LIN_code' => 'total', |
|
668 | - 'LIN_name' => esc_html__('Grand Total', 'event_espresso'), |
|
669 | - 'LIN_type' => EEM_Line_Item::type_total, |
|
670 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION, |
|
671 | - )); |
|
672 | - $total_line_item = apply_filters( |
|
673 | - 'FHEE__EEH_Line_Item__create_total_line_item__total_line_item', |
|
674 | - $total_line_item |
|
675 | - ); |
|
676 | - self::set_TXN_ID($total_line_item, $transaction); |
|
677 | - self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
678 | - self::create_taxes_subtotal($total_line_item, $transaction); |
|
679 | - return $total_line_item; |
|
680 | - } |
|
681 | - |
|
682 | - |
|
683 | - /** |
|
684 | - * Creates a default items subtotal line item |
|
685 | - * |
|
686 | - * @param EE_Line_Item $total_line_item |
|
687 | - * @param EE_Transaction $transaction |
|
688 | - * @return EE_Line_Item |
|
689 | - * @throws EE_Error |
|
690 | - * @throws InvalidArgumentException |
|
691 | - * @throws InvalidDataTypeException |
|
692 | - * @throws InvalidInterfaceException |
|
693 | - * @throws ReflectionException |
|
694 | - */ |
|
695 | - protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
696 | - { |
|
697 | - $pre_tax_line_item = EE_Line_Item::new_instance(array( |
|
698 | - 'LIN_code' => 'pre-tax-subtotal', |
|
699 | - 'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'), |
|
700 | - 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
701 | - )); |
|
702 | - $pre_tax_line_item = apply_filters( |
|
703 | - 'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item', |
|
704 | - $pre_tax_line_item |
|
705 | - ); |
|
706 | - self::set_TXN_ID($pre_tax_line_item, $transaction); |
|
707 | - $total_line_item->add_child_line_item($pre_tax_line_item); |
|
708 | - self::create_event_subtotal($pre_tax_line_item, $transaction); |
|
709 | - return $pre_tax_line_item; |
|
710 | - } |
|
711 | - |
|
712 | - |
|
713 | - /** |
|
714 | - * Creates a line item for the taxes subtotal and finds all the tax prices |
|
715 | - * and applies taxes to it |
|
716 | - * |
|
717 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
718 | - * @param EE_Transaction $transaction |
|
719 | - * @return EE_Line_Item |
|
720 | - * @throws EE_Error |
|
721 | - * @throws InvalidArgumentException |
|
722 | - * @throws InvalidDataTypeException |
|
723 | - * @throws InvalidInterfaceException |
|
724 | - * @throws ReflectionException |
|
725 | - */ |
|
726 | - protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
727 | - { |
|
728 | - $tax_line_item = EE_Line_Item::new_instance(array( |
|
729 | - 'LIN_code' => 'taxes', |
|
730 | - 'LIN_name' => esc_html__('Taxes', 'event_espresso'), |
|
731 | - 'LIN_type' => EEM_Line_Item::type_tax_sub_total, |
|
732 | - 'LIN_order' => 1000,// this should always come last |
|
733 | - )); |
|
734 | - $tax_line_item = apply_filters( |
|
735 | - 'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item', |
|
736 | - $tax_line_item |
|
737 | - ); |
|
738 | - self::set_TXN_ID($tax_line_item, $transaction); |
|
739 | - $total_line_item->add_child_line_item($tax_line_item); |
|
740 | - // and lastly, add the actual taxes |
|
741 | - self::apply_taxes($total_line_item); |
|
742 | - return $tax_line_item; |
|
743 | - } |
|
744 | - |
|
745 | - |
|
746 | - /** |
|
747 | - * Creates a default items subtotal line item |
|
748 | - * |
|
749 | - * @param EE_Line_Item $pre_tax_line_item |
|
750 | - * @param EE_Transaction $transaction |
|
751 | - * @param EE_Event $event |
|
752 | - * @return EE_Line_Item |
|
753 | - * @throws EE_Error |
|
754 | - * @throws InvalidArgumentException |
|
755 | - * @throws InvalidDataTypeException |
|
756 | - * @throws InvalidInterfaceException |
|
757 | - * @throws ReflectionException |
|
758 | - */ |
|
759 | - public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null) |
|
760 | - { |
|
761 | - $event_line_item = EE_Line_Item::new_instance(array( |
|
762 | - 'LIN_code' => self::get_event_code($event), |
|
763 | - 'LIN_name' => self::get_event_name($event), |
|
764 | - 'LIN_desc' => self::get_event_desc($event), |
|
765 | - 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
766 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT, |
|
767 | - 'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0, |
|
768 | - )); |
|
769 | - $event_line_item = apply_filters( |
|
770 | - 'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item', |
|
771 | - $event_line_item |
|
772 | - ); |
|
773 | - self::set_TXN_ID($event_line_item, $transaction); |
|
774 | - $pre_tax_line_item->add_child_line_item($event_line_item); |
|
775 | - return $event_line_item; |
|
776 | - } |
|
777 | - |
|
778 | - |
|
779 | - /** |
|
780 | - * Gets what the event ticket's code SHOULD be |
|
781 | - * |
|
782 | - * @param EE_Event $event |
|
783 | - * @return string |
|
784 | - * @throws EE_Error |
|
785 | - */ |
|
786 | - public static function get_event_code($event) |
|
787 | - { |
|
788 | - return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0'); |
|
789 | - } |
|
790 | - |
|
791 | - |
|
792 | - /** |
|
793 | - * Gets the event name |
|
794 | - * |
|
795 | - * @param EE_Event $event |
|
796 | - * @return string |
|
797 | - * @throws EE_Error |
|
798 | - */ |
|
799 | - public static function get_event_name($event) |
|
800 | - { |
|
801 | - return $event instanceof EE_Event |
|
802 | - ? mb_substr($event->name(), 0, 245) |
|
803 | - : esc_html__('Event', 'event_espresso'); |
|
804 | - } |
|
805 | - |
|
806 | - |
|
807 | - /** |
|
808 | - * Gets the event excerpt |
|
809 | - * |
|
810 | - * @param EE_Event $event |
|
811 | - * @return string |
|
812 | - * @throws EE_Error |
|
813 | - */ |
|
814 | - public static function get_event_desc($event) |
|
815 | - { |
|
816 | - return $event instanceof EE_Event ? $event->short_description() : ''; |
|
817 | - } |
|
818 | - |
|
819 | - |
|
820 | - /** |
|
821 | - * Given the grand total line item and a ticket, finds the event sub-total |
|
822 | - * line item the ticket's purchase should be added onto |
|
823 | - * |
|
824 | - * @access public |
|
825 | - * @param EE_Line_Item $grand_total the grand total line item |
|
826 | - * @param EE_Ticket $ticket |
|
827 | - * @return EE_Line_Item |
|
828 | - * @throws EE_Error |
|
829 | - * @throws InvalidArgumentException |
|
830 | - * @throws InvalidDataTypeException |
|
831 | - * @throws InvalidInterfaceException |
|
832 | - * @throws ReflectionException |
|
833 | - */ |
|
834 | - public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) |
|
835 | - { |
|
836 | - $first_datetime = $ticket->first_datetime(); |
|
837 | - if (! $first_datetime instanceof EE_Datetime) { |
|
838 | - throw new EE_Error( |
|
839 | - sprintf( |
|
840 | - __('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), |
|
841 | - $ticket->ID() |
|
842 | - ) |
|
843 | - ); |
|
844 | - } |
|
845 | - $event = $first_datetime->event(); |
|
846 | - if (! $event instanceof EE_Event) { |
|
847 | - throw new EE_Error( |
|
848 | - sprintf( |
|
849 | - esc_html__( |
|
850 | - 'The supplied ticket (ID %d) has no event data associated with it.', |
|
851 | - 'event_espresso' |
|
852 | - ), |
|
853 | - $ticket->ID() |
|
854 | - ) |
|
855 | - ); |
|
856 | - } |
|
857 | - $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event); |
|
858 | - if (! $events_sub_total instanceof EE_Line_Item) { |
|
859 | - throw new EE_Error( |
|
860 | - sprintf( |
|
861 | - esc_html__( |
|
862 | - 'There is no events sub-total for ticket %s on total line item %d', |
|
863 | - 'event_espresso' |
|
864 | - ), |
|
865 | - $ticket->ID(), |
|
866 | - $grand_total->ID() |
|
867 | - ) |
|
868 | - ); |
|
869 | - } |
|
870 | - return $events_sub_total; |
|
871 | - } |
|
872 | - |
|
873 | - |
|
874 | - /** |
|
875 | - * Gets the event line item |
|
876 | - * |
|
877 | - * @param EE_Line_Item $grand_total |
|
878 | - * @param EE_Event $event |
|
879 | - * @return EE_Line_Item for the event subtotal which is a child of $grand_total |
|
880 | - * @throws EE_Error |
|
881 | - * @throws InvalidArgumentException |
|
882 | - * @throws InvalidDataTypeException |
|
883 | - * @throws InvalidInterfaceException |
|
884 | - * @throws ReflectionException |
|
885 | - */ |
|
886 | - public static function get_event_line_item(EE_Line_Item $grand_total, $event) |
|
887 | - { |
|
888 | - /** @type EE_Event $event */ |
|
889 | - $event = EEM_Event::instance()->ensure_is_obj($event, true); |
|
890 | - $event_line_item = null; |
|
891 | - $found = false; |
|
892 | - foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) { |
|
893 | - // default event subtotal, we should only ever find this the first time this method is called |
|
894 | - if (! $event_line_item->OBJ_ID()) { |
|
895 | - // let's use this! but first... set the event details |
|
896 | - EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
897 | - $found = true; |
|
898 | - break; |
|
899 | - } |
|
900 | - if ($event_line_item->OBJ_ID() === $event->ID()) { |
|
901 | - // found existing line item for this event in the cart, so break out of loop and use this one |
|
902 | - $found = true; |
|
903 | - break; |
|
904 | - } |
|
905 | - } |
|
906 | - if (! $found) { |
|
907 | - // there is no event sub-total yet, so add it |
|
908 | - $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total); |
|
909 | - // create a new "event" subtotal below that |
|
910 | - $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event); |
|
911 | - // and set the event details |
|
912 | - EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
913 | - } |
|
914 | - return $event_line_item; |
|
915 | - } |
|
916 | - |
|
917 | - |
|
918 | - /** |
|
919 | - * Creates a default items subtotal line item |
|
920 | - * |
|
921 | - * @param EE_Line_Item $event_line_item |
|
922 | - * @param EE_Event $event |
|
923 | - * @param EE_Transaction $transaction |
|
924 | - * @return void |
|
925 | - * @throws EE_Error |
|
926 | - * @throws InvalidArgumentException |
|
927 | - * @throws InvalidDataTypeException |
|
928 | - * @throws InvalidInterfaceException |
|
929 | - * @throws ReflectionException |
|
930 | - */ |
|
931 | - public static function set_event_subtotal_details( |
|
932 | - EE_Line_Item $event_line_item, |
|
933 | - EE_Event $event, |
|
934 | - $transaction = null |
|
935 | - ) { |
|
936 | - if ($event instanceof EE_Event) { |
|
937 | - $event_line_item->set_code(self::get_event_code($event)); |
|
938 | - $event_line_item->set_name(self::get_event_name($event)); |
|
939 | - $event_line_item->set_desc(self::get_event_desc($event)); |
|
940 | - $event_line_item->set_OBJ_ID($event->ID()); |
|
941 | - } |
|
942 | - self::set_TXN_ID($event_line_item, $transaction); |
|
943 | - } |
|
944 | - |
|
945 | - |
|
946 | - /** |
|
947 | - * Finds what taxes should apply, adds them as tax line items under the taxes sub-total, |
|
948 | - * and recalculates the taxes sub-total and the grand total. Resets the taxes, so |
|
949 | - * any old taxes are removed |
|
950 | - * |
|
951 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
952 | - * @param bool $update_txn_status |
|
953 | - * @return bool |
|
954 | - * @throws EE_Error |
|
955 | - * @throws InvalidArgumentException |
|
956 | - * @throws InvalidDataTypeException |
|
957 | - * @throws InvalidInterfaceException |
|
958 | - * @throws ReflectionException |
|
959 | - * @throws RuntimeException |
|
960 | - */ |
|
961 | - public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false) |
|
962 | - { |
|
963 | - /** @type EEM_Price $EEM_Price */ |
|
964 | - $EEM_Price = EE_Registry::instance()->load_model('Price'); |
|
965 | - // get array of taxes via Price Model |
|
966 | - $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes(); |
|
967 | - ksort($ordered_taxes); |
|
968 | - $taxes_line_item = self::get_taxes_subtotal($total_line_item); |
|
969 | - // just to be safe, remove its old tax line items |
|
970 | - $deleted = $taxes_line_item->delete_children_line_items(); |
|
971 | - $updates = false; |
|
972 | - // loop thru taxes |
|
973 | - foreach ($ordered_taxes as $order => $taxes) { |
|
974 | - foreach ($taxes as $tax) { |
|
975 | - if ($tax instanceof EE_Price) { |
|
976 | - $tax_line_item = EE_Line_Item::new_instance( |
|
977 | - array( |
|
978 | - 'LIN_name' => $tax->name(), |
|
979 | - 'LIN_desc' => $tax->desc(), |
|
980 | - 'LIN_percent' => $tax->amount(), |
|
981 | - 'LIN_is_taxable' => false, |
|
982 | - 'LIN_order' => $order, |
|
983 | - 'LIN_total' => 0, |
|
984 | - 'LIN_type' => EEM_Line_Item::type_tax, |
|
985 | - 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
986 | - 'OBJ_ID' => $tax->ID(), |
|
987 | - ) |
|
988 | - ); |
|
989 | - $tax_line_item = apply_filters( |
|
990 | - 'FHEE__EEH_Line_Item__apply_taxes__tax_line_item', |
|
991 | - $tax_line_item |
|
992 | - ); |
|
993 | - $updates = $taxes_line_item->add_child_line_item($tax_line_item) ? |
|
994 | - true : |
|
995 | - $updates; |
|
996 | - } |
|
997 | - } |
|
998 | - } |
|
999 | - // only recalculate totals if something changed |
|
1000 | - if ($deleted || $updates) { |
|
1001 | - $total_line_item->recalculate_total_including_taxes($update_txn_status); |
|
1002 | - return true; |
|
1003 | - } |
|
1004 | - return false; |
|
1005 | - } |
|
1006 | - |
|
1007 | - |
|
1008 | - /** |
|
1009 | - * Ensures that taxes have been applied to the order, if not applies them. |
|
1010 | - * Returns the total amount of tax |
|
1011 | - * |
|
1012 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
1013 | - * @return float |
|
1014 | - * @throws EE_Error |
|
1015 | - * @throws InvalidArgumentException |
|
1016 | - * @throws InvalidDataTypeException |
|
1017 | - * @throws InvalidInterfaceException |
|
1018 | - * @throws ReflectionException |
|
1019 | - */ |
|
1020 | - public static function ensure_taxes_applied($total_line_item) |
|
1021 | - { |
|
1022 | - $taxes_subtotal = self::get_taxes_subtotal($total_line_item); |
|
1023 | - if (! $taxes_subtotal->children()) { |
|
1024 | - self::apply_taxes($total_line_item); |
|
1025 | - } |
|
1026 | - return $taxes_subtotal->total(); |
|
1027 | - } |
|
1028 | - |
|
1029 | - |
|
1030 | - /** |
|
1031 | - * Deletes ALL children of the passed line item |
|
1032 | - * |
|
1033 | - * @param EE_Line_Item $parent_line_item |
|
1034 | - * @return bool |
|
1035 | - * @throws EE_Error |
|
1036 | - * @throws InvalidArgumentException |
|
1037 | - * @throws InvalidDataTypeException |
|
1038 | - * @throws InvalidInterfaceException |
|
1039 | - * @throws ReflectionException |
|
1040 | - */ |
|
1041 | - public static function delete_all_child_items(EE_Line_Item $parent_line_item) |
|
1042 | - { |
|
1043 | - $deleted = 0; |
|
1044 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
1045 | - if ($child_line_item instanceof EE_Line_Item) { |
|
1046 | - $deleted += EEH_Line_Item::delete_all_child_items($child_line_item); |
|
1047 | - if ($child_line_item->ID()) { |
|
1048 | - $child_line_item->delete(); |
|
1049 | - unset($child_line_item); |
|
1050 | - } else { |
|
1051 | - $parent_line_item->delete_child_line_item($child_line_item->code()); |
|
1052 | - } |
|
1053 | - $deleted++; |
|
1054 | - } |
|
1055 | - } |
|
1056 | - return $deleted; |
|
1057 | - } |
|
1058 | - |
|
1059 | - |
|
1060 | - /** |
|
1061 | - * Deletes the line items as indicated by the line item code(s) provided, |
|
1062 | - * regardless of where they're found in the line item tree. Automatically |
|
1063 | - * re-calculates the line item totals and updates the related transaction. But |
|
1064 | - * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
1065 | - * should probably change because of this). |
|
1066 | - * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
1067 | - * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
1068 | - * |
|
1069 | - * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
1070 | - * @param array|bool|string $line_item_codes |
|
1071 | - * @return int number of items successfully removed |
|
1072 | - * @throws EE_Error |
|
1073 | - */ |
|
1074 | - public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false) |
|
1075 | - { |
|
1076 | - |
|
1077 | - if ($total_line_item->type() !== EEM_Line_Item::type_total) { |
|
1078 | - EE_Error::doing_it_wrong( |
|
1079 | - 'EEH_Line_Item::delete_items', |
|
1080 | - esc_html__( |
|
1081 | - 'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly', |
|
1082 | - 'event_espresso' |
|
1083 | - ), |
|
1084 | - '4.6.18' |
|
1085 | - ); |
|
1086 | - } |
|
1087 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1088 | - |
|
1089 | - // check if only a single line_item_id was passed |
|
1090 | - if (! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
1091 | - // place single line_item_id in an array to appear as multiple line_item_ids |
|
1092 | - $line_item_codes = array($line_item_codes); |
|
1093 | - } |
|
1094 | - $removals = 0; |
|
1095 | - // cycle thru line_item_ids |
|
1096 | - foreach ($line_item_codes as $line_item_id) { |
|
1097 | - $removals += $total_line_item->delete_child_line_item($line_item_id); |
|
1098 | - } |
|
1099 | - |
|
1100 | - if ($removals > 0) { |
|
1101 | - $total_line_item->recalculate_taxes_and_tax_total(); |
|
1102 | - return $removals; |
|
1103 | - } else { |
|
1104 | - return false; |
|
1105 | - } |
|
1106 | - } |
|
1107 | - |
|
1108 | - |
|
1109 | - /** |
|
1110 | - * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
1111 | - * tax and updates the total line item accordingly |
|
1112 | - * |
|
1113 | - * @param EE_Line_Item $total_line_item |
|
1114 | - * @param float $amount |
|
1115 | - * @param string $name |
|
1116 | - * @param string $description |
|
1117 | - * @param string $code |
|
1118 | - * @param boolean $add_to_existing_line_item |
|
1119 | - * if true, and a duplicate line item with the same code is found, |
|
1120 | - * $amount will be added onto it; otherwise will simply set the taxes to match $amount |
|
1121 | - * @return EE_Line_Item the new tax line item created |
|
1122 | - * @throws EE_Error |
|
1123 | - * @throws InvalidArgumentException |
|
1124 | - * @throws InvalidDataTypeException |
|
1125 | - * @throws InvalidInterfaceException |
|
1126 | - * @throws ReflectionException |
|
1127 | - */ |
|
1128 | - public static function set_total_tax_to( |
|
1129 | - EE_Line_Item $total_line_item, |
|
1130 | - $amount, |
|
1131 | - $name = null, |
|
1132 | - $description = null, |
|
1133 | - $code = null, |
|
1134 | - $add_to_existing_line_item = false |
|
1135 | - ) { |
|
1136 | - $tax_subtotal = self::get_taxes_subtotal($total_line_item); |
|
1137 | - $taxable_total = $total_line_item->taxable_total(); |
|
1138 | - |
|
1139 | - if ($add_to_existing_line_item) { |
|
1140 | - $new_tax = $tax_subtotal->get_child_line_item($code); |
|
1141 | - EEM_Line_Item::instance()->delete( |
|
1142 | - array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID())) |
|
1143 | - ); |
|
1144 | - } else { |
|
1145 | - $new_tax = null; |
|
1146 | - $tax_subtotal->delete_children_line_items(); |
|
1147 | - } |
|
1148 | - if ($new_tax) { |
|
1149 | - $new_tax->set_total($new_tax->total() + $amount); |
|
1150 | - $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0); |
|
1151 | - } else { |
|
1152 | - // no existing tax item. Create it |
|
1153 | - $new_tax = EE_Line_Item::new_instance(array( |
|
1154 | - 'TXN_ID' => $total_line_item->TXN_ID(), |
|
1155 | - 'LIN_name' => $name ? $name : esc_html__('Tax', 'event_espresso'), |
|
1156 | - 'LIN_desc' => $description ? $description : '', |
|
1157 | - 'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0, |
|
1158 | - 'LIN_total' => $amount, |
|
1159 | - 'LIN_parent' => $tax_subtotal->ID(), |
|
1160 | - 'LIN_type' => EEM_Line_Item::type_tax, |
|
1161 | - 'LIN_code' => $code, |
|
1162 | - )); |
|
1163 | - } |
|
1164 | - |
|
1165 | - $new_tax = apply_filters( |
|
1166 | - 'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal', |
|
1167 | - $new_tax, |
|
1168 | - $total_line_item |
|
1169 | - ); |
|
1170 | - $new_tax->save(); |
|
1171 | - $tax_subtotal->set_total($new_tax->total()); |
|
1172 | - $tax_subtotal->save(); |
|
1173 | - $total_line_item->recalculate_total_including_taxes(); |
|
1174 | - return $new_tax; |
|
1175 | - } |
|
1176 | - |
|
1177 | - |
|
1178 | - /** |
|
1179 | - * Makes all the line items which are children of $line_item taxable (or not). |
|
1180 | - * Does NOT save the line items |
|
1181 | - * |
|
1182 | - * @param EE_Line_Item $line_item |
|
1183 | - * @param boolean $taxable |
|
1184 | - * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
1185 | - * it will be whitelisted (ie, except from becoming taxable) |
|
1186 | - * @throws EE_Error |
|
1187 | - */ |
|
1188 | - public static function set_line_items_taxable( |
|
1189 | - EE_Line_Item $line_item, |
|
1190 | - $taxable = true, |
|
1191 | - $code_substring_for_whitelist = null |
|
1192 | - ) { |
|
1193 | - $whitelisted = false; |
|
1194 | - if ($code_substring_for_whitelist !== null) { |
|
1195 | - $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false; |
|
1196 | - } |
|
1197 | - if (! $whitelisted && $line_item->is_line_item()) { |
|
1198 | - $line_item->set_is_taxable($taxable); |
|
1199 | - } |
|
1200 | - foreach ($line_item->children() as $child_line_item) { |
|
1201 | - EEH_Line_Item::set_line_items_taxable( |
|
1202 | - $child_line_item, |
|
1203 | - $taxable, |
|
1204 | - $code_substring_for_whitelist |
|
1205 | - ); |
|
1206 | - } |
|
1207 | - } |
|
1208 | - |
|
1209 | - |
|
1210 | - /** |
|
1211 | - * Gets all descendants that are event subtotals |
|
1212 | - * |
|
1213 | - * @uses EEH_Line_Item::get_subtotals_of_object_type() |
|
1214 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1215 | - * @return EE_Line_Item[] |
|
1216 | - * @throws EE_Error |
|
1217 | - */ |
|
1218 | - public static function get_event_subtotals(EE_Line_Item $parent_line_item) |
|
1219 | - { |
|
1220 | - return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT); |
|
1221 | - } |
|
1222 | - |
|
1223 | - |
|
1224 | - /** |
|
1225 | - * Gets all descendants subtotals that match the supplied object type |
|
1226 | - * |
|
1227 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1228 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1229 | - * @param string $obj_type |
|
1230 | - * @return EE_Line_Item[] |
|
1231 | - * @throws EE_Error |
|
1232 | - */ |
|
1233 | - public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
1234 | - { |
|
1235 | - return self::_get_descendants_by_type_and_object_type( |
|
1236 | - $parent_line_item, |
|
1237 | - EEM_Line_Item::type_sub_total, |
|
1238 | - $obj_type |
|
1239 | - ); |
|
1240 | - } |
|
1241 | - |
|
1242 | - |
|
1243 | - /** |
|
1244 | - * Gets all descendants that are tickets |
|
1245 | - * |
|
1246 | - * @uses EEH_Line_Item::get_line_items_of_object_type() |
|
1247 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1248 | - * @return EE_Line_Item[] |
|
1249 | - * @throws EE_Error |
|
1250 | - */ |
|
1251 | - public static function get_ticket_line_items(EE_Line_Item $parent_line_item) |
|
1252 | - { |
|
1253 | - return self::get_line_items_of_object_type( |
|
1254 | - $parent_line_item, |
|
1255 | - EEM_Line_Item::OBJ_TYPE_TICKET |
|
1256 | - ); |
|
1257 | - } |
|
1258 | - |
|
1259 | - |
|
1260 | - /** |
|
1261 | - * Gets all descendants subtotals that match the supplied object type |
|
1262 | - * |
|
1263 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1264 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1265 | - * @param string $obj_type |
|
1266 | - * @return EE_Line_Item[] |
|
1267 | - * @throws EE_Error |
|
1268 | - */ |
|
1269 | - public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
1270 | - { |
|
1271 | - return self::_get_descendants_by_type_and_object_type( |
|
1272 | - $parent_line_item, |
|
1273 | - EEM_Line_Item::type_line_item, |
|
1274 | - $obj_type |
|
1275 | - ); |
|
1276 | - } |
|
1277 | - |
|
1278 | - |
|
1279 | - /** |
|
1280 | - * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax' |
|
1281 | - * |
|
1282 | - * @uses EEH_Line_Item::get_descendants_of_type() |
|
1283 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1284 | - * @return EE_Line_Item[] |
|
1285 | - * @throws EE_Error |
|
1286 | - */ |
|
1287 | - public static function get_tax_descendants(EE_Line_Item $parent_line_item) |
|
1288 | - { |
|
1289 | - return EEH_Line_Item::get_descendants_of_type( |
|
1290 | - $parent_line_item, |
|
1291 | - EEM_Line_Item::type_tax |
|
1292 | - ); |
|
1293 | - } |
|
1294 | - |
|
1295 | - |
|
1296 | - /** |
|
1297 | - * Gets all the real items purchased which are children of this item |
|
1298 | - * |
|
1299 | - * @uses EEH_Line_Item::get_descendants_of_type() |
|
1300 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1301 | - * @return EE_Line_Item[] |
|
1302 | - * @throws EE_Error |
|
1303 | - */ |
|
1304 | - public static function get_line_item_descendants(EE_Line_Item $parent_line_item) |
|
1305 | - { |
|
1306 | - return EEH_Line_Item::get_descendants_of_type( |
|
1307 | - $parent_line_item, |
|
1308 | - EEM_Line_Item::type_line_item |
|
1309 | - ); |
|
1310 | - } |
|
1311 | - |
|
1312 | - |
|
1313 | - /** |
|
1314 | - * Gets all descendants of supplied line item that match the supplied line item type |
|
1315 | - * |
|
1316 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1317 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1318 | - * @param string $line_item_type one of the EEM_Line_Item constants |
|
1319 | - * @return EE_Line_Item[] |
|
1320 | - * @throws EE_Error |
|
1321 | - */ |
|
1322 | - public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) |
|
1323 | - { |
|
1324 | - return self::_get_descendants_by_type_and_object_type( |
|
1325 | - $parent_line_item, |
|
1326 | - $line_item_type, |
|
1327 | - null |
|
1328 | - ); |
|
1329 | - } |
|
1330 | - |
|
1331 | - |
|
1332 | - /** |
|
1333 | - * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
1334 | - * as well |
|
1335 | - * |
|
1336 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1337 | - * @param string $line_item_type one of the EEM_Line_Item constants |
|
1338 | - * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when |
|
1339 | - * searching |
|
1340 | - * @return EE_Line_Item[] |
|
1341 | - * @throws EE_Error |
|
1342 | - */ |
|
1343 | - protected static function _get_descendants_by_type_and_object_type( |
|
1344 | - EE_Line_Item $parent_line_item, |
|
1345 | - $line_item_type, |
|
1346 | - $obj_type = null |
|
1347 | - ) { |
|
1348 | - $objects = array(); |
|
1349 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
1350 | - if ($child_line_item instanceof EE_Line_Item) { |
|
1351 | - if ($child_line_item->type() === $line_item_type |
|
1352 | - && ( |
|
1353 | - $child_line_item->OBJ_type() === $obj_type || $obj_type === null |
|
1354 | - ) |
|
1355 | - ) { |
|
1356 | - $objects[] = $child_line_item; |
|
1357 | - } else { |
|
1358 | - // go-through-all-its children looking for more matches |
|
1359 | - $objects = array_merge( |
|
1360 | - $objects, |
|
1361 | - self::_get_descendants_by_type_and_object_type( |
|
1362 | - $child_line_item, |
|
1363 | - $line_item_type, |
|
1364 | - $obj_type |
|
1365 | - ) |
|
1366 | - ); |
|
1367 | - } |
|
1368 | - } |
|
1369 | - } |
|
1370 | - return $objects; |
|
1371 | - } |
|
1372 | - |
|
1373 | - |
|
1374 | - /** |
|
1375 | - * Gets all descendants subtotals that match the supplied object type |
|
1376 | - * |
|
1377 | - * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1378 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1379 | - * @param string $OBJ_type object type (like Event) |
|
1380 | - * @param array $OBJ_IDs array of OBJ_IDs |
|
1381 | - * @return EE_Line_Item[] |
|
1382 | - * @throws EE_Error |
|
1383 | - */ |
|
1384 | - public static function get_line_items_by_object_type_and_IDs( |
|
1385 | - EE_Line_Item $parent_line_item, |
|
1386 | - $OBJ_type = '', |
|
1387 | - $OBJ_IDs = array() |
|
1388 | - ) { |
|
1389 | - return self::_get_descendants_by_object_type_and_object_ID( |
|
1390 | - $parent_line_item, |
|
1391 | - $OBJ_type, |
|
1392 | - $OBJ_IDs |
|
1393 | - ); |
|
1394 | - } |
|
1395 | - |
|
1396 | - |
|
1397 | - /** |
|
1398 | - * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
1399 | - * as well |
|
1400 | - * |
|
1401 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1402 | - * @param string $OBJ_type object type (like Event) |
|
1403 | - * @param array $OBJ_IDs array of OBJ_IDs |
|
1404 | - * @return EE_Line_Item[] |
|
1405 | - * @throws EE_Error |
|
1406 | - */ |
|
1407 | - protected static function _get_descendants_by_object_type_and_object_ID( |
|
1408 | - EE_Line_Item $parent_line_item, |
|
1409 | - $OBJ_type, |
|
1410 | - $OBJ_IDs |
|
1411 | - ) { |
|
1412 | - $objects = array(); |
|
1413 | - foreach ($parent_line_item->children() as $child_line_item) { |
|
1414 | - if ($child_line_item instanceof EE_Line_Item) { |
|
1415 | - if ($child_line_item->OBJ_type() === $OBJ_type |
|
1416 | - && is_array($OBJ_IDs) |
|
1417 | - && in_array($child_line_item->OBJ_ID(), $OBJ_IDs) |
|
1418 | - ) { |
|
1419 | - $objects[] = $child_line_item; |
|
1420 | - } else { |
|
1421 | - // go-through-all-its children looking for more matches |
|
1422 | - $objects = array_merge( |
|
1423 | - $objects, |
|
1424 | - self::_get_descendants_by_object_type_and_object_ID( |
|
1425 | - $child_line_item, |
|
1426 | - $OBJ_type, |
|
1427 | - $OBJ_IDs |
|
1428 | - ) |
|
1429 | - ); |
|
1430 | - } |
|
1431 | - } |
|
1432 | - } |
|
1433 | - return $objects; |
|
1434 | - } |
|
1435 | - |
|
1436 | - |
|
1437 | - /** |
|
1438 | - * Uses a breadth-first-search in order to find the nearest descendant of |
|
1439 | - * the specified type and returns it, else NULL |
|
1440 | - * |
|
1441 | - * @uses EEH_Line_Item::_get_nearest_descendant() |
|
1442 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1443 | - * @param string $type like one of the EEM_Line_Item::type_* |
|
1444 | - * @return EE_Line_Item |
|
1445 | - * @throws EE_Error |
|
1446 | - * @throws InvalidArgumentException |
|
1447 | - * @throws InvalidDataTypeException |
|
1448 | - * @throws InvalidInterfaceException |
|
1449 | - * @throws ReflectionException |
|
1450 | - */ |
|
1451 | - public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) |
|
1452 | - { |
|
1453 | - return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type); |
|
1454 | - } |
|
1455 | - |
|
1456 | - |
|
1457 | - /** |
|
1458 | - * Uses a breadth-first-search in order to find the nearest descendant |
|
1459 | - * having the specified LIN_code and returns it, else NULL |
|
1460 | - * |
|
1461 | - * @uses EEH_Line_Item::_get_nearest_descendant() |
|
1462 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1463 | - * @param string $code any value used for LIN_code |
|
1464 | - * @return EE_Line_Item |
|
1465 | - * @throws EE_Error |
|
1466 | - * @throws InvalidArgumentException |
|
1467 | - * @throws InvalidDataTypeException |
|
1468 | - * @throws InvalidInterfaceException |
|
1469 | - * @throws ReflectionException |
|
1470 | - */ |
|
1471 | - public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) |
|
1472 | - { |
|
1473 | - return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code); |
|
1474 | - } |
|
1475 | - |
|
1476 | - |
|
1477 | - /** |
|
1478 | - * Uses a breadth-first-search in order to find the nearest descendant |
|
1479 | - * having the specified LIN_code and returns it, else NULL |
|
1480 | - * |
|
1481 | - * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1482 | - * @param string $search_field name of EE_Line_Item property |
|
1483 | - * @param string $value any value stored in $search_field |
|
1484 | - * @return EE_Line_Item |
|
1485 | - * @throws EE_Error |
|
1486 | - * @throws InvalidArgumentException |
|
1487 | - * @throws InvalidDataTypeException |
|
1488 | - * @throws InvalidInterfaceException |
|
1489 | - * @throws ReflectionException |
|
1490 | - */ |
|
1491 | - protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) |
|
1492 | - { |
|
1493 | - foreach ($parent_line_item->children() as $child) { |
|
1494 | - if ($child->get($search_field) == $value) { |
|
1495 | - return $child; |
|
1496 | - } |
|
1497 | - } |
|
1498 | - foreach ($parent_line_item->children() as $child) { |
|
1499 | - $descendant_found = self::_get_nearest_descendant( |
|
1500 | - $child, |
|
1501 | - $search_field, |
|
1502 | - $value |
|
1503 | - ); |
|
1504 | - if ($descendant_found) { |
|
1505 | - return $descendant_found; |
|
1506 | - } |
|
1507 | - } |
|
1508 | - return null; |
|
1509 | - } |
|
1510 | - |
|
1511 | - |
|
1512 | - /** |
|
1513 | - * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction, |
|
1514 | - * else recursively walks up the line item tree until a parent of type total is found, |
|
1515 | - * |
|
1516 | - * @param EE_Line_Item $line_item |
|
1517 | - * @return EE_Line_Item |
|
1518 | - * @throws EE_Error |
|
1519 | - */ |
|
1520 | - public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) |
|
1521 | - { |
|
1522 | - if ($line_item->TXN_ID()) { |
|
1523 | - $total_line_item = $line_item->transaction()->total_line_item(false); |
|
1524 | - if ($total_line_item instanceof EE_Line_Item) { |
|
1525 | - return $total_line_item; |
|
1526 | - } |
|
1527 | - } else { |
|
1528 | - $line_item_parent = $line_item->parent(); |
|
1529 | - if ($line_item_parent instanceof EE_Line_Item) { |
|
1530 | - if ($line_item_parent->is_total()) { |
|
1531 | - return $line_item_parent; |
|
1532 | - } |
|
1533 | - return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent); |
|
1534 | - } |
|
1535 | - } |
|
1536 | - throw new EE_Error( |
|
1537 | - sprintf( |
|
1538 | - esc_html__( |
|
1539 | - 'A valid grand total for line item %1$d was not found.', |
|
1540 | - 'event_espresso' |
|
1541 | - ), |
|
1542 | - $line_item->ID() |
|
1543 | - ) |
|
1544 | - ); |
|
1545 | - } |
|
1546 | - |
|
1547 | - |
|
1548 | - /** |
|
1549 | - * Prints out a representation of the line item tree |
|
1550 | - * |
|
1551 | - * @param EE_Line_Item $line_item |
|
1552 | - * @param int $indentation |
|
1553 | - * @return void |
|
1554 | - * @throws EE_Error |
|
1555 | - */ |
|
1556 | - public static function visualize(EE_Line_Item $line_item, $indentation = 0) |
|
1557 | - { |
|
1558 | - echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
1559 | - if (! $indentation) { |
|
1560 | - echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
1561 | - } |
|
1562 | - for ($i = 0; $i < $indentation; $i++) { |
|
1563 | - echo '. '; |
|
1564 | - } |
|
1565 | - $breakdown = ''; |
|
1566 | - if ($line_item->is_line_item()) { |
|
1567 | - if ($line_item->is_percent()) { |
|
1568 | - $breakdown = "{$line_item->percent()}%"; |
|
1569 | - } else { |
|
1570 | - $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
1571 | - } |
|
1572 | - } |
|
1573 | - echo $line_item->name(); |
|
1574 | - echo " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : "; |
|
1575 | - echo '$' . (string) $line_item->total(); |
|
1576 | - if ($breakdown) { |
|
1577 | - echo " ( {$breakdown} )"; |
|
1578 | - } |
|
1579 | - if ($line_item->is_taxable()) { |
|
1580 | - echo ' * taxable'; |
|
1581 | - } |
|
1582 | - if ($line_item->children()) { |
|
1583 | - foreach ($line_item->children() as $child) { |
|
1584 | - self::visualize($child, $indentation + 1); |
|
1585 | - } |
|
1586 | - } |
|
1587 | - } |
|
1588 | - |
|
1589 | - |
|
1590 | - /** |
|
1591 | - * Calculates the registration's final price, taking into account that they |
|
1592 | - * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes, |
|
1593 | - * and receive a portion of any transaction-wide discounts. |
|
1594 | - * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount |
|
1595 | - * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get |
|
1596 | - * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50 |
|
1597 | - * and brent's final price should be $5.50. |
|
1598 | - * In order to do this, we basically need to traverse the line item tree calculating |
|
1599 | - * the running totals (just as if we were recalculating the total), but when we identify |
|
1600 | - * regular line items, we need to keep track of their share of the grand total. |
|
1601 | - * Also, we need to keep track of the TAXABLE total for each ticket purchase, so |
|
1602 | - * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total" |
|
1603 | - * when there are non-taxable items; otherwise they would be the same) |
|
1604 | - * |
|
1605 | - * @param EE_Line_Item $line_item |
|
1606 | - * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that |
|
1607 | - * can be included in price calculations at this moment |
|
1608 | - * @return array keys are line items for tickets IDs and values are their share of the running total, |
|
1609 | - * plus the key 'total', and 'taxable' which also has keys of all |
|
1610 | - * the ticket IDs. |
|
1611 | - * Eg array( |
|
1612 | - * 12 => 4.3 |
|
1613 | - * 23 => 8.0 |
|
1614 | - * 'total' => 16.6, |
|
1615 | - * 'taxable' => array( |
|
1616 | - * 12 => 10, |
|
1617 | - * 23 => 4 |
|
1618 | - * ). |
|
1619 | - * So to find which registrations have which final price, we need |
|
1620 | - * to find which line item is theirs, which can be done with |
|
1621 | - * `EEM_Line_Item::instance()->get_line_item_for_registration( |
|
1622 | - * $registration );` |
|
1623 | - * @throws EE_Error |
|
1624 | - * @throws InvalidArgumentException |
|
1625 | - * @throws InvalidDataTypeException |
|
1626 | - * @throws InvalidInterfaceException |
|
1627 | - * @throws ReflectionException |
|
1628 | - */ |
|
1629 | - public static function calculate_reg_final_prices_per_line_item( |
|
1630 | - EE_Line_Item $line_item, |
|
1631 | - $billable_ticket_quantities = array() |
|
1632 | - ) { |
|
1633 | - $running_totals = [ |
|
1634 | - 'total' => 0, |
|
1635 | - 'taxable' => ['total' => 0] |
|
1636 | - ]; |
|
1637 | - foreach ($line_item->children() as $child_line_item) { |
|
1638 | - switch ($child_line_item->type()) { |
|
1639 | - case EEM_Line_Item::type_sub_total: |
|
1640 | - $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
1641 | - $child_line_item, |
|
1642 | - $billable_ticket_quantities |
|
1643 | - ); |
|
1644 | - // combine arrays but preserve numeric keys |
|
1645 | - $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals); |
|
1646 | - $running_totals['total'] += $running_totals_from_subtotal['total']; |
|
1647 | - $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total']; |
|
1648 | - break; |
|
1649 | - |
|
1650 | - case EEM_Line_Item::type_tax_sub_total: |
|
1651 | - // find how much the taxes percentage is |
|
1652 | - if ($child_line_item->percent() !== 0) { |
|
1653 | - $tax_percent_decimal = $child_line_item->percent() / 100; |
|
1654 | - } else { |
|
1655 | - $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100; |
|
1656 | - } |
|
1657 | - // and apply to all the taxable totals, and add to the pretax totals |
|
1658 | - foreach ($running_totals as $line_item_id => $this_running_total) { |
|
1659 | - // "total" and "taxable" array key is an exception |
|
1660 | - if ($line_item_id === 'taxable') { |
|
1661 | - continue; |
|
1662 | - } |
|
1663 | - $taxable_total = $running_totals['taxable'][ $line_item_id ]; |
|
1664 | - $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal); |
|
1665 | - } |
|
1666 | - break; |
|
1667 | - |
|
1668 | - case EEM_Line_Item::type_line_item: |
|
1669 | - // ticket line items or ???? |
|
1670 | - if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
1671 | - // kk it's a ticket |
|
1672 | - if (isset($running_totals[ $child_line_item->ID() ])) { |
|
1673 | - // huh? that shouldn't happen. |
|
1674 | - $running_totals['total'] += $child_line_item->total(); |
|
1675 | - } else { |
|
1676 | - // its not in our running totals yet. great. |
|
1677 | - if ($child_line_item->is_taxable()) { |
|
1678 | - $taxable_amount = $child_line_item->unit_price(); |
|
1679 | - } else { |
|
1680 | - $taxable_amount = 0; |
|
1681 | - } |
|
1682 | - // are we only calculating totals for some tickets? |
|
1683 | - if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) { |
|
1684 | - $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ]; |
|
1685 | - $running_totals[ $child_line_item->ID() ] = $quantity |
|
1686 | - ? $child_line_item->unit_price() |
|
1687 | - : 0; |
|
1688 | - $running_totals['taxable'][ $child_line_item->ID() ] = $quantity |
|
1689 | - ? $taxable_amount |
|
1690 | - : 0; |
|
1691 | - } else { |
|
1692 | - $quantity = $child_line_item->quantity(); |
|
1693 | - $running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price(); |
|
1694 | - $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount; |
|
1695 | - } |
|
1696 | - $running_totals['taxable']['total'] += $taxable_amount * $quantity; |
|
1697 | - $running_totals['total'] += $child_line_item->unit_price() * $quantity; |
|
1698 | - } |
|
1699 | - } else { |
|
1700 | - // it's some other type of item added to the cart |
|
1701 | - // it should affect the running totals |
|
1702 | - // basically we want to convert it into a PERCENT modifier. Because |
|
1703 | - // more clearly affect all registration's final price equally |
|
1704 | - $line_items_percent_of_running_total = $running_totals['total'] > 0 |
|
1705 | - ? ($child_line_item->total() / $running_totals['total']) + 1 |
|
1706 | - : 1; |
|
1707 | - foreach ($running_totals as $line_item_id => $this_running_total) { |
|
1708 | - // the "taxable" array key is an exception |
|
1709 | - if ($line_item_id === 'taxable') { |
|
1710 | - continue; |
|
1711 | - } |
|
1712 | - // update the running totals |
|
1713 | - // yes this actually even works for the running grand total! |
|
1714 | - $running_totals[ $line_item_id ] = |
|
1715 | - $line_items_percent_of_running_total * $this_running_total; |
|
1716 | - |
|
1717 | - if ($child_line_item->is_taxable()) { |
|
1718 | - $running_totals['taxable'][ $line_item_id ] = |
|
1719 | - $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ]; |
|
1720 | - } |
|
1721 | - } |
|
1722 | - } |
|
1723 | - break; |
|
1724 | - } |
|
1725 | - } |
|
1726 | - return $running_totals; |
|
1727 | - } |
|
1728 | - |
|
1729 | - |
|
1730 | - /** |
|
1731 | - * @param EE_Line_Item $total_line_item |
|
1732 | - * @param EE_Line_Item $ticket_line_item |
|
1733 | - * @return float | null |
|
1734 | - * @throws EE_Error |
|
1735 | - * @throws InvalidArgumentException |
|
1736 | - * @throws InvalidDataTypeException |
|
1737 | - * @throws InvalidInterfaceException |
|
1738 | - * @throws OutOfRangeException |
|
1739 | - * @throws ReflectionException |
|
1740 | - */ |
|
1741 | - public static function calculate_final_price_for_ticket_line_item( |
|
1742 | - EE_Line_Item $total_line_item, |
|
1743 | - EE_Line_Item $ticket_line_item |
|
1744 | - ) { |
|
1745 | - static $final_prices_per_ticket_line_item = array(); |
|
1746 | - if (empty($final_prices_per_ticket_line_item)) { |
|
1747 | - $final_prices_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
1748 | - $total_line_item |
|
1749 | - ); |
|
1750 | - } |
|
1751 | - // ok now find this new registration's final price |
|
1752 | - if (isset($final_prices_per_ticket_line_item[ $ticket_line_item->ID() ])) { |
|
1753 | - return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ]; |
|
1754 | - } |
|
1755 | - $message = sprintf( |
|
1756 | - esc_html__( |
|
1757 | - 'The final price for the ticket line item (ID:%1$d) could not be calculated.', |
|
1758 | - 'event_espresso' |
|
1759 | - ), |
|
1760 | - $ticket_line_item->ID() |
|
1761 | - ); |
|
1762 | - if (WP_DEBUG) { |
|
1763 | - $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true); |
|
1764 | - throw new OutOfRangeException($message); |
|
1765 | - } |
|
1766 | - EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message); |
|
1767 | - return null; |
|
1768 | - } |
|
1769 | - |
|
1770 | - |
|
1771 | - /** |
|
1772 | - * Creates a duplicate of the line item tree, except only includes billable items |
|
1773 | - * and the portion of line items attributed to billable things |
|
1774 | - * |
|
1775 | - * @param EE_Line_Item $line_item |
|
1776 | - * @param EE_Registration[] $registrations |
|
1777 | - * @return EE_Line_Item |
|
1778 | - * @throws EE_Error |
|
1779 | - * @throws InvalidArgumentException |
|
1780 | - * @throws InvalidDataTypeException |
|
1781 | - * @throws InvalidInterfaceException |
|
1782 | - * @throws ReflectionException |
|
1783 | - */ |
|
1784 | - public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) |
|
1785 | - { |
|
1786 | - $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations); |
|
1787 | - foreach ($line_item->children() as $child_li) { |
|
1788 | - $copy_li->add_child_line_item( |
|
1789 | - EEH_Line_Item::billable_line_item_tree($child_li, $registrations) |
|
1790 | - ); |
|
1791 | - } |
|
1792 | - // if this is the grand total line item, make sure the totals all add up |
|
1793 | - // (we could have duplicated this logic AS we copied the line items, but |
|
1794 | - // it seems DRYer this way) |
|
1795 | - if ($copy_li->type() === EEM_Line_Item::type_total) { |
|
1796 | - $copy_li->recalculate_total_including_taxes(); |
|
1797 | - } |
|
1798 | - return $copy_li; |
|
1799 | - } |
|
1800 | - |
|
1801 | - |
|
1802 | - /** |
|
1803 | - * Creates a new, unsaved line item from $line_item that factors in the |
|
1804 | - * number of billable registrations on $registrations. |
|
1805 | - * |
|
1806 | - * @param EE_Line_Item $line_item |
|
1807 | - * @param EE_Registration[] $registrations |
|
1808 | - * @return EE_Line_Item |
|
1809 | - * @throws EE_Error |
|
1810 | - * @throws InvalidArgumentException |
|
1811 | - * @throws InvalidDataTypeException |
|
1812 | - * @throws InvalidInterfaceException |
|
1813 | - * @throws ReflectionException |
|
1814 | - */ |
|
1815 | - public static function billable_line_item(EE_Line_Item $line_item, $registrations) |
|
1816 | - { |
|
1817 | - $new_li_fields = $line_item->model_field_array(); |
|
1818 | - if ($line_item->type() === EEM_Line_Item::type_line_item && |
|
1819 | - $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1820 | - ) { |
|
1821 | - $count = 0; |
|
1822 | - foreach ($registrations as $registration) { |
|
1823 | - if ($line_item->OBJ_ID() === $registration->ticket_ID() && |
|
1824 | - in_array( |
|
1825 | - $registration->status_ID(), |
|
1826 | - EEM_Registration::reg_statuses_that_allow_payment(), |
|
1827 | - true |
|
1828 | - ) |
|
1829 | - ) { |
|
1830 | - $count++; |
|
1831 | - } |
|
1832 | - } |
|
1833 | - $new_li_fields['LIN_quantity'] = $count; |
|
1834 | - } |
|
1835 | - // don't set the total. We'll leave that up to the code that calculates it |
|
1836 | - unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']); |
|
1837 | - return EE_Line_Item::new_instance($new_li_fields); |
|
1838 | - } |
|
1839 | - |
|
1840 | - |
|
1841 | - /** |
|
1842 | - * Returns a modified line item tree where all the subtotals which have a total of 0 |
|
1843 | - * are removed, and line items with a quantity of 0 |
|
1844 | - * |
|
1845 | - * @param EE_Line_Item $line_item |null |
|
1846 | - * @return EE_Line_Item|null |
|
1847 | - * @throws EE_Error |
|
1848 | - * @throws InvalidArgumentException |
|
1849 | - * @throws InvalidDataTypeException |
|
1850 | - * @throws InvalidInterfaceException |
|
1851 | - * @throws ReflectionException |
|
1852 | - */ |
|
1853 | - public static function non_empty_line_items(EE_Line_Item $line_item) |
|
1854 | - { |
|
1855 | - $copied_li = EEH_Line_Item::non_empty_line_item($line_item); |
|
1856 | - if ($copied_li === null) { |
|
1857 | - return null; |
|
1858 | - } |
|
1859 | - // if this is an event subtotal, we want to only include it if it |
|
1860 | - // has a non-zero total and at least one ticket line item child |
|
1861 | - $ticket_children = 0; |
|
1862 | - foreach ($line_item->children() as $child_li) { |
|
1863 | - $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li); |
|
1864 | - if ($child_li_copy !== null) { |
|
1865 | - $copied_li->add_child_line_item($child_li_copy); |
|
1866 | - if ($child_li_copy->type() === EEM_Line_Item::type_line_item && |
|
1867 | - $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1868 | - ) { |
|
1869 | - $ticket_children++; |
|
1870 | - } |
|
1871 | - } |
|
1872 | - } |
|
1873 | - // if this is an event subtotal with NO ticket children |
|
1874 | - // we basically want to ignore it |
|
1875 | - if ($ticket_children === 0 |
|
1876 | - && $line_item->type() === EEM_Line_Item::type_sub_total |
|
1877 | - && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
1878 | - && $line_item->total() === 0 |
|
1879 | - ) { |
|
1880 | - return null; |
|
1881 | - } |
|
1882 | - return $copied_li; |
|
1883 | - } |
|
1884 | - |
|
1885 | - |
|
1886 | - /** |
|
1887 | - * Creates a new, unsaved line item, but if it's a ticket line item |
|
1888 | - * with a total of 0, or a subtotal of 0, returns null instead |
|
1889 | - * |
|
1890 | - * @param EE_Line_Item $line_item |
|
1891 | - * @return EE_Line_Item |
|
1892 | - * @throws EE_Error |
|
1893 | - * @throws InvalidArgumentException |
|
1894 | - * @throws InvalidDataTypeException |
|
1895 | - * @throws InvalidInterfaceException |
|
1896 | - * @throws ReflectionException |
|
1897 | - */ |
|
1898 | - public static function non_empty_line_item(EE_Line_Item $line_item) |
|
1899 | - { |
|
1900 | - if ($line_item->type() === EEM_Line_Item::type_line_item |
|
1901 | - && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1902 | - && $line_item->quantity() === 0 |
|
1903 | - ) { |
|
1904 | - return null; |
|
1905 | - } |
|
1906 | - $new_li_fields = $line_item->model_field_array(); |
|
1907 | - // don't set the total. We'll leave that up to the code that calculates it |
|
1908 | - unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']); |
|
1909 | - return EE_Line_Item::new_instance($new_li_fields); |
|
1910 | - } |
|
1911 | - |
|
1912 | - |
|
1913 | - /** |
|
1914 | - * Cycles through all of the ticket line items for the supplied total line item |
|
1915 | - * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket |
|
1916 | - * |
|
1917 | - * @param EE_Line_Item $total_line_item |
|
1918 | - * @since 4.9.79.p |
|
1919 | - * @throws EE_Error |
|
1920 | - * @throws InvalidArgumentException |
|
1921 | - * @throws InvalidDataTypeException |
|
1922 | - * @throws InvalidInterfaceException |
|
1923 | - * @throws ReflectionException |
|
1924 | - */ |
|
1925 | - public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item) |
|
1926 | - { |
|
1927 | - $ticket_line_items = self::get_ticket_line_items($total_line_item); |
|
1928 | - foreach ($ticket_line_items as $ticket_line_item) { |
|
1929 | - if ($ticket_line_item instanceof EE_Line_Item |
|
1930 | - && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1931 | - ) { |
|
1932 | - $ticket = $ticket_line_item->ticket(); |
|
1933 | - if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) { |
|
1934 | - $ticket_line_item->set_is_taxable($ticket->taxable()); |
|
1935 | - $ticket_line_item->save(); |
|
1936 | - } |
|
1937 | - } |
|
1938 | - } |
|
1939 | - } |
|
1940 | - |
|
1941 | - |
|
1942 | - |
|
1943 | - /**************************************** @DEPRECATED METHODS *************************************** */ |
|
1944 | - /** |
|
1945 | - * @deprecated |
|
1946 | - * @param EE_Line_Item $total_line_item |
|
1947 | - * @return EE_Line_Item |
|
1948 | - * @throws EE_Error |
|
1949 | - * @throws InvalidArgumentException |
|
1950 | - * @throws InvalidDataTypeException |
|
1951 | - * @throws InvalidInterfaceException |
|
1952 | - * @throws ReflectionException |
|
1953 | - */ |
|
1954 | - public static function get_items_subtotal(EE_Line_Item $total_line_item) |
|
1955 | - { |
|
1956 | - EE_Error::doing_it_wrong( |
|
1957 | - 'EEH_Line_Item::get_items_subtotal()', |
|
1958 | - sprintf( |
|
1959 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
1960 | - 'EEH_Line_Item::get_pre_tax_subtotal()' |
|
1961 | - ), |
|
1962 | - '4.6.0' |
|
1963 | - ); |
|
1964 | - return self::get_pre_tax_subtotal($total_line_item); |
|
1965 | - } |
|
1966 | - |
|
1967 | - |
|
1968 | - /** |
|
1969 | - * @deprecated |
|
1970 | - * @param EE_Transaction $transaction |
|
1971 | - * @return EE_Line_Item |
|
1972 | - * @throws EE_Error |
|
1973 | - * @throws InvalidArgumentException |
|
1974 | - * @throws InvalidDataTypeException |
|
1975 | - * @throws InvalidInterfaceException |
|
1976 | - * @throws ReflectionException |
|
1977 | - */ |
|
1978 | - public static function create_default_total_line_item($transaction = null) |
|
1979 | - { |
|
1980 | - EE_Error::doing_it_wrong( |
|
1981 | - 'EEH_Line_Item::create_default_total_line_item()', |
|
1982 | - sprintf( |
|
1983 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
1984 | - 'EEH_Line_Item::create_total_line_item()' |
|
1985 | - ), |
|
1986 | - '4.6.0' |
|
1987 | - ); |
|
1988 | - return self::create_total_line_item($transaction); |
|
1989 | - } |
|
1990 | - |
|
1991 | - |
|
1992 | - /** |
|
1993 | - * @deprecated |
|
1994 | - * @param EE_Line_Item $total_line_item |
|
1995 | - * @param EE_Transaction $transaction |
|
1996 | - * @return EE_Line_Item |
|
1997 | - * @throws EE_Error |
|
1998 | - * @throws InvalidArgumentException |
|
1999 | - * @throws InvalidDataTypeException |
|
2000 | - * @throws InvalidInterfaceException |
|
2001 | - * @throws ReflectionException |
|
2002 | - */ |
|
2003 | - public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2004 | - { |
|
2005 | - EE_Error::doing_it_wrong( |
|
2006 | - 'EEH_Line_Item::create_default_tickets_subtotal()', |
|
2007 | - sprintf( |
|
2008 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2009 | - 'EEH_Line_Item::create_pre_tax_subtotal()' |
|
2010 | - ), |
|
2011 | - '4.6.0' |
|
2012 | - ); |
|
2013 | - return self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
2014 | - } |
|
2015 | - |
|
2016 | - |
|
2017 | - /** |
|
2018 | - * @deprecated |
|
2019 | - * @param EE_Line_Item $total_line_item |
|
2020 | - * @param EE_Transaction $transaction |
|
2021 | - * @return EE_Line_Item |
|
2022 | - * @throws EE_Error |
|
2023 | - * @throws InvalidArgumentException |
|
2024 | - * @throws InvalidDataTypeException |
|
2025 | - * @throws InvalidInterfaceException |
|
2026 | - * @throws ReflectionException |
|
2027 | - */ |
|
2028 | - public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2029 | - { |
|
2030 | - EE_Error::doing_it_wrong( |
|
2031 | - 'EEH_Line_Item::create_default_taxes_subtotal()', |
|
2032 | - sprintf( |
|
2033 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2034 | - 'EEH_Line_Item::create_taxes_subtotal()' |
|
2035 | - ), |
|
2036 | - '4.6.0' |
|
2037 | - ); |
|
2038 | - return self::create_taxes_subtotal($total_line_item, $transaction); |
|
2039 | - } |
|
2040 | - |
|
2041 | - |
|
2042 | - /** |
|
2043 | - * @deprecated |
|
2044 | - * @param EE_Line_Item $total_line_item |
|
2045 | - * @param EE_Transaction $transaction |
|
2046 | - * @return EE_Line_Item |
|
2047 | - * @throws EE_Error |
|
2048 | - * @throws InvalidArgumentException |
|
2049 | - * @throws InvalidDataTypeException |
|
2050 | - * @throws InvalidInterfaceException |
|
2051 | - * @throws ReflectionException |
|
2052 | - */ |
|
2053 | - public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2054 | - { |
|
2055 | - EE_Error::doing_it_wrong( |
|
2056 | - 'EEH_Line_Item::create_default_event_subtotal()', |
|
2057 | - sprintf( |
|
2058 | - esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2059 | - 'EEH_Line_Item::create_event_subtotal()' |
|
2060 | - ), |
|
2061 | - '4.6.0' |
|
2062 | - ); |
|
2063 | - return self::create_event_subtotal($total_line_item, $transaction); |
|
2064 | - } |
|
24 | + /** |
|
25 | + * Adds a simple item (unrelated to any other model object) to the provided PARENT line item. |
|
26 | + * Does NOT automatically re-calculate the line item totals or update the related transaction. |
|
27 | + * You should call recalculate_total_including_taxes() on the grant total line item after this |
|
28 | + * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
29 | + * to keep the registration final prices in-sync with the transaction's total. |
|
30 | + * |
|
31 | + * @param EE_Line_Item $parent_line_item |
|
32 | + * @param string $name |
|
33 | + * @param float $unit_price |
|
34 | + * @param string $description |
|
35 | + * @param int $quantity |
|
36 | + * @param boolean $taxable |
|
37 | + * @param boolean $code if set to a value, ensures there is only one line item with that code |
|
38 | + * @return boolean success |
|
39 | + * @throws EE_Error |
|
40 | + * @throws InvalidArgumentException |
|
41 | + * @throws InvalidDataTypeException |
|
42 | + * @throws InvalidInterfaceException |
|
43 | + * @throws ReflectionException |
|
44 | + */ |
|
45 | + public static function add_unrelated_item( |
|
46 | + EE_Line_Item $parent_line_item, |
|
47 | + $name, |
|
48 | + $unit_price, |
|
49 | + $description = '', |
|
50 | + $quantity = 1, |
|
51 | + $taxable = false, |
|
52 | + $code = null |
|
53 | + ) { |
|
54 | + $items_subtotal = self::get_pre_tax_subtotal($parent_line_item); |
|
55 | + $line_item = EE_Line_Item::new_instance(array( |
|
56 | + 'LIN_name' => $name, |
|
57 | + 'LIN_desc' => $description, |
|
58 | + 'LIN_unit_price' => $unit_price, |
|
59 | + 'LIN_quantity' => $quantity, |
|
60 | + 'LIN_percent' => null, |
|
61 | + 'LIN_is_taxable' => $taxable, |
|
62 | + 'LIN_order' => $items_subtotal instanceof EE_Line_Item ? count($items_subtotal->children()) : 0, |
|
63 | + 'LIN_total' => (float) $unit_price * (int) $quantity, |
|
64 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
65 | + 'LIN_code' => $code, |
|
66 | + )); |
|
67 | + $line_item = apply_filters( |
|
68 | + 'FHEE__EEH_Line_Item__add_unrelated_item__line_item', |
|
69 | + $line_item, |
|
70 | + $parent_line_item |
|
71 | + ); |
|
72 | + return self::add_item($parent_line_item, $line_item); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Adds a simple item ( unrelated to any other model object) to the total line item, |
|
78 | + * in the correct spot in the line item tree. Does not automatically |
|
79 | + * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's |
|
80 | + * registrations' final prices (which should probably change because of this). |
|
81 | + * You should call recalculate_total_including_taxes() on the grand total line item, then |
|
82 | + * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices() |
|
83 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
84 | + * |
|
85 | + * @param EE_Line_Item $parent_line_item |
|
86 | + * @param string $name |
|
87 | + * @param float $percentage_amount |
|
88 | + * @param string $description |
|
89 | + * @param boolean $taxable |
|
90 | + * @return boolean success |
|
91 | + * @throws EE_Error |
|
92 | + */ |
|
93 | + public static function add_percentage_based_item( |
|
94 | + EE_Line_Item $parent_line_item, |
|
95 | + $name, |
|
96 | + $percentage_amount, |
|
97 | + $description = '', |
|
98 | + $taxable = false |
|
99 | + ) { |
|
100 | + $line_item = EE_Line_Item::new_instance(array( |
|
101 | + 'LIN_name' => $name, |
|
102 | + 'LIN_desc' => $description, |
|
103 | + 'LIN_unit_price' => 0, |
|
104 | + 'LIN_percent' => $percentage_amount, |
|
105 | + 'LIN_quantity' => 1, |
|
106 | + 'LIN_is_taxable' => $taxable, |
|
107 | + 'LIN_total' => (float) ($percentage_amount * ($parent_line_item->total() / 100)), |
|
108 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
109 | + 'LIN_parent' => $parent_line_item->ID(), |
|
110 | + )); |
|
111 | + $line_item = apply_filters( |
|
112 | + 'FHEE__EEH_Line_Item__add_percentage_based_item__line_item', |
|
113 | + $line_item |
|
114 | + ); |
|
115 | + return $parent_line_item->add_child_line_item($line_item, false); |
|
116 | + } |
|
117 | + |
|
118 | + |
|
119 | + /** |
|
120 | + * Returns the new line item created by adding a purchase of the ticket |
|
121 | + * ensures that ticket line item is saved, and that cart total has been recalculated. |
|
122 | + * If this ticket has already been purchased, just increments its count. |
|
123 | + * Automatically re-calculates the line item totals and updates the related transaction. But |
|
124 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
125 | + * should probably change because of this). |
|
126 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
127 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
128 | + * |
|
129 | + * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total |
|
130 | + * @param EE_Ticket $ticket |
|
131 | + * @param int $qty |
|
132 | + * @return EE_Line_Item |
|
133 | + * @throws EE_Error |
|
134 | + * @throws InvalidArgumentException |
|
135 | + * @throws InvalidDataTypeException |
|
136 | + * @throws InvalidInterfaceException |
|
137 | + * @throws ReflectionException |
|
138 | + */ |
|
139 | + public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
140 | + { |
|
141 | + if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) { |
|
142 | + throw new EE_Error( |
|
143 | + sprintf( |
|
144 | + esc_html__( |
|
145 | + 'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.', |
|
146 | + 'event_espresso' |
|
147 | + ), |
|
148 | + $ticket->ID(), |
|
149 | + $total_line_item->ID() |
|
150 | + ) |
|
151 | + ); |
|
152 | + } |
|
153 | + // either increment the qty for an existing ticket |
|
154 | + $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty); |
|
155 | + // or add a new one |
|
156 | + if (! $line_item instanceof EE_Line_Item) { |
|
157 | + $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty); |
|
158 | + } |
|
159 | + $total_line_item->recalculate_total_including_taxes(); |
|
160 | + return $line_item; |
|
161 | + } |
|
162 | + |
|
163 | + |
|
164 | + /** |
|
165 | + * Returns the new line item created by adding a purchase of the ticket |
|
166 | + * |
|
167 | + * @param EE_Line_Item $total_line_item |
|
168 | + * @param EE_Ticket $ticket |
|
169 | + * @param int $qty |
|
170 | + * @return EE_Line_Item |
|
171 | + * @throws EE_Error |
|
172 | + * @throws InvalidArgumentException |
|
173 | + * @throws InvalidDataTypeException |
|
174 | + * @throws InvalidInterfaceException |
|
175 | + * @throws ReflectionException |
|
176 | + */ |
|
177 | + public static function increment_ticket_qty_if_already_in_cart( |
|
178 | + EE_Line_Item $total_line_item, |
|
179 | + EE_Ticket $ticket, |
|
180 | + $qty = 1 |
|
181 | + ) { |
|
182 | + $line_item = null; |
|
183 | + if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) { |
|
184 | + $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item); |
|
185 | + foreach ((array) $ticket_line_items as $ticket_line_item) { |
|
186 | + if ($ticket_line_item instanceof EE_Line_Item |
|
187 | + && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID() |
|
188 | + ) { |
|
189 | + $line_item = $ticket_line_item; |
|
190 | + break; |
|
191 | + } |
|
192 | + } |
|
193 | + } |
|
194 | + if ($line_item instanceof EE_Line_Item) { |
|
195 | + EEH_Line_Item::increment_quantity($line_item, $qty); |
|
196 | + return $line_item; |
|
197 | + } |
|
198 | + return null; |
|
199 | + } |
|
200 | + |
|
201 | + |
|
202 | + /** |
|
203 | + * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
204 | + * Does NOT save or recalculate other line items totals |
|
205 | + * |
|
206 | + * @param EE_Line_Item $line_item |
|
207 | + * @param int $qty |
|
208 | + * @return void |
|
209 | + * @throws EE_Error |
|
210 | + * @throws InvalidArgumentException |
|
211 | + * @throws InvalidDataTypeException |
|
212 | + * @throws InvalidInterfaceException |
|
213 | + * @throws ReflectionException |
|
214 | + */ |
|
215 | + public static function increment_quantity(EE_Line_Item $line_item, $qty = 1) |
|
216 | + { |
|
217 | + if (! $line_item->is_percent()) { |
|
218 | + $qty += $line_item->quantity(); |
|
219 | + $line_item->set_quantity($qty); |
|
220 | + $line_item->set_total($line_item->unit_price() * $qty); |
|
221 | + $line_item->save(); |
|
222 | + } |
|
223 | + foreach ($line_item->children() as $child) { |
|
224 | + if ($child->is_sub_line_item()) { |
|
225 | + EEH_Line_Item::update_quantity($child, $qty); |
|
226 | + } |
|
227 | + } |
|
228 | + } |
|
229 | + |
|
230 | + |
|
231 | + /** |
|
232 | + * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected). |
|
233 | + * Does NOT save or recalculate other line items totals |
|
234 | + * |
|
235 | + * @param EE_Line_Item $line_item |
|
236 | + * @param int $qty |
|
237 | + * @return void |
|
238 | + * @throws EE_Error |
|
239 | + * @throws InvalidArgumentException |
|
240 | + * @throws InvalidDataTypeException |
|
241 | + * @throws InvalidInterfaceException |
|
242 | + * @throws ReflectionException |
|
243 | + */ |
|
244 | + public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1) |
|
245 | + { |
|
246 | + if (! $line_item->is_percent()) { |
|
247 | + $qty = $line_item->quantity() - $qty; |
|
248 | + $qty = max($qty, 0); |
|
249 | + $line_item->set_quantity($qty); |
|
250 | + $line_item->set_total($line_item->unit_price() * $qty); |
|
251 | + $line_item->save(); |
|
252 | + } |
|
253 | + foreach ($line_item->children() as $child) { |
|
254 | + if ($child->is_sub_line_item()) { |
|
255 | + EEH_Line_Item::update_quantity($child, $qty); |
|
256 | + } |
|
257 | + } |
|
258 | + } |
|
259 | + |
|
260 | + |
|
261 | + /** |
|
262 | + * Updates the line item and its children's quantities to the specified number. |
|
263 | + * Does NOT save them or recalculate totals. |
|
264 | + * |
|
265 | + * @param EE_Line_Item $line_item |
|
266 | + * @param int $new_quantity |
|
267 | + * @throws EE_Error |
|
268 | + * @throws InvalidArgumentException |
|
269 | + * @throws InvalidDataTypeException |
|
270 | + * @throws InvalidInterfaceException |
|
271 | + * @throws ReflectionException |
|
272 | + */ |
|
273 | + public static function update_quantity(EE_Line_Item $line_item, $new_quantity) |
|
274 | + { |
|
275 | + if (! $line_item->is_percent()) { |
|
276 | + $line_item->set_quantity($new_quantity); |
|
277 | + $line_item->set_total($line_item->unit_price() * $new_quantity); |
|
278 | + $line_item->save(); |
|
279 | + } |
|
280 | + foreach ($line_item->children() as $child) { |
|
281 | + if ($child->is_sub_line_item()) { |
|
282 | + EEH_Line_Item::update_quantity($child, $new_quantity); |
|
283 | + } |
|
284 | + } |
|
285 | + } |
|
286 | + |
|
287 | + |
|
288 | + /** |
|
289 | + * Returns the new line item created by adding a purchase of the ticket |
|
290 | + * |
|
291 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
292 | + * @param EE_Ticket $ticket |
|
293 | + * @param int $qty |
|
294 | + * @return EE_Line_Item |
|
295 | + * @throws EE_Error |
|
296 | + * @throws InvalidArgumentException |
|
297 | + * @throws InvalidDataTypeException |
|
298 | + * @throws InvalidInterfaceException |
|
299 | + * @throws ReflectionException |
|
300 | + */ |
|
301 | + public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1) |
|
302 | + { |
|
303 | + $datetimes = $ticket->datetimes(); |
|
304 | + $first_datetime = reset($datetimes); |
|
305 | + $first_datetime_name = esc_html__('Event', 'event_espresso'); |
|
306 | + if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) { |
|
307 | + $first_datetime_name = $first_datetime->event()->name(); |
|
308 | + } |
|
309 | + $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name); |
|
310 | + // get event subtotal line |
|
311 | + $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket); |
|
312 | + // add $ticket to cart |
|
313 | + $line_item = EE_Line_Item::new_instance(array( |
|
314 | + 'LIN_name' => $ticket->name(), |
|
315 | + 'LIN_desc' => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event, |
|
316 | + 'LIN_unit_price' => $ticket->price(), |
|
317 | + 'LIN_quantity' => $qty, |
|
318 | + 'LIN_is_taxable' => $ticket->taxable(), |
|
319 | + 'LIN_order' => count($events_sub_total->children()), |
|
320 | + 'LIN_total' => $ticket->price() * $qty, |
|
321 | + 'LIN_type' => EEM_Line_Item::type_line_item, |
|
322 | + 'OBJ_ID' => $ticket->ID(), |
|
323 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET, |
|
324 | + )); |
|
325 | + $line_item = apply_filters( |
|
326 | + 'FHEE__EEH_Line_Item__create_ticket_line_item__line_item', |
|
327 | + $line_item |
|
328 | + ); |
|
329 | + $events_sub_total->add_child_line_item($line_item); |
|
330 | + // now add the sub-line items |
|
331 | + $running_total_for_ticket = 0; |
|
332 | + foreach ($ticket->prices(array('order_by' => array('PRC_order' => 'ASC'))) as $price) { |
|
333 | + $sign = $price->is_discount() ? -1 : 1; |
|
334 | + $price_total = $price->is_percent() |
|
335 | + ? $running_total_for_ticket * $price->amount() / 100 |
|
336 | + : $price->amount() * $qty; |
|
337 | + $sub_line_item = EE_Line_Item::new_instance(array( |
|
338 | + 'LIN_name' => $price->name(), |
|
339 | + 'LIN_desc' => $price->desc(), |
|
340 | + 'LIN_quantity' => $price->is_percent() ? null : $qty, |
|
341 | + 'LIN_is_taxable' => false, |
|
342 | + 'LIN_order' => $price->order(), |
|
343 | + 'LIN_total' => $sign * $price_total, |
|
344 | + 'LIN_type' => EEM_Line_Item::type_sub_line_item, |
|
345 | + 'OBJ_ID' => $price->ID(), |
|
346 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
347 | + )); |
|
348 | + $sub_line_item = apply_filters( |
|
349 | + 'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item', |
|
350 | + $sub_line_item |
|
351 | + ); |
|
352 | + if ($price->is_percent()) { |
|
353 | + $sub_line_item->set_percent($sign * $price->amount()); |
|
354 | + } else { |
|
355 | + $sub_line_item->set_unit_price($sign * $price->amount()); |
|
356 | + } |
|
357 | + $running_total_for_ticket += $price_total; |
|
358 | + $line_item->add_child_line_item($sub_line_item); |
|
359 | + } |
|
360 | + return $line_item; |
|
361 | + } |
|
362 | + |
|
363 | + |
|
364 | + /** |
|
365 | + * Adds the specified item under the pre-tax-sub-total line item. Automatically |
|
366 | + * re-calculates the line item totals and updates the related transaction. But |
|
367 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
368 | + * should probably change because of this). |
|
369 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
370 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
371 | + * |
|
372 | + * @param EE_Line_Item $total_line_item |
|
373 | + * @param EE_Line_Item $item to be added |
|
374 | + * @return boolean |
|
375 | + * @throws EE_Error |
|
376 | + * @throws InvalidArgumentException |
|
377 | + * @throws InvalidDataTypeException |
|
378 | + * @throws InvalidInterfaceException |
|
379 | + * @throws ReflectionException |
|
380 | + */ |
|
381 | + public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item) |
|
382 | + { |
|
383 | + $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item); |
|
384 | + if ($pre_tax_subtotal instanceof EE_Line_Item) { |
|
385 | + $success = $pre_tax_subtotal->add_child_line_item($item); |
|
386 | + } else { |
|
387 | + return false; |
|
388 | + } |
|
389 | + $total_line_item->recalculate_total_including_taxes(); |
|
390 | + return $success; |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * cancels an existing ticket line item, |
|
396 | + * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item. |
|
397 | + * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
398 | + * |
|
399 | + * @param EE_Line_Item $ticket_line_item |
|
400 | + * @param int $qty |
|
401 | + * @return bool success |
|
402 | + * @throws EE_Error |
|
403 | + * @throws InvalidArgumentException |
|
404 | + * @throws InvalidDataTypeException |
|
405 | + * @throws InvalidInterfaceException |
|
406 | + * @throws ReflectionException |
|
407 | + */ |
|
408 | + public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
409 | + { |
|
410 | + // validate incoming line_item |
|
411 | + if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
412 | + throw new EE_Error( |
|
413 | + sprintf( |
|
414 | + esc_html__( |
|
415 | + 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
416 | + 'event_espresso' |
|
417 | + ), |
|
418 | + $ticket_line_item->type() |
|
419 | + ) |
|
420 | + ); |
|
421 | + } |
|
422 | + if ($ticket_line_item->quantity() < $qty) { |
|
423 | + throw new EE_Error( |
|
424 | + sprintf( |
|
425 | + esc_html__( |
|
426 | + 'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.', |
|
427 | + 'event_espresso' |
|
428 | + ), |
|
429 | + $qty, |
|
430 | + $ticket_line_item->quantity() |
|
431 | + ) |
|
432 | + ); |
|
433 | + } |
|
434 | + // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this |
|
435 | + $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty); |
|
436 | + foreach ($ticket_line_item->children() as $child_line_item) { |
|
437 | + if ($child_line_item->is_sub_line_item() |
|
438 | + && ! $child_line_item->is_percent() |
|
439 | + && ! $child_line_item->is_cancellation() |
|
440 | + ) { |
|
441 | + $child_line_item->set_quantity($child_line_item->quantity() - $qty); |
|
442 | + } |
|
443 | + } |
|
444 | + // get cancellation sub line item |
|
445 | + $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
446 | + $ticket_line_item, |
|
447 | + EEM_Line_Item::type_cancellation |
|
448 | + ); |
|
449 | + $cancellation_line_item = reset($cancellation_line_item); |
|
450 | + // verify that this ticket was indeed previously cancelled |
|
451 | + if ($cancellation_line_item instanceof EE_Line_Item) { |
|
452 | + // increment cancelled quantity |
|
453 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty); |
|
454 | + } else { |
|
455 | + // create cancellation sub line item |
|
456 | + $cancellation_line_item = EE_Line_Item::new_instance(array( |
|
457 | + 'LIN_name' => esc_html__('Cancellation', 'event_espresso'), |
|
458 | + 'LIN_desc' => sprintf( |
|
459 | + esc_html_x( |
|
460 | + 'Cancelled %1$s : %2$s', |
|
461 | + 'Cancelled Ticket Name : 2015-01-01 11:11', |
|
462 | + 'event_espresso' |
|
463 | + ), |
|
464 | + $ticket_line_item->name(), |
|
465 | + current_time(get_option('date_format') . ' ' . get_option('time_format')) |
|
466 | + ), |
|
467 | + 'LIN_unit_price' => 0, // $ticket_line_item->unit_price() |
|
468 | + 'LIN_quantity' => $qty, |
|
469 | + 'LIN_is_taxable' => $ticket_line_item->is_taxable(), |
|
470 | + 'LIN_order' => count($ticket_line_item->children()), |
|
471 | + 'LIN_total' => 0, // $ticket_line_item->unit_price() |
|
472 | + 'LIN_type' => EEM_Line_Item::type_cancellation, |
|
473 | + )); |
|
474 | + $ticket_line_item->add_child_line_item($cancellation_line_item); |
|
475 | + } |
|
476 | + if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
477 | + // decrement parent line item quantity |
|
478 | + $event_line_item = $ticket_line_item->parent(); |
|
479 | + if ($event_line_item instanceof EE_Line_Item |
|
480 | + && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
481 | + ) { |
|
482 | + $event_line_item->set_quantity($event_line_item->quantity() - $qty); |
|
483 | + $event_line_item->save(); |
|
484 | + } |
|
485 | + EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
486 | + return true; |
|
487 | + } |
|
488 | + return false; |
|
489 | + } |
|
490 | + |
|
491 | + |
|
492 | + /** |
|
493 | + * reinstates (un-cancels?) a previously canceled ticket line item, |
|
494 | + * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item. |
|
495 | + * ALL totals and subtotals will NEED TO BE UPDATED after performing this action |
|
496 | + * |
|
497 | + * @param EE_Line_Item $ticket_line_item |
|
498 | + * @param int $qty |
|
499 | + * @return bool success |
|
500 | + * @throws EE_Error |
|
501 | + * @throws InvalidArgumentException |
|
502 | + * @throws InvalidDataTypeException |
|
503 | + * @throws InvalidInterfaceException |
|
504 | + * @throws ReflectionException |
|
505 | + */ |
|
506 | + public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1) |
|
507 | + { |
|
508 | + // validate incoming line_item |
|
509 | + if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
510 | + throw new EE_Error( |
|
511 | + sprintf( |
|
512 | + esc_html__( |
|
513 | + 'The supplied line item must have an Object Type of "Ticket", not %1$s.', |
|
514 | + 'event_espresso' |
|
515 | + ), |
|
516 | + $ticket_line_item->type() |
|
517 | + ) |
|
518 | + ); |
|
519 | + } |
|
520 | + // get cancellation sub line item |
|
521 | + $cancellation_line_item = EEH_Line_Item::get_descendants_of_type( |
|
522 | + $ticket_line_item, |
|
523 | + EEM_Line_Item::type_cancellation |
|
524 | + ); |
|
525 | + $cancellation_line_item = reset($cancellation_line_item); |
|
526 | + // verify that this ticket was indeed previously cancelled |
|
527 | + if (! $cancellation_line_item instanceof EE_Line_Item) { |
|
528 | + return false; |
|
529 | + } |
|
530 | + if ($cancellation_line_item->quantity() > $qty) { |
|
531 | + // decrement cancelled quantity |
|
532 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
533 | + } elseif ($cancellation_line_item->quantity() === $qty) { |
|
534 | + // decrement cancelled quantity in case anyone still has the object kicking around |
|
535 | + $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty); |
|
536 | + // delete because quantity will end up as 0 |
|
537 | + $cancellation_line_item->delete(); |
|
538 | + // and attempt to destroy the object, |
|
539 | + // even though PHP won't actually destroy it until it needs the memory |
|
540 | + unset($cancellation_line_item); |
|
541 | + } else { |
|
542 | + // what ?!?! negative quantity ?!?! |
|
543 | + throw new EE_Error( |
|
544 | + sprintf( |
|
545 | + esc_html__( |
|
546 | + 'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.', |
|
547 | + 'event_espresso' |
|
548 | + ), |
|
549 | + $qty, |
|
550 | + $cancellation_line_item->quantity() |
|
551 | + ) |
|
552 | + ); |
|
553 | + } |
|
554 | + // increment ticket quantity |
|
555 | + $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty); |
|
556 | + if ($ticket_line_item->save_this_and_descendants() > 0) { |
|
557 | + // increment parent line item quantity |
|
558 | + $event_line_item = $ticket_line_item->parent(); |
|
559 | + if ($event_line_item instanceof EE_Line_Item |
|
560 | + && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
561 | + ) { |
|
562 | + $event_line_item->set_quantity($event_line_item->quantity() + $qty); |
|
563 | + } |
|
564 | + EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item); |
|
565 | + return true; |
|
566 | + } |
|
567 | + return false; |
|
568 | + } |
|
569 | + |
|
570 | + |
|
571 | + /** |
|
572 | + * calls EEH_Line_Item::find_transaction_grand_total_for_line_item() |
|
573 | + * then EE_Line_Item::recalculate_total_including_taxes() on the result |
|
574 | + * |
|
575 | + * @param EE_Line_Item $line_item |
|
576 | + * @return float |
|
577 | + * @throws EE_Error |
|
578 | + * @throws InvalidArgumentException |
|
579 | + * @throws InvalidDataTypeException |
|
580 | + * @throws InvalidInterfaceException |
|
581 | + * @throws ReflectionException |
|
582 | + */ |
|
583 | + public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item) |
|
584 | + { |
|
585 | + $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item); |
|
586 | + return $grand_total_line_item->recalculate_total_including_taxes(); |
|
587 | + } |
|
588 | + |
|
589 | + |
|
590 | + /** |
|
591 | + * Gets the line item which contains the subtotal of all the items |
|
592 | + * |
|
593 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
594 | + * @return EE_Line_Item |
|
595 | + * @throws EE_Error |
|
596 | + * @throws InvalidArgumentException |
|
597 | + * @throws InvalidDataTypeException |
|
598 | + * @throws InvalidInterfaceException |
|
599 | + * @throws ReflectionException |
|
600 | + */ |
|
601 | + public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item) |
|
602 | + { |
|
603 | + $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal'); |
|
604 | + return $pre_tax_subtotal instanceof EE_Line_Item |
|
605 | + ? $pre_tax_subtotal |
|
606 | + : self::create_pre_tax_subtotal($total_line_item); |
|
607 | + } |
|
608 | + |
|
609 | + |
|
610 | + /** |
|
611 | + * Gets the line item for the taxes subtotal |
|
612 | + * |
|
613 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
614 | + * @return EE_Line_Item |
|
615 | + * @throws EE_Error |
|
616 | + * @throws InvalidArgumentException |
|
617 | + * @throws InvalidDataTypeException |
|
618 | + * @throws InvalidInterfaceException |
|
619 | + * @throws ReflectionException |
|
620 | + */ |
|
621 | + public static function get_taxes_subtotal(EE_Line_Item $total_line_item) |
|
622 | + { |
|
623 | + $taxes = $total_line_item->get_child_line_item('taxes'); |
|
624 | + return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item); |
|
625 | + } |
|
626 | + |
|
627 | + |
|
628 | + /** |
|
629 | + * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object |
|
630 | + * |
|
631 | + * @param EE_Line_Item $line_item |
|
632 | + * @param EE_Transaction $transaction |
|
633 | + * @return void |
|
634 | + * @throws EE_Error |
|
635 | + * @throws InvalidArgumentException |
|
636 | + * @throws InvalidDataTypeException |
|
637 | + * @throws InvalidInterfaceException |
|
638 | + * @throws ReflectionException |
|
639 | + */ |
|
640 | + public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null) |
|
641 | + { |
|
642 | + if ($transaction) { |
|
643 | + /** @type EEM_Transaction $EEM_Transaction */ |
|
644 | + $EEM_Transaction = EE_Registry::instance()->load_model('Transaction'); |
|
645 | + $TXN_ID = $EEM_Transaction->ensure_is_ID($transaction); |
|
646 | + $line_item->set_TXN_ID($TXN_ID); |
|
647 | + } |
|
648 | + } |
|
649 | + |
|
650 | + |
|
651 | + /** |
|
652 | + * Creates a new default total line item for the transaction, |
|
653 | + * and its tickets subtotal and taxes subtotal line items (and adds the |
|
654 | + * existing taxes as children of the taxes subtotal line item) |
|
655 | + * |
|
656 | + * @param EE_Transaction $transaction |
|
657 | + * @return EE_Line_Item of type total |
|
658 | + * @throws EE_Error |
|
659 | + * @throws InvalidArgumentException |
|
660 | + * @throws InvalidDataTypeException |
|
661 | + * @throws InvalidInterfaceException |
|
662 | + * @throws ReflectionException |
|
663 | + */ |
|
664 | + public static function create_total_line_item($transaction = null) |
|
665 | + { |
|
666 | + $total_line_item = EE_Line_Item::new_instance(array( |
|
667 | + 'LIN_code' => 'total', |
|
668 | + 'LIN_name' => esc_html__('Grand Total', 'event_espresso'), |
|
669 | + 'LIN_type' => EEM_Line_Item::type_total, |
|
670 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION, |
|
671 | + )); |
|
672 | + $total_line_item = apply_filters( |
|
673 | + 'FHEE__EEH_Line_Item__create_total_line_item__total_line_item', |
|
674 | + $total_line_item |
|
675 | + ); |
|
676 | + self::set_TXN_ID($total_line_item, $transaction); |
|
677 | + self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
678 | + self::create_taxes_subtotal($total_line_item, $transaction); |
|
679 | + return $total_line_item; |
|
680 | + } |
|
681 | + |
|
682 | + |
|
683 | + /** |
|
684 | + * Creates a default items subtotal line item |
|
685 | + * |
|
686 | + * @param EE_Line_Item $total_line_item |
|
687 | + * @param EE_Transaction $transaction |
|
688 | + * @return EE_Line_Item |
|
689 | + * @throws EE_Error |
|
690 | + * @throws InvalidArgumentException |
|
691 | + * @throws InvalidDataTypeException |
|
692 | + * @throws InvalidInterfaceException |
|
693 | + * @throws ReflectionException |
|
694 | + */ |
|
695 | + protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
696 | + { |
|
697 | + $pre_tax_line_item = EE_Line_Item::new_instance(array( |
|
698 | + 'LIN_code' => 'pre-tax-subtotal', |
|
699 | + 'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'), |
|
700 | + 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
701 | + )); |
|
702 | + $pre_tax_line_item = apply_filters( |
|
703 | + 'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item', |
|
704 | + $pre_tax_line_item |
|
705 | + ); |
|
706 | + self::set_TXN_ID($pre_tax_line_item, $transaction); |
|
707 | + $total_line_item->add_child_line_item($pre_tax_line_item); |
|
708 | + self::create_event_subtotal($pre_tax_line_item, $transaction); |
|
709 | + return $pre_tax_line_item; |
|
710 | + } |
|
711 | + |
|
712 | + |
|
713 | + /** |
|
714 | + * Creates a line item for the taxes subtotal and finds all the tax prices |
|
715 | + * and applies taxes to it |
|
716 | + * |
|
717 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
718 | + * @param EE_Transaction $transaction |
|
719 | + * @return EE_Line_Item |
|
720 | + * @throws EE_Error |
|
721 | + * @throws InvalidArgumentException |
|
722 | + * @throws InvalidDataTypeException |
|
723 | + * @throws InvalidInterfaceException |
|
724 | + * @throws ReflectionException |
|
725 | + */ |
|
726 | + protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
727 | + { |
|
728 | + $tax_line_item = EE_Line_Item::new_instance(array( |
|
729 | + 'LIN_code' => 'taxes', |
|
730 | + 'LIN_name' => esc_html__('Taxes', 'event_espresso'), |
|
731 | + 'LIN_type' => EEM_Line_Item::type_tax_sub_total, |
|
732 | + 'LIN_order' => 1000,// this should always come last |
|
733 | + )); |
|
734 | + $tax_line_item = apply_filters( |
|
735 | + 'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item', |
|
736 | + $tax_line_item |
|
737 | + ); |
|
738 | + self::set_TXN_ID($tax_line_item, $transaction); |
|
739 | + $total_line_item->add_child_line_item($tax_line_item); |
|
740 | + // and lastly, add the actual taxes |
|
741 | + self::apply_taxes($total_line_item); |
|
742 | + return $tax_line_item; |
|
743 | + } |
|
744 | + |
|
745 | + |
|
746 | + /** |
|
747 | + * Creates a default items subtotal line item |
|
748 | + * |
|
749 | + * @param EE_Line_Item $pre_tax_line_item |
|
750 | + * @param EE_Transaction $transaction |
|
751 | + * @param EE_Event $event |
|
752 | + * @return EE_Line_Item |
|
753 | + * @throws EE_Error |
|
754 | + * @throws InvalidArgumentException |
|
755 | + * @throws InvalidDataTypeException |
|
756 | + * @throws InvalidInterfaceException |
|
757 | + * @throws ReflectionException |
|
758 | + */ |
|
759 | + public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null) |
|
760 | + { |
|
761 | + $event_line_item = EE_Line_Item::new_instance(array( |
|
762 | + 'LIN_code' => self::get_event_code($event), |
|
763 | + 'LIN_name' => self::get_event_name($event), |
|
764 | + 'LIN_desc' => self::get_event_desc($event), |
|
765 | + 'LIN_type' => EEM_Line_Item::type_sub_total, |
|
766 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT, |
|
767 | + 'OBJ_ID' => $event instanceof EE_Event ? $event->ID() : 0, |
|
768 | + )); |
|
769 | + $event_line_item = apply_filters( |
|
770 | + 'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item', |
|
771 | + $event_line_item |
|
772 | + ); |
|
773 | + self::set_TXN_ID($event_line_item, $transaction); |
|
774 | + $pre_tax_line_item->add_child_line_item($event_line_item); |
|
775 | + return $event_line_item; |
|
776 | + } |
|
777 | + |
|
778 | + |
|
779 | + /** |
|
780 | + * Gets what the event ticket's code SHOULD be |
|
781 | + * |
|
782 | + * @param EE_Event $event |
|
783 | + * @return string |
|
784 | + * @throws EE_Error |
|
785 | + */ |
|
786 | + public static function get_event_code($event) |
|
787 | + { |
|
788 | + return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0'); |
|
789 | + } |
|
790 | + |
|
791 | + |
|
792 | + /** |
|
793 | + * Gets the event name |
|
794 | + * |
|
795 | + * @param EE_Event $event |
|
796 | + * @return string |
|
797 | + * @throws EE_Error |
|
798 | + */ |
|
799 | + public static function get_event_name($event) |
|
800 | + { |
|
801 | + return $event instanceof EE_Event |
|
802 | + ? mb_substr($event->name(), 0, 245) |
|
803 | + : esc_html__('Event', 'event_espresso'); |
|
804 | + } |
|
805 | + |
|
806 | + |
|
807 | + /** |
|
808 | + * Gets the event excerpt |
|
809 | + * |
|
810 | + * @param EE_Event $event |
|
811 | + * @return string |
|
812 | + * @throws EE_Error |
|
813 | + */ |
|
814 | + public static function get_event_desc($event) |
|
815 | + { |
|
816 | + return $event instanceof EE_Event ? $event->short_description() : ''; |
|
817 | + } |
|
818 | + |
|
819 | + |
|
820 | + /** |
|
821 | + * Given the grand total line item and a ticket, finds the event sub-total |
|
822 | + * line item the ticket's purchase should be added onto |
|
823 | + * |
|
824 | + * @access public |
|
825 | + * @param EE_Line_Item $grand_total the grand total line item |
|
826 | + * @param EE_Ticket $ticket |
|
827 | + * @return EE_Line_Item |
|
828 | + * @throws EE_Error |
|
829 | + * @throws InvalidArgumentException |
|
830 | + * @throws InvalidDataTypeException |
|
831 | + * @throws InvalidInterfaceException |
|
832 | + * @throws ReflectionException |
|
833 | + */ |
|
834 | + public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket) |
|
835 | + { |
|
836 | + $first_datetime = $ticket->first_datetime(); |
|
837 | + if (! $first_datetime instanceof EE_Datetime) { |
|
838 | + throw new EE_Error( |
|
839 | + sprintf( |
|
840 | + __('The supplied ticket (ID %d) has no datetimes', 'event_espresso'), |
|
841 | + $ticket->ID() |
|
842 | + ) |
|
843 | + ); |
|
844 | + } |
|
845 | + $event = $first_datetime->event(); |
|
846 | + if (! $event instanceof EE_Event) { |
|
847 | + throw new EE_Error( |
|
848 | + sprintf( |
|
849 | + esc_html__( |
|
850 | + 'The supplied ticket (ID %d) has no event data associated with it.', |
|
851 | + 'event_espresso' |
|
852 | + ), |
|
853 | + $ticket->ID() |
|
854 | + ) |
|
855 | + ); |
|
856 | + } |
|
857 | + $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event); |
|
858 | + if (! $events_sub_total instanceof EE_Line_Item) { |
|
859 | + throw new EE_Error( |
|
860 | + sprintf( |
|
861 | + esc_html__( |
|
862 | + 'There is no events sub-total for ticket %s on total line item %d', |
|
863 | + 'event_espresso' |
|
864 | + ), |
|
865 | + $ticket->ID(), |
|
866 | + $grand_total->ID() |
|
867 | + ) |
|
868 | + ); |
|
869 | + } |
|
870 | + return $events_sub_total; |
|
871 | + } |
|
872 | + |
|
873 | + |
|
874 | + /** |
|
875 | + * Gets the event line item |
|
876 | + * |
|
877 | + * @param EE_Line_Item $grand_total |
|
878 | + * @param EE_Event $event |
|
879 | + * @return EE_Line_Item for the event subtotal which is a child of $grand_total |
|
880 | + * @throws EE_Error |
|
881 | + * @throws InvalidArgumentException |
|
882 | + * @throws InvalidDataTypeException |
|
883 | + * @throws InvalidInterfaceException |
|
884 | + * @throws ReflectionException |
|
885 | + */ |
|
886 | + public static function get_event_line_item(EE_Line_Item $grand_total, $event) |
|
887 | + { |
|
888 | + /** @type EE_Event $event */ |
|
889 | + $event = EEM_Event::instance()->ensure_is_obj($event, true); |
|
890 | + $event_line_item = null; |
|
891 | + $found = false; |
|
892 | + foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) { |
|
893 | + // default event subtotal, we should only ever find this the first time this method is called |
|
894 | + if (! $event_line_item->OBJ_ID()) { |
|
895 | + // let's use this! but first... set the event details |
|
896 | + EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
897 | + $found = true; |
|
898 | + break; |
|
899 | + } |
|
900 | + if ($event_line_item->OBJ_ID() === $event->ID()) { |
|
901 | + // found existing line item for this event in the cart, so break out of loop and use this one |
|
902 | + $found = true; |
|
903 | + break; |
|
904 | + } |
|
905 | + } |
|
906 | + if (! $found) { |
|
907 | + // there is no event sub-total yet, so add it |
|
908 | + $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total); |
|
909 | + // create a new "event" subtotal below that |
|
910 | + $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event); |
|
911 | + // and set the event details |
|
912 | + EEH_Line_Item::set_event_subtotal_details($event_line_item, $event); |
|
913 | + } |
|
914 | + return $event_line_item; |
|
915 | + } |
|
916 | + |
|
917 | + |
|
918 | + /** |
|
919 | + * Creates a default items subtotal line item |
|
920 | + * |
|
921 | + * @param EE_Line_Item $event_line_item |
|
922 | + * @param EE_Event $event |
|
923 | + * @param EE_Transaction $transaction |
|
924 | + * @return void |
|
925 | + * @throws EE_Error |
|
926 | + * @throws InvalidArgumentException |
|
927 | + * @throws InvalidDataTypeException |
|
928 | + * @throws InvalidInterfaceException |
|
929 | + * @throws ReflectionException |
|
930 | + */ |
|
931 | + public static function set_event_subtotal_details( |
|
932 | + EE_Line_Item $event_line_item, |
|
933 | + EE_Event $event, |
|
934 | + $transaction = null |
|
935 | + ) { |
|
936 | + if ($event instanceof EE_Event) { |
|
937 | + $event_line_item->set_code(self::get_event_code($event)); |
|
938 | + $event_line_item->set_name(self::get_event_name($event)); |
|
939 | + $event_line_item->set_desc(self::get_event_desc($event)); |
|
940 | + $event_line_item->set_OBJ_ID($event->ID()); |
|
941 | + } |
|
942 | + self::set_TXN_ID($event_line_item, $transaction); |
|
943 | + } |
|
944 | + |
|
945 | + |
|
946 | + /** |
|
947 | + * Finds what taxes should apply, adds them as tax line items under the taxes sub-total, |
|
948 | + * and recalculates the taxes sub-total and the grand total. Resets the taxes, so |
|
949 | + * any old taxes are removed |
|
950 | + * |
|
951 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
952 | + * @param bool $update_txn_status |
|
953 | + * @return bool |
|
954 | + * @throws EE_Error |
|
955 | + * @throws InvalidArgumentException |
|
956 | + * @throws InvalidDataTypeException |
|
957 | + * @throws InvalidInterfaceException |
|
958 | + * @throws ReflectionException |
|
959 | + * @throws RuntimeException |
|
960 | + */ |
|
961 | + public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false) |
|
962 | + { |
|
963 | + /** @type EEM_Price $EEM_Price */ |
|
964 | + $EEM_Price = EE_Registry::instance()->load_model('Price'); |
|
965 | + // get array of taxes via Price Model |
|
966 | + $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes(); |
|
967 | + ksort($ordered_taxes); |
|
968 | + $taxes_line_item = self::get_taxes_subtotal($total_line_item); |
|
969 | + // just to be safe, remove its old tax line items |
|
970 | + $deleted = $taxes_line_item->delete_children_line_items(); |
|
971 | + $updates = false; |
|
972 | + // loop thru taxes |
|
973 | + foreach ($ordered_taxes as $order => $taxes) { |
|
974 | + foreach ($taxes as $tax) { |
|
975 | + if ($tax instanceof EE_Price) { |
|
976 | + $tax_line_item = EE_Line_Item::new_instance( |
|
977 | + array( |
|
978 | + 'LIN_name' => $tax->name(), |
|
979 | + 'LIN_desc' => $tax->desc(), |
|
980 | + 'LIN_percent' => $tax->amount(), |
|
981 | + 'LIN_is_taxable' => false, |
|
982 | + 'LIN_order' => $order, |
|
983 | + 'LIN_total' => 0, |
|
984 | + 'LIN_type' => EEM_Line_Item::type_tax, |
|
985 | + 'OBJ_type' => EEM_Line_Item::OBJ_TYPE_PRICE, |
|
986 | + 'OBJ_ID' => $tax->ID(), |
|
987 | + ) |
|
988 | + ); |
|
989 | + $tax_line_item = apply_filters( |
|
990 | + 'FHEE__EEH_Line_Item__apply_taxes__tax_line_item', |
|
991 | + $tax_line_item |
|
992 | + ); |
|
993 | + $updates = $taxes_line_item->add_child_line_item($tax_line_item) ? |
|
994 | + true : |
|
995 | + $updates; |
|
996 | + } |
|
997 | + } |
|
998 | + } |
|
999 | + // only recalculate totals if something changed |
|
1000 | + if ($deleted || $updates) { |
|
1001 | + $total_line_item->recalculate_total_including_taxes($update_txn_status); |
|
1002 | + return true; |
|
1003 | + } |
|
1004 | + return false; |
|
1005 | + } |
|
1006 | + |
|
1007 | + |
|
1008 | + /** |
|
1009 | + * Ensures that taxes have been applied to the order, if not applies them. |
|
1010 | + * Returns the total amount of tax |
|
1011 | + * |
|
1012 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
1013 | + * @return float |
|
1014 | + * @throws EE_Error |
|
1015 | + * @throws InvalidArgumentException |
|
1016 | + * @throws InvalidDataTypeException |
|
1017 | + * @throws InvalidInterfaceException |
|
1018 | + * @throws ReflectionException |
|
1019 | + */ |
|
1020 | + public static function ensure_taxes_applied($total_line_item) |
|
1021 | + { |
|
1022 | + $taxes_subtotal = self::get_taxes_subtotal($total_line_item); |
|
1023 | + if (! $taxes_subtotal->children()) { |
|
1024 | + self::apply_taxes($total_line_item); |
|
1025 | + } |
|
1026 | + return $taxes_subtotal->total(); |
|
1027 | + } |
|
1028 | + |
|
1029 | + |
|
1030 | + /** |
|
1031 | + * Deletes ALL children of the passed line item |
|
1032 | + * |
|
1033 | + * @param EE_Line_Item $parent_line_item |
|
1034 | + * @return bool |
|
1035 | + * @throws EE_Error |
|
1036 | + * @throws InvalidArgumentException |
|
1037 | + * @throws InvalidDataTypeException |
|
1038 | + * @throws InvalidInterfaceException |
|
1039 | + * @throws ReflectionException |
|
1040 | + */ |
|
1041 | + public static function delete_all_child_items(EE_Line_Item $parent_line_item) |
|
1042 | + { |
|
1043 | + $deleted = 0; |
|
1044 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
1045 | + if ($child_line_item instanceof EE_Line_Item) { |
|
1046 | + $deleted += EEH_Line_Item::delete_all_child_items($child_line_item); |
|
1047 | + if ($child_line_item->ID()) { |
|
1048 | + $child_line_item->delete(); |
|
1049 | + unset($child_line_item); |
|
1050 | + } else { |
|
1051 | + $parent_line_item->delete_child_line_item($child_line_item->code()); |
|
1052 | + } |
|
1053 | + $deleted++; |
|
1054 | + } |
|
1055 | + } |
|
1056 | + return $deleted; |
|
1057 | + } |
|
1058 | + |
|
1059 | + |
|
1060 | + /** |
|
1061 | + * Deletes the line items as indicated by the line item code(s) provided, |
|
1062 | + * regardless of where they're found in the line item tree. Automatically |
|
1063 | + * re-calculates the line item totals and updates the related transaction. But |
|
1064 | + * DOES NOT automatically upgrade the transaction's registrations' final prices (which |
|
1065 | + * should probably change because of this). |
|
1066 | + * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item() |
|
1067 | + * after using this, to keep the registration final prices in-sync with the transaction's total. |
|
1068 | + * |
|
1069 | + * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total |
|
1070 | + * @param array|bool|string $line_item_codes |
|
1071 | + * @return int number of items successfully removed |
|
1072 | + * @throws EE_Error |
|
1073 | + */ |
|
1074 | + public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false) |
|
1075 | + { |
|
1076 | + |
|
1077 | + if ($total_line_item->type() !== EEM_Line_Item::type_total) { |
|
1078 | + EE_Error::doing_it_wrong( |
|
1079 | + 'EEH_Line_Item::delete_items', |
|
1080 | + esc_html__( |
|
1081 | + 'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly', |
|
1082 | + 'event_espresso' |
|
1083 | + ), |
|
1084 | + '4.6.18' |
|
1085 | + ); |
|
1086 | + } |
|
1087 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1088 | + |
|
1089 | + // check if only a single line_item_id was passed |
|
1090 | + if (! empty($line_item_codes) && ! is_array($line_item_codes)) { |
|
1091 | + // place single line_item_id in an array to appear as multiple line_item_ids |
|
1092 | + $line_item_codes = array($line_item_codes); |
|
1093 | + } |
|
1094 | + $removals = 0; |
|
1095 | + // cycle thru line_item_ids |
|
1096 | + foreach ($line_item_codes as $line_item_id) { |
|
1097 | + $removals += $total_line_item->delete_child_line_item($line_item_id); |
|
1098 | + } |
|
1099 | + |
|
1100 | + if ($removals > 0) { |
|
1101 | + $total_line_item->recalculate_taxes_and_tax_total(); |
|
1102 | + return $removals; |
|
1103 | + } else { |
|
1104 | + return false; |
|
1105 | + } |
|
1106 | + } |
|
1107 | + |
|
1108 | + |
|
1109 | + /** |
|
1110 | + * Overwrites the previous tax by clearing out the old taxes, and creates a new |
|
1111 | + * tax and updates the total line item accordingly |
|
1112 | + * |
|
1113 | + * @param EE_Line_Item $total_line_item |
|
1114 | + * @param float $amount |
|
1115 | + * @param string $name |
|
1116 | + * @param string $description |
|
1117 | + * @param string $code |
|
1118 | + * @param boolean $add_to_existing_line_item |
|
1119 | + * if true, and a duplicate line item with the same code is found, |
|
1120 | + * $amount will be added onto it; otherwise will simply set the taxes to match $amount |
|
1121 | + * @return EE_Line_Item the new tax line item created |
|
1122 | + * @throws EE_Error |
|
1123 | + * @throws InvalidArgumentException |
|
1124 | + * @throws InvalidDataTypeException |
|
1125 | + * @throws InvalidInterfaceException |
|
1126 | + * @throws ReflectionException |
|
1127 | + */ |
|
1128 | + public static function set_total_tax_to( |
|
1129 | + EE_Line_Item $total_line_item, |
|
1130 | + $amount, |
|
1131 | + $name = null, |
|
1132 | + $description = null, |
|
1133 | + $code = null, |
|
1134 | + $add_to_existing_line_item = false |
|
1135 | + ) { |
|
1136 | + $tax_subtotal = self::get_taxes_subtotal($total_line_item); |
|
1137 | + $taxable_total = $total_line_item->taxable_total(); |
|
1138 | + |
|
1139 | + if ($add_to_existing_line_item) { |
|
1140 | + $new_tax = $tax_subtotal->get_child_line_item($code); |
|
1141 | + EEM_Line_Item::instance()->delete( |
|
1142 | + array(array('LIN_code' => array('!=', $code), 'LIN_parent' => $tax_subtotal->ID())) |
|
1143 | + ); |
|
1144 | + } else { |
|
1145 | + $new_tax = null; |
|
1146 | + $tax_subtotal->delete_children_line_items(); |
|
1147 | + } |
|
1148 | + if ($new_tax) { |
|
1149 | + $new_tax->set_total($new_tax->total() + $amount); |
|
1150 | + $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0); |
|
1151 | + } else { |
|
1152 | + // no existing tax item. Create it |
|
1153 | + $new_tax = EE_Line_Item::new_instance(array( |
|
1154 | + 'TXN_ID' => $total_line_item->TXN_ID(), |
|
1155 | + 'LIN_name' => $name ? $name : esc_html__('Tax', 'event_espresso'), |
|
1156 | + 'LIN_desc' => $description ? $description : '', |
|
1157 | + 'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0, |
|
1158 | + 'LIN_total' => $amount, |
|
1159 | + 'LIN_parent' => $tax_subtotal->ID(), |
|
1160 | + 'LIN_type' => EEM_Line_Item::type_tax, |
|
1161 | + 'LIN_code' => $code, |
|
1162 | + )); |
|
1163 | + } |
|
1164 | + |
|
1165 | + $new_tax = apply_filters( |
|
1166 | + 'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal', |
|
1167 | + $new_tax, |
|
1168 | + $total_line_item |
|
1169 | + ); |
|
1170 | + $new_tax->save(); |
|
1171 | + $tax_subtotal->set_total($new_tax->total()); |
|
1172 | + $tax_subtotal->save(); |
|
1173 | + $total_line_item->recalculate_total_including_taxes(); |
|
1174 | + return $new_tax; |
|
1175 | + } |
|
1176 | + |
|
1177 | + |
|
1178 | + /** |
|
1179 | + * Makes all the line items which are children of $line_item taxable (or not). |
|
1180 | + * Does NOT save the line items |
|
1181 | + * |
|
1182 | + * @param EE_Line_Item $line_item |
|
1183 | + * @param boolean $taxable |
|
1184 | + * @param string $code_substring_for_whitelist if this string is part of the line item's code |
|
1185 | + * it will be whitelisted (ie, except from becoming taxable) |
|
1186 | + * @throws EE_Error |
|
1187 | + */ |
|
1188 | + public static function set_line_items_taxable( |
|
1189 | + EE_Line_Item $line_item, |
|
1190 | + $taxable = true, |
|
1191 | + $code_substring_for_whitelist = null |
|
1192 | + ) { |
|
1193 | + $whitelisted = false; |
|
1194 | + if ($code_substring_for_whitelist !== null) { |
|
1195 | + $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false; |
|
1196 | + } |
|
1197 | + if (! $whitelisted && $line_item->is_line_item()) { |
|
1198 | + $line_item->set_is_taxable($taxable); |
|
1199 | + } |
|
1200 | + foreach ($line_item->children() as $child_line_item) { |
|
1201 | + EEH_Line_Item::set_line_items_taxable( |
|
1202 | + $child_line_item, |
|
1203 | + $taxable, |
|
1204 | + $code_substring_for_whitelist |
|
1205 | + ); |
|
1206 | + } |
|
1207 | + } |
|
1208 | + |
|
1209 | + |
|
1210 | + /** |
|
1211 | + * Gets all descendants that are event subtotals |
|
1212 | + * |
|
1213 | + * @uses EEH_Line_Item::get_subtotals_of_object_type() |
|
1214 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1215 | + * @return EE_Line_Item[] |
|
1216 | + * @throws EE_Error |
|
1217 | + */ |
|
1218 | + public static function get_event_subtotals(EE_Line_Item $parent_line_item) |
|
1219 | + { |
|
1220 | + return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT); |
|
1221 | + } |
|
1222 | + |
|
1223 | + |
|
1224 | + /** |
|
1225 | + * Gets all descendants subtotals that match the supplied object type |
|
1226 | + * |
|
1227 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1228 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1229 | + * @param string $obj_type |
|
1230 | + * @return EE_Line_Item[] |
|
1231 | + * @throws EE_Error |
|
1232 | + */ |
|
1233 | + public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
1234 | + { |
|
1235 | + return self::_get_descendants_by_type_and_object_type( |
|
1236 | + $parent_line_item, |
|
1237 | + EEM_Line_Item::type_sub_total, |
|
1238 | + $obj_type |
|
1239 | + ); |
|
1240 | + } |
|
1241 | + |
|
1242 | + |
|
1243 | + /** |
|
1244 | + * Gets all descendants that are tickets |
|
1245 | + * |
|
1246 | + * @uses EEH_Line_Item::get_line_items_of_object_type() |
|
1247 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1248 | + * @return EE_Line_Item[] |
|
1249 | + * @throws EE_Error |
|
1250 | + */ |
|
1251 | + public static function get_ticket_line_items(EE_Line_Item $parent_line_item) |
|
1252 | + { |
|
1253 | + return self::get_line_items_of_object_type( |
|
1254 | + $parent_line_item, |
|
1255 | + EEM_Line_Item::OBJ_TYPE_TICKET |
|
1256 | + ); |
|
1257 | + } |
|
1258 | + |
|
1259 | + |
|
1260 | + /** |
|
1261 | + * Gets all descendants subtotals that match the supplied object type |
|
1262 | + * |
|
1263 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1264 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1265 | + * @param string $obj_type |
|
1266 | + * @return EE_Line_Item[] |
|
1267 | + * @throws EE_Error |
|
1268 | + */ |
|
1269 | + public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '') |
|
1270 | + { |
|
1271 | + return self::_get_descendants_by_type_and_object_type( |
|
1272 | + $parent_line_item, |
|
1273 | + EEM_Line_Item::type_line_item, |
|
1274 | + $obj_type |
|
1275 | + ); |
|
1276 | + } |
|
1277 | + |
|
1278 | + |
|
1279 | + /** |
|
1280 | + * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax' |
|
1281 | + * |
|
1282 | + * @uses EEH_Line_Item::get_descendants_of_type() |
|
1283 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1284 | + * @return EE_Line_Item[] |
|
1285 | + * @throws EE_Error |
|
1286 | + */ |
|
1287 | + public static function get_tax_descendants(EE_Line_Item $parent_line_item) |
|
1288 | + { |
|
1289 | + return EEH_Line_Item::get_descendants_of_type( |
|
1290 | + $parent_line_item, |
|
1291 | + EEM_Line_Item::type_tax |
|
1292 | + ); |
|
1293 | + } |
|
1294 | + |
|
1295 | + |
|
1296 | + /** |
|
1297 | + * Gets all the real items purchased which are children of this item |
|
1298 | + * |
|
1299 | + * @uses EEH_Line_Item::get_descendants_of_type() |
|
1300 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1301 | + * @return EE_Line_Item[] |
|
1302 | + * @throws EE_Error |
|
1303 | + */ |
|
1304 | + public static function get_line_item_descendants(EE_Line_Item $parent_line_item) |
|
1305 | + { |
|
1306 | + return EEH_Line_Item::get_descendants_of_type( |
|
1307 | + $parent_line_item, |
|
1308 | + EEM_Line_Item::type_line_item |
|
1309 | + ); |
|
1310 | + } |
|
1311 | + |
|
1312 | + |
|
1313 | + /** |
|
1314 | + * Gets all descendants of supplied line item that match the supplied line item type |
|
1315 | + * |
|
1316 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1317 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1318 | + * @param string $line_item_type one of the EEM_Line_Item constants |
|
1319 | + * @return EE_Line_Item[] |
|
1320 | + * @throws EE_Error |
|
1321 | + */ |
|
1322 | + public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type) |
|
1323 | + { |
|
1324 | + return self::_get_descendants_by_type_and_object_type( |
|
1325 | + $parent_line_item, |
|
1326 | + $line_item_type, |
|
1327 | + null |
|
1328 | + ); |
|
1329 | + } |
|
1330 | + |
|
1331 | + |
|
1332 | + /** |
|
1333 | + * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
1334 | + * as well |
|
1335 | + * |
|
1336 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1337 | + * @param string $line_item_type one of the EEM_Line_Item constants |
|
1338 | + * @param string | NULL $obj_type object model class name (minus prefix) or NULL to ignore object type when |
|
1339 | + * searching |
|
1340 | + * @return EE_Line_Item[] |
|
1341 | + * @throws EE_Error |
|
1342 | + */ |
|
1343 | + protected static function _get_descendants_by_type_and_object_type( |
|
1344 | + EE_Line_Item $parent_line_item, |
|
1345 | + $line_item_type, |
|
1346 | + $obj_type = null |
|
1347 | + ) { |
|
1348 | + $objects = array(); |
|
1349 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
1350 | + if ($child_line_item instanceof EE_Line_Item) { |
|
1351 | + if ($child_line_item->type() === $line_item_type |
|
1352 | + && ( |
|
1353 | + $child_line_item->OBJ_type() === $obj_type || $obj_type === null |
|
1354 | + ) |
|
1355 | + ) { |
|
1356 | + $objects[] = $child_line_item; |
|
1357 | + } else { |
|
1358 | + // go-through-all-its children looking for more matches |
|
1359 | + $objects = array_merge( |
|
1360 | + $objects, |
|
1361 | + self::_get_descendants_by_type_and_object_type( |
|
1362 | + $child_line_item, |
|
1363 | + $line_item_type, |
|
1364 | + $obj_type |
|
1365 | + ) |
|
1366 | + ); |
|
1367 | + } |
|
1368 | + } |
|
1369 | + } |
|
1370 | + return $objects; |
|
1371 | + } |
|
1372 | + |
|
1373 | + |
|
1374 | + /** |
|
1375 | + * Gets all descendants subtotals that match the supplied object type |
|
1376 | + * |
|
1377 | + * @uses EEH_Line_Item::_get_descendants_by_type_and_object_type() |
|
1378 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1379 | + * @param string $OBJ_type object type (like Event) |
|
1380 | + * @param array $OBJ_IDs array of OBJ_IDs |
|
1381 | + * @return EE_Line_Item[] |
|
1382 | + * @throws EE_Error |
|
1383 | + */ |
|
1384 | + public static function get_line_items_by_object_type_and_IDs( |
|
1385 | + EE_Line_Item $parent_line_item, |
|
1386 | + $OBJ_type = '', |
|
1387 | + $OBJ_IDs = array() |
|
1388 | + ) { |
|
1389 | + return self::_get_descendants_by_object_type_and_object_ID( |
|
1390 | + $parent_line_item, |
|
1391 | + $OBJ_type, |
|
1392 | + $OBJ_IDs |
|
1393 | + ); |
|
1394 | + } |
|
1395 | + |
|
1396 | + |
|
1397 | + /** |
|
1398 | + * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type |
|
1399 | + * as well |
|
1400 | + * |
|
1401 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1402 | + * @param string $OBJ_type object type (like Event) |
|
1403 | + * @param array $OBJ_IDs array of OBJ_IDs |
|
1404 | + * @return EE_Line_Item[] |
|
1405 | + * @throws EE_Error |
|
1406 | + */ |
|
1407 | + protected static function _get_descendants_by_object_type_and_object_ID( |
|
1408 | + EE_Line_Item $parent_line_item, |
|
1409 | + $OBJ_type, |
|
1410 | + $OBJ_IDs |
|
1411 | + ) { |
|
1412 | + $objects = array(); |
|
1413 | + foreach ($parent_line_item->children() as $child_line_item) { |
|
1414 | + if ($child_line_item instanceof EE_Line_Item) { |
|
1415 | + if ($child_line_item->OBJ_type() === $OBJ_type |
|
1416 | + && is_array($OBJ_IDs) |
|
1417 | + && in_array($child_line_item->OBJ_ID(), $OBJ_IDs) |
|
1418 | + ) { |
|
1419 | + $objects[] = $child_line_item; |
|
1420 | + } else { |
|
1421 | + // go-through-all-its children looking for more matches |
|
1422 | + $objects = array_merge( |
|
1423 | + $objects, |
|
1424 | + self::_get_descendants_by_object_type_and_object_ID( |
|
1425 | + $child_line_item, |
|
1426 | + $OBJ_type, |
|
1427 | + $OBJ_IDs |
|
1428 | + ) |
|
1429 | + ); |
|
1430 | + } |
|
1431 | + } |
|
1432 | + } |
|
1433 | + return $objects; |
|
1434 | + } |
|
1435 | + |
|
1436 | + |
|
1437 | + /** |
|
1438 | + * Uses a breadth-first-search in order to find the nearest descendant of |
|
1439 | + * the specified type and returns it, else NULL |
|
1440 | + * |
|
1441 | + * @uses EEH_Line_Item::_get_nearest_descendant() |
|
1442 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1443 | + * @param string $type like one of the EEM_Line_Item::type_* |
|
1444 | + * @return EE_Line_Item |
|
1445 | + * @throws EE_Error |
|
1446 | + * @throws InvalidArgumentException |
|
1447 | + * @throws InvalidDataTypeException |
|
1448 | + * @throws InvalidInterfaceException |
|
1449 | + * @throws ReflectionException |
|
1450 | + */ |
|
1451 | + public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type) |
|
1452 | + { |
|
1453 | + return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type); |
|
1454 | + } |
|
1455 | + |
|
1456 | + |
|
1457 | + /** |
|
1458 | + * Uses a breadth-first-search in order to find the nearest descendant |
|
1459 | + * having the specified LIN_code and returns it, else NULL |
|
1460 | + * |
|
1461 | + * @uses EEH_Line_Item::_get_nearest_descendant() |
|
1462 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1463 | + * @param string $code any value used for LIN_code |
|
1464 | + * @return EE_Line_Item |
|
1465 | + * @throws EE_Error |
|
1466 | + * @throws InvalidArgumentException |
|
1467 | + * @throws InvalidDataTypeException |
|
1468 | + * @throws InvalidInterfaceException |
|
1469 | + * @throws ReflectionException |
|
1470 | + */ |
|
1471 | + public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code) |
|
1472 | + { |
|
1473 | + return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code); |
|
1474 | + } |
|
1475 | + |
|
1476 | + |
|
1477 | + /** |
|
1478 | + * Uses a breadth-first-search in order to find the nearest descendant |
|
1479 | + * having the specified LIN_code and returns it, else NULL |
|
1480 | + * |
|
1481 | + * @param EE_Line_Item $parent_line_item - the line item to find descendants of |
|
1482 | + * @param string $search_field name of EE_Line_Item property |
|
1483 | + * @param string $value any value stored in $search_field |
|
1484 | + * @return EE_Line_Item |
|
1485 | + * @throws EE_Error |
|
1486 | + * @throws InvalidArgumentException |
|
1487 | + * @throws InvalidDataTypeException |
|
1488 | + * @throws InvalidInterfaceException |
|
1489 | + * @throws ReflectionException |
|
1490 | + */ |
|
1491 | + protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value) |
|
1492 | + { |
|
1493 | + foreach ($parent_line_item->children() as $child) { |
|
1494 | + if ($child->get($search_field) == $value) { |
|
1495 | + return $child; |
|
1496 | + } |
|
1497 | + } |
|
1498 | + foreach ($parent_line_item->children() as $child) { |
|
1499 | + $descendant_found = self::_get_nearest_descendant( |
|
1500 | + $child, |
|
1501 | + $search_field, |
|
1502 | + $value |
|
1503 | + ); |
|
1504 | + if ($descendant_found) { |
|
1505 | + return $descendant_found; |
|
1506 | + } |
|
1507 | + } |
|
1508 | + return null; |
|
1509 | + } |
|
1510 | + |
|
1511 | + |
|
1512 | + /** |
|
1513 | + * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction, |
|
1514 | + * else recursively walks up the line item tree until a parent of type total is found, |
|
1515 | + * |
|
1516 | + * @param EE_Line_Item $line_item |
|
1517 | + * @return EE_Line_Item |
|
1518 | + * @throws EE_Error |
|
1519 | + */ |
|
1520 | + public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item) |
|
1521 | + { |
|
1522 | + if ($line_item->TXN_ID()) { |
|
1523 | + $total_line_item = $line_item->transaction()->total_line_item(false); |
|
1524 | + if ($total_line_item instanceof EE_Line_Item) { |
|
1525 | + return $total_line_item; |
|
1526 | + } |
|
1527 | + } else { |
|
1528 | + $line_item_parent = $line_item->parent(); |
|
1529 | + if ($line_item_parent instanceof EE_Line_Item) { |
|
1530 | + if ($line_item_parent->is_total()) { |
|
1531 | + return $line_item_parent; |
|
1532 | + } |
|
1533 | + return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent); |
|
1534 | + } |
|
1535 | + } |
|
1536 | + throw new EE_Error( |
|
1537 | + sprintf( |
|
1538 | + esc_html__( |
|
1539 | + 'A valid grand total for line item %1$d was not found.', |
|
1540 | + 'event_espresso' |
|
1541 | + ), |
|
1542 | + $line_item->ID() |
|
1543 | + ) |
|
1544 | + ); |
|
1545 | + } |
|
1546 | + |
|
1547 | + |
|
1548 | + /** |
|
1549 | + * Prints out a representation of the line item tree |
|
1550 | + * |
|
1551 | + * @param EE_Line_Item $line_item |
|
1552 | + * @param int $indentation |
|
1553 | + * @return void |
|
1554 | + * @throws EE_Error |
|
1555 | + */ |
|
1556 | + public static function visualize(EE_Line_Item $line_item, $indentation = 0) |
|
1557 | + { |
|
1558 | + echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
1559 | + if (! $indentation) { |
|
1560 | + echo defined('EE_TESTS_DIR') ? "\n" : '<br />'; |
|
1561 | + } |
|
1562 | + for ($i = 0; $i < $indentation; $i++) { |
|
1563 | + echo '. '; |
|
1564 | + } |
|
1565 | + $breakdown = ''; |
|
1566 | + if ($line_item->is_line_item()) { |
|
1567 | + if ($line_item->is_percent()) { |
|
1568 | + $breakdown = "{$line_item->percent()}%"; |
|
1569 | + } else { |
|
1570 | + $breakdown = '$' . "{$line_item->unit_price()} x {$line_item->quantity()}"; |
|
1571 | + } |
|
1572 | + } |
|
1573 | + echo $line_item->name(); |
|
1574 | + echo " [ ID:{$line_item->ID()} | qty:{$line_item->quantity()} ] {$line_item->type()} : "; |
|
1575 | + echo '$' . (string) $line_item->total(); |
|
1576 | + if ($breakdown) { |
|
1577 | + echo " ( {$breakdown} )"; |
|
1578 | + } |
|
1579 | + if ($line_item->is_taxable()) { |
|
1580 | + echo ' * taxable'; |
|
1581 | + } |
|
1582 | + if ($line_item->children()) { |
|
1583 | + foreach ($line_item->children() as $child) { |
|
1584 | + self::visualize($child, $indentation + 1); |
|
1585 | + } |
|
1586 | + } |
|
1587 | + } |
|
1588 | + |
|
1589 | + |
|
1590 | + /** |
|
1591 | + * Calculates the registration's final price, taking into account that they |
|
1592 | + * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes, |
|
1593 | + * and receive a portion of any transaction-wide discounts. |
|
1594 | + * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount |
|
1595 | + * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get |
|
1596 | + * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50 |
|
1597 | + * and brent's final price should be $5.50. |
|
1598 | + * In order to do this, we basically need to traverse the line item tree calculating |
|
1599 | + * the running totals (just as if we were recalculating the total), but when we identify |
|
1600 | + * regular line items, we need to keep track of their share of the grand total. |
|
1601 | + * Also, we need to keep track of the TAXABLE total for each ticket purchase, so |
|
1602 | + * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total" |
|
1603 | + * when there are non-taxable items; otherwise they would be the same) |
|
1604 | + * |
|
1605 | + * @param EE_Line_Item $line_item |
|
1606 | + * @param array $billable_ticket_quantities array of EE_Ticket IDs and their corresponding quantity that |
|
1607 | + * can be included in price calculations at this moment |
|
1608 | + * @return array keys are line items for tickets IDs and values are their share of the running total, |
|
1609 | + * plus the key 'total', and 'taxable' which also has keys of all |
|
1610 | + * the ticket IDs. |
|
1611 | + * Eg array( |
|
1612 | + * 12 => 4.3 |
|
1613 | + * 23 => 8.0 |
|
1614 | + * 'total' => 16.6, |
|
1615 | + * 'taxable' => array( |
|
1616 | + * 12 => 10, |
|
1617 | + * 23 => 4 |
|
1618 | + * ). |
|
1619 | + * So to find which registrations have which final price, we need |
|
1620 | + * to find which line item is theirs, which can be done with |
|
1621 | + * `EEM_Line_Item::instance()->get_line_item_for_registration( |
|
1622 | + * $registration );` |
|
1623 | + * @throws EE_Error |
|
1624 | + * @throws InvalidArgumentException |
|
1625 | + * @throws InvalidDataTypeException |
|
1626 | + * @throws InvalidInterfaceException |
|
1627 | + * @throws ReflectionException |
|
1628 | + */ |
|
1629 | + public static function calculate_reg_final_prices_per_line_item( |
|
1630 | + EE_Line_Item $line_item, |
|
1631 | + $billable_ticket_quantities = array() |
|
1632 | + ) { |
|
1633 | + $running_totals = [ |
|
1634 | + 'total' => 0, |
|
1635 | + 'taxable' => ['total' => 0] |
|
1636 | + ]; |
|
1637 | + foreach ($line_item->children() as $child_line_item) { |
|
1638 | + switch ($child_line_item->type()) { |
|
1639 | + case EEM_Line_Item::type_sub_total: |
|
1640 | + $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
1641 | + $child_line_item, |
|
1642 | + $billable_ticket_quantities |
|
1643 | + ); |
|
1644 | + // combine arrays but preserve numeric keys |
|
1645 | + $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals); |
|
1646 | + $running_totals['total'] += $running_totals_from_subtotal['total']; |
|
1647 | + $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total']; |
|
1648 | + break; |
|
1649 | + |
|
1650 | + case EEM_Line_Item::type_tax_sub_total: |
|
1651 | + // find how much the taxes percentage is |
|
1652 | + if ($child_line_item->percent() !== 0) { |
|
1653 | + $tax_percent_decimal = $child_line_item->percent() / 100; |
|
1654 | + } else { |
|
1655 | + $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100; |
|
1656 | + } |
|
1657 | + // and apply to all the taxable totals, and add to the pretax totals |
|
1658 | + foreach ($running_totals as $line_item_id => $this_running_total) { |
|
1659 | + // "total" and "taxable" array key is an exception |
|
1660 | + if ($line_item_id === 'taxable') { |
|
1661 | + continue; |
|
1662 | + } |
|
1663 | + $taxable_total = $running_totals['taxable'][ $line_item_id ]; |
|
1664 | + $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal); |
|
1665 | + } |
|
1666 | + break; |
|
1667 | + |
|
1668 | + case EEM_Line_Item::type_line_item: |
|
1669 | + // ticket line items or ???? |
|
1670 | + if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) { |
|
1671 | + // kk it's a ticket |
|
1672 | + if (isset($running_totals[ $child_line_item->ID() ])) { |
|
1673 | + // huh? that shouldn't happen. |
|
1674 | + $running_totals['total'] += $child_line_item->total(); |
|
1675 | + } else { |
|
1676 | + // its not in our running totals yet. great. |
|
1677 | + if ($child_line_item->is_taxable()) { |
|
1678 | + $taxable_amount = $child_line_item->unit_price(); |
|
1679 | + } else { |
|
1680 | + $taxable_amount = 0; |
|
1681 | + } |
|
1682 | + // are we only calculating totals for some tickets? |
|
1683 | + if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) { |
|
1684 | + $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ]; |
|
1685 | + $running_totals[ $child_line_item->ID() ] = $quantity |
|
1686 | + ? $child_line_item->unit_price() |
|
1687 | + : 0; |
|
1688 | + $running_totals['taxable'][ $child_line_item->ID() ] = $quantity |
|
1689 | + ? $taxable_amount |
|
1690 | + : 0; |
|
1691 | + } else { |
|
1692 | + $quantity = $child_line_item->quantity(); |
|
1693 | + $running_totals[ $child_line_item->ID() ] = $child_line_item->unit_price(); |
|
1694 | + $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount; |
|
1695 | + } |
|
1696 | + $running_totals['taxable']['total'] += $taxable_amount * $quantity; |
|
1697 | + $running_totals['total'] += $child_line_item->unit_price() * $quantity; |
|
1698 | + } |
|
1699 | + } else { |
|
1700 | + // it's some other type of item added to the cart |
|
1701 | + // it should affect the running totals |
|
1702 | + // basically we want to convert it into a PERCENT modifier. Because |
|
1703 | + // more clearly affect all registration's final price equally |
|
1704 | + $line_items_percent_of_running_total = $running_totals['total'] > 0 |
|
1705 | + ? ($child_line_item->total() / $running_totals['total']) + 1 |
|
1706 | + : 1; |
|
1707 | + foreach ($running_totals as $line_item_id => $this_running_total) { |
|
1708 | + // the "taxable" array key is an exception |
|
1709 | + if ($line_item_id === 'taxable') { |
|
1710 | + continue; |
|
1711 | + } |
|
1712 | + // update the running totals |
|
1713 | + // yes this actually even works for the running grand total! |
|
1714 | + $running_totals[ $line_item_id ] = |
|
1715 | + $line_items_percent_of_running_total * $this_running_total; |
|
1716 | + |
|
1717 | + if ($child_line_item->is_taxable()) { |
|
1718 | + $running_totals['taxable'][ $line_item_id ] = |
|
1719 | + $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ]; |
|
1720 | + } |
|
1721 | + } |
|
1722 | + } |
|
1723 | + break; |
|
1724 | + } |
|
1725 | + } |
|
1726 | + return $running_totals; |
|
1727 | + } |
|
1728 | + |
|
1729 | + |
|
1730 | + /** |
|
1731 | + * @param EE_Line_Item $total_line_item |
|
1732 | + * @param EE_Line_Item $ticket_line_item |
|
1733 | + * @return float | null |
|
1734 | + * @throws EE_Error |
|
1735 | + * @throws InvalidArgumentException |
|
1736 | + * @throws InvalidDataTypeException |
|
1737 | + * @throws InvalidInterfaceException |
|
1738 | + * @throws OutOfRangeException |
|
1739 | + * @throws ReflectionException |
|
1740 | + */ |
|
1741 | + public static function calculate_final_price_for_ticket_line_item( |
|
1742 | + EE_Line_Item $total_line_item, |
|
1743 | + EE_Line_Item $ticket_line_item |
|
1744 | + ) { |
|
1745 | + static $final_prices_per_ticket_line_item = array(); |
|
1746 | + if (empty($final_prices_per_ticket_line_item)) { |
|
1747 | + $final_prices_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( |
|
1748 | + $total_line_item |
|
1749 | + ); |
|
1750 | + } |
|
1751 | + // ok now find this new registration's final price |
|
1752 | + if (isset($final_prices_per_ticket_line_item[ $ticket_line_item->ID() ])) { |
|
1753 | + return $final_prices_per_ticket_line_item[ $ticket_line_item->ID() ]; |
|
1754 | + } |
|
1755 | + $message = sprintf( |
|
1756 | + esc_html__( |
|
1757 | + 'The final price for the ticket line item (ID:%1$d) could not be calculated.', |
|
1758 | + 'event_espresso' |
|
1759 | + ), |
|
1760 | + $ticket_line_item->ID() |
|
1761 | + ); |
|
1762 | + if (WP_DEBUG) { |
|
1763 | + $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true); |
|
1764 | + throw new OutOfRangeException($message); |
|
1765 | + } |
|
1766 | + EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message); |
|
1767 | + return null; |
|
1768 | + } |
|
1769 | + |
|
1770 | + |
|
1771 | + /** |
|
1772 | + * Creates a duplicate of the line item tree, except only includes billable items |
|
1773 | + * and the portion of line items attributed to billable things |
|
1774 | + * |
|
1775 | + * @param EE_Line_Item $line_item |
|
1776 | + * @param EE_Registration[] $registrations |
|
1777 | + * @return EE_Line_Item |
|
1778 | + * @throws EE_Error |
|
1779 | + * @throws InvalidArgumentException |
|
1780 | + * @throws InvalidDataTypeException |
|
1781 | + * @throws InvalidInterfaceException |
|
1782 | + * @throws ReflectionException |
|
1783 | + */ |
|
1784 | + public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations) |
|
1785 | + { |
|
1786 | + $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations); |
|
1787 | + foreach ($line_item->children() as $child_li) { |
|
1788 | + $copy_li->add_child_line_item( |
|
1789 | + EEH_Line_Item::billable_line_item_tree($child_li, $registrations) |
|
1790 | + ); |
|
1791 | + } |
|
1792 | + // if this is the grand total line item, make sure the totals all add up |
|
1793 | + // (we could have duplicated this logic AS we copied the line items, but |
|
1794 | + // it seems DRYer this way) |
|
1795 | + if ($copy_li->type() === EEM_Line_Item::type_total) { |
|
1796 | + $copy_li->recalculate_total_including_taxes(); |
|
1797 | + } |
|
1798 | + return $copy_li; |
|
1799 | + } |
|
1800 | + |
|
1801 | + |
|
1802 | + /** |
|
1803 | + * Creates a new, unsaved line item from $line_item that factors in the |
|
1804 | + * number of billable registrations on $registrations. |
|
1805 | + * |
|
1806 | + * @param EE_Line_Item $line_item |
|
1807 | + * @param EE_Registration[] $registrations |
|
1808 | + * @return EE_Line_Item |
|
1809 | + * @throws EE_Error |
|
1810 | + * @throws InvalidArgumentException |
|
1811 | + * @throws InvalidDataTypeException |
|
1812 | + * @throws InvalidInterfaceException |
|
1813 | + * @throws ReflectionException |
|
1814 | + */ |
|
1815 | + public static function billable_line_item(EE_Line_Item $line_item, $registrations) |
|
1816 | + { |
|
1817 | + $new_li_fields = $line_item->model_field_array(); |
|
1818 | + if ($line_item->type() === EEM_Line_Item::type_line_item && |
|
1819 | + $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1820 | + ) { |
|
1821 | + $count = 0; |
|
1822 | + foreach ($registrations as $registration) { |
|
1823 | + if ($line_item->OBJ_ID() === $registration->ticket_ID() && |
|
1824 | + in_array( |
|
1825 | + $registration->status_ID(), |
|
1826 | + EEM_Registration::reg_statuses_that_allow_payment(), |
|
1827 | + true |
|
1828 | + ) |
|
1829 | + ) { |
|
1830 | + $count++; |
|
1831 | + } |
|
1832 | + } |
|
1833 | + $new_li_fields['LIN_quantity'] = $count; |
|
1834 | + } |
|
1835 | + // don't set the total. We'll leave that up to the code that calculates it |
|
1836 | + unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']); |
|
1837 | + return EE_Line_Item::new_instance($new_li_fields); |
|
1838 | + } |
|
1839 | + |
|
1840 | + |
|
1841 | + /** |
|
1842 | + * Returns a modified line item tree where all the subtotals which have a total of 0 |
|
1843 | + * are removed, and line items with a quantity of 0 |
|
1844 | + * |
|
1845 | + * @param EE_Line_Item $line_item |null |
|
1846 | + * @return EE_Line_Item|null |
|
1847 | + * @throws EE_Error |
|
1848 | + * @throws InvalidArgumentException |
|
1849 | + * @throws InvalidDataTypeException |
|
1850 | + * @throws InvalidInterfaceException |
|
1851 | + * @throws ReflectionException |
|
1852 | + */ |
|
1853 | + public static function non_empty_line_items(EE_Line_Item $line_item) |
|
1854 | + { |
|
1855 | + $copied_li = EEH_Line_Item::non_empty_line_item($line_item); |
|
1856 | + if ($copied_li === null) { |
|
1857 | + return null; |
|
1858 | + } |
|
1859 | + // if this is an event subtotal, we want to only include it if it |
|
1860 | + // has a non-zero total and at least one ticket line item child |
|
1861 | + $ticket_children = 0; |
|
1862 | + foreach ($line_item->children() as $child_li) { |
|
1863 | + $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li); |
|
1864 | + if ($child_li_copy !== null) { |
|
1865 | + $copied_li->add_child_line_item($child_li_copy); |
|
1866 | + if ($child_li_copy->type() === EEM_Line_Item::type_line_item && |
|
1867 | + $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1868 | + ) { |
|
1869 | + $ticket_children++; |
|
1870 | + } |
|
1871 | + } |
|
1872 | + } |
|
1873 | + // if this is an event subtotal with NO ticket children |
|
1874 | + // we basically want to ignore it |
|
1875 | + if ($ticket_children === 0 |
|
1876 | + && $line_item->type() === EEM_Line_Item::type_sub_total |
|
1877 | + && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT |
|
1878 | + && $line_item->total() === 0 |
|
1879 | + ) { |
|
1880 | + return null; |
|
1881 | + } |
|
1882 | + return $copied_li; |
|
1883 | + } |
|
1884 | + |
|
1885 | + |
|
1886 | + /** |
|
1887 | + * Creates a new, unsaved line item, but if it's a ticket line item |
|
1888 | + * with a total of 0, or a subtotal of 0, returns null instead |
|
1889 | + * |
|
1890 | + * @param EE_Line_Item $line_item |
|
1891 | + * @return EE_Line_Item |
|
1892 | + * @throws EE_Error |
|
1893 | + * @throws InvalidArgumentException |
|
1894 | + * @throws InvalidDataTypeException |
|
1895 | + * @throws InvalidInterfaceException |
|
1896 | + * @throws ReflectionException |
|
1897 | + */ |
|
1898 | + public static function non_empty_line_item(EE_Line_Item $line_item) |
|
1899 | + { |
|
1900 | + if ($line_item->type() === EEM_Line_Item::type_line_item |
|
1901 | + && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1902 | + && $line_item->quantity() === 0 |
|
1903 | + ) { |
|
1904 | + return null; |
|
1905 | + } |
|
1906 | + $new_li_fields = $line_item->model_field_array(); |
|
1907 | + // don't set the total. We'll leave that up to the code that calculates it |
|
1908 | + unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']); |
|
1909 | + return EE_Line_Item::new_instance($new_li_fields); |
|
1910 | + } |
|
1911 | + |
|
1912 | + |
|
1913 | + /** |
|
1914 | + * Cycles through all of the ticket line items for the supplied total line item |
|
1915 | + * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket |
|
1916 | + * |
|
1917 | + * @param EE_Line_Item $total_line_item |
|
1918 | + * @since 4.9.79.p |
|
1919 | + * @throws EE_Error |
|
1920 | + * @throws InvalidArgumentException |
|
1921 | + * @throws InvalidDataTypeException |
|
1922 | + * @throws InvalidInterfaceException |
|
1923 | + * @throws ReflectionException |
|
1924 | + */ |
|
1925 | + public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item) |
|
1926 | + { |
|
1927 | + $ticket_line_items = self::get_ticket_line_items($total_line_item); |
|
1928 | + foreach ($ticket_line_items as $ticket_line_item) { |
|
1929 | + if ($ticket_line_item instanceof EE_Line_Item |
|
1930 | + && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET |
|
1931 | + ) { |
|
1932 | + $ticket = $ticket_line_item->ticket(); |
|
1933 | + if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) { |
|
1934 | + $ticket_line_item->set_is_taxable($ticket->taxable()); |
|
1935 | + $ticket_line_item->save(); |
|
1936 | + } |
|
1937 | + } |
|
1938 | + } |
|
1939 | + } |
|
1940 | + |
|
1941 | + |
|
1942 | + |
|
1943 | + /**************************************** @DEPRECATED METHODS *************************************** */ |
|
1944 | + /** |
|
1945 | + * @deprecated |
|
1946 | + * @param EE_Line_Item $total_line_item |
|
1947 | + * @return EE_Line_Item |
|
1948 | + * @throws EE_Error |
|
1949 | + * @throws InvalidArgumentException |
|
1950 | + * @throws InvalidDataTypeException |
|
1951 | + * @throws InvalidInterfaceException |
|
1952 | + * @throws ReflectionException |
|
1953 | + */ |
|
1954 | + public static function get_items_subtotal(EE_Line_Item $total_line_item) |
|
1955 | + { |
|
1956 | + EE_Error::doing_it_wrong( |
|
1957 | + 'EEH_Line_Item::get_items_subtotal()', |
|
1958 | + sprintf( |
|
1959 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
1960 | + 'EEH_Line_Item::get_pre_tax_subtotal()' |
|
1961 | + ), |
|
1962 | + '4.6.0' |
|
1963 | + ); |
|
1964 | + return self::get_pre_tax_subtotal($total_line_item); |
|
1965 | + } |
|
1966 | + |
|
1967 | + |
|
1968 | + /** |
|
1969 | + * @deprecated |
|
1970 | + * @param EE_Transaction $transaction |
|
1971 | + * @return EE_Line_Item |
|
1972 | + * @throws EE_Error |
|
1973 | + * @throws InvalidArgumentException |
|
1974 | + * @throws InvalidDataTypeException |
|
1975 | + * @throws InvalidInterfaceException |
|
1976 | + * @throws ReflectionException |
|
1977 | + */ |
|
1978 | + public static function create_default_total_line_item($transaction = null) |
|
1979 | + { |
|
1980 | + EE_Error::doing_it_wrong( |
|
1981 | + 'EEH_Line_Item::create_default_total_line_item()', |
|
1982 | + sprintf( |
|
1983 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
1984 | + 'EEH_Line_Item::create_total_line_item()' |
|
1985 | + ), |
|
1986 | + '4.6.0' |
|
1987 | + ); |
|
1988 | + return self::create_total_line_item($transaction); |
|
1989 | + } |
|
1990 | + |
|
1991 | + |
|
1992 | + /** |
|
1993 | + * @deprecated |
|
1994 | + * @param EE_Line_Item $total_line_item |
|
1995 | + * @param EE_Transaction $transaction |
|
1996 | + * @return EE_Line_Item |
|
1997 | + * @throws EE_Error |
|
1998 | + * @throws InvalidArgumentException |
|
1999 | + * @throws InvalidDataTypeException |
|
2000 | + * @throws InvalidInterfaceException |
|
2001 | + * @throws ReflectionException |
|
2002 | + */ |
|
2003 | + public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2004 | + { |
|
2005 | + EE_Error::doing_it_wrong( |
|
2006 | + 'EEH_Line_Item::create_default_tickets_subtotal()', |
|
2007 | + sprintf( |
|
2008 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2009 | + 'EEH_Line_Item::create_pre_tax_subtotal()' |
|
2010 | + ), |
|
2011 | + '4.6.0' |
|
2012 | + ); |
|
2013 | + return self::create_pre_tax_subtotal($total_line_item, $transaction); |
|
2014 | + } |
|
2015 | + |
|
2016 | + |
|
2017 | + /** |
|
2018 | + * @deprecated |
|
2019 | + * @param EE_Line_Item $total_line_item |
|
2020 | + * @param EE_Transaction $transaction |
|
2021 | + * @return EE_Line_Item |
|
2022 | + * @throws EE_Error |
|
2023 | + * @throws InvalidArgumentException |
|
2024 | + * @throws InvalidDataTypeException |
|
2025 | + * @throws InvalidInterfaceException |
|
2026 | + * @throws ReflectionException |
|
2027 | + */ |
|
2028 | + public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2029 | + { |
|
2030 | + EE_Error::doing_it_wrong( |
|
2031 | + 'EEH_Line_Item::create_default_taxes_subtotal()', |
|
2032 | + sprintf( |
|
2033 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2034 | + 'EEH_Line_Item::create_taxes_subtotal()' |
|
2035 | + ), |
|
2036 | + '4.6.0' |
|
2037 | + ); |
|
2038 | + return self::create_taxes_subtotal($total_line_item, $transaction); |
|
2039 | + } |
|
2040 | + |
|
2041 | + |
|
2042 | + /** |
|
2043 | + * @deprecated |
|
2044 | + * @param EE_Line_Item $total_line_item |
|
2045 | + * @param EE_Transaction $transaction |
|
2046 | + * @return EE_Line_Item |
|
2047 | + * @throws EE_Error |
|
2048 | + * @throws InvalidArgumentException |
|
2049 | + * @throws InvalidDataTypeException |
|
2050 | + * @throws InvalidInterfaceException |
|
2051 | + * @throws ReflectionException |
|
2052 | + */ |
|
2053 | + public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null) |
|
2054 | + { |
|
2055 | + EE_Error::doing_it_wrong( |
|
2056 | + 'EEH_Line_Item::create_default_event_subtotal()', |
|
2057 | + sprintf( |
|
2058 | + esc_html__('Method replaced with %1$s', 'event_espresso'), |
|
2059 | + 'EEH_Line_Item::create_event_subtotal()' |
|
2060 | + ), |
|
2061 | + '4.6.0' |
|
2062 | + ); |
|
2063 | + return self::create_event_subtotal($total_line_item, $transaction); |
|
2064 | + } |
|
2065 | 2065 | } |
@@ -12,2671 +12,2671 @@ |
||
12 | 12 | class Events_Admin_Page extends EE_Admin_Page_CPT |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * This will hold the event object for event_details screen. |
|
17 | - * |
|
18 | - * @access protected |
|
19 | - * @var EE_Event $_event |
|
20 | - */ |
|
21 | - protected $_event; |
|
22 | - |
|
23 | - |
|
24 | - /** |
|
25 | - * This will hold the category object for category_details screen. |
|
26 | - * |
|
27 | - * @var stdClass $_category |
|
28 | - */ |
|
29 | - protected $_category; |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * This will hold the event model instance |
|
34 | - * |
|
35 | - * @var EEM_Event $_event_model |
|
36 | - */ |
|
37 | - protected $_event_model; |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @var EE_Event |
|
42 | - */ |
|
43 | - protected $_cpt_model_obj = false; |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * Initialize page props for this admin page group. |
|
48 | - */ |
|
49 | - protected function _init_page_props() |
|
50 | - { |
|
51 | - $this->page_slug = EVENTS_PG_SLUG; |
|
52 | - $this->page_label = EVENTS_LABEL; |
|
53 | - $this->_admin_base_url = EVENTS_ADMIN_URL; |
|
54 | - $this->_admin_base_path = EVENTS_ADMIN; |
|
55 | - $this->_cpt_model_names = array( |
|
56 | - 'create_new' => 'EEM_Event', |
|
57 | - 'edit' => 'EEM_Event', |
|
58 | - ); |
|
59 | - $this->_cpt_edit_routes = array( |
|
60 | - 'espresso_events' => 'edit', |
|
61 | - ); |
|
62 | - add_action( |
|
63 | - 'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object', |
|
64 | - array($this, 'verify_event_edit'), |
|
65 | - 10, |
|
66 | - 2 |
|
67 | - ); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * Sets the ajax hooks used for this admin page group. |
|
73 | - */ |
|
74 | - protected function _ajax_hooks() |
|
75 | - { |
|
76 | - add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting')); |
|
77 | - } |
|
78 | - |
|
79 | - |
|
80 | - /** |
|
81 | - * Sets the page properties for this admin page group. |
|
82 | - */ |
|
83 | - protected function _define_page_props() |
|
84 | - { |
|
85 | - $this->_admin_page_title = EVENTS_LABEL; |
|
86 | - $this->_labels = array( |
|
87 | - 'buttons' => array( |
|
88 | - 'add' => esc_html__('Add New Event', 'event_espresso'), |
|
89 | - 'edit' => esc_html__('Edit Event', 'event_espresso'), |
|
90 | - 'delete' => esc_html__('Delete Event', 'event_espresso'), |
|
91 | - 'add_category' => esc_html__('Add New Category', 'event_espresso'), |
|
92 | - 'edit_category' => esc_html__('Edit Category', 'event_espresso'), |
|
93 | - 'delete_category' => esc_html__('Delete Category', 'event_espresso'), |
|
94 | - ), |
|
95 | - 'editor_title' => array( |
|
96 | - 'espresso_events' => esc_html__('Enter event title here', 'event_espresso'), |
|
97 | - ), |
|
98 | - 'publishbox' => array( |
|
99 | - 'create_new' => esc_html__('Save New Event', 'event_espresso'), |
|
100 | - 'edit' => esc_html__('Update Event', 'event_espresso'), |
|
101 | - 'add_category' => esc_html__('Save New Category', 'event_espresso'), |
|
102 | - 'edit_category' => esc_html__('Update Category', 'event_espresso'), |
|
103 | - 'template_settings' => esc_html__('Update Settings', 'event_espresso'), |
|
104 | - ), |
|
105 | - ); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * Sets the page routes property for this admin page group. |
|
111 | - */ |
|
112 | - protected function _set_page_routes() |
|
113 | - { |
|
114 | - // load formatter helper |
|
115 | - // load field generator helper |
|
116 | - // is there a evt_id in the request? |
|
117 | - $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID']) |
|
118 | - ? $this->_req_data['EVT_ID'] |
|
119 | - : 0; |
|
120 | - $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id; |
|
121 | - $this->_page_routes = array( |
|
122 | - 'default' => array( |
|
123 | - 'func' => '_events_overview_list_table', |
|
124 | - 'capability' => 'ee_read_events', |
|
125 | - ), |
|
126 | - 'create_new' => array( |
|
127 | - 'func' => '_create_new_cpt_item', |
|
128 | - 'capability' => 'ee_edit_events', |
|
129 | - ), |
|
130 | - 'edit' => array( |
|
131 | - 'func' => '_edit_cpt_item', |
|
132 | - 'capability' => 'ee_edit_event', |
|
133 | - 'obj_id' => $evt_id, |
|
134 | - ), |
|
135 | - 'copy_event' => array( |
|
136 | - 'func' => '_copy_events', |
|
137 | - 'capability' => 'ee_edit_event', |
|
138 | - 'obj_id' => $evt_id, |
|
139 | - 'noheader' => true, |
|
140 | - ), |
|
141 | - 'trash_event' => array( |
|
142 | - 'func' => '_trash_or_restore_event', |
|
143 | - 'args' => array('event_status' => 'trash'), |
|
144 | - 'capability' => 'ee_delete_event', |
|
145 | - 'obj_id' => $evt_id, |
|
146 | - 'noheader' => true, |
|
147 | - ), |
|
148 | - 'trash_events' => array( |
|
149 | - 'func' => '_trash_or_restore_events', |
|
150 | - 'args' => array('event_status' => 'trash'), |
|
151 | - 'capability' => 'ee_delete_events', |
|
152 | - 'noheader' => true, |
|
153 | - ), |
|
154 | - 'restore_event' => array( |
|
155 | - 'func' => '_trash_or_restore_event', |
|
156 | - 'args' => array('event_status' => 'draft'), |
|
157 | - 'capability' => 'ee_delete_event', |
|
158 | - 'obj_id' => $evt_id, |
|
159 | - 'noheader' => true, |
|
160 | - ), |
|
161 | - 'restore_events' => array( |
|
162 | - 'func' => '_trash_or_restore_events', |
|
163 | - 'args' => array('event_status' => 'draft'), |
|
164 | - 'capability' => 'ee_delete_events', |
|
165 | - 'noheader' => true, |
|
166 | - ), |
|
167 | - 'delete_event' => array( |
|
168 | - 'func' => '_delete_event', |
|
169 | - 'capability' => 'ee_delete_event', |
|
170 | - 'obj_id' => $evt_id, |
|
171 | - 'noheader' => true, |
|
172 | - ), |
|
173 | - 'delete_events' => array( |
|
174 | - 'func' => '_delete_events', |
|
175 | - 'capability' => 'ee_delete_events', |
|
176 | - 'noheader' => true, |
|
177 | - ), |
|
178 | - 'view_report' => array( |
|
179 | - 'func' => '_view_report', |
|
180 | - 'capablity' => 'ee_edit_events', |
|
181 | - ), |
|
182 | - 'default_event_settings' => array( |
|
183 | - 'func' => '_default_event_settings', |
|
184 | - 'capability' => 'manage_options', |
|
185 | - ), |
|
186 | - 'update_default_event_settings' => array( |
|
187 | - 'func' => '_update_default_event_settings', |
|
188 | - 'capability' => 'manage_options', |
|
189 | - 'noheader' => true, |
|
190 | - ), |
|
191 | - 'template_settings' => array( |
|
192 | - 'func' => '_template_settings', |
|
193 | - 'capability' => 'manage_options', |
|
194 | - ), |
|
195 | - // event category tab related |
|
196 | - 'add_category' => array( |
|
197 | - 'func' => '_category_details', |
|
198 | - 'capability' => 'ee_edit_event_category', |
|
199 | - 'args' => array('add'), |
|
200 | - ), |
|
201 | - 'edit_category' => array( |
|
202 | - 'func' => '_category_details', |
|
203 | - 'capability' => 'ee_edit_event_category', |
|
204 | - 'args' => array('edit'), |
|
205 | - ), |
|
206 | - 'delete_categories' => array( |
|
207 | - 'func' => '_delete_categories', |
|
208 | - 'capability' => 'ee_delete_event_category', |
|
209 | - 'noheader' => true, |
|
210 | - ), |
|
211 | - 'delete_category' => array( |
|
212 | - 'func' => '_delete_categories', |
|
213 | - 'capability' => 'ee_delete_event_category', |
|
214 | - 'noheader' => true, |
|
215 | - ), |
|
216 | - 'insert_category' => array( |
|
217 | - 'func' => '_insert_or_update_category', |
|
218 | - 'args' => array('new_category' => true), |
|
219 | - 'capability' => 'ee_edit_event_category', |
|
220 | - 'noheader' => true, |
|
221 | - ), |
|
222 | - 'update_category' => array( |
|
223 | - 'func' => '_insert_or_update_category', |
|
224 | - 'args' => array('new_category' => false), |
|
225 | - 'capability' => 'ee_edit_event_category', |
|
226 | - 'noheader' => true, |
|
227 | - ), |
|
228 | - 'category_list' => array( |
|
229 | - 'func' => '_category_list_table', |
|
230 | - 'capability' => 'ee_manage_event_categories', |
|
231 | - ), |
|
232 | - ); |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - /** |
|
237 | - * Set the _page_config property for this admin page group. |
|
238 | - */ |
|
239 | - protected function _set_page_config() |
|
240 | - { |
|
241 | - $this->_page_config = array( |
|
242 | - 'default' => array( |
|
243 | - 'nav' => array( |
|
244 | - 'label' => esc_html__('Overview', 'event_espresso'), |
|
245 | - 'order' => 10, |
|
246 | - ), |
|
247 | - 'list_table' => 'Events_Admin_List_Table', |
|
248 | - 'help_tabs' => array( |
|
249 | - 'events_overview_help_tab' => array( |
|
250 | - 'title' => esc_html__('Events Overview', 'event_espresso'), |
|
251 | - 'filename' => 'events_overview', |
|
252 | - ), |
|
253 | - 'events_overview_table_column_headings_help_tab' => array( |
|
254 | - 'title' => esc_html__('Events Overview Table Column Headings', 'event_espresso'), |
|
255 | - 'filename' => 'events_overview_table_column_headings', |
|
256 | - ), |
|
257 | - 'events_overview_filters_help_tab' => array( |
|
258 | - 'title' => esc_html__('Events Overview Filters', 'event_espresso'), |
|
259 | - 'filename' => 'events_overview_filters', |
|
260 | - ), |
|
261 | - 'events_overview_view_help_tab' => array( |
|
262 | - 'title' => esc_html__('Events Overview Views', 'event_espresso'), |
|
263 | - 'filename' => 'events_overview_views', |
|
264 | - ), |
|
265 | - 'events_overview_other_help_tab' => array( |
|
266 | - 'title' => esc_html__('Events Overview Other', 'event_espresso'), |
|
267 | - 'filename' => 'events_overview_other', |
|
268 | - ), |
|
269 | - ), |
|
270 | - 'help_tour' => array( |
|
271 | - 'Event_Overview_Help_Tour', |
|
272 | - // 'New_Features_Test_Help_Tour' for testing multiple help tour |
|
273 | - ), |
|
274 | - 'qtips' => array( |
|
275 | - 'EE_Event_List_Table_Tips', |
|
276 | - ), |
|
277 | - 'require_nonce' => false, |
|
278 | - ), |
|
279 | - 'create_new' => array( |
|
280 | - 'nav' => array( |
|
281 | - 'label' => esc_html__('Add Event', 'event_espresso'), |
|
282 | - 'order' => 5, |
|
283 | - 'persistent' => false, |
|
284 | - ), |
|
285 | - 'metaboxes' => array('_register_event_editor_meta_boxes'), |
|
286 | - 'help_tabs' => array( |
|
287 | - 'event_editor_help_tab' => array( |
|
288 | - 'title' => esc_html__('Event Editor', 'event_espresso'), |
|
289 | - 'filename' => 'event_editor', |
|
290 | - ), |
|
291 | - 'event_editor_title_richtexteditor_help_tab' => array( |
|
292 | - 'title' => esc_html__('Event Title & Rich Text Editor', 'event_espresso'), |
|
293 | - 'filename' => 'event_editor_title_richtexteditor', |
|
294 | - ), |
|
295 | - 'event_editor_venue_details_help_tab' => array( |
|
296 | - 'title' => esc_html__('Event Venue Details', 'event_espresso'), |
|
297 | - 'filename' => 'event_editor_venue_details', |
|
298 | - ), |
|
299 | - 'event_editor_event_datetimes_help_tab' => array( |
|
300 | - 'title' => esc_html__('Event Datetimes', 'event_espresso'), |
|
301 | - 'filename' => 'event_editor_event_datetimes', |
|
302 | - ), |
|
303 | - 'event_editor_event_tickets_help_tab' => array( |
|
304 | - 'title' => esc_html__('Event Tickets', 'event_espresso'), |
|
305 | - 'filename' => 'event_editor_event_tickets', |
|
306 | - ), |
|
307 | - 'event_editor_event_registration_options_help_tab' => array( |
|
308 | - 'title' => esc_html__('Event Registration Options', 'event_espresso'), |
|
309 | - 'filename' => 'event_editor_event_registration_options', |
|
310 | - ), |
|
311 | - 'event_editor_tags_categories_help_tab' => array( |
|
312 | - 'title' => esc_html__('Event Tags & Categories', 'event_espresso'), |
|
313 | - 'filename' => 'event_editor_tags_categories', |
|
314 | - ), |
|
315 | - 'event_editor_questions_registrants_help_tab' => array( |
|
316 | - 'title' => esc_html__('Questions for Registrants', 'event_espresso'), |
|
317 | - 'filename' => 'event_editor_questions_registrants', |
|
318 | - ), |
|
319 | - 'event_editor_save_new_event_help_tab' => array( |
|
320 | - 'title' => esc_html__('Save New Event', 'event_espresso'), |
|
321 | - 'filename' => 'event_editor_save_new_event', |
|
322 | - ), |
|
323 | - 'event_editor_other_help_tab' => array( |
|
324 | - 'title' => esc_html__('Event Other', 'event_espresso'), |
|
325 | - 'filename' => 'event_editor_other', |
|
326 | - ), |
|
327 | - ), |
|
328 | - 'help_tour' => array( |
|
329 | - 'Event_Editor_Help_Tour', |
|
330 | - ), |
|
331 | - 'qtips' => array('EE_Event_Editor_Decaf_Tips'), |
|
332 | - 'require_nonce' => false, |
|
333 | - ), |
|
334 | - 'edit' => array( |
|
335 | - 'nav' => array( |
|
336 | - 'label' => esc_html__('Edit Event', 'event_espresso'), |
|
337 | - 'order' => 5, |
|
338 | - 'persistent' => false, |
|
339 | - 'url' => isset($this->_req_data['post']) |
|
340 | - ? EE_Admin_Page::add_query_args_and_nonce( |
|
341 | - array('post' => $this->_req_data['post'], 'action' => 'edit'), |
|
342 | - $this->_current_page_view_url |
|
343 | - ) |
|
344 | - : $this->_admin_base_url, |
|
345 | - ), |
|
346 | - 'metaboxes' => array('_register_event_editor_meta_boxes'), |
|
347 | - 'help_tabs' => array( |
|
348 | - 'event_editor_help_tab' => array( |
|
349 | - 'title' => esc_html__('Event Editor', 'event_espresso'), |
|
350 | - 'filename' => 'event_editor', |
|
351 | - ), |
|
352 | - 'event_editor_title_richtexteditor_help_tab' => array( |
|
353 | - 'title' => esc_html__('Event Title & Rich Text Editor', 'event_espresso'), |
|
354 | - 'filename' => 'event_editor_title_richtexteditor', |
|
355 | - ), |
|
356 | - 'event_editor_venue_details_help_tab' => array( |
|
357 | - 'title' => esc_html__('Event Venue Details', 'event_espresso'), |
|
358 | - 'filename' => 'event_editor_venue_details', |
|
359 | - ), |
|
360 | - 'event_editor_event_datetimes_help_tab' => array( |
|
361 | - 'title' => esc_html__('Event Datetimes', 'event_espresso'), |
|
362 | - 'filename' => 'event_editor_event_datetimes', |
|
363 | - ), |
|
364 | - 'event_editor_event_tickets_help_tab' => array( |
|
365 | - 'title' => esc_html__('Event Tickets', 'event_espresso'), |
|
366 | - 'filename' => 'event_editor_event_tickets', |
|
367 | - ), |
|
368 | - 'event_editor_event_registration_options_help_tab' => array( |
|
369 | - 'title' => esc_html__('Event Registration Options', 'event_espresso'), |
|
370 | - 'filename' => 'event_editor_event_registration_options', |
|
371 | - ), |
|
372 | - 'event_editor_tags_categories_help_tab' => array( |
|
373 | - 'title' => esc_html__('Event Tags & Categories', 'event_espresso'), |
|
374 | - 'filename' => 'event_editor_tags_categories', |
|
375 | - ), |
|
376 | - 'event_editor_questions_registrants_help_tab' => array( |
|
377 | - 'title' => esc_html__('Questions for Registrants', 'event_espresso'), |
|
378 | - 'filename' => 'event_editor_questions_registrants', |
|
379 | - ), |
|
380 | - 'event_editor_save_new_event_help_tab' => array( |
|
381 | - 'title' => esc_html__('Save New Event', 'event_espresso'), |
|
382 | - 'filename' => 'event_editor_save_new_event', |
|
383 | - ), |
|
384 | - 'event_editor_other_help_tab' => array( |
|
385 | - 'title' => esc_html__('Event Other', 'event_espresso'), |
|
386 | - 'filename' => 'event_editor_other', |
|
387 | - ), |
|
388 | - ), |
|
389 | - 'qtips' => array('EE_Event_Editor_Decaf_Tips'), |
|
390 | - 'require_nonce' => false, |
|
391 | - ), |
|
392 | - 'default_event_settings' => array( |
|
393 | - 'nav' => array( |
|
394 | - 'label' => esc_html__('Default Settings', 'event_espresso'), |
|
395 | - 'order' => 40, |
|
396 | - ), |
|
397 | - 'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')), |
|
398 | - 'labels' => array( |
|
399 | - 'publishbox' => esc_html__('Update Settings', 'event_espresso'), |
|
400 | - ), |
|
401 | - 'help_tabs' => array( |
|
402 | - 'default_settings_help_tab' => array( |
|
403 | - 'title' => esc_html__('Default Event Settings', 'event_espresso'), |
|
404 | - 'filename' => 'events_default_settings', |
|
405 | - ), |
|
406 | - 'default_settings_status_help_tab' => array( |
|
407 | - 'title' => esc_html__('Default Registration Status', 'event_espresso'), |
|
408 | - 'filename' => 'events_default_settings_status', |
|
409 | - ), |
|
410 | - 'default_maximum_tickets_help_tab' => array( |
|
411 | - 'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'), |
|
412 | - 'filename' => 'events_default_settings_max_tickets', |
|
413 | - ), |
|
414 | - ), |
|
415 | - 'help_tour' => array('Event_Default_Settings_Help_Tour'), |
|
416 | - 'require_nonce' => false, |
|
417 | - ), |
|
418 | - // template settings |
|
419 | - 'template_settings' => array( |
|
420 | - 'nav' => array( |
|
421 | - 'label' => esc_html__('Templates', 'event_espresso'), |
|
422 | - 'order' => 30, |
|
423 | - ), |
|
424 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
425 | - 'help_tabs' => array( |
|
426 | - 'general_settings_templates_help_tab' => array( |
|
427 | - 'title' => esc_html__('Templates', 'event_espresso'), |
|
428 | - 'filename' => 'general_settings_templates', |
|
429 | - ), |
|
430 | - ), |
|
431 | - 'help_tour' => array('Templates_Help_Tour'), |
|
432 | - 'require_nonce' => false, |
|
433 | - ), |
|
434 | - // event category stuff |
|
435 | - 'add_category' => array( |
|
436 | - 'nav' => array( |
|
437 | - 'label' => esc_html__('Add Category', 'event_espresso'), |
|
438 | - 'order' => 15, |
|
439 | - 'persistent' => false, |
|
440 | - ), |
|
441 | - 'help_tabs' => array( |
|
442 | - 'add_category_help_tab' => array( |
|
443 | - 'title' => esc_html__('Add New Event Category', 'event_espresso'), |
|
444 | - 'filename' => 'events_add_category', |
|
445 | - ), |
|
446 | - ), |
|
447 | - 'help_tour' => array('Event_Add_Category_Help_Tour'), |
|
448 | - 'metaboxes' => array('_publish_post_box'), |
|
449 | - 'require_nonce' => false, |
|
450 | - ), |
|
451 | - 'edit_category' => array( |
|
452 | - 'nav' => array( |
|
453 | - 'label' => esc_html__('Edit Category', 'event_espresso'), |
|
454 | - 'order' => 15, |
|
455 | - 'persistent' => false, |
|
456 | - 'url' => isset($this->_req_data['EVT_CAT_ID']) |
|
457 | - ? add_query_arg( |
|
458 | - array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']), |
|
459 | - $this->_current_page_view_url |
|
460 | - ) |
|
461 | - : $this->_admin_base_url, |
|
462 | - ), |
|
463 | - 'help_tabs' => array( |
|
464 | - 'edit_category_help_tab' => array( |
|
465 | - 'title' => esc_html__('Edit Event Category', 'event_espresso'), |
|
466 | - 'filename' => 'events_edit_category', |
|
467 | - ), |
|
468 | - ), |
|
469 | - /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/ |
|
470 | - 'metaboxes' => array('_publish_post_box'), |
|
471 | - 'require_nonce' => false, |
|
472 | - ), |
|
473 | - 'category_list' => array( |
|
474 | - 'nav' => array( |
|
475 | - 'label' => esc_html__('Categories', 'event_espresso'), |
|
476 | - 'order' => 20, |
|
477 | - ), |
|
478 | - 'list_table' => 'Event_Categories_Admin_List_Table', |
|
479 | - 'help_tabs' => array( |
|
480 | - 'events_categories_help_tab' => array( |
|
481 | - 'title' => esc_html__('Event Categories', 'event_espresso'), |
|
482 | - 'filename' => 'events_categories', |
|
483 | - ), |
|
484 | - 'events_categories_table_column_headings_help_tab' => array( |
|
485 | - 'title' => esc_html__('Event Categories Table Column Headings', 'event_espresso'), |
|
486 | - 'filename' => 'events_categories_table_column_headings', |
|
487 | - ), |
|
488 | - 'events_categories_view_help_tab' => array( |
|
489 | - 'title' => esc_html__('Event Categories Views', 'event_espresso'), |
|
490 | - 'filename' => 'events_categories_views', |
|
491 | - ), |
|
492 | - 'events_categories_other_help_tab' => array( |
|
493 | - 'title' => esc_html__('Event Categories Other', 'event_espresso'), |
|
494 | - 'filename' => 'events_categories_other', |
|
495 | - ), |
|
496 | - ), |
|
497 | - 'help_tour' => array( |
|
498 | - 'Event_Categories_Help_Tour', |
|
499 | - ), |
|
500 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
501 | - 'require_nonce' => false, |
|
502 | - ), |
|
503 | - ); |
|
504 | - } |
|
505 | - |
|
506 | - |
|
507 | - /** |
|
508 | - * Used to register any global screen options if necessary for every route in this admin page group. |
|
509 | - */ |
|
510 | - protected function _add_screen_options() |
|
511 | - { |
|
512 | - } |
|
513 | - |
|
514 | - |
|
515 | - /** |
|
516 | - * Implementing the screen options for the 'default' route. |
|
517 | - */ |
|
518 | - protected function _add_screen_options_default() |
|
519 | - { |
|
520 | - $this->_per_page_screen_option(); |
|
521 | - } |
|
522 | - |
|
523 | - |
|
524 | - /** |
|
525 | - * Implementing screen options for the category list route. |
|
526 | - */ |
|
527 | - protected function _add_screen_options_category_list() |
|
528 | - { |
|
529 | - $page_title = $this->_admin_page_title; |
|
530 | - $this->_admin_page_title = esc_html__('Categories', 'event_espresso'); |
|
531 | - $this->_per_page_screen_option(); |
|
532 | - $this->_admin_page_title = $page_title; |
|
533 | - } |
|
534 | - |
|
535 | - |
|
536 | - /** |
|
537 | - * Used to register any global feature pointers for the admin page group. |
|
538 | - */ |
|
539 | - protected function _add_feature_pointers() |
|
540 | - { |
|
541 | - } |
|
542 | - |
|
543 | - |
|
544 | - /** |
|
545 | - * Registers and enqueues any global scripts and styles for the entire admin page group. |
|
546 | - */ |
|
547 | - public function load_scripts_styles() |
|
548 | - { |
|
549 | - wp_register_style( |
|
550 | - 'events-admin-css', |
|
551 | - EVENTS_ASSETS_URL . 'events-admin-page.css', |
|
552 | - array(), |
|
553 | - EVENT_ESPRESSO_VERSION |
|
554 | - ); |
|
555 | - wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION); |
|
556 | - wp_enqueue_style('events-admin-css'); |
|
557 | - wp_enqueue_style('ee-cat-admin'); |
|
558 | - // todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details |
|
559 | - // registers for all views |
|
560 | - // scripts |
|
561 | - wp_register_script( |
|
562 | - 'event_editor_js', |
|
563 | - EVENTS_ASSETS_URL . 'event_editor.js', |
|
564 | - array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'), |
|
565 | - EVENT_ESPRESSO_VERSION, |
|
566 | - true |
|
567 | - ); |
|
568 | - } |
|
569 | - |
|
570 | - |
|
571 | - /** |
|
572 | - * Enqueuing scripts and styles specific to this view |
|
573 | - */ |
|
574 | - public function load_scripts_styles_create_new() |
|
575 | - { |
|
576 | - $this->load_scripts_styles_edit(); |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - /** |
|
581 | - * Enqueuing scripts and styles specific to this view |
|
582 | - */ |
|
583 | - public function load_scripts_styles_edit() |
|
584 | - { |
|
585 | - // styles |
|
586 | - wp_enqueue_style('espresso-ui-theme'); |
|
587 | - wp_register_style( |
|
588 | - 'event-editor-css', |
|
589 | - EVENTS_ASSETS_URL . 'event-editor.css', |
|
590 | - array('ee-admin-css'), |
|
591 | - EVENT_ESPRESSO_VERSION |
|
592 | - ); |
|
593 | - wp_enqueue_style('event-editor-css'); |
|
594 | - // scripts |
|
595 | - wp_register_script( |
|
596 | - 'event-datetime-metabox', |
|
597 | - EVENTS_ASSETS_URL . 'event-datetime-metabox.js', |
|
598 | - array('event_editor_js', 'ee-datepicker'), |
|
599 | - EVENT_ESPRESSO_VERSION |
|
600 | - ); |
|
601 | - wp_enqueue_script('event-datetime-metabox'); |
|
602 | - } |
|
603 | - |
|
604 | - |
|
605 | - /** |
|
606 | - * Populating the _views property for the category list table view. |
|
607 | - */ |
|
608 | - protected function _set_list_table_views_category_list() |
|
609 | - { |
|
610 | - $this->_views = array( |
|
611 | - 'all' => array( |
|
612 | - 'slug' => 'all', |
|
613 | - 'label' => esc_html__('All', 'event_espresso'), |
|
614 | - 'count' => 0, |
|
615 | - 'bulk_action' => array( |
|
616 | - 'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'), |
|
617 | - ), |
|
618 | - ), |
|
619 | - ); |
|
620 | - } |
|
621 | - |
|
622 | - |
|
623 | - /** |
|
624 | - * For adding anything that fires on the admin_init hook for any route within this admin page group. |
|
625 | - */ |
|
626 | - public function admin_init() |
|
627 | - { |
|
628 | - EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__( |
|
629 | - 'Do you really want to delete this image? Please remember to update your event to complete the removal.', |
|
630 | - 'event_espresso' |
|
631 | - ); |
|
632 | - } |
|
633 | - |
|
634 | - |
|
635 | - /** |
|
636 | - * For adding anything that should be triggered on the admin_notices hook for any route within this admin page |
|
637 | - * group. |
|
638 | - */ |
|
639 | - public function admin_notices() |
|
640 | - { |
|
641 | - } |
|
642 | - |
|
643 | - |
|
644 | - /** |
|
645 | - * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within |
|
646 | - * this admin page group. |
|
647 | - */ |
|
648 | - public function admin_footer_scripts() |
|
649 | - { |
|
650 | - } |
|
651 | - |
|
652 | - |
|
653 | - /** |
|
654 | - * Call this function to verify if an event is public and has tickets for sale. If it does, then we need to show a |
|
655 | - * warning (via EE_Error::add_error()); |
|
656 | - * |
|
657 | - * @param EE_Event $event Event object |
|
658 | - * @param string $req_type |
|
659 | - * @return void |
|
660 | - * @throws EE_Error |
|
661 | - * @access public |
|
662 | - */ |
|
663 | - public function verify_event_edit($event = null, $req_type = '') |
|
664 | - { |
|
665 | - // don't need to do this when processing |
|
666 | - if (! empty($req_type)) { |
|
667 | - return; |
|
668 | - } |
|
669 | - // no event? |
|
670 | - if (empty($event)) { |
|
671 | - // set event |
|
672 | - $event = $this->_cpt_model_obj; |
|
673 | - } |
|
674 | - // STILL no event? |
|
675 | - if (! $event instanceof EE_Event) { |
|
676 | - return; |
|
677 | - } |
|
678 | - $orig_status = $event->status(); |
|
679 | - // first check if event is active. |
|
680 | - if ($orig_status === EEM_Event::cancelled |
|
681 | - || $orig_status === EEM_Event::postponed |
|
682 | - || $event->is_expired() |
|
683 | - || $event->is_inactive() |
|
684 | - ) { |
|
685 | - return; |
|
686 | - } |
|
687 | - // made it here so it IS active... next check that any of the tickets are sold. |
|
688 | - if ($event->is_sold_out(true)) { |
|
689 | - if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) { |
|
690 | - EE_Error::add_attention( |
|
691 | - sprintf( |
|
692 | - esc_html__( |
|
693 | - 'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event. However, this change is not permanent until you update the event. You can change the status back to something else before updating if you wish.', |
|
694 | - 'event_espresso' |
|
695 | - ), |
|
696 | - EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence') |
|
697 | - ) |
|
698 | - ); |
|
699 | - } |
|
700 | - return; |
|
701 | - } elseif ($orig_status === EEM_Event::sold_out) { |
|
702 | - EE_Error::add_attention( |
|
703 | - sprintf( |
|
704 | - esc_html__( |
|
705 | - 'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets. However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.', |
|
706 | - 'event_espresso' |
|
707 | - ), |
|
708 | - EEH_Template::pretty_status($event->status(), false, 'sentence') |
|
709 | - ) |
|
710 | - ); |
|
711 | - } |
|
712 | - // now we need to determine if the event has any tickets on sale. If not then we dont' show the error |
|
713 | - if (! $event->tickets_on_sale()) { |
|
714 | - return; |
|
715 | - } |
|
716 | - // made it here so show warning |
|
717 | - $this->_edit_event_warning(); |
|
718 | - } |
|
719 | - |
|
720 | - |
|
721 | - /** |
|
722 | - * This is the text used for when an event is being edited that is public and has tickets for sale. |
|
723 | - * When needed, hook this into a EE_Error::add_error() notice. |
|
724 | - * |
|
725 | - * @access protected |
|
726 | - * @return void |
|
727 | - */ |
|
728 | - protected function _edit_event_warning() |
|
729 | - { |
|
730 | - // we don't want to add warnings during these requests |
|
731 | - if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') { |
|
732 | - return; |
|
733 | - } |
|
734 | - EE_Error::add_attention( |
|
735 | - sprintf( |
|
736 | - esc_html__( |
|
737 | - 'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s', |
|
738 | - 'event_espresso' |
|
739 | - ), |
|
740 | - '<a class="espresso-help-tab-lnk">', |
|
741 | - '</a>' |
|
742 | - ) |
|
743 | - ); |
|
744 | - } |
|
745 | - |
|
746 | - |
|
747 | - /** |
|
748 | - * When a user is creating a new event, notify them if they haven't set their timezone. |
|
749 | - * Otherwise, do the normal logic |
|
750 | - * |
|
751 | - * @return string |
|
752 | - * @throws \EE_Error |
|
753 | - */ |
|
754 | - protected function _create_new_cpt_item() |
|
755 | - { |
|
756 | - $has_timezone_string = get_option('timezone_string'); |
|
757 | - // only nag them about setting their timezone if it's their first event, and they haven't already done it |
|
758 | - if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) { |
|
759 | - EE_Error::add_attention( |
|
760 | - sprintf( |
|
761 | - __( |
|
762 | - 'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s', |
|
763 | - 'event_espresso' |
|
764 | - ), |
|
765 | - '<br>', |
|
766 | - '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">' |
|
767 | - . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale()) |
|
768 | - . '</select>', |
|
769 | - '<button class="button button-secondary timezone-submit">', |
|
770 | - '</button><span class="spinner"></span>' |
|
771 | - ), |
|
772 | - __FILE__, |
|
773 | - __FUNCTION__, |
|
774 | - __LINE__ |
|
775 | - ); |
|
776 | - } |
|
777 | - return parent::_create_new_cpt_item(); |
|
778 | - } |
|
779 | - |
|
780 | - |
|
781 | - /** |
|
782 | - * Sets the _views property for the default route in this admin page group. |
|
783 | - */ |
|
784 | - protected function _set_list_table_views_default() |
|
785 | - { |
|
786 | - $this->_views = array( |
|
787 | - 'all' => array( |
|
788 | - 'slug' => 'all', |
|
789 | - 'label' => esc_html__('View All Events', 'event_espresso'), |
|
790 | - 'count' => 0, |
|
791 | - 'bulk_action' => array( |
|
792 | - 'trash_events' => esc_html__('Move to Trash', 'event_espresso'), |
|
793 | - ), |
|
794 | - ), |
|
795 | - 'draft' => array( |
|
796 | - 'slug' => 'draft', |
|
797 | - 'label' => esc_html__('Draft', 'event_espresso'), |
|
798 | - 'count' => 0, |
|
799 | - 'bulk_action' => array( |
|
800 | - 'trash_events' => esc_html__('Move to Trash', 'event_espresso'), |
|
801 | - ), |
|
802 | - ), |
|
803 | - ); |
|
804 | - if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) { |
|
805 | - $this->_views['trash'] = array( |
|
806 | - 'slug' => 'trash', |
|
807 | - 'label' => esc_html__('Trash', 'event_espresso'), |
|
808 | - 'count' => 0, |
|
809 | - 'bulk_action' => array( |
|
810 | - 'restore_events' => esc_html__('Restore From Trash', 'event_espresso'), |
|
811 | - 'delete_events' => esc_html__('Delete Permanently', 'event_espresso'), |
|
812 | - ), |
|
813 | - ); |
|
814 | - } |
|
815 | - } |
|
816 | - |
|
817 | - |
|
818 | - /** |
|
819 | - * Provides the legend item array for the default list table view. |
|
820 | - * |
|
821 | - * @return array |
|
822 | - */ |
|
823 | - protected function _event_legend_items() |
|
824 | - { |
|
825 | - $items = array( |
|
826 | - 'view_details' => array( |
|
827 | - 'class' => 'dashicons dashicons-search', |
|
828 | - 'desc' => esc_html__('View Event', 'event_espresso'), |
|
829 | - ), |
|
830 | - 'edit_event' => array( |
|
831 | - 'class' => 'ee-icon ee-icon-calendar-edit', |
|
832 | - 'desc' => esc_html__('Edit Event Details', 'event_espresso'), |
|
833 | - ), |
|
834 | - 'view_attendees' => array( |
|
835 | - 'class' => 'dashicons dashicons-groups', |
|
836 | - 'desc' => esc_html__('View Registrations for Event', 'event_espresso'), |
|
837 | - ), |
|
838 | - ); |
|
839 | - $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items); |
|
840 | - $statuses = array( |
|
841 | - 'sold_out_status' => array( |
|
842 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out, |
|
843 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'), |
|
844 | - ), |
|
845 | - 'active_status' => array( |
|
846 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active, |
|
847 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'), |
|
848 | - ), |
|
849 | - 'upcoming_status' => array( |
|
850 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming, |
|
851 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'), |
|
852 | - ), |
|
853 | - 'postponed_status' => array( |
|
854 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed, |
|
855 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'), |
|
856 | - ), |
|
857 | - 'cancelled_status' => array( |
|
858 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled, |
|
859 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'), |
|
860 | - ), |
|
861 | - 'expired_status' => array( |
|
862 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired, |
|
863 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'), |
|
864 | - ), |
|
865 | - 'inactive_status' => array( |
|
866 | - 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive, |
|
867 | - 'desc' => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'), |
|
868 | - ), |
|
869 | - ); |
|
870 | - $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses); |
|
871 | - return array_merge($items, $statuses); |
|
872 | - } |
|
873 | - |
|
874 | - |
|
875 | - /** |
|
876 | - * @return EEM_Event |
|
877 | - */ |
|
878 | - private function _event_model() |
|
879 | - { |
|
880 | - if (! $this->_event_model instanceof EEM_Event) { |
|
881 | - $this->_event_model = EE_Registry::instance()->load_model('Event'); |
|
882 | - } |
|
883 | - return $this->_event_model; |
|
884 | - } |
|
885 | - |
|
886 | - |
|
887 | - /** |
|
888 | - * Adds extra buttons to the WP CPT permalink field row. |
|
889 | - * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
890 | - * |
|
891 | - * @param string $return the current html |
|
892 | - * @param int $id the post id for the page |
|
893 | - * @param string $new_title What the title is |
|
894 | - * @param string $new_slug what the slug is |
|
895 | - * @return string The new html string for the permalink area |
|
896 | - */ |
|
897 | - public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug) |
|
898 | - { |
|
899 | - // make sure this is only when editing |
|
900 | - if (! empty($id)) { |
|
901 | - $post = get_post($id); |
|
902 | - $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#" tabindex="-1">' |
|
903 | - . esc_html__('Shortcode', 'event_espresso') |
|
904 | - . '</a> '; |
|
905 | - $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id=' |
|
906 | - . $post->ID |
|
907 | - . ']">'; |
|
908 | - } |
|
909 | - return $return; |
|
910 | - } |
|
911 | - |
|
912 | - |
|
913 | - /** |
|
914 | - * _events_overview_list_table |
|
915 | - * This contains the logic for showing the events_overview list |
|
916 | - * |
|
917 | - * @access protected |
|
918 | - * @return void |
|
919 | - * @throws \EE_Error |
|
920 | - */ |
|
921 | - protected function _events_overview_list_table() |
|
922 | - { |
|
923 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
924 | - $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table']) |
|
925 | - ? (array) $this->_template_args['after_list_table'] |
|
926 | - : array(); |
|
927 | - $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br() |
|
928 | - . EEH_Template::get_button_or_link( |
|
929 | - get_post_type_archive_link('espresso_events'), |
|
930 | - esc_html__("View Event Archive Page", "event_espresso"), |
|
931 | - 'button' |
|
932 | - ); |
|
933 | - $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items()); |
|
934 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
935 | - 'create_new', |
|
936 | - 'add', |
|
937 | - array(), |
|
938 | - 'add-new-h2' |
|
939 | - ); |
|
940 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
941 | - } |
|
942 | - |
|
943 | - |
|
944 | - /** |
|
945 | - * this allows for extra misc actions in the default WP publish box |
|
946 | - * |
|
947 | - * @return void |
|
948 | - */ |
|
949 | - public function extra_misc_actions_publish_box() |
|
950 | - { |
|
951 | - $this->_generate_publish_box_extra_content(); |
|
952 | - } |
|
953 | - |
|
954 | - |
|
955 | - /** |
|
956 | - * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
957 | - * saved. |
|
958 | - * Typically you would use this to save any additional data. |
|
959 | - * Keep in mind also that "save_post" runs on EVERY post update to the database. |
|
960 | - * ALSO very important. When a post transitions from scheduled to published, |
|
961 | - * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from |
|
962 | - * other meta saves. So MAKE sure that you handle this accordingly. |
|
963 | - * |
|
964 | - * @access protected |
|
965 | - * @abstract |
|
966 | - * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
967 | - * @param object $post The post object of the cpt that was saved. |
|
968 | - * @return void |
|
969 | - * @throws \EE_Error |
|
970 | - */ |
|
971 | - protected function _insert_update_cpt_item($post_id, $post) |
|
972 | - { |
|
973 | - if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') { |
|
974 | - // get out we're not processing an event save. |
|
975 | - return; |
|
976 | - } |
|
977 | - $event_values = array( |
|
978 | - 'EVT_display_desc' => ! empty($this->_req_data['display_desc']) ? 1 : 0, |
|
979 | - 'EVT_display_ticket_selector' => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0, |
|
980 | - 'EVT_additional_limit' => min( |
|
981 | - apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255), |
|
982 | - ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null |
|
983 | - ), |
|
984 | - 'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status']) |
|
985 | - ? $this->_req_data['EVT_default_registration_status'] |
|
986 | - : EE_Registry::instance()->CFG->registration->default_STS_ID, |
|
987 | - 'EVT_member_only' => ! empty($this->_req_data['member_only']) ? 1 : 0, |
|
988 | - 'EVT_allow_overflow' => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0, |
|
989 | - 'EVT_timezone_string' => ! empty($this->_req_data['timezone_string']) |
|
990 | - ? $this->_req_data['timezone_string'] : null, |
|
991 | - 'EVT_external_URL' => ! empty($this->_req_data['externalURL']) |
|
992 | - ? $this->_req_data['externalURL'] : null, |
|
993 | - 'EVT_phone' => ! empty($this->_req_data['event_phone']) |
|
994 | - ? $this->_req_data['event_phone'] : null, |
|
995 | - ); |
|
996 | - // update event |
|
997 | - $success = $this->_event_model()->update_by_ID($event_values, $post_id); |
|
998 | - // get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id! |
|
999 | - $get_one_where = array( |
|
1000 | - $this->_event_model()->primary_key_name() => $post_id, |
|
1001 | - 'OR' => array( |
|
1002 | - 'status' => $post->post_status, |
|
1003 | - // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db, |
|
1004 | - // but the returned object here has a status of "publish", so use the original post status as well |
|
1005 | - 'status*1' => $this->_req_data['original_post_status'], |
|
1006 | - ), |
|
1007 | - ); |
|
1008 | - $event = $this->_event_model()->get_one(array($get_one_where)); |
|
1009 | - // the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons. |
|
1010 | - $event_update_callbacks = apply_filters( |
|
1011 | - 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
1012 | - array( |
|
1013 | - array($this, '_default_venue_update'), |
|
1014 | - array($this, '_default_tickets_update'), |
|
1015 | - ) |
|
1016 | - ); |
|
1017 | - $att_success = true; |
|
1018 | - foreach ($event_update_callbacks as $e_callback) { |
|
1019 | - $_success = is_callable($e_callback) |
|
1020 | - ? call_user_func($e_callback, $event, $this->_req_data) |
|
1021 | - : false; |
|
1022 | - // if ANY of these updates fail then we want the appropriate global error message |
|
1023 | - $att_success = ! $att_success ? $att_success : $_success; |
|
1024 | - } |
|
1025 | - // any errors? |
|
1026 | - if ($success && false === $att_success) { |
|
1027 | - EE_Error::add_error( |
|
1028 | - esc_html__( |
|
1029 | - 'Event Details saved successfully but something went wrong with saving attachments.', |
|
1030 | - 'event_espresso' |
|
1031 | - ), |
|
1032 | - __FILE__, |
|
1033 | - __FUNCTION__, |
|
1034 | - __LINE__ |
|
1035 | - ); |
|
1036 | - } elseif ($success === false) { |
|
1037 | - EE_Error::add_error( |
|
1038 | - esc_html__('Event Details did not save successfully.', 'event_espresso'), |
|
1039 | - __FILE__, |
|
1040 | - __FUNCTION__, |
|
1041 | - __LINE__ |
|
1042 | - ); |
|
1043 | - } |
|
1044 | - } |
|
1045 | - |
|
1046 | - |
|
1047 | - /** |
|
1048 | - * @see parent::restore_item() |
|
1049 | - * @param int $post_id |
|
1050 | - * @param int $revision_id |
|
1051 | - */ |
|
1052 | - protected function _restore_cpt_item($post_id, $revision_id) |
|
1053 | - { |
|
1054 | - // copy existing event meta to new post |
|
1055 | - $post_evt = $this->_event_model()->get_one_by_ID($post_id); |
|
1056 | - if ($post_evt instanceof EE_Event) { |
|
1057 | - // meta revision restore |
|
1058 | - $post_evt->restore_revision($revision_id); |
|
1059 | - // related objs restore |
|
1060 | - $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price')); |
|
1061 | - } |
|
1062 | - } |
|
1063 | - |
|
1064 | - |
|
1065 | - /** |
|
1066 | - * Attach the venue to the Event |
|
1067 | - * |
|
1068 | - * @param \EE_Event $evtobj Event Object to add the venue to |
|
1069 | - * @param array $data The request data from the form |
|
1070 | - * @return bool Success or fail. |
|
1071 | - */ |
|
1072 | - protected function _default_venue_update(\EE_Event $evtobj, $data) |
|
1073 | - { |
|
1074 | - require_once(EE_MODELS . 'EEM_Venue.model.php'); |
|
1075 | - $venue_model = EE_Registry::instance()->load_model('Venue'); |
|
1076 | - $rows_affected = null; |
|
1077 | - $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null; |
|
1078 | - // very important. If we don't have a venue name... |
|
1079 | - // then we'll get out because not necessary to create empty venue |
|
1080 | - if (empty($data['venue_title'])) { |
|
1081 | - return false; |
|
1082 | - } |
|
1083 | - $venue_array = array( |
|
1084 | - 'VNU_wp_user' => $evtobj->get('EVT_wp_user'), |
|
1085 | - 'VNU_name' => ! empty($data['venue_title']) ? $data['venue_title'] : null, |
|
1086 | - 'VNU_desc' => ! empty($data['venue_description']) ? $data['venue_description'] : null, |
|
1087 | - 'VNU_identifier' => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null, |
|
1088 | - 'VNU_short_desc' => ! empty($data['venue_short_description']) ? $data['venue_short_description'] |
|
1089 | - : null, |
|
1090 | - 'VNU_address' => ! empty($data['address']) ? $data['address'] : null, |
|
1091 | - 'VNU_address2' => ! empty($data['address2']) ? $data['address2'] : null, |
|
1092 | - 'VNU_city' => ! empty($data['city']) ? $data['city'] : null, |
|
1093 | - 'STA_ID' => ! empty($data['state']) ? $data['state'] : null, |
|
1094 | - 'CNT_ISO' => ! empty($data['countries']) ? $data['countries'] : null, |
|
1095 | - 'VNU_zip' => ! empty($data['zip']) ? $data['zip'] : null, |
|
1096 | - 'VNU_phone' => ! empty($data['venue_phone']) ? $data['venue_phone'] : null, |
|
1097 | - 'VNU_capacity' => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null, |
|
1098 | - 'VNU_url' => ! empty($data['venue_url']) ? $data['venue_url'] : null, |
|
1099 | - 'VNU_virtual_phone' => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null, |
|
1100 | - 'VNU_virtual_url' => ! empty($data['virtual_url']) ? $data['virtual_url'] : null, |
|
1101 | - 'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0, |
|
1102 | - 'status' => 'publish', |
|
1103 | - ); |
|
1104 | - // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out. |
|
1105 | - if (! empty($venue_id)) { |
|
1106 | - $update_where = array($venue_model->primary_key_name() => $venue_id); |
|
1107 | - $rows_affected = $venue_model->update($venue_array, array($update_where)); |
|
1108 | - // we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present. |
|
1109 | - $evtobj->_add_relation_to($venue_id, 'Venue'); |
|
1110 | - return $rows_affected > 0 ? true : false; |
|
1111 | - } else { |
|
1112 | - // we insert the venue |
|
1113 | - $venue_id = $venue_model->insert($venue_array); |
|
1114 | - $evtobj->_add_relation_to($venue_id, 'Venue'); |
|
1115 | - return ! empty($venue_id) ? true : false; |
|
1116 | - } |
|
1117 | - // when we have the ancestor come in it's already been handled by the revision save. |
|
1118 | - } |
|
1119 | - |
|
1120 | - |
|
1121 | - /** |
|
1122 | - * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
1123 | - * |
|
1124 | - * @param EE_Event $evtobj The Event object we're attaching data to |
|
1125 | - * @param array $data The request data from the form |
|
1126 | - * @return array |
|
1127 | - */ |
|
1128 | - protected function _default_tickets_update(EE_Event $evtobj, $data) |
|
1129 | - { |
|
1130 | - $success = true; |
|
1131 | - $saved_dtt = null; |
|
1132 | - $saved_tickets = array(); |
|
1133 | - $incoming_date_formats = array('Y-m-d', 'h:i a'); |
|
1134 | - foreach ($data['edit_event_datetimes'] as $row => $dtt) { |
|
1135 | - // trim all values to ensure any excess whitespace is removed. |
|
1136 | - $dtt = array_map('trim', $dtt); |
|
1137 | - $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end'] |
|
1138 | - : $dtt['DTT_EVT_start']; |
|
1139 | - $datetime_values = array( |
|
1140 | - 'DTT_ID' => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null, |
|
1141 | - 'DTT_EVT_start' => $dtt['DTT_EVT_start'], |
|
1142 | - 'DTT_EVT_end' => $dtt['DTT_EVT_end'], |
|
1143 | - 'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'], |
|
1144 | - 'DTT_order' => $row, |
|
1145 | - ); |
|
1146 | - // if we have an id then let's get existing object first and then set the new values. Otherwise we instantiate a new object for save. |
|
1147 | - if (! empty($dtt['DTT_ID'])) { |
|
1148 | - $DTM = EE_Registry::instance() |
|
1149 | - ->load_model('Datetime', array($evtobj->get_timezone())) |
|
1150 | - ->get_one_by_ID($dtt['DTT_ID']); |
|
1151 | - $DTM->set_date_format($incoming_date_formats[0]); |
|
1152 | - $DTM->set_time_format($incoming_date_formats[1]); |
|
1153 | - foreach ($datetime_values as $field => $value) { |
|
1154 | - $DTM->set($field, $value); |
|
1155 | - } |
|
1156 | - // make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it. We need to do this so we dont' TRASH the parent DTT. |
|
1157 | - $saved_dtts[ $DTM->ID() ] = $DTM; |
|
1158 | - } else { |
|
1159 | - $DTM = EE_Registry::instance()->load_class( |
|
1160 | - 'Datetime', |
|
1161 | - array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats), |
|
1162 | - false, |
|
1163 | - false |
|
1164 | - ); |
|
1165 | - foreach ($datetime_values as $field => $value) { |
|
1166 | - $DTM->set($field, $value); |
|
1167 | - } |
|
1168 | - } |
|
1169 | - $DTM->save(); |
|
1170 | - $DTT = $evtobj->_add_relation_to($DTM, 'Datetime'); |
|
1171 | - // load DTT helper |
|
1172 | - // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date. |
|
1173 | - if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) { |
|
1174 | - $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start')); |
|
1175 | - $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days'); |
|
1176 | - $DTT->save(); |
|
1177 | - } |
|
1178 | - // now we got to make sure we add the new DTT_ID to the $saved_dtts array because it is possible there was a new one created for the autosave. |
|
1179 | - $saved_dtt = $DTT; |
|
1180 | - $success = ! $success ? $success : $DTT; |
|
1181 | - // if ANY of these updates fail then we want the appropriate global error message. |
|
1182 | - // //todo this is actually sucky we need a better error message but this is what it is for now. |
|
1183 | - } |
|
1184 | - // no dtts get deleted so we don't do any of that logic here. |
|
1185 | - // update tickets next |
|
1186 | - $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
1187 | - foreach ($data['edit_tickets'] as $row => $tkt) { |
|
1188 | - $incoming_date_formats = array('Y-m-d', 'h:i a'); |
|
1189 | - $update_prices = false; |
|
1190 | - $ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount']) |
|
1191 | - ? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0; |
|
1192 | - // trim inputs to ensure any excess whitespace is removed. |
|
1193 | - $tkt = array_map('trim', $tkt); |
|
1194 | - if (empty($tkt['TKT_start_date'])) { |
|
1195 | - // let's use now in the set timezone. |
|
1196 | - $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone())); |
|
1197 | - $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]); |
|
1198 | - } |
|
1199 | - if (empty($tkt['TKT_end_date'])) { |
|
1200 | - // use the start date of the first datetime |
|
1201 | - $dtt = $evtobj->first_datetime(); |
|
1202 | - $tkt['TKT_end_date'] = $dtt->start_date_and_time( |
|
1203 | - $incoming_date_formats[0], |
|
1204 | - $incoming_date_formats[1] |
|
1205 | - ); |
|
1206 | - } |
|
1207 | - $TKT_values = array( |
|
1208 | - 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
1209 | - 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
1210 | - 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
1211 | - 'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '', |
|
1212 | - 'TKT_start_date' => $tkt['TKT_start_date'], |
|
1213 | - 'TKT_end_date' => $tkt['TKT_end_date'], |
|
1214 | - 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'], |
|
1215 | - 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'], |
|
1216 | - 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
1217 | - 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
1218 | - 'TKT_row' => $row, |
|
1219 | - 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row, |
|
1220 | - 'TKT_price' => $ticket_price, |
|
1221 | - ); |
|
1222 | - // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well. |
|
1223 | - if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
1224 | - $TKT_values['TKT_ID'] = 0; |
|
1225 | - $TKT_values['TKT_is_default'] = 0; |
|
1226 | - $TKT_values['TKT_price'] = $ticket_price; |
|
1227 | - $update_prices = true; |
|
1228 | - } |
|
1229 | - // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
1230 | - // we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified. |
|
1231 | - // keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
1232 | - if (! empty($tkt['TKT_ID'])) { |
|
1233 | - $TKT = EE_Registry::instance() |
|
1234 | - ->load_model('Ticket', array($evtobj->get_timezone())) |
|
1235 | - ->get_one_by_ID($tkt['TKT_ID']); |
|
1236 | - if ($TKT instanceof EE_Ticket) { |
|
1237 | - $ticket_sold = $TKT->count_related( |
|
1238 | - 'Registration', |
|
1239 | - array( |
|
1240 | - array( |
|
1241 | - 'STS_ID' => array( |
|
1242 | - 'NOT IN', |
|
1243 | - array(EEM_Registration::status_id_incomplete), |
|
1244 | - ), |
|
1245 | - ), |
|
1246 | - ) |
|
1247 | - ) > 0 ? true : false; |
|
1248 | - // let's just check the total price for the existing ticket and determine if it matches the new total price. if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket. |
|
1249 | - $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price') |
|
1250 | - && ! $TKT->get('TKT_deleted'); |
|
1251 | - $TKT->set_date_format($incoming_date_formats[0]); |
|
1252 | - $TKT->set_time_format($incoming_date_formats[1]); |
|
1253 | - // set new values |
|
1254 | - foreach ($TKT_values as $field => $value) { |
|
1255 | - if ($field == 'TKT_qty') { |
|
1256 | - $TKT->set_qty($value); |
|
1257 | - } else { |
|
1258 | - $TKT->set($field, $value); |
|
1259 | - } |
|
1260 | - } |
|
1261 | - // if $create_new_TKT is false then we can safely update the existing ticket. Otherwise we have to create a new ticket. |
|
1262 | - if ($create_new_TKT) { |
|
1263 | - // archive the old ticket first |
|
1264 | - $TKT->set('TKT_deleted', 1); |
|
1265 | - $TKT->save(); |
|
1266 | - // make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine. |
|
1267 | - $saved_tickets[ $TKT->ID() ] = $TKT; |
|
1268 | - // create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it. |
|
1269 | - $TKT = clone $TKT; |
|
1270 | - $TKT->set('TKT_ID', 0); |
|
1271 | - $TKT->set('TKT_deleted', 0); |
|
1272 | - $TKT->set('TKT_price', $ticket_price); |
|
1273 | - $TKT->set('TKT_sold', 0); |
|
1274 | - // now we need to make sure that $new prices are created as well and attached to new ticket. |
|
1275 | - $update_prices = true; |
|
1276 | - } |
|
1277 | - // make sure price is set if it hasn't been already |
|
1278 | - $TKT->set('TKT_price', $ticket_price); |
|
1279 | - } |
|
1280 | - } else { |
|
1281 | - // no TKT_id so a new TKT |
|
1282 | - $TKT_values['TKT_price'] = $ticket_price; |
|
1283 | - $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false); |
|
1284 | - if ($TKT instanceof EE_Ticket) { |
|
1285 | - // need to reset values to properly account for the date formats |
|
1286 | - $TKT->set_date_format($incoming_date_formats[0]); |
|
1287 | - $TKT->set_time_format($incoming_date_formats[1]); |
|
1288 | - $TKT->set_timezone($evtobj->get_timezone()); |
|
1289 | - // set new values |
|
1290 | - foreach ($TKT_values as $field => $value) { |
|
1291 | - if ($field == 'TKT_qty') { |
|
1292 | - $TKT->set_qty($value); |
|
1293 | - } else { |
|
1294 | - $TKT->set($field, $value); |
|
1295 | - } |
|
1296 | - } |
|
1297 | - $update_prices = true; |
|
1298 | - } |
|
1299 | - } |
|
1300 | - // cap ticket qty by datetime reg limits |
|
1301 | - $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit'))); |
|
1302 | - // update ticket. |
|
1303 | - $TKT->save(); |
|
1304 | - // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date. |
|
1305 | - if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) { |
|
1306 | - $TKT->set('TKT_end_date', $TKT->get('TKT_start_date')); |
|
1307 | - $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days'); |
|
1308 | - $TKT->save(); |
|
1309 | - } |
|
1310 | - // initially let's add the ticket to the dtt |
|
1311 | - $saved_dtt->_add_relation_to($TKT, 'Ticket'); |
|
1312 | - $saved_tickets[ $TKT->ID() ] = $TKT; |
|
1313 | - // add prices to ticket |
|
1314 | - $this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices); |
|
1315 | - } |
|
1316 | - // however now we need to handle permanently deleting tickets via the ui. Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold. However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db. |
|
1317 | - $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets; |
|
1318 | - $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
1319 | - foreach ($tickets_removed as $id) { |
|
1320 | - $id = absint($id); |
|
1321 | - // get the ticket for this id |
|
1322 | - $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
1323 | - // need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold) |
|
1324 | - $dtts = $tkt_to_remove->get_many_related('Datetime'); |
|
1325 | - foreach ($dtts as $dtt) { |
|
1326 | - $tkt_to_remove->_remove_relation_to($dtt, 'Datetime'); |
|
1327 | - } |
|
1328 | - // need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
1329 | - $tkt_to_remove->delete_related_permanently('Price'); |
|
1330 | - // finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships) |
|
1331 | - $tkt_to_remove->delete_permanently(); |
|
1332 | - } |
|
1333 | - return array($saved_dtt, $saved_tickets); |
|
1334 | - } |
|
1335 | - |
|
1336 | - |
|
1337 | - /** |
|
1338 | - * This attaches a list of given prices to a ticket. |
|
1339 | - * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
1340 | - * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
1341 | - * price info and prices are automatically "archived" via the ticket. |
|
1342 | - * |
|
1343 | - * @access private |
|
1344 | - * @param array $prices Array of prices from the form. |
|
1345 | - * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
1346 | - * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
1347 | - * @return void |
|
1348 | - */ |
|
1349 | - private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false) |
|
1350 | - { |
|
1351 | - foreach ($prices as $row => $prc) { |
|
1352 | - $PRC_values = array( |
|
1353 | - 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
1354 | - 'PRT_ID' => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null, |
|
1355 | - 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
1356 | - 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
1357 | - 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
1358 | - 'PRC_is_default' => 0, // make sure prices are NOT set as default from this context |
|
1359 | - 'PRC_order' => $row, |
|
1360 | - ); |
|
1361 | - if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
1362 | - $PRC_values['PRC_ID'] = 0; |
|
1363 | - $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false); |
|
1364 | - } else { |
|
1365 | - $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
1366 | - // update this price with new values |
|
1367 | - foreach ($PRC_values as $field => $newprc) { |
|
1368 | - $PRC->set($field, $newprc); |
|
1369 | - } |
|
1370 | - $PRC->save(); |
|
1371 | - } |
|
1372 | - $ticket->_add_relation_to($PRC, 'Price'); |
|
1373 | - } |
|
1374 | - } |
|
1375 | - |
|
1376 | - |
|
1377 | - /** |
|
1378 | - * Add in our autosave ajax handlers |
|
1379 | - * |
|
1380 | - */ |
|
1381 | - protected function _ee_autosave_create_new() |
|
1382 | - { |
|
1383 | - } |
|
1384 | - |
|
1385 | - |
|
1386 | - /** |
|
1387 | - * More autosave handlers. |
|
1388 | - */ |
|
1389 | - protected function _ee_autosave_edit() |
|
1390 | - { |
|
1391 | - return; // TEMPORARILY EXITING CAUSE THIS IS A TODO |
|
1392 | - } |
|
1393 | - |
|
1394 | - |
|
1395 | - /** |
|
1396 | - * _generate_publish_box_extra_content |
|
1397 | - */ |
|
1398 | - private function _generate_publish_box_extra_content() |
|
1399 | - { |
|
1400 | - // load formatter helper |
|
1401 | - // args for getting related registrations |
|
1402 | - $approved_query_args = array( |
|
1403 | - array( |
|
1404 | - 'REG_deleted' => 0, |
|
1405 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
1406 | - ), |
|
1407 | - ); |
|
1408 | - $not_approved_query_args = array( |
|
1409 | - array( |
|
1410 | - 'REG_deleted' => 0, |
|
1411 | - 'STS_ID' => EEM_Registration::status_id_not_approved, |
|
1412 | - ), |
|
1413 | - ); |
|
1414 | - $pending_payment_query_args = array( |
|
1415 | - array( |
|
1416 | - 'REG_deleted' => 0, |
|
1417 | - 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
1418 | - ), |
|
1419 | - ); |
|
1420 | - // publish box |
|
1421 | - $publish_box_extra_args = array( |
|
1422 | - 'view_approved_reg_url' => add_query_arg( |
|
1423 | - array( |
|
1424 | - 'action' => 'default', |
|
1425 | - 'event_id' => $this->_cpt_model_obj->ID(), |
|
1426 | - '_reg_status' => EEM_Registration::status_id_approved, |
|
1427 | - ), |
|
1428 | - REG_ADMIN_URL |
|
1429 | - ), |
|
1430 | - 'view_not_approved_reg_url' => add_query_arg( |
|
1431 | - array( |
|
1432 | - 'action' => 'default', |
|
1433 | - 'event_id' => $this->_cpt_model_obj->ID(), |
|
1434 | - '_reg_status' => EEM_Registration::status_id_not_approved, |
|
1435 | - ), |
|
1436 | - REG_ADMIN_URL |
|
1437 | - ), |
|
1438 | - 'view_pending_payment_reg_url' => add_query_arg( |
|
1439 | - array( |
|
1440 | - 'action' => 'default', |
|
1441 | - 'event_id' => $this->_cpt_model_obj->ID(), |
|
1442 | - '_reg_status' => EEM_Registration::status_id_pending_payment, |
|
1443 | - ), |
|
1444 | - REG_ADMIN_URL |
|
1445 | - ), |
|
1446 | - 'approved_regs' => $this->_cpt_model_obj->count_related( |
|
1447 | - 'Registration', |
|
1448 | - $approved_query_args |
|
1449 | - ), |
|
1450 | - 'not_approved_regs' => $this->_cpt_model_obj->count_related( |
|
1451 | - 'Registration', |
|
1452 | - $not_approved_query_args |
|
1453 | - ), |
|
1454 | - 'pending_payment_regs' => $this->_cpt_model_obj->count_related( |
|
1455 | - 'Registration', |
|
1456 | - $pending_payment_query_args |
|
1457 | - ), |
|
1458 | - 'misc_pub_section_class' => apply_filters( |
|
1459 | - 'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class', |
|
1460 | - 'misc-pub-section' |
|
1461 | - ), |
|
1462 | - ); |
|
1463 | - ob_start(); |
|
1464 | - do_action( |
|
1465 | - 'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add', |
|
1466 | - $this->_cpt_model_obj |
|
1467 | - ); |
|
1468 | - $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean(); |
|
1469 | - // load template |
|
1470 | - EEH_Template::display_template( |
|
1471 | - EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php', |
|
1472 | - $publish_box_extra_args |
|
1473 | - ); |
|
1474 | - } |
|
1475 | - |
|
1476 | - |
|
1477 | - /** |
|
1478 | - * @return EE_Event |
|
1479 | - */ |
|
1480 | - public function get_event_object() |
|
1481 | - { |
|
1482 | - return $this->_cpt_model_obj; |
|
1483 | - } |
|
1484 | - |
|
1485 | - |
|
1486 | - |
|
1487 | - |
|
1488 | - /** METABOXES * */ |
|
1489 | - /** |
|
1490 | - * _register_event_editor_meta_boxes |
|
1491 | - * add all metaboxes related to the event_editor |
|
1492 | - * |
|
1493 | - * @return void |
|
1494 | - */ |
|
1495 | - protected function _register_event_editor_meta_boxes() |
|
1496 | - { |
|
1497 | - $this->verify_cpt_object(); |
|
1498 | - add_meta_box( |
|
1499 | - 'espresso_event_editor_tickets', |
|
1500 | - esc_html__('Event Datetime & Ticket', 'event_espresso'), |
|
1501 | - array($this, 'ticket_metabox'), |
|
1502 | - $this->page_slug, |
|
1503 | - 'normal', |
|
1504 | - 'high' |
|
1505 | - ); |
|
1506 | - add_meta_box( |
|
1507 | - 'espresso_event_editor_event_options', |
|
1508 | - esc_html__('Event Registration Options', 'event_espresso'), |
|
1509 | - array($this, 'registration_options_meta_box'), |
|
1510 | - $this->page_slug, |
|
1511 | - 'side', |
|
1512 | - 'default' |
|
1513 | - ); |
|
1514 | - // NOTE: if you're looking for other metaboxes in here, |
|
1515 | - // where a metabox has a related management page in the admin |
|
1516 | - // you will find it setup in the related management page's "_Hooks" file. |
|
1517 | - // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php". |
|
1518 | - } |
|
1519 | - |
|
1520 | - |
|
1521 | - /** |
|
1522 | - * @throws DomainException |
|
1523 | - * @throws EE_Error |
|
1524 | - */ |
|
1525 | - public function ticket_metabox() |
|
1526 | - { |
|
1527 | - $existing_datetime_ids = $existing_ticket_ids = array(); |
|
1528 | - // defaults for template args |
|
1529 | - $template_args = array( |
|
1530 | - 'existing_datetime_ids' => '', |
|
1531 | - 'event_datetime_help_link' => '', |
|
1532 | - 'ticket_options_help_link' => '', |
|
1533 | - 'time' => null, |
|
1534 | - 'ticket_rows' => '', |
|
1535 | - 'existing_ticket_ids' => '', |
|
1536 | - 'total_ticket_rows' => 1, |
|
1537 | - 'ticket_js_structure' => '', |
|
1538 | - 'trash_icon' => 'ee-lock-icon', |
|
1539 | - 'disabled' => '', |
|
1540 | - ); |
|
1541 | - $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null; |
|
1542 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1543 | - /** |
|
1544 | - * 1. Start with retrieving Datetimes |
|
1545 | - * 2. Fore each datetime get related tickets |
|
1546 | - * 3. For each ticket get related prices |
|
1547 | - */ |
|
1548 | - $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id); |
|
1549 | - /** @type EE_Datetime $first_datetime */ |
|
1550 | - $first_datetime = reset($times); |
|
1551 | - // do we get related tickets? |
|
1552 | - if ($first_datetime instanceof EE_Datetime |
|
1553 | - && $first_datetime->ID() !== 0 |
|
1554 | - ) { |
|
1555 | - $existing_datetime_ids[] = $first_datetime->get('DTT_ID'); |
|
1556 | - $template_args['time'] = $first_datetime; |
|
1557 | - $related_tickets = $first_datetime->tickets( |
|
1558 | - array( |
|
1559 | - array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)), |
|
1560 | - 'default_where_conditions' => 'none', |
|
1561 | - ) |
|
1562 | - ); |
|
1563 | - if (! empty($related_tickets)) { |
|
1564 | - $template_args['total_ticket_rows'] = count($related_tickets); |
|
1565 | - $row = 0; |
|
1566 | - foreach ($related_tickets as $ticket) { |
|
1567 | - $existing_ticket_ids[] = $ticket->get('TKT_ID'); |
|
1568 | - $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row); |
|
1569 | - $row++; |
|
1570 | - } |
|
1571 | - } else { |
|
1572 | - $template_args['total_ticket_rows'] = 1; |
|
1573 | - /** @type EE_Ticket $ticket */ |
|
1574 | - $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object(); |
|
1575 | - $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket); |
|
1576 | - } |
|
1577 | - } else { |
|
1578 | - $template_args['time'] = $times[0]; |
|
1579 | - /** @type EE_Ticket $ticket */ |
|
1580 | - $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets(); |
|
1581 | - $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]); |
|
1582 | - // NOTE: we're just sending the first default row |
|
1583 | - // (decaf can't manage default tickets so this should be sufficient); |
|
1584 | - } |
|
1585 | - $template_args['event_datetime_help_link'] = $this->_get_help_tab_link( |
|
1586 | - 'event_editor_event_datetimes_help_tab' |
|
1587 | - ); |
|
1588 | - $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info'); |
|
1589 | - $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1590 | - $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1591 | - $template_args['ticket_js_structure'] = $this->_get_ticket_row( |
|
1592 | - EE_Registry::instance()->load_model('Ticket')->create_default_object(), |
|
1593 | - true |
|
1594 | - ); |
|
1595 | - $template = apply_filters( |
|
1596 | - 'FHEE__Events_Admin_Page__ticket_metabox__template', |
|
1597 | - EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php' |
|
1598 | - ); |
|
1599 | - EEH_Template::display_template($template, $template_args); |
|
1600 | - } |
|
1601 | - |
|
1602 | - |
|
1603 | - /** |
|
1604 | - * Setup an individual ticket form for the decaf event editor page |
|
1605 | - * |
|
1606 | - * @access private |
|
1607 | - * @param EE_Ticket $ticket the ticket object |
|
1608 | - * @param boolean $skeleton whether we're generating a skeleton for js manipulation |
|
1609 | - * @param int $row |
|
1610 | - * @return string generated html for the ticket row. |
|
1611 | - */ |
|
1612 | - private function _get_ticket_row($ticket, $skeleton = false, $row = 0) |
|
1613 | - { |
|
1614 | - $template_args = array( |
|
1615 | - 'tkt_status_class' => ' tkt-status-' . $ticket->ticket_status(), |
|
1616 | - 'tkt_archive_class' => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived' |
|
1617 | - : '', |
|
1618 | - 'ticketrow' => $skeleton ? 'TICKETNUM' : $row, |
|
1619 | - 'TKT_ID' => $ticket->get('TKT_ID'), |
|
1620 | - 'TKT_name' => $ticket->get('TKT_name'), |
|
1621 | - 'TKT_start_date' => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'), |
|
1622 | - 'TKT_end_date' => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'), |
|
1623 | - 'TKT_is_default' => $ticket->get('TKT_is_default'), |
|
1624 | - 'TKT_qty' => $ticket->get_pretty('TKT_qty', 'input'), |
|
1625 | - 'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1626 | - 'TKT_sold' => $skeleton ? 0 : $ticket->get('TKT_sold'), |
|
1627 | - 'trash_icon' => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted'))) |
|
1628 | - && (! empty($ticket) && $ticket->get('TKT_sold') === 0) |
|
1629 | - ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon', |
|
1630 | - 'disabled' => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? '' |
|
1631 | - : ' disabled=disabled', |
|
1632 | - ); |
|
1633 | - $price = $ticket->ID() !== 0 |
|
1634 | - ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none')) |
|
1635 | - : EE_Registry::instance()->load_model('Price')->create_default_object(); |
|
1636 | - $price_args = array( |
|
1637 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1638 | - 'PRC_amount' => $price->get('PRC_amount'), |
|
1639 | - 'PRT_ID' => $price->get('PRT_ID'), |
|
1640 | - 'PRC_ID' => $price->get('PRC_ID'), |
|
1641 | - 'PRC_is_default' => $price->get('PRC_is_default'), |
|
1642 | - ); |
|
1643 | - // make sure we have default start and end dates if skeleton |
|
1644 | - // handle rows that should NOT be empty |
|
1645 | - if (empty($template_args['TKT_start_date'])) { |
|
1646 | - // if empty then the start date will be now. |
|
1647 | - $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp')); |
|
1648 | - } |
|
1649 | - if (empty($template_args['TKT_end_date'])) { |
|
1650 | - // get the earliest datetime (if present); |
|
1651 | - $earliest_dtt = $this->_cpt_model_obj->ID() > 0 |
|
1652 | - ? $this->_cpt_model_obj->get_first_related( |
|
1653 | - 'Datetime', |
|
1654 | - array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1655 | - ) |
|
1656 | - : null; |
|
1657 | - if (! empty($earliest_dtt)) { |
|
1658 | - $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a'); |
|
1659 | - } else { |
|
1660 | - $template_args['TKT_end_date'] = date( |
|
1661 | - 'Y-m-d h:i a', |
|
1662 | - mktime(0, 0, 0, date("m"), date("d") + 7, date("Y")) |
|
1663 | - ); |
|
1664 | - } |
|
1665 | - } |
|
1666 | - $template_args = array_merge($template_args, $price_args); |
|
1667 | - $template = apply_filters( |
|
1668 | - 'FHEE__Events_Admin_Page__get_ticket_row__template', |
|
1669 | - EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php', |
|
1670 | - $ticket |
|
1671 | - ); |
|
1672 | - return EEH_Template::display_template($template, $template_args, true); |
|
1673 | - } |
|
1674 | - |
|
1675 | - |
|
1676 | - /** |
|
1677 | - * @throws DomainException |
|
1678 | - */ |
|
1679 | - public function registration_options_meta_box() |
|
1680 | - { |
|
1681 | - $yes_no_values = array( |
|
1682 | - array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')), |
|
1683 | - array('id' => false, 'text' => esc_html__('No', 'event_espresso')), |
|
1684 | - ); |
|
1685 | - $default_reg_status_values = EEM_Registration::reg_status_array( |
|
1686 | - array( |
|
1687 | - EEM_Registration::status_id_cancelled, |
|
1688 | - EEM_Registration::status_id_declined, |
|
1689 | - EEM_Registration::status_id_incomplete, |
|
1690 | - ), |
|
1691 | - true |
|
1692 | - ); |
|
1693 | - // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active()); |
|
1694 | - $template_args['_event'] = $this->_cpt_model_obj; |
|
1695 | - $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false); |
|
1696 | - $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit(); |
|
1697 | - $template_args['default_registration_status'] = EEH_Form_Fields::select_input( |
|
1698 | - 'default_reg_status', |
|
1699 | - $default_reg_status_values, |
|
1700 | - $this->_cpt_model_obj->default_registration_status() |
|
1701 | - ); |
|
1702 | - $template_args['display_description'] = EEH_Form_Fields::select_input( |
|
1703 | - 'display_desc', |
|
1704 | - $yes_no_values, |
|
1705 | - $this->_cpt_model_obj->display_description() |
|
1706 | - ); |
|
1707 | - $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input( |
|
1708 | - 'display_ticket_selector', |
|
1709 | - $yes_no_values, |
|
1710 | - $this->_cpt_model_obj->display_ticket_selector(), |
|
1711 | - '', |
|
1712 | - '', |
|
1713 | - false |
|
1714 | - ); |
|
1715 | - $template_args['additional_registration_options'] = apply_filters( |
|
1716 | - 'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options', |
|
1717 | - '', |
|
1718 | - $template_args, |
|
1719 | - $yes_no_values, |
|
1720 | - $default_reg_status_values |
|
1721 | - ); |
|
1722 | - EEH_Template::display_template( |
|
1723 | - EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php', |
|
1724 | - $template_args |
|
1725 | - ); |
|
1726 | - } |
|
1727 | - |
|
1728 | - |
|
1729 | - /** |
|
1730 | - * _get_events() |
|
1731 | - * This method simply returns all the events (for the given _view and paging) |
|
1732 | - * |
|
1733 | - * @access public |
|
1734 | - * @param int $per_page count of items per page (20 default); |
|
1735 | - * @param int $current_page what is the current page being viewed. |
|
1736 | - * @param bool $count if TRUE then we just return a count of ALL events matching the given _view. |
|
1737 | - * If FALSE then we return an array of event objects |
|
1738 | - * that match the given _view and paging parameters. |
|
1739 | - * @return array an array of event objects. |
|
1740 | - */ |
|
1741 | - public function get_events($per_page = 10, $current_page = 1, $count = false) |
|
1742 | - { |
|
1743 | - $EEME = $this->_event_model(); |
|
1744 | - $offset = ($current_page - 1) * $per_page; |
|
1745 | - $limit = $count ? null : $offset . ',' . $per_page; |
|
1746 | - $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID'; |
|
1747 | - $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC"; |
|
1748 | - if (isset($this->_req_data['month_range'])) { |
|
1749 | - $pieces = explode(' ', $this->_req_data['month_range'], 3); |
|
1750 | - // simulate the FIRST day of the month, that fixes issues for months like February |
|
1751 | - // where PHP doesn't know what to assume for date. |
|
1752 | - // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437 |
|
1753 | - $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : ''; |
|
1754 | - $year_r = ! empty($pieces[1]) ? $pieces[1] : ''; |
|
1755 | - } |
|
1756 | - $where = array(); |
|
1757 | - $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null; |
|
1758 | - // determine what post_status our condition will have for the query. |
|
1759 | - switch ($status) { |
|
1760 | - case 'month': |
|
1761 | - case 'today': |
|
1762 | - case null: |
|
1763 | - case 'all': |
|
1764 | - break; |
|
1765 | - case 'draft': |
|
1766 | - $where['status'] = array('IN', array('draft', 'auto-draft')); |
|
1767 | - break; |
|
1768 | - default: |
|
1769 | - $where['status'] = $status; |
|
1770 | - } |
|
1771 | - // categories? |
|
1772 | - $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0 |
|
1773 | - ? $this->_req_data['EVT_CAT'] : null; |
|
1774 | - if (! empty($category)) { |
|
1775 | - $where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
1776 | - $where['Term_Taxonomy.term_id'] = $category; |
|
1777 | - } |
|
1778 | - // date where conditions |
|
1779 | - $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start'); |
|
1780 | - if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') { |
|
1781 | - $DateTime = new DateTime( |
|
1782 | - $year_r . '-' . $month_r . '-01 00:00:00', |
|
1783 | - new DateTimeZone(EEM_Datetime::instance()->get_timezone()) |
|
1784 | - ); |
|
1785 | - $start = $DateTime->format(implode(' ', $start_formats)); |
|
1786 | - $end = $DateTime->setDate( |
|
1787 | - $year_r, |
|
1788 | - $month_r, |
|
1789 | - $DateTime |
|
1790 | - ->format('t') |
|
1791 | - )->setTime(23, 59, 59) |
|
1792 | - ->format(implode(' ', $start_formats)); |
|
1793 | - $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1794 | - } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') { |
|
1795 | - $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone())); |
|
1796 | - $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats)); |
|
1797 | - $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats)); |
|
1798 | - $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1799 | - } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') { |
|
1800 | - $now = date('Y-m-01'); |
|
1801 | - $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone())); |
|
1802 | - $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats)); |
|
1803 | - $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t')) |
|
1804 | - ->setTime(23, 59, 59) |
|
1805 | - ->format(implode(' ', $start_formats)); |
|
1806 | - $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1807 | - } |
|
1808 | - if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) { |
|
1809 | - $where['EVT_wp_user'] = get_current_user_id(); |
|
1810 | - } else { |
|
1811 | - if (! isset($where['status'])) { |
|
1812 | - if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) { |
|
1813 | - $where['OR'] = array( |
|
1814 | - 'status*restrict_private' => array('!=', 'private'), |
|
1815 | - 'AND' => array( |
|
1816 | - 'status*inclusive' => array('=', 'private'), |
|
1817 | - 'EVT_wp_user' => get_current_user_id(), |
|
1818 | - ), |
|
1819 | - ); |
|
1820 | - } |
|
1821 | - } |
|
1822 | - } |
|
1823 | - if (isset($this->_req_data['EVT_wp_user'])) { |
|
1824 | - if ($this->_req_data['EVT_wp_user'] != get_current_user_id() |
|
1825 | - && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events') |
|
1826 | - ) { |
|
1827 | - $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user']; |
|
1828 | - } |
|
1829 | - } |
|
1830 | - // search query handling |
|
1831 | - if (isset($this->_req_data['s'])) { |
|
1832 | - $search_string = '%' . $this->_req_data['s'] . '%'; |
|
1833 | - $where['OR'] = array( |
|
1834 | - 'EVT_name' => array('LIKE', $search_string), |
|
1835 | - 'EVT_desc' => array('LIKE', $search_string), |
|
1836 | - 'EVT_short_desc' => array('LIKE', $search_string), |
|
1837 | - ); |
|
1838 | - } |
|
1839 | - $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data); |
|
1840 | - $query_params = apply_filters( |
|
1841 | - 'FHEE__Events_Admin_Page__get_events__query_params', |
|
1842 | - array( |
|
1843 | - $where, |
|
1844 | - 'limit' => $limit, |
|
1845 | - 'order_by' => $orderby, |
|
1846 | - 'order' => $order, |
|
1847 | - 'group_by' => 'EVT_ID', |
|
1848 | - ), |
|
1849 | - $this->_req_data |
|
1850 | - ); |
|
1851 | - // let's first check if we have special requests coming in. |
|
1852 | - if (isset($this->_req_data['active_status'])) { |
|
1853 | - switch ($this->_req_data['active_status']) { |
|
1854 | - case 'upcoming': |
|
1855 | - return $EEME->get_upcoming_events($query_params, $count); |
|
1856 | - break; |
|
1857 | - case 'expired': |
|
1858 | - return $EEME->get_expired_events($query_params, $count); |
|
1859 | - break; |
|
1860 | - case 'active': |
|
1861 | - return $EEME->get_active_events($query_params, $count); |
|
1862 | - break; |
|
1863 | - case 'inactive': |
|
1864 | - return $EEME->get_inactive_events($query_params, $count); |
|
1865 | - break; |
|
1866 | - } |
|
1867 | - } |
|
1868 | - $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params); |
|
1869 | - return $events; |
|
1870 | - } |
|
1871 | - |
|
1872 | - |
|
1873 | - /** |
|
1874 | - * handling for WordPress CPT actions (trash, restore, delete) |
|
1875 | - * |
|
1876 | - * @param string $post_id |
|
1877 | - */ |
|
1878 | - public function trash_cpt_item($post_id) |
|
1879 | - { |
|
1880 | - $this->_req_data['EVT_ID'] = $post_id; |
|
1881 | - $this->_trash_or_restore_event('trash', false); |
|
1882 | - } |
|
1883 | - |
|
1884 | - |
|
1885 | - /** |
|
1886 | - * @param string $post_id |
|
1887 | - */ |
|
1888 | - public function restore_cpt_item($post_id) |
|
1889 | - { |
|
1890 | - $this->_req_data['EVT_ID'] = $post_id; |
|
1891 | - $this->_trash_or_restore_event('draft', false); |
|
1892 | - } |
|
1893 | - |
|
1894 | - |
|
1895 | - /** |
|
1896 | - * @param string $post_id |
|
1897 | - */ |
|
1898 | - public function delete_cpt_item($post_id) |
|
1899 | - { |
|
1900 | - $this->_req_data['EVT_ID'] = $post_id; |
|
1901 | - $this->_delete_event(false); |
|
1902 | - } |
|
1903 | - |
|
1904 | - |
|
1905 | - /** |
|
1906 | - * _trash_or_restore_event |
|
1907 | - * |
|
1908 | - * @access protected |
|
1909 | - * @param string $event_status |
|
1910 | - * @param bool $redirect_after |
|
1911 | - */ |
|
1912 | - protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true) |
|
1913 | - { |
|
1914 | - // determine the event id and set to array. |
|
1915 | - $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false; |
|
1916 | - // loop thru events |
|
1917 | - if ($EVT_ID) { |
|
1918 | - // clean status |
|
1919 | - $event_status = sanitize_key($event_status); |
|
1920 | - // grab status |
|
1921 | - if (! empty($event_status)) { |
|
1922 | - $success = $this->_change_event_status($EVT_ID, $event_status); |
|
1923 | - } else { |
|
1924 | - $success = false; |
|
1925 | - $msg = esc_html__( |
|
1926 | - 'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.', |
|
1927 | - 'event_espresso' |
|
1928 | - ); |
|
1929 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1930 | - } |
|
1931 | - } else { |
|
1932 | - $success = false; |
|
1933 | - $msg = esc_html__( |
|
1934 | - 'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.', |
|
1935 | - 'event_espresso' |
|
1936 | - ); |
|
1937 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1938 | - } |
|
1939 | - $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash'; |
|
1940 | - if ($redirect_after) { |
|
1941 | - $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default')); |
|
1942 | - } |
|
1943 | - } |
|
1944 | - |
|
1945 | - |
|
1946 | - /** |
|
1947 | - * _trash_or_restore_events |
|
1948 | - * |
|
1949 | - * @access protected |
|
1950 | - * @param string $event_status |
|
1951 | - * @return void |
|
1952 | - */ |
|
1953 | - protected function _trash_or_restore_events($event_status = 'trash') |
|
1954 | - { |
|
1955 | - // clean status |
|
1956 | - $event_status = sanitize_key($event_status); |
|
1957 | - // grab status |
|
1958 | - if (! empty($event_status)) { |
|
1959 | - $success = true; |
|
1960 | - // determine the event id and set to array. |
|
1961 | - $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array(); |
|
1962 | - // loop thru events |
|
1963 | - foreach ($EVT_IDs as $EVT_ID) { |
|
1964 | - if ($EVT_ID = absint($EVT_ID)) { |
|
1965 | - $results = $this->_change_event_status($EVT_ID, $event_status); |
|
1966 | - $success = $results !== false ? $success : false; |
|
1967 | - } else { |
|
1968 | - $msg = sprintf( |
|
1969 | - esc_html__( |
|
1970 | - 'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.', |
|
1971 | - 'event_espresso' |
|
1972 | - ), |
|
1973 | - $EVT_ID |
|
1974 | - ); |
|
1975 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1976 | - $success = false; |
|
1977 | - } |
|
1978 | - } |
|
1979 | - } else { |
|
1980 | - $success = false; |
|
1981 | - $msg = esc_html__( |
|
1982 | - 'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.', |
|
1983 | - 'event_espresso' |
|
1984 | - ); |
|
1985 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1986 | - } |
|
1987 | - // in order to force a pluralized result message we need to send back a success status greater than 1 |
|
1988 | - $success = $success ? 2 : false; |
|
1989 | - $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash'; |
|
1990 | - $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default')); |
|
1991 | - } |
|
1992 | - |
|
1993 | - |
|
1994 | - /** |
|
1995 | - * _trash_or_restore_events |
|
1996 | - * |
|
1997 | - * @access private |
|
1998 | - * @param int $EVT_ID |
|
1999 | - * @param string $event_status |
|
2000 | - * @return bool |
|
2001 | - */ |
|
2002 | - private function _change_event_status($EVT_ID = 0, $event_status = '') |
|
2003 | - { |
|
2004 | - // grab event id |
|
2005 | - if (! $EVT_ID) { |
|
2006 | - $msg = esc_html__( |
|
2007 | - 'An error occurred. No Event ID or an invalid Event ID was received.', |
|
2008 | - 'event_espresso' |
|
2009 | - ); |
|
2010 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2011 | - return false; |
|
2012 | - } |
|
2013 | - $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
2014 | - // clean status |
|
2015 | - $event_status = sanitize_key($event_status); |
|
2016 | - // grab status |
|
2017 | - if (empty($event_status)) { |
|
2018 | - $msg = esc_html__( |
|
2019 | - 'An error occurred. No Event Status or an invalid Event Status was received.', |
|
2020 | - 'event_espresso' |
|
2021 | - ); |
|
2022 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2023 | - return false; |
|
2024 | - } |
|
2025 | - // was event trashed or restored ? |
|
2026 | - switch ($event_status) { |
|
2027 | - case 'draft': |
|
2028 | - $action = 'restored from the trash'; |
|
2029 | - $hook = 'AHEE_event_restored_from_trash'; |
|
2030 | - break; |
|
2031 | - case 'trash': |
|
2032 | - $action = 'moved to the trash'; |
|
2033 | - $hook = 'AHEE_event_moved_to_trash'; |
|
2034 | - break; |
|
2035 | - default: |
|
2036 | - $action = 'updated'; |
|
2037 | - $hook = false; |
|
2038 | - } |
|
2039 | - // use class to change status |
|
2040 | - $this->_cpt_model_obj->set_status($event_status); |
|
2041 | - $success = $this->_cpt_model_obj->save(); |
|
2042 | - if ($success === false) { |
|
2043 | - $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action); |
|
2044 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2045 | - return false; |
|
2046 | - } |
|
2047 | - if ($hook) { |
|
2048 | - do_action($hook); |
|
2049 | - } |
|
2050 | - return true; |
|
2051 | - } |
|
2052 | - |
|
2053 | - |
|
2054 | - /** |
|
2055 | - * _delete_event |
|
2056 | - * |
|
2057 | - * @access protected |
|
2058 | - * @param bool $redirect_after |
|
2059 | - */ |
|
2060 | - protected function _delete_event($redirect_after = true) |
|
2061 | - { |
|
2062 | - // determine the event id and set to array. |
|
2063 | - $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null; |
|
2064 | - $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID; |
|
2065 | - // loop thru events |
|
2066 | - if ($EVT_ID) { |
|
2067 | - $success = $this->_permanently_delete_event($EVT_ID); |
|
2068 | - // get list of events with no prices |
|
2069 | - $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array()); |
|
2070 | - // remove this event from the list of events with no prices |
|
2071 | - if (isset($espresso_no_ticket_prices[ $EVT_ID ])) { |
|
2072 | - unset($espresso_no_ticket_prices[ $EVT_ID ]); |
|
2073 | - } |
|
2074 | - update_option('ee_no_ticket_prices', $espresso_no_ticket_prices); |
|
2075 | - } else { |
|
2076 | - $success = false; |
|
2077 | - $msg = esc_html__( |
|
2078 | - 'An error occurred. An event could not be deleted because a valid event ID was not not supplied.', |
|
2079 | - 'event_espresso' |
|
2080 | - ); |
|
2081 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2082 | - } |
|
2083 | - if ($redirect_after) { |
|
2084 | - $this->_redirect_after_action( |
|
2085 | - $success, |
|
2086 | - 'Event', |
|
2087 | - 'deleted', |
|
2088 | - array('action' => 'default', 'status' => 'trash') |
|
2089 | - ); |
|
2090 | - } |
|
2091 | - } |
|
2092 | - |
|
2093 | - |
|
2094 | - /** |
|
2095 | - * _delete_events |
|
2096 | - * |
|
2097 | - * @access protected |
|
2098 | - * @return void |
|
2099 | - */ |
|
2100 | - protected function _delete_events() |
|
2101 | - { |
|
2102 | - $success = true; |
|
2103 | - // get list of events with no prices |
|
2104 | - $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array()); |
|
2105 | - // determine the event id and set to array. |
|
2106 | - $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array(); |
|
2107 | - // loop thru events |
|
2108 | - foreach ($EVT_IDs as $EVT_ID) { |
|
2109 | - $EVT_ID = absint($EVT_ID); |
|
2110 | - if ($EVT_ID) { |
|
2111 | - $results = $this->_permanently_delete_event($EVT_ID); |
|
2112 | - $success = $results !== false ? $success : false; |
|
2113 | - // remove this event from the list of events with no prices |
|
2114 | - unset($espresso_no_ticket_prices[ $EVT_ID ]); |
|
2115 | - } else { |
|
2116 | - $success = false; |
|
2117 | - $msg = esc_html__( |
|
2118 | - 'An error occurred. An event could not be deleted because a valid event ID was not not supplied.', |
|
2119 | - 'event_espresso' |
|
2120 | - ); |
|
2121 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2122 | - } |
|
2123 | - } |
|
2124 | - update_option('ee_no_ticket_prices', $espresso_no_ticket_prices); |
|
2125 | - // in order to force a pluralized result message we need to send back a success status greater than 1 |
|
2126 | - $success = $success ? 2 : false; |
|
2127 | - $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default')); |
|
2128 | - } |
|
2129 | - |
|
2130 | - |
|
2131 | - /** |
|
2132 | - * _permanently_delete_event |
|
2133 | - * |
|
2134 | - * @access private |
|
2135 | - * @param int $EVT_ID |
|
2136 | - * @return bool |
|
2137 | - */ |
|
2138 | - private function _permanently_delete_event($EVT_ID = 0) |
|
2139 | - { |
|
2140 | - // grab event id |
|
2141 | - if (! $EVT_ID) { |
|
2142 | - $msg = esc_html__( |
|
2143 | - 'An error occurred. No Event ID or an invalid Event ID was received.', |
|
2144 | - 'event_espresso' |
|
2145 | - ); |
|
2146 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2147 | - return false; |
|
2148 | - } |
|
2149 | - if (! $this->_cpt_model_obj instanceof EE_Event |
|
2150 | - || $this->_cpt_model_obj->ID() !== $EVT_ID |
|
2151 | - ) { |
|
2152 | - $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
2153 | - } |
|
2154 | - if (! $this->_cpt_model_obj instanceof EE_Event) { |
|
2155 | - return false; |
|
2156 | - } |
|
2157 | - // need to delete related tickets and prices first. |
|
2158 | - $datetimes = $this->_cpt_model_obj->get_many_related('Datetime'); |
|
2159 | - foreach ($datetimes as $datetime) { |
|
2160 | - $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime'); |
|
2161 | - $tickets = $datetime->get_many_related('Ticket'); |
|
2162 | - foreach ($tickets as $ticket) { |
|
2163 | - $ticket->_remove_relation_to($datetime, 'Datetime'); |
|
2164 | - $ticket->delete_related_permanently('Price'); |
|
2165 | - $ticket->delete_permanently(); |
|
2166 | - } |
|
2167 | - $datetime->delete(); |
|
2168 | - } |
|
2169 | - // what about related venues or terms? |
|
2170 | - $venues = $this->_cpt_model_obj->get_many_related('Venue'); |
|
2171 | - foreach ($venues as $venue) { |
|
2172 | - $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue'); |
|
2173 | - } |
|
2174 | - // any attached question groups? |
|
2175 | - $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group'); |
|
2176 | - if (! empty($question_groups)) { |
|
2177 | - foreach ($question_groups as $question_group) { |
|
2178 | - $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group'); |
|
2179 | - } |
|
2180 | - } |
|
2181 | - // Message Template Groups |
|
2182 | - $this->_cpt_model_obj->_remove_relations('Message_Template_Group'); |
|
2183 | - /** @type EE_Term_Taxonomy[] $term_taxonomies */ |
|
2184 | - $term_taxonomies = $this->_cpt_model_obj->term_taxonomies(); |
|
2185 | - foreach ($term_taxonomies as $term_taxonomy) { |
|
2186 | - $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy); |
|
2187 | - } |
|
2188 | - $success = $this->_cpt_model_obj->delete_permanently(); |
|
2189 | - // did it all go as planned ? |
|
2190 | - if ($success) { |
|
2191 | - $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID); |
|
2192 | - EE_Error::add_success($msg); |
|
2193 | - } else { |
|
2194 | - $msg = sprintf( |
|
2195 | - esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'), |
|
2196 | - $EVT_ID |
|
2197 | - ); |
|
2198 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2199 | - return false; |
|
2200 | - } |
|
2201 | - do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID); |
|
2202 | - return true; |
|
2203 | - } |
|
2204 | - |
|
2205 | - |
|
2206 | - /** |
|
2207 | - * get total number of events |
|
2208 | - * |
|
2209 | - * @access public |
|
2210 | - * @return int |
|
2211 | - */ |
|
2212 | - public function total_events() |
|
2213 | - { |
|
2214 | - $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true); |
|
2215 | - return $count; |
|
2216 | - } |
|
2217 | - |
|
2218 | - |
|
2219 | - /** |
|
2220 | - * get total number of draft events |
|
2221 | - * |
|
2222 | - * @access public |
|
2223 | - * @return int |
|
2224 | - */ |
|
2225 | - public function total_events_draft() |
|
2226 | - { |
|
2227 | - $where = array( |
|
2228 | - 'status' => array('IN', array('draft', 'auto-draft')), |
|
2229 | - ); |
|
2230 | - $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true); |
|
2231 | - return $count; |
|
2232 | - } |
|
2233 | - |
|
2234 | - |
|
2235 | - /** |
|
2236 | - * get total number of trashed events |
|
2237 | - * |
|
2238 | - * @access public |
|
2239 | - * @return int |
|
2240 | - */ |
|
2241 | - public function total_trashed_events() |
|
2242 | - { |
|
2243 | - $where = array( |
|
2244 | - 'status' => 'trash', |
|
2245 | - ); |
|
2246 | - $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true); |
|
2247 | - return $count; |
|
2248 | - } |
|
2249 | - |
|
2250 | - |
|
2251 | - /** |
|
2252 | - * _default_event_settings |
|
2253 | - * This generates the Default Settings Tab |
|
2254 | - * |
|
2255 | - * @return void |
|
2256 | - * @throws EE_Error |
|
2257 | - */ |
|
2258 | - protected function _default_event_settings() |
|
2259 | - { |
|
2260 | - $this->_set_add_edit_form_tags('update_default_event_settings'); |
|
2261 | - $this->_set_publish_post_box_vars(null, false, false, null, false); |
|
2262 | - $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html(); |
|
2263 | - $this->display_admin_page_with_sidebar(); |
|
2264 | - } |
|
2265 | - |
|
2266 | - |
|
2267 | - /** |
|
2268 | - * Return the form for event settings. |
|
2269 | - * |
|
2270 | - * @return EE_Form_Section_Proper |
|
2271 | - * @throws EE_Error |
|
2272 | - */ |
|
2273 | - protected function _default_event_settings_form() |
|
2274 | - { |
|
2275 | - $registration_config = EE_Registry::instance()->CFG->registration; |
|
2276 | - $registration_stati_for_selection = EEM_Registration::reg_status_array( |
|
2277 | - // exclude |
|
2278 | - array( |
|
2279 | - EEM_Registration::status_id_cancelled, |
|
2280 | - EEM_Registration::status_id_declined, |
|
2281 | - EEM_Registration::status_id_incomplete, |
|
2282 | - EEM_Registration::status_id_wait_list, |
|
2283 | - ), |
|
2284 | - true |
|
2285 | - ); |
|
2286 | - return new EE_Form_Section_Proper( |
|
2287 | - array( |
|
2288 | - 'name' => 'update_default_event_settings', |
|
2289 | - 'html_id' => 'update_default_event_settings', |
|
2290 | - 'html_class' => 'form-table', |
|
2291 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
2292 | - 'subsections' => apply_filters( |
|
2293 | - 'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections', |
|
2294 | - array( |
|
2295 | - 'default_reg_status' => new EE_Select_Input( |
|
2296 | - $registration_stati_for_selection, |
|
2297 | - array( |
|
2298 | - 'default' => isset($registration_config->default_STS_ID) |
|
2299 | - && array_key_exists( |
|
2300 | - $registration_config->default_STS_ID, |
|
2301 | - $registration_stati_for_selection |
|
2302 | - ) |
|
2303 | - ? sanitize_text_field($registration_config->default_STS_ID) |
|
2304 | - : EEM_Registration::status_id_pending_payment, |
|
2305 | - 'html_label_text' => esc_html__('Default Registration Status', 'event_espresso') |
|
2306 | - . EEH_Template::get_help_tab_link( |
|
2307 | - 'default_settings_status_help_tab' |
|
2308 | - ), |
|
2309 | - 'html_help_text' => esc_html__( |
|
2310 | - 'This setting allows you to preselect what the default registration status setting is when creating an event. Note that changing this setting does NOT retroactively apply it to existing events.', |
|
2311 | - 'event_espresso' |
|
2312 | - ), |
|
2313 | - ) |
|
2314 | - ), |
|
2315 | - 'default_max_tickets' => new EE_Integer_Input( |
|
2316 | - array( |
|
2317 | - 'default' => isset($registration_config->default_maximum_number_of_tickets) |
|
2318 | - ? $registration_config->default_maximum_number_of_tickets |
|
2319 | - : EEM_Event::get_default_additional_limit(), |
|
2320 | - 'html_label_text' => esc_html__( |
|
2321 | - 'Default Maximum Tickets Allowed Per Order:', |
|
2322 | - 'event_espresso' |
|
2323 | - ) |
|
2324 | - . EEH_Template::get_help_tab_link( |
|
2325 | - 'default_maximum_tickets_help_tab"' |
|
2326 | - ), |
|
2327 | - 'html_help_text' => esc_html__( |
|
2328 | - 'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.', |
|
2329 | - 'event_espresso' |
|
2330 | - ), |
|
2331 | - ) |
|
2332 | - ), |
|
2333 | - ) |
|
2334 | - ), |
|
2335 | - ) |
|
2336 | - ); |
|
2337 | - } |
|
2338 | - |
|
2339 | - |
|
2340 | - /** |
|
2341 | - * _update_default_event_settings |
|
2342 | - * |
|
2343 | - * @access protected |
|
2344 | - * @return void |
|
2345 | - * @throws EE_Error |
|
2346 | - */ |
|
2347 | - protected function _update_default_event_settings() |
|
2348 | - { |
|
2349 | - $registration_config = EE_Registry::instance()->CFG->registration; |
|
2350 | - $form = $this->_default_event_settings_form(); |
|
2351 | - if ($form->was_submitted()) { |
|
2352 | - $form->receive_form_submission(); |
|
2353 | - if ($form->is_valid()) { |
|
2354 | - $valid_data = $form->valid_data(); |
|
2355 | - if (isset($valid_data['default_reg_status'])) { |
|
2356 | - $registration_config->default_STS_ID = $valid_data['default_reg_status']; |
|
2357 | - } |
|
2358 | - if (isset($valid_data['default_max_tickets'])) { |
|
2359 | - $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets']; |
|
2360 | - } |
|
2361 | - // update because data was valid! |
|
2362 | - EE_Registry::instance()->CFG->update_espresso_config(); |
|
2363 | - EE_Error::overwrite_success(); |
|
2364 | - EE_Error::add_success( |
|
2365 | - __('Default Event Settings were updated', 'event_espresso') |
|
2366 | - ); |
|
2367 | - } |
|
2368 | - } |
|
2369 | - $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true); |
|
2370 | - } |
|
2371 | - |
|
2372 | - |
|
2373 | - /************* Templates *************/ |
|
2374 | - protected function _template_settings() |
|
2375 | - { |
|
2376 | - $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso'); |
|
2377 | - $this->_template_args['preview_img'] = '<img src="' |
|
2378 | - . EVENTS_ASSETS_URL |
|
2379 | - . DS |
|
2380 | - . 'images' |
|
2381 | - . DS |
|
2382 | - . 'caffeinated_template_features.jpg" alt="' |
|
2383 | - . esc_attr__('Template Settings Preview screenshot', 'event_espresso') |
|
2384 | - . '" />'; |
|
2385 | - $this->_template_args['preview_text'] = '<strong>' |
|
2386 | - . esc_html__( |
|
2387 | - 'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.', |
|
2388 | - 'event_espresso' |
|
2389 | - ) . '</strong>'; |
|
2390 | - $this->display_admin_caf_preview_page('template_settings_tab'); |
|
2391 | - } |
|
2392 | - |
|
2393 | - |
|
2394 | - /** Event Category Stuff **/ |
|
2395 | - /** |
|
2396 | - * set the _category property with the category object for the loaded page. |
|
2397 | - * |
|
2398 | - * @access private |
|
2399 | - * @return void |
|
2400 | - */ |
|
2401 | - private function _set_category_object() |
|
2402 | - { |
|
2403 | - if (isset($this->_category->id) && ! empty($this->_category->id)) { |
|
2404 | - return; |
|
2405 | - } //already have the category object so get out. |
|
2406 | - // set default category object |
|
2407 | - $this->_set_empty_category_object(); |
|
2408 | - // only set if we've got an id |
|
2409 | - if (! isset($this->_req_data['EVT_CAT_ID'])) { |
|
2410 | - return; |
|
2411 | - } |
|
2412 | - $category_id = absint($this->_req_data['EVT_CAT_ID']); |
|
2413 | - $term = get_term($category_id, 'espresso_event_categories'); |
|
2414 | - if (! empty($term)) { |
|
2415 | - $this->_category->category_name = $term->name; |
|
2416 | - $this->_category->category_identifier = $term->slug; |
|
2417 | - $this->_category->category_desc = $term->description; |
|
2418 | - $this->_category->id = $term->term_id; |
|
2419 | - $this->_category->parent = $term->parent; |
|
2420 | - } |
|
2421 | - } |
|
2422 | - |
|
2423 | - |
|
2424 | - /** |
|
2425 | - * Clears out category properties. |
|
2426 | - */ |
|
2427 | - private function _set_empty_category_object() |
|
2428 | - { |
|
2429 | - $this->_category = new stdClass(); |
|
2430 | - $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = ''; |
|
2431 | - $this->_category->id = $this->_category->parent = 0; |
|
2432 | - } |
|
2433 | - |
|
2434 | - |
|
2435 | - /** |
|
2436 | - * @throws EE_Error |
|
2437 | - */ |
|
2438 | - protected function _category_list_table() |
|
2439 | - { |
|
2440 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2441 | - $this->_search_btn_label = esc_html__('Categories', 'event_espresso'); |
|
2442 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
2443 | - 'add_category', |
|
2444 | - 'add_category', |
|
2445 | - array(), |
|
2446 | - 'add-new-h2' |
|
2447 | - ); |
|
2448 | - $this->display_admin_list_table_page_with_sidebar(); |
|
2449 | - } |
|
2450 | - |
|
2451 | - |
|
2452 | - /** |
|
2453 | - * Output category details view. |
|
2454 | - */ |
|
2455 | - protected function _category_details($view) |
|
2456 | - { |
|
2457 | - // load formatter helper |
|
2458 | - // load field generator helper |
|
2459 | - $route = $view == 'edit' ? 'update_category' : 'insert_category'; |
|
2460 | - $this->_set_add_edit_form_tags($route); |
|
2461 | - $this->_set_category_object(); |
|
2462 | - $id = ! empty($this->_category->id) ? $this->_category->id : ''; |
|
2463 | - $delete_action = 'delete_category'; |
|
2464 | - // custom redirect |
|
2465 | - $redirect = EE_Admin_Page::add_query_args_and_nonce( |
|
2466 | - array('action' => 'category_list'), |
|
2467 | - $this->_admin_base_url |
|
2468 | - ); |
|
2469 | - $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect); |
|
2470 | - // take care of contents |
|
2471 | - $this->_template_args['admin_page_content'] = $this->_category_details_content(); |
|
2472 | - $this->display_admin_page_with_sidebar(); |
|
2473 | - } |
|
2474 | - |
|
2475 | - |
|
2476 | - /** |
|
2477 | - * Output category details content. |
|
2478 | - */ |
|
2479 | - protected function _category_details_content() |
|
2480 | - { |
|
2481 | - $editor_args['category_desc'] = array( |
|
2482 | - 'type' => 'wp_editor', |
|
2483 | - 'value' => EEH_Formatter::admin_format_content($this->_category->category_desc), |
|
2484 | - 'class' => 'my_editor_custom', |
|
2485 | - 'wpeditor_args' => array('media_buttons' => false), |
|
2486 | - ); |
|
2487 | - $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array'); |
|
2488 | - $all_terms = get_terms( |
|
2489 | - array('espresso_event_categories'), |
|
2490 | - array('hide_empty' => 0, 'exclude' => array($this->_category->id)) |
|
2491 | - ); |
|
2492 | - // setup category select for term parents. |
|
2493 | - $category_select_values[] = array( |
|
2494 | - 'text' => esc_html__('No Parent', 'event_espresso'), |
|
2495 | - 'id' => 0, |
|
2496 | - ); |
|
2497 | - foreach ($all_terms as $term) { |
|
2498 | - $category_select_values[] = array( |
|
2499 | - 'text' => $term->name, |
|
2500 | - 'id' => $term->term_id, |
|
2501 | - ); |
|
2502 | - } |
|
2503 | - $category_select = EEH_Form_Fields::select_input( |
|
2504 | - 'category_parent', |
|
2505 | - $category_select_values, |
|
2506 | - $this->_category->parent |
|
2507 | - ); |
|
2508 | - $template_args = array( |
|
2509 | - 'category' => $this->_category, |
|
2510 | - 'category_select' => $category_select, |
|
2511 | - 'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'), |
|
2512 | - 'category_desc_editor' => $_wp_editor['category_desc']['field'], |
|
2513 | - 'disable' => '', |
|
2514 | - 'disabled_message' => false, |
|
2515 | - ); |
|
2516 | - $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php'; |
|
2517 | - return EEH_Template::display_template($template, $template_args, true); |
|
2518 | - } |
|
2519 | - |
|
2520 | - |
|
2521 | - /** |
|
2522 | - * Handles deleting categories. |
|
2523 | - */ |
|
2524 | - protected function _delete_categories() |
|
2525 | - { |
|
2526 | - $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID'] |
|
2527 | - : (array) $this->_req_data['category_id']; |
|
2528 | - foreach ($cat_ids as $cat_id) { |
|
2529 | - $this->_delete_category($cat_id); |
|
2530 | - } |
|
2531 | - // doesn't matter what page we're coming from... we're going to the same place after delete. |
|
2532 | - $query_args = array( |
|
2533 | - 'action' => 'category_list', |
|
2534 | - ); |
|
2535 | - $this->_redirect_after_action(0, '', '', $query_args); |
|
2536 | - } |
|
2537 | - |
|
2538 | - |
|
2539 | - /** |
|
2540 | - * Handles deleting specific category. |
|
2541 | - * |
|
2542 | - * @param int $cat_id |
|
2543 | - */ |
|
2544 | - protected function _delete_category($cat_id) |
|
2545 | - { |
|
2546 | - $cat_id = absint($cat_id); |
|
2547 | - wp_delete_term($cat_id, 'espresso_event_categories'); |
|
2548 | - } |
|
2549 | - |
|
2550 | - |
|
2551 | - /** |
|
2552 | - * Handles triggering the update or insertion of a new category. |
|
2553 | - * |
|
2554 | - * @param bool $new_category true means we're triggering the insert of a new category. |
|
2555 | - */ |
|
2556 | - protected function _insert_or_update_category($new_category) |
|
2557 | - { |
|
2558 | - $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true); |
|
2559 | - $success = 0; // we already have a success message so lets not send another. |
|
2560 | - if ($cat_id) { |
|
2561 | - $query_args = array( |
|
2562 | - 'action' => 'edit_category', |
|
2563 | - 'EVT_CAT_ID' => $cat_id, |
|
2564 | - ); |
|
2565 | - } else { |
|
2566 | - $query_args = array('action' => 'add_category'); |
|
2567 | - } |
|
2568 | - $this->_redirect_after_action($success, '', '', $query_args, true); |
|
2569 | - } |
|
2570 | - |
|
2571 | - |
|
2572 | - /** |
|
2573 | - * Inserts or updates category |
|
2574 | - * |
|
2575 | - * @param bool $update (true indicates we're updating a category). |
|
2576 | - * @return bool|mixed|string |
|
2577 | - */ |
|
2578 | - private function _insert_category($update = false) |
|
2579 | - { |
|
2580 | - $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : ''; |
|
2581 | - $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : ''; |
|
2582 | - $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : ''; |
|
2583 | - $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0; |
|
2584 | - if (empty($category_name)) { |
|
2585 | - $msg = esc_html__('You must add a name for the category.', 'event_espresso'); |
|
2586 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2587 | - return false; |
|
2588 | - } |
|
2589 | - $term_args = array( |
|
2590 | - 'name' => $category_name, |
|
2591 | - 'description' => $category_desc, |
|
2592 | - 'parent' => $category_parent, |
|
2593 | - ); |
|
2594 | - // was the category_identifier input disabled? |
|
2595 | - if (isset($this->_req_data['category_identifier'])) { |
|
2596 | - $term_args['slug'] = $this->_req_data['category_identifier']; |
|
2597 | - } |
|
2598 | - $insert_ids = $update |
|
2599 | - ? wp_update_term($cat_id, 'espresso_event_categories', $term_args) |
|
2600 | - : wp_insert_term($category_name, 'espresso_event_categories', $term_args); |
|
2601 | - if (! is_array($insert_ids)) { |
|
2602 | - $msg = esc_html__( |
|
2603 | - 'An error occurred and the category has not been saved to the database.', |
|
2604 | - 'event_espresso' |
|
2605 | - ); |
|
2606 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2607 | - } else { |
|
2608 | - $cat_id = $insert_ids['term_id']; |
|
2609 | - $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name); |
|
2610 | - EE_Error::add_success($msg); |
|
2611 | - } |
|
2612 | - return $cat_id; |
|
2613 | - } |
|
2614 | - |
|
2615 | - |
|
2616 | - /** |
|
2617 | - * Gets categories or count of categories matching the arguments in the request. |
|
2618 | - * |
|
2619 | - * @param int $per_page |
|
2620 | - * @param int $current_page |
|
2621 | - * @param bool $count |
|
2622 | - * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int |
|
2623 | - */ |
|
2624 | - public function get_categories($per_page = 10, $current_page = 1, $count = false) |
|
2625 | - { |
|
2626 | - // testing term stuff |
|
2627 | - $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id'; |
|
2628 | - $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
2629 | - $limit = ($current_page - 1) * $per_page; |
|
2630 | - $where = array('taxonomy' => 'espresso_event_categories'); |
|
2631 | - if (isset($this->_req_data['s'])) { |
|
2632 | - $sstr = '%' . $this->_req_data['s'] . '%'; |
|
2633 | - $where['OR'] = array( |
|
2634 | - 'Term.name' => array('LIKE', $sstr), |
|
2635 | - 'description' => array('LIKE', $sstr), |
|
2636 | - ); |
|
2637 | - } |
|
2638 | - $query_params = array( |
|
2639 | - $where, |
|
2640 | - 'order_by' => array($orderby => $order), |
|
2641 | - 'limit' => $limit . ',' . $per_page, |
|
2642 | - 'force_join' => array('Term'), |
|
2643 | - ); |
|
2644 | - $categories = $count |
|
2645 | - ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id') |
|
2646 | - : EEM_Term_Taxonomy::instance()->get_all($query_params); |
|
2647 | - return $categories; |
|
2648 | - } |
|
2649 | - |
|
2650 | - /* end category stuff */ |
|
2651 | - /**************/ |
|
2652 | - |
|
2653 | - |
|
2654 | - /** |
|
2655 | - * Callback for the `ee_save_timezone_setting` ajax action. |
|
2656 | - * |
|
2657 | - * @throws EE_Error |
|
2658 | - */ |
|
2659 | - public function save_timezonestring_setting() |
|
2660 | - { |
|
2661 | - $timezone_string = isset($this->_req_data['timezone_selected']) |
|
2662 | - ? $this->_req_data['timezone_selected'] |
|
2663 | - : ''; |
|
2664 | - if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) { |
|
2665 | - EE_Error::add_error( |
|
2666 | - esc_html__('An invalid timezone string submitted.', 'event_espresso'), |
|
2667 | - __FILE__, |
|
2668 | - __FUNCTION__, |
|
2669 | - __LINE__ |
|
2670 | - ); |
|
2671 | - $this->_template_args['error'] = true; |
|
2672 | - $this->_return_json(); |
|
2673 | - } |
|
2674 | - |
|
2675 | - update_option('timezone_string', $timezone_string); |
|
2676 | - EE_Error::add_success( |
|
2677 | - esc_html__('Your timezone string was updated.', 'event_espresso') |
|
2678 | - ); |
|
2679 | - $this->_template_args['success'] = true; |
|
2680 | - $this->_return_json(true, array('action' => 'create_new')); |
|
2681 | - } |
|
15 | + /** |
|
16 | + * This will hold the event object for event_details screen. |
|
17 | + * |
|
18 | + * @access protected |
|
19 | + * @var EE_Event $_event |
|
20 | + */ |
|
21 | + protected $_event; |
|
22 | + |
|
23 | + |
|
24 | + /** |
|
25 | + * This will hold the category object for category_details screen. |
|
26 | + * |
|
27 | + * @var stdClass $_category |
|
28 | + */ |
|
29 | + protected $_category; |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * This will hold the event model instance |
|
34 | + * |
|
35 | + * @var EEM_Event $_event_model |
|
36 | + */ |
|
37 | + protected $_event_model; |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @var EE_Event |
|
42 | + */ |
|
43 | + protected $_cpt_model_obj = false; |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * Initialize page props for this admin page group. |
|
48 | + */ |
|
49 | + protected function _init_page_props() |
|
50 | + { |
|
51 | + $this->page_slug = EVENTS_PG_SLUG; |
|
52 | + $this->page_label = EVENTS_LABEL; |
|
53 | + $this->_admin_base_url = EVENTS_ADMIN_URL; |
|
54 | + $this->_admin_base_path = EVENTS_ADMIN; |
|
55 | + $this->_cpt_model_names = array( |
|
56 | + 'create_new' => 'EEM_Event', |
|
57 | + 'edit' => 'EEM_Event', |
|
58 | + ); |
|
59 | + $this->_cpt_edit_routes = array( |
|
60 | + 'espresso_events' => 'edit', |
|
61 | + ); |
|
62 | + add_action( |
|
63 | + 'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object', |
|
64 | + array($this, 'verify_event_edit'), |
|
65 | + 10, |
|
66 | + 2 |
|
67 | + ); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * Sets the ajax hooks used for this admin page group. |
|
73 | + */ |
|
74 | + protected function _ajax_hooks() |
|
75 | + { |
|
76 | + add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting')); |
|
77 | + } |
|
78 | + |
|
79 | + |
|
80 | + /** |
|
81 | + * Sets the page properties for this admin page group. |
|
82 | + */ |
|
83 | + protected function _define_page_props() |
|
84 | + { |
|
85 | + $this->_admin_page_title = EVENTS_LABEL; |
|
86 | + $this->_labels = array( |
|
87 | + 'buttons' => array( |
|
88 | + 'add' => esc_html__('Add New Event', 'event_espresso'), |
|
89 | + 'edit' => esc_html__('Edit Event', 'event_espresso'), |
|
90 | + 'delete' => esc_html__('Delete Event', 'event_espresso'), |
|
91 | + 'add_category' => esc_html__('Add New Category', 'event_espresso'), |
|
92 | + 'edit_category' => esc_html__('Edit Category', 'event_espresso'), |
|
93 | + 'delete_category' => esc_html__('Delete Category', 'event_espresso'), |
|
94 | + ), |
|
95 | + 'editor_title' => array( |
|
96 | + 'espresso_events' => esc_html__('Enter event title here', 'event_espresso'), |
|
97 | + ), |
|
98 | + 'publishbox' => array( |
|
99 | + 'create_new' => esc_html__('Save New Event', 'event_espresso'), |
|
100 | + 'edit' => esc_html__('Update Event', 'event_espresso'), |
|
101 | + 'add_category' => esc_html__('Save New Category', 'event_espresso'), |
|
102 | + 'edit_category' => esc_html__('Update Category', 'event_espresso'), |
|
103 | + 'template_settings' => esc_html__('Update Settings', 'event_espresso'), |
|
104 | + ), |
|
105 | + ); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * Sets the page routes property for this admin page group. |
|
111 | + */ |
|
112 | + protected function _set_page_routes() |
|
113 | + { |
|
114 | + // load formatter helper |
|
115 | + // load field generator helper |
|
116 | + // is there a evt_id in the request? |
|
117 | + $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID']) |
|
118 | + ? $this->_req_data['EVT_ID'] |
|
119 | + : 0; |
|
120 | + $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id; |
|
121 | + $this->_page_routes = array( |
|
122 | + 'default' => array( |
|
123 | + 'func' => '_events_overview_list_table', |
|
124 | + 'capability' => 'ee_read_events', |
|
125 | + ), |
|
126 | + 'create_new' => array( |
|
127 | + 'func' => '_create_new_cpt_item', |
|
128 | + 'capability' => 'ee_edit_events', |
|
129 | + ), |
|
130 | + 'edit' => array( |
|
131 | + 'func' => '_edit_cpt_item', |
|
132 | + 'capability' => 'ee_edit_event', |
|
133 | + 'obj_id' => $evt_id, |
|
134 | + ), |
|
135 | + 'copy_event' => array( |
|
136 | + 'func' => '_copy_events', |
|
137 | + 'capability' => 'ee_edit_event', |
|
138 | + 'obj_id' => $evt_id, |
|
139 | + 'noheader' => true, |
|
140 | + ), |
|
141 | + 'trash_event' => array( |
|
142 | + 'func' => '_trash_or_restore_event', |
|
143 | + 'args' => array('event_status' => 'trash'), |
|
144 | + 'capability' => 'ee_delete_event', |
|
145 | + 'obj_id' => $evt_id, |
|
146 | + 'noheader' => true, |
|
147 | + ), |
|
148 | + 'trash_events' => array( |
|
149 | + 'func' => '_trash_or_restore_events', |
|
150 | + 'args' => array('event_status' => 'trash'), |
|
151 | + 'capability' => 'ee_delete_events', |
|
152 | + 'noheader' => true, |
|
153 | + ), |
|
154 | + 'restore_event' => array( |
|
155 | + 'func' => '_trash_or_restore_event', |
|
156 | + 'args' => array('event_status' => 'draft'), |
|
157 | + 'capability' => 'ee_delete_event', |
|
158 | + 'obj_id' => $evt_id, |
|
159 | + 'noheader' => true, |
|
160 | + ), |
|
161 | + 'restore_events' => array( |
|
162 | + 'func' => '_trash_or_restore_events', |
|
163 | + 'args' => array('event_status' => 'draft'), |
|
164 | + 'capability' => 'ee_delete_events', |
|
165 | + 'noheader' => true, |
|
166 | + ), |
|
167 | + 'delete_event' => array( |
|
168 | + 'func' => '_delete_event', |
|
169 | + 'capability' => 'ee_delete_event', |
|
170 | + 'obj_id' => $evt_id, |
|
171 | + 'noheader' => true, |
|
172 | + ), |
|
173 | + 'delete_events' => array( |
|
174 | + 'func' => '_delete_events', |
|
175 | + 'capability' => 'ee_delete_events', |
|
176 | + 'noheader' => true, |
|
177 | + ), |
|
178 | + 'view_report' => array( |
|
179 | + 'func' => '_view_report', |
|
180 | + 'capablity' => 'ee_edit_events', |
|
181 | + ), |
|
182 | + 'default_event_settings' => array( |
|
183 | + 'func' => '_default_event_settings', |
|
184 | + 'capability' => 'manage_options', |
|
185 | + ), |
|
186 | + 'update_default_event_settings' => array( |
|
187 | + 'func' => '_update_default_event_settings', |
|
188 | + 'capability' => 'manage_options', |
|
189 | + 'noheader' => true, |
|
190 | + ), |
|
191 | + 'template_settings' => array( |
|
192 | + 'func' => '_template_settings', |
|
193 | + 'capability' => 'manage_options', |
|
194 | + ), |
|
195 | + // event category tab related |
|
196 | + 'add_category' => array( |
|
197 | + 'func' => '_category_details', |
|
198 | + 'capability' => 'ee_edit_event_category', |
|
199 | + 'args' => array('add'), |
|
200 | + ), |
|
201 | + 'edit_category' => array( |
|
202 | + 'func' => '_category_details', |
|
203 | + 'capability' => 'ee_edit_event_category', |
|
204 | + 'args' => array('edit'), |
|
205 | + ), |
|
206 | + 'delete_categories' => array( |
|
207 | + 'func' => '_delete_categories', |
|
208 | + 'capability' => 'ee_delete_event_category', |
|
209 | + 'noheader' => true, |
|
210 | + ), |
|
211 | + 'delete_category' => array( |
|
212 | + 'func' => '_delete_categories', |
|
213 | + 'capability' => 'ee_delete_event_category', |
|
214 | + 'noheader' => true, |
|
215 | + ), |
|
216 | + 'insert_category' => array( |
|
217 | + 'func' => '_insert_or_update_category', |
|
218 | + 'args' => array('new_category' => true), |
|
219 | + 'capability' => 'ee_edit_event_category', |
|
220 | + 'noheader' => true, |
|
221 | + ), |
|
222 | + 'update_category' => array( |
|
223 | + 'func' => '_insert_or_update_category', |
|
224 | + 'args' => array('new_category' => false), |
|
225 | + 'capability' => 'ee_edit_event_category', |
|
226 | + 'noheader' => true, |
|
227 | + ), |
|
228 | + 'category_list' => array( |
|
229 | + 'func' => '_category_list_table', |
|
230 | + 'capability' => 'ee_manage_event_categories', |
|
231 | + ), |
|
232 | + ); |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + /** |
|
237 | + * Set the _page_config property for this admin page group. |
|
238 | + */ |
|
239 | + protected function _set_page_config() |
|
240 | + { |
|
241 | + $this->_page_config = array( |
|
242 | + 'default' => array( |
|
243 | + 'nav' => array( |
|
244 | + 'label' => esc_html__('Overview', 'event_espresso'), |
|
245 | + 'order' => 10, |
|
246 | + ), |
|
247 | + 'list_table' => 'Events_Admin_List_Table', |
|
248 | + 'help_tabs' => array( |
|
249 | + 'events_overview_help_tab' => array( |
|
250 | + 'title' => esc_html__('Events Overview', 'event_espresso'), |
|
251 | + 'filename' => 'events_overview', |
|
252 | + ), |
|
253 | + 'events_overview_table_column_headings_help_tab' => array( |
|
254 | + 'title' => esc_html__('Events Overview Table Column Headings', 'event_espresso'), |
|
255 | + 'filename' => 'events_overview_table_column_headings', |
|
256 | + ), |
|
257 | + 'events_overview_filters_help_tab' => array( |
|
258 | + 'title' => esc_html__('Events Overview Filters', 'event_espresso'), |
|
259 | + 'filename' => 'events_overview_filters', |
|
260 | + ), |
|
261 | + 'events_overview_view_help_tab' => array( |
|
262 | + 'title' => esc_html__('Events Overview Views', 'event_espresso'), |
|
263 | + 'filename' => 'events_overview_views', |
|
264 | + ), |
|
265 | + 'events_overview_other_help_tab' => array( |
|
266 | + 'title' => esc_html__('Events Overview Other', 'event_espresso'), |
|
267 | + 'filename' => 'events_overview_other', |
|
268 | + ), |
|
269 | + ), |
|
270 | + 'help_tour' => array( |
|
271 | + 'Event_Overview_Help_Tour', |
|
272 | + // 'New_Features_Test_Help_Tour' for testing multiple help tour |
|
273 | + ), |
|
274 | + 'qtips' => array( |
|
275 | + 'EE_Event_List_Table_Tips', |
|
276 | + ), |
|
277 | + 'require_nonce' => false, |
|
278 | + ), |
|
279 | + 'create_new' => array( |
|
280 | + 'nav' => array( |
|
281 | + 'label' => esc_html__('Add Event', 'event_espresso'), |
|
282 | + 'order' => 5, |
|
283 | + 'persistent' => false, |
|
284 | + ), |
|
285 | + 'metaboxes' => array('_register_event_editor_meta_boxes'), |
|
286 | + 'help_tabs' => array( |
|
287 | + 'event_editor_help_tab' => array( |
|
288 | + 'title' => esc_html__('Event Editor', 'event_espresso'), |
|
289 | + 'filename' => 'event_editor', |
|
290 | + ), |
|
291 | + 'event_editor_title_richtexteditor_help_tab' => array( |
|
292 | + 'title' => esc_html__('Event Title & Rich Text Editor', 'event_espresso'), |
|
293 | + 'filename' => 'event_editor_title_richtexteditor', |
|
294 | + ), |
|
295 | + 'event_editor_venue_details_help_tab' => array( |
|
296 | + 'title' => esc_html__('Event Venue Details', 'event_espresso'), |
|
297 | + 'filename' => 'event_editor_venue_details', |
|
298 | + ), |
|
299 | + 'event_editor_event_datetimes_help_tab' => array( |
|
300 | + 'title' => esc_html__('Event Datetimes', 'event_espresso'), |
|
301 | + 'filename' => 'event_editor_event_datetimes', |
|
302 | + ), |
|
303 | + 'event_editor_event_tickets_help_tab' => array( |
|
304 | + 'title' => esc_html__('Event Tickets', 'event_espresso'), |
|
305 | + 'filename' => 'event_editor_event_tickets', |
|
306 | + ), |
|
307 | + 'event_editor_event_registration_options_help_tab' => array( |
|
308 | + 'title' => esc_html__('Event Registration Options', 'event_espresso'), |
|
309 | + 'filename' => 'event_editor_event_registration_options', |
|
310 | + ), |
|
311 | + 'event_editor_tags_categories_help_tab' => array( |
|
312 | + 'title' => esc_html__('Event Tags & Categories', 'event_espresso'), |
|
313 | + 'filename' => 'event_editor_tags_categories', |
|
314 | + ), |
|
315 | + 'event_editor_questions_registrants_help_tab' => array( |
|
316 | + 'title' => esc_html__('Questions for Registrants', 'event_espresso'), |
|
317 | + 'filename' => 'event_editor_questions_registrants', |
|
318 | + ), |
|
319 | + 'event_editor_save_new_event_help_tab' => array( |
|
320 | + 'title' => esc_html__('Save New Event', 'event_espresso'), |
|
321 | + 'filename' => 'event_editor_save_new_event', |
|
322 | + ), |
|
323 | + 'event_editor_other_help_tab' => array( |
|
324 | + 'title' => esc_html__('Event Other', 'event_espresso'), |
|
325 | + 'filename' => 'event_editor_other', |
|
326 | + ), |
|
327 | + ), |
|
328 | + 'help_tour' => array( |
|
329 | + 'Event_Editor_Help_Tour', |
|
330 | + ), |
|
331 | + 'qtips' => array('EE_Event_Editor_Decaf_Tips'), |
|
332 | + 'require_nonce' => false, |
|
333 | + ), |
|
334 | + 'edit' => array( |
|
335 | + 'nav' => array( |
|
336 | + 'label' => esc_html__('Edit Event', 'event_espresso'), |
|
337 | + 'order' => 5, |
|
338 | + 'persistent' => false, |
|
339 | + 'url' => isset($this->_req_data['post']) |
|
340 | + ? EE_Admin_Page::add_query_args_and_nonce( |
|
341 | + array('post' => $this->_req_data['post'], 'action' => 'edit'), |
|
342 | + $this->_current_page_view_url |
|
343 | + ) |
|
344 | + : $this->_admin_base_url, |
|
345 | + ), |
|
346 | + 'metaboxes' => array('_register_event_editor_meta_boxes'), |
|
347 | + 'help_tabs' => array( |
|
348 | + 'event_editor_help_tab' => array( |
|
349 | + 'title' => esc_html__('Event Editor', 'event_espresso'), |
|
350 | + 'filename' => 'event_editor', |
|
351 | + ), |
|
352 | + 'event_editor_title_richtexteditor_help_tab' => array( |
|
353 | + 'title' => esc_html__('Event Title & Rich Text Editor', 'event_espresso'), |
|
354 | + 'filename' => 'event_editor_title_richtexteditor', |
|
355 | + ), |
|
356 | + 'event_editor_venue_details_help_tab' => array( |
|
357 | + 'title' => esc_html__('Event Venue Details', 'event_espresso'), |
|
358 | + 'filename' => 'event_editor_venue_details', |
|
359 | + ), |
|
360 | + 'event_editor_event_datetimes_help_tab' => array( |
|
361 | + 'title' => esc_html__('Event Datetimes', 'event_espresso'), |
|
362 | + 'filename' => 'event_editor_event_datetimes', |
|
363 | + ), |
|
364 | + 'event_editor_event_tickets_help_tab' => array( |
|
365 | + 'title' => esc_html__('Event Tickets', 'event_espresso'), |
|
366 | + 'filename' => 'event_editor_event_tickets', |
|
367 | + ), |
|
368 | + 'event_editor_event_registration_options_help_tab' => array( |
|
369 | + 'title' => esc_html__('Event Registration Options', 'event_espresso'), |
|
370 | + 'filename' => 'event_editor_event_registration_options', |
|
371 | + ), |
|
372 | + 'event_editor_tags_categories_help_tab' => array( |
|
373 | + 'title' => esc_html__('Event Tags & Categories', 'event_espresso'), |
|
374 | + 'filename' => 'event_editor_tags_categories', |
|
375 | + ), |
|
376 | + 'event_editor_questions_registrants_help_tab' => array( |
|
377 | + 'title' => esc_html__('Questions for Registrants', 'event_espresso'), |
|
378 | + 'filename' => 'event_editor_questions_registrants', |
|
379 | + ), |
|
380 | + 'event_editor_save_new_event_help_tab' => array( |
|
381 | + 'title' => esc_html__('Save New Event', 'event_espresso'), |
|
382 | + 'filename' => 'event_editor_save_new_event', |
|
383 | + ), |
|
384 | + 'event_editor_other_help_tab' => array( |
|
385 | + 'title' => esc_html__('Event Other', 'event_espresso'), |
|
386 | + 'filename' => 'event_editor_other', |
|
387 | + ), |
|
388 | + ), |
|
389 | + 'qtips' => array('EE_Event_Editor_Decaf_Tips'), |
|
390 | + 'require_nonce' => false, |
|
391 | + ), |
|
392 | + 'default_event_settings' => array( |
|
393 | + 'nav' => array( |
|
394 | + 'label' => esc_html__('Default Settings', 'event_espresso'), |
|
395 | + 'order' => 40, |
|
396 | + ), |
|
397 | + 'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')), |
|
398 | + 'labels' => array( |
|
399 | + 'publishbox' => esc_html__('Update Settings', 'event_espresso'), |
|
400 | + ), |
|
401 | + 'help_tabs' => array( |
|
402 | + 'default_settings_help_tab' => array( |
|
403 | + 'title' => esc_html__('Default Event Settings', 'event_espresso'), |
|
404 | + 'filename' => 'events_default_settings', |
|
405 | + ), |
|
406 | + 'default_settings_status_help_tab' => array( |
|
407 | + 'title' => esc_html__('Default Registration Status', 'event_espresso'), |
|
408 | + 'filename' => 'events_default_settings_status', |
|
409 | + ), |
|
410 | + 'default_maximum_tickets_help_tab' => array( |
|
411 | + 'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'), |
|
412 | + 'filename' => 'events_default_settings_max_tickets', |
|
413 | + ), |
|
414 | + ), |
|
415 | + 'help_tour' => array('Event_Default_Settings_Help_Tour'), |
|
416 | + 'require_nonce' => false, |
|
417 | + ), |
|
418 | + // template settings |
|
419 | + 'template_settings' => array( |
|
420 | + 'nav' => array( |
|
421 | + 'label' => esc_html__('Templates', 'event_espresso'), |
|
422 | + 'order' => 30, |
|
423 | + ), |
|
424 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
425 | + 'help_tabs' => array( |
|
426 | + 'general_settings_templates_help_tab' => array( |
|
427 | + 'title' => esc_html__('Templates', 'event_espresso'), |
|
428 | + 'filename' => 'general_settings_templates', |
|
429 | + ), |
|
430 | + ), |
|
431 | + 'help_tour' => array('Templates_Help_Tour'), |
|
432 | + 'require_nonce' => false, |
|
433 | + ), |
|
434 | + // event category stuff |
|
435 | + 'add_category' => array( |
|
436 | + 'nav' => array( |
|
437 | + 'label' => esc_html__('Add Category', 'event_espresso'), |
|
438 | + 'order' => 15, |
|
439 | + 'persistent' => false, |
|
440 | + ), |
|
441 | + 'help_tabs' => array( |
|
442 | + 'add_category_help_tab' => array( |
|
443 | + 'title' => esc_html__('Add New Event Category', 'event_espresso'), |
|
444 | + 'filename' => 'events_add_category', |
|
445 | + ), |
|
446 | + ), |
|
447 | + 'help_tour' => array('Event_Add_Category_Help_Tour'), |
|
448 | + 'metaboxes' => array('_publish_post_box'), |
|
449 | + 'require_nonce' => false, |
|
450 | + ), |
|
451 | + 'edit_category' => array( |
|
452 | + 'nav' => array( |
|
453 | + 'label' => esc_html__('Edit Category', 'event_espresso'), |
|
454 | + 'order' => 15, |
|
455 | + 'persistent' => false, |
|
456 | + 'url' => isset($this->_req_data['EVT_CAT_ID']) |
|
457 | + ? add_query_arg( |
|
458 | + array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']), |
|
459 | + $this->_current_page_view_url |
|
460 | + ) |
|
461 | + : $this->_admin_base_url, |
|
462 | + ), |
|
463 | + 'help_tabs' => array( |
|
464 | + 'edit_category_help_tab' => array( |
|
465 | + 'title' => esc_html__('Edit Event Category', 'event_espresso'), |
|
466 | + 'filename' => 'events_edit_category', |
|
467 | + ), |
|
468 | + ), |
|
469 | + /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/ |
|
470 | + 'metaboxes' => array('_publish_post_box'), |
|
471 | + 'require_nonce' => false, |
|
472 | + ), |
|
473 | + 'category_list' => array( |
|
474 | + 'nav' => array( |
|
475 | + 'label' => esc_html__('Categories', 'event_espresso'), |
|
476 | + 'order' => 20, |
|
477 | + ), |
|
478 | + 'list_table' => 'Event_Categories_Admin_List_Table', |
|
479 | + 'help_tabs' => array( |
|
480 | + 'events_categories_help_tab' => array( |
|
481 | + 'title' => esc_html__('Event Categories', 'event_espresso'), |
|
482 | + 'filename' => 'events_categories', |
|
483 | + ), |
|
484 | + 'events_categories_table_column_headings_help_tab' => array( |
|
485 | + 'title' => esc_html__('Event Categories Table Column Headings', 'event_espresso'), |
|
486 | + 'filename' => 'events_categories_table_column_headings', |
|
487 | + ), |
|
488 | + 'events_categories_view_help_tab' => array( |
|
489 | + 'title' => esc_html__('Event Categories Views', 'event_espresso'), |
|
490 | + 'filename' => 'events_categories_views', |
|
491 | + ), |
|
492 | + 'events_categories_other_help_tab' => array( |
|
493 | + 'title' => esc_html__('Event Categories Other', 'event_espresso'), |
|
494 | + 'filename' => 'events_categories_other', |
|
495 | + ), |
|
496 | + ), |
|
497 | + 'help_tour' => array( |
|
498 | + 'Event_Categories_Help_Tour', |
|
499 | + ), |
|
500 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
501 | + 'require_nonce' => false, |
|
502 | + ), |
|
503 | + ); |
|
504 | + } |
|
505 | + |
|
506 | + |
|
507 | + /** |
|
508 | + * Used to register any global screen options if necessary for every route in this admin page group. |
|
509 | + */ |
|
510 | + protected function _add_screen_options() |
|
511 | + { |
|
512 | + } |
|
513 | + |
|
514 | + |
|
515 | + /** |
|
516 | + * Implementing the screen options for the 'default' route. |
|
517 | + */ |
|
518 | + protected function _add_screen_options_default() |
|
519 | + { |
|
520 | + $this->_per_page_screen_option(); |
|
521 | + } |
|
522 | + |
|
523 | + |
|
524 | + /** |
|
525 | + * Implementing screen options for the category list route. |
|
526 | + */ |
|
527 | + protected function _add_screen_options_category_list() |
|
528 | + { |
|
529 | + $page_title = $this->_admin_page_title; |
|
530 | + $this->_admin_page_title = esc_html__('Categories', 'event_espresso'); |
|
531 | + $this->_per_page_screen_option(); |
|
532 | + $this->_admin_page_title = $page_title; |
|
533 | + } |
|
534 | + |
|
535 | + |
|
536 | + /** |
|
537 | + * Used to register any global feature pointers for the admin page group. |
|
538 | + */ |
|
539 | + protected function _add_feature_pointers() |
|
540 | + { |
|
541 | + } |
|
542 | + |
|
543 | + |
|
544 | + /** |
|
545 | + * Registers and enqueues any global scripts and styles for the entire admin page group. |
|
546 | + */ |
|
547 | + public function load_scripts_styles() |
|
548 | + { |
|
549 | + wp_register_style( |
|
550 | + 'events-admin-css', |
|
551 | + EVENTS_ASSETS_URL . 'events-admin-page.css', |
|
552 | + array(), |
|
553 | + EVENT_ESPRESSO_VERSION |
|
554 | + ); |
|
555 | + wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION); |
|
556 | + wp_enqueue_style('events-admin-css'); |
|
557 | + wp_enqueue_style('ee-cat-admin'); |
|
558 | + // todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details |
|
559 | + // registers for all views |
|
560 | + // scripts |
|
561 | + wp_register_script( |
|
562 | + 'event_editor_js', |
|
563 | + EVENTS_ASSETS_URL . 'event_editor.js', |
|
564 | + array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'), |
|
565 | + EVENT_ESPRESSO_VERSION, |
|
566 | + true |
|
567 | + ); |
|
568 | + } |
|
569 | + |
|
570 | + |
|
571 | + /** |
|
572 | + * Enqueuing scripts and styles specific to this view |
|
573 | + */ |
|
574 | + public function load_scripts_styles_create_new() |
|
575 | + { |
|
576 | + $this->load_scripts_styles_edit(); |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + /** |
|
581 | + * Enqueuing scripts and styles specific to this view |
|
582 | + */ |
|
583 | + public function load_scripts_styles_edit() |
|
584 | + { |
|
585 | + // styles |
|
586 | + wp_enqueue_style('espresso-ui-theme'); |
|
587 | + wp_register_style( |
|
588 | + 'event-editor-css', |
|
589 | + EVENTS_ASSETS_URL . 'event-editor.css', |
|
590 | + array('ee-admin-css'), |
|
591 | + EVENT_ESPRESSO_VERSION |
|
592 | + ); |
|
593 | + wp_enqueue_style('event-editor-css'); |
|
594 | + // scripts |
|
595 | + wp_register_script( |
|
596 | + 'event-datetime-metabox', |
|
597 | + EVENTS_ASSETS_URL . 'event-datetime-metabox.js', |
|
598 | + array('event_editor_js', 'ee-datepicker'), |
|
599 | + EVENT_ESPRESSO_VERSION |
|
600 | + ); |
|
601 | + wp_enqueue_script('event-datetime-metabox'); |
|
602 | + } |
|
603 | + |
|
604 | + |
|
605 | + /** |
|
606 | + * Populating the _views property for the category list table view. |
|
607 | + */ |
|
608 | + protected function _set_list_table_views_category_list() |
|
609 | + { |
|
610 | + $this->_views = array( |
|
611 | + 'all' => array( |
|
612 | + 'slug' => 'all', |
|
613 | + 'label' => esc_html__('All', 'event_espresso'), |
|
614 | + 'count' => 0, |
|
615 | + 'bulk_action' => array( |
|
616 | + 'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'), |
|
617 | + ), |
|
618 | + ), |
|
619 | + ); |
|
620 | + } |
|
621 | + |
|
622 | + |
|
623 | + /** |
|
624 | + * For adding anything that fires on the admin_init hook for any route within this admin page group. |
|
625 | + */ |
|
626 | + public function admin_init() |
|
627 | + { |
|
628 | + EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__( |
|
629 | + 'Do you really want to delete this image? Please remember to update your event to complete the removal.', |
|
630 | + 'event_espresso' |
|
631 | + ); |
|
632 | + } |
|
633 | + |
|
634 | + |
|
635 | + /** |
|
636 | + * For adding anything that should be triggered on the admin_notices hook for any route within this admin page |
|
637 | + * group. |
|
638 | + */ |
|
639 | + public function admin_notices() |
|
640 | + { |
|
641 | + } |
|
642 | + |
|
643 | + |
|
644 | + /** |
|
645 | + * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within |
|
646 | + * this admin page group. |
|
647 | + */ |
|
648 | + public function admin_footer_scripts() |
|
649 | + { |
|
650 | + } |
|
651 | + |
|
652 | + |
|
653 | + /** |
|
654 | + * Call this function to verify if an event is public and has tickets for sale. If it does, then we need to show a |
|
655 | + * warning (via EE_Error::add_error()); |
|
656 | + * |
|
657 | + * @param EE_Event $event Event object |
|
658 | + * @param string $req_type |
|
659 | + * @return void |
|
660 | + * @throws EE_Error |
|
661 | + * @access public |
|
662 | + */ |
|
663 | + public function verify_event_edit($event = null, $req_type = '') |
|
664 | + { |
|
665 | + // don't need to do this when processing |
|
666 | + if (! empty($req_type)) { |
|
667 | + return; |
|
668 | + } |
|
669 | + // no event? |
|
670 | + if (empty($event)) { |
|
671 | + // set event |
|
672 | + $event = $this->_cpt_model_obj; |
|
673 | + } |
|
674 | + // STILL no event? |
|
675 | + if (! $event instanceof EE_Event) { |
|
676 | + return; |
|
677 | + } |
|
678 | + $orig_status = $event->status(); |
|
679 | + // first check if event is active. |
|
680 | + if ($orig_status === EEM_Event::cancelled |
|
681 | + || $orig_status === EEM_Event::postponed |
|
682 | + || $event->is_expired() |
|
683 | + || $event->is_inactive() |
|
684 | + ) { |
|
685 | + return; |
|
686 | + } |
|
687 | + // made it here so it IS active... next check that any of the tickets are sold. |
|
688 | + if ($event->is_sold_out(true)) { |
|
689 | + if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) { |
|
690 | + EE_Error::add_attention( |
|
691 | + sprintf( |
|
692 | + esc_html__( |
|
693 | + 'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event. However, this change is not permanent until you update the event. You can change the status back to something else before updating if you wish.', |
|
694 | + 'event_espresso' |
|
695 | + ), |
|
696 | + EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence') |
|
697 | + ) |
|
698 | + ); |
|
699 | + } |
|
700 | + return; |
|
701 | + } elseif ($orig_status === EEM_Event::sold_out) { |
|
702 | + EE_Error::add_attention( |
|
703 | + sprintf( |
|
704 | + esc_html__( |
|
705 | + 'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets. However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.', |
|
706 | + 'event_espresso' |
|
707 | + ), |
|
708 | + EEH_Template::pretty_status($event->status(), false, 'sentence') |
|
709 | + ) |
|
710 | + ); |
|
711 | + } |
|
712 | + // now we need to determine if the event has any tickets on sale. If not then we dont' show the error |
|
713 | + if (! $event->tickets_on_sale()) { |
|
714 | + return; |
|
715 | + } |
|
716 | + // made it here so show warning |
|
717 | + $this->_edit_event_warning(); |
|
718 | + } |
|
719 | + |
|
720 | + |
|
721 | + /** |
|
722 | + * This is the text used for when an event is being edited that is public and has tickets for sale. |
|
723 | + * When needed, hook this into a EE_Error::add_error() notice. |
|
724 | + * |
|
725 | + * @access protected |
|
726 | + * @return void |
|
727 | + */ |
|
728 | + protected function _edit_event_warning() |
|
729 | + { |
|
730 | + // we don't want to add warnings during these requests |
|
731 | + if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') { |
|
732 | + return; |
|
733 | + } |
|
734 | + EE_Error::add_attention( |
|
735 | + sprintf( |
|
736 | + esc_html__( |
|
737 | + 'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s', |
|
738 | + 'event_espresso' |
|
739 | + ), |
|
740 | + '<a class="espresso-help-tab-lnk">', |
|
741 | + '</a>' |
|
742 | + ) |
|
743 | + ); |
|
744 | + } |
|
745 | + |
|
746 | + |
|
747 | + /** |
|
748 | + * When a user is creating a new event, notify them if they haven't set their timezone. |
|
749 | + * Otherwise, do the normal logic |
|
750 | + * |
|
751 | + * @return string |
|
752 | + * @throws \EE_Error |
|
753 | + */ |
|
754 | + protected function _create_new_cpt_item() |
|
755 | + { |
|
756 | + $has_timezone_string = get_option('timezone_string'); |
|
757 | + // only nag them about setting their timezone if it's their first event, and they haven't already done it |
|
758 | + if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) { |
|
759 | + EE_Error::add_attention( |
|
760 | + sprintf( |
|
761 | + __( |
|
762 | + 'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s', |
|
763 | + 'event_espresso' |
|
764 | + ), |
|
765 | + '<br>', |
|
766 | + '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">' |
|
767 | + . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale()) |
|
768 | + . '</select>', |
|
769 | + '<button class="button button-secondary timezone-submit">', |
|
770 | + '</button><span class="spinner"></span>' |
|
771 | + ), |
|
772 | + __FILE__, |
|
773 | + __FUNCTION__, |
|
774 | + __LINE__ |
|
775 | + ); |
|
776 | + } |
|
777 | + return parent::_create_new_cpt_item(); |
|
778 | + } |
|
779 | + |
|
780 | + |
|
781 | + /** |
|
782 | + * Sets the _views property for the default route in this admin page group. |
|
783 | + */ |
|
784 | + protected function _set_list_table_views_default() |
|
785 | + { |
|
786 | + $this->_views = array( |
|
787 | + 'all' => array( |
|
788 | + 'slug' => 'all', |
|
789 | + 'label' => esc_html__('View All Events', 'event_espresso'), |
|
790 | + 'count' => 0, |
|
791 | + 'bulk_action' => array( |
|
792 | + 'trash_events' => esc_html__('Move to Trash', 'event_espresso'), |
|
793 | + ), |
|
794 | + ), |
|
795 | + 'draft' => array( |
|
796 | + 'slug' => 'draft', |
|
797 | + 'label' => esc_html__('Draft', 'event_espresso'), |
|
798 | + 'count' => 0, |
|
799 | + 'bulk_action' => array( |
|
800 | + 'trash_events' => esc_html__('Move to Trash', 'event_espresso'), |
|
801 | + ), |
|
802 | + ), |
|
803 | + ); |
|
804 | + if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) { |
|
805 | + $this->_views['trash'] = array( |
|
806 | + 'slug' => 'trash', |
|
807 | + 'label' => esc_html__('Trash', 'event_espresso'), |
|
808 | + 'count' => 0, |
|
809 | + 'bulk_action' => array( |
|
810 | + 'restore_events' => esc_html__('Restore From Trash', 'event_espresso'), |
|
811 | + 'delete_events' => esc_html__('Delete Permanently', 'event_espresso'), |
|
812 | + ), |
|
813 | + ); |
|
814 | + } |
|
815 | + } |
|
816 | + |
|
817 | + |
|
818 | + /** |
|
819 | + * Provides the legend item array for the default list table view. |
|
820 | + * |
|
821 | + * @return array |
|
822 | + */ |
|
823 | + protected function _event_legend_items() |
|
824 | + { |
|
825 | + $items = array( |
|
826 | + 'view_details' => array( |
|
827 | + 'class' => 'dashicons dashicons-search', |
|
828 | + 'desc' => esc_html__('View Event', 'event_espresso'), |
|
829 | + ), |
|
830 | + 'edit_event' => array( |
|
831 | + 'class' => 'ee-icon ee-icon-calendar-edit', |
|
832 | + 'desc' => esc_html__('Edit Event Details', 'event_espresso'), |
|
833 | + ), |
|
834 | + 'view_attendees' => array( |
|
835 | + 'class' => 'dashicons dashicons-groups', |
|
836 | + 'desc' => esc_html__('View Registrations for Event', 'event_espresso'), |
|
837 | + ), |
|
838 | + ); |
|
839 | + $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items); |
|
840 | + $statuses = array( |
|
841 | + 'sold_out_status' => array( |
|
842 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out, |
|
843 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'), |
|
844 | + ), |
|
845 | + 'active_status' => array( |
|
846 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active, |
|
847 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'), |
|
848 | + ), |
|
849 | + 'upcoming_status' => array( |
|
850 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming, |
|
851 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'), |
|
852 | + ), |
|
853 | + 'postponed_status' => array( |
|
854 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed, |
|
855 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'), |
|
856 | + ), |
|
857 | + 'cancelled_status' => array( |
|
858 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled, |
|
859 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'), |
|
860 | + ), |
|
861 | + 'expired_status' => array( |
|
862 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired, |
|
863 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'), |
|
864 | + ), |
|
865 | + 'inactive_status' => array( |
|
866 | + 'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive, |
|
867 | + 'desc' => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'), |
|
868 | + ), |
|
869 | + ); |
|
870 | + $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses); |
|
871 | + return array_merge($items, $statuses); |
|
872 | + } |
|
873 | + |
|
874 | + |
|
875 | + /** |
|
876 | + * @return EEM_Event |
|
877 | + */ |
|
878 | + private function _event_model() |
|
879 | + { |
|
880 | + if (! $this->_event_model instanceof EEM_Event) { |
|
881 | + $this->_event_model = EE_Registry::instance()->load_model('Event'); |
|
882 | + } |
|
883 | + return $this->_event_model; |
|
884 | + } |
|
885 | + |
|
886 | + |
|
887 | + /** |
|
888 | + * Adds extra buttons to the WP CPT permalink field row. |
|
889 | + * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
890 | + * |
|
891 | + * @param string $return the current html |
|
892 | + * @param int $id the post id for the page |
|
893 | + * @param string $new_title What the title is |
|
894 | + * @param string $new_slug what the slug is |
|
895 | + * @return string The new html string for the permalink area |
|
896 | + */ |
|
897 | + public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug) |
|
898 | + { |
|
899 | + // make sure this is only when editing |
|
900 | + if (! empty($id)) { |
|
901 | + $post = get_post($id); |
|
902 | + $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#" tabindex="-1">' |
|
903 | + . esc_html__('Shortcode', 'event_espresso') |
|
904 | + . '</a> '; |
|
905 | + $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id=' |
|
906 | + . $post->ID |
|
907 | + . ']">'; |
|
908 | + } |
|
909 | + return $return; |
|
910 | + } |
|
911 | + |
|
912 | + |
|
913 | + /** |
|
914 | + * _events_overview_list_table |
|
915 | + * This contains the logic for showing the events_overview list |
|
916 | + * |
|
917 | + * @access protected |
|
918 | + * @return void |
|
919 | + * @throws \EE_Error |
|
920 | + */ |
|
921 | + protected function _events_overview_list_table() |
|
922 | + { |
|
923 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
924 | + $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table']) |
|
925 | + ? (array) $this->_template_args['after_list_table'] |
|
926 | + : array(); |
|
927 | + $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br() |
|
928 | + . EEH_Template::get_button_or_link( |
|
929 | + get_post_type_archive_link('espresso_events'), |
|
930 | + esc_html__("View Event Archive Page", "event_espresso"), |
|
931 | + 'button' |
|
932 | + ); |
|
933 | + $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items()); |
|
934 | + $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
935 | + 'create_new', |
|
936 | + 'add', |
|
937 | + array(), |
|
938 | + 'add-new-h2' |
|
939 | + ); |
|
940 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
941 | + } |
|
942 | + |
|
943 | + |
|
944 | + /** |
|
945 | + * this allows for extra misc actions in the default WP publish box |
|
946 | + * |
|
947 | + * @return void |
|
948 | + */ |
|
949 | + public function extra_misc_actions_publish_box() |
|
950 | + { |
|
951 | + $this->_generate_publish_box_extra_content(); |
|
952 | + } |
|
953 | + |
|
954 | + |
|
955 | + /** |
|
956 | + * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
957 | + * saved. |
|
958 | + * Typically you would use this to save any additional data. |
|
959 | + * Keep in mind also that "save_post" runs on EVERY post update to the database. |
|
960 | + * ALSO very important. When a post transitions from scheduled to published, |
|
961 | + * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from |
|
962 | + * other meta saves. So MAKE sure that you handle this accordingly. |
|
963 | + * |
|
964 | + * @access protected |
|
965 | + * @abstract |
|
966 | + * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
967 | + * @param object $post The post object of the cpt that was saved. |
|
968 | + * @return void |
|
969 | + * @throws \EE_Error |
|
970 | + */ |
|
971 | + protected function _insert_update_cpt_item($post_id, $post) |
|
972 | + { |
|
973 | + if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') { |
|
974 | + // get out we're not processing an event save. |
|
975 | + return; |
|
976 | + } |
|
977 | + $event_values = array( |
|
978 | + 'EVT_display_desc' => ! empty($this->_req_data['display_desc']) ? 1 : 0, |
|
979 | + 'EVT_display_ticket_selector' => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0, |
|
980 | + 'EVT_additional_limit' => min( |
|
981 | + apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255), |
|
982 | + ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null |
|
983 | + ), |
|
984 | + 'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status']) |
|
985 | + ? $this->_req_data['EVT_default_registration_status'] |
|
986 | + : EE_Registry::instance()->CFG->registration->default_STS_ID, |
|
987 | + 'EVT_member_only' => ! empty($this->_req_data['member_only']) ? 1 : 0, |
|
988 | + 'EVT_allow_overflow' => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0, |
|
989 | + 'EVT_timezone_string' => ! empty($this->_req_data['timezone_string']) |
|
990 | + ? $this->_req_data['timezone_string'] : null, |
|
991 | + 'EVT_external_URL' => ! empty($this->_req_data['externalURL']) |
|
992 | + ? $this->_req_data['externalURL'] : null, |
|
993 | + 'EVT_phone' => ! empty($this->_req_data['event_phone']) |
|
994 | + ? $this->_req_data['event_phone'] : null, |
|
995 | + ); |
|
996 | + // update event |
|
997 | + $success = $this->_event_model()->update_by_ID($event_values, $post_id); |
|
998 | + // get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id! |
|
999 | + $get_one_where = array( |
|
1000 | + $this->_event_model()->primary_key_name() => $post_id, |
|
1001 | + 'OR' => array( |
|
1002 | + 'status' => $post->post_status, |
|
1003 | + // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db, |
|
1004 | + // but the returned object here has a status of "publish", so use the original post status as well |
|
1005 | + 'status*1' => $this->_req_data['original_post_status'], |
|
1006 | + ), |
|
1007 | + ); |
|
1008 | + $event = $this->_event_model()->get_one(array($get_one_where)); |
|
1009 | + // the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons. |
|
1010 | + $event_update_callbacks = apply_filters( |
|
1011 | + 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
1012 | + array( |
|
1013 | + array($this, '_default_venue_update'), |
|
1014 | + array($this, '_default_tickets_update'), |
|
1015 | + ) |
|
1016 | + ); |
|
1017 | + $att_success = true; |
|
1018 | + foreach ($event_update_callbacks as $e_callback) { |
|
1019 | + $_success = is_callable($e_callback) |
|
1020 | + ? call_user_func($e_callback, $event, $this->_req_data) |
|
1021 | + : false; |
|
1022 | + // if ANY of these updates fail then we want the appropriate global error message |
|
1023 | + $att_success = ! $att_success ? $att_success : $_success; |
|
1024 | + } |
|
1025 | + // any errors? |
|
1026 | + if ($success && false === $att_success) { |
|
1027 | + EE_Error::add_error( |
|
1028 | + esc_html__( |
|
1029 | + 'Event Details saved successfully but something went wrong with saving attachments.', |
|
1030 | + 'event_espresso' |
|
1031 | + ), |
|
1032 | + __FILE__, |
|
1033 | + __FUNCTION__, |
|
1034 | + __LINE__ |
|
1035 | + ); |
|
1036 | + } elseif ($success === false) { |
|
1037 | + EE_Error::add_error( |
|
1038 | + esc_html__('Event Details did not save successfully.', 'event_espresso'), |
|
1039 | + __FILE__, |
|
1040 | + __FUNCTION__, |
|
1041 | + __LINE__ |
|
1042 | + ); |
|
1043 | + } |
|
1044 | + } |
|
1045 | + |
|
1046 | + |
|
1047 | + /** |
|
1048 | + * @see parent::restore_item() |
|
1049 | + * @param int $post_id |
|
1050 | + * @param int $revision_id |
|
1051 | + */ |
|
1052 | + protected function _restore_cpt_item($post_id, $revision_id) |
|
1053 | + { |
|
1054 | + // copy existing event meta to new post |
|
1055 | + $post_evt = $this->_event_model()->get_one_by_ID($post_id); |
|
1056 | + if ($post_evt instanceof EE_Event) { |
|
1057 | + // meta revision restore |
|
1058 | + $post_evt->restore_revision($revision_id); |
|
1059 | + // related objs restore |
|
1060 | + $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price')); |
|
1061 | + } |
|
1062 | + } |
|
1063 | + |
|
1064 | + |
|
1065 | + /** |
|
1066 | + * Attach the venue to the Event |
|
1067 | + * |
|
1068 | + * @param \EE_Event $evtobj Event Object to add the venue to |
|
1069 | + * @param array $data The request data from the form |
|
1070 | + * @return bool Success or fail. |
|
1071 | + */ |
|
1072 | + protected function _default_venue_update(\EE_Event $evtobj, $data) |
|
1073 | + { |
|
1074 | + require_once(EE_MODELS . 'EEM_Venue.model.php'); |
|
1075 | + $venue_model = EE_Registry::instance()->load_model('Venue'); |
|
1076 | + $rows_affected = null; |
|
1077 | + $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null; |
|
1078 | + // very important. If we don't have a venue name... |
|
1079 | + // then we'll get out because not necessary to create empty venue |
|
1080 | + if (empty($data['venue_title'])) { |
|
1081 | + return false; |
|
1082 | + } |
|
1083 | + $venue_array = array( |
|
1084 | + 'VNU_wp_user' => $evtobj->get('EVT_wp_user'), |
|
1085 | + 'VNU_name' => ! empty($data['venue_title']) ? $data['venue_title'] : null, |
|
1086 | + 'VNU_desc' => ! empty($data['venue_description']) ? $data['venue_description'] : null, |
|
1087 | + 'VNU_identifier' => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null, |
|
1088 | + 'VNU_short_desc' => ! empty($data['venue_short_description']) ? $data['venue_short_description'] |
|
1089 | + : null, |
|
1090 | + 'VNU_address' => ! empty($data['address']) ? $data['address'] : null, |
|
1091 | + 'VNU_address2' => ! empty($data['address2']) ? $data['address2'] : null, |
|
1092 | + 'VNU_city' => ! empty($data['city']) ? $data['city'] : null, |
|
1093 | + 'STA_ID' => ! empty($data['state']) ? $data['state'] : null, |
|
1094 | + 'CNT_ISO' => ! empty($data['countries']) ? $data['countries'] : null, |
|
1095 | + 'VNU_zip' => ! empty($data['zip']) ? $data['zip'] : null, |
|
1096 | + 'VNU_phone' => ! empty($data['venue_phone']) ? $data['venue_phone'] : null, |
|
1097 | + 'VNU_capacity' => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null, |
|
1098 | + 'VNU_url' => ! empty($data['venue_url']) ? $data['venue_url'] : null, |
|
1099 | + 'VNU_virtual_phone' => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null, |
|
1100 | + 'VNU_virtual_url' => ! empty($data['virtual_url']) ? $data['virtual_url'] : null, |
|
1101 | + 'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0, |
|
1102 | + 'status' => 'publish', |
|
1103 | + ); |
|
1104 | + // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out. |
|
1105 | + if (! empty($venue_id)) { |
|
1106 | + $update_where = array($venue_model->primary_key_name() => $venue_id); |
|
1107 | + $rows_affected = $venue_model->update($venue_array, array($update_where)); |
|
1108 | + // we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present. |
|
1109 | + $evtobj->_add_relation_to($venue_id, 'Venue'); |
|
1110 | + return $rows_affected > 0 ? true : false; |
|
1111 | + } else { |
|
1112 | + // we insert the venue |
|
1113 | + $venue_id = $venue_model->insert($venue_array); |
|
1114 | + $evtobj->_add_relation_to($venue_id, 'Venue'); |
|
1115 | + return ! empty($venue_id) ? true : false; |
|
1116 | + } |
|
1117 | + // when we have the ancestor come in it's already been handled by the revision save. |
|
1118 | + } |
|
1119 | + |
|
1120 | + |
|
1121 | + /** |
|
1122 | + * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
1123 | + * |
|
1124 | + * @param EE_Event $evtobj The Event object we're attaching data to |
|
1125 | + * @param array $data The request data from the form |
|
1126 | + * @return array |
|
1127 | + */ |
|
1128 | + protected function _default_tickets_update(EE_Event $evtobj, $data) |
|
1129 | + { |
|
1130 | + $success = true; |
|
1131 | + $saved_dtt = null; |
|
1132 | + $saved_tickets = array(); |
|
1133 | + $incoming_date_formats = array('Y-m-d', 'h:i a'); |
|
1134 | + foreach ($data['edit_event_datetimes'] as $row => $dtt) { |
|
1135 | + // trim all values to ensure any excess whitespace is removed. |
|
1136 | + $dtt = array_map('trim', $dtt); |
|
1137 | + $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end'] |
|
1138 | + : $dtt['DTT_EVT_start']; |
|
1139 | + $datetime_values = array( |
|
1140 | + 'DTT_ID' => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null, |
|
1141 | + 'DTT_EVT_start' => $dtt['DTT_EVT_start'], |
|
1142 | + 'DTT_EVT_end' => $dtt['DTT_EVT_end'], |
|
1143 | + 'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'], |
|
1144 | + 'DTT_order' => $row, |
|
1145 | + ); |
|
1146 | + // if we have an id then let's get existing object first and then set the new values. Otherwise we instantiate a new object for save. |
|
1147 | + if (! empty($dtt['DTT_ID'])) { |
|
1148 | + $DTM = EE_Registry::instance() |
|
1149 | + ->load_model('Datetime', array($evtobj->get_timezone())) |
|
1150 | + ->get_one_by_ID($dtt['DTT_ID']); |
|
1151 | + $DTM->set_date_format($incoming_date_formats[0]); |
|
1152 | + $DTM->set_time_format($incoming_date_formats[1]); |
|
1153 | + foreach ($datetime_values as $field => $value) { |
|
1154 | + $DTM->set($field, $value); |
|
1155 | + } |
|
1156 | + // make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it. We need to do this so we dont' TRASH the parent DTT. |
|
1157 | + $saved_dtts[ $DTM->ID() ] = $DTM; |
|
1158 | + } else { |
|
1159 | + $DTM = EE_Registry::instance()->load_class( |
|
1160 | + 'Datetime', |
|
1161 | + array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats), |
|
1162 | + false, |
|
1163 | + false |
|
1164 | + ); |
|
1165 | + foreach ($datetime_values as $field => $value) { |
|
1166 | + $DTM->set($field, $value); |
|
1167 | + } |
|
1168 | + } |
|
1169 | + $DTM->save(); |
|
1170 | + $DTT = $evtobj->_add_relation_to($DTM, 'Datetime'); |
|
1171 | + // load DTT helper |
|
1172 | + // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date. |
|
1173 | + if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) { |
|
1174 | + $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start')); |
|
1175 | + $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days'); |
|
1176 | + $DTT->save(); |
|
1177 | + } |
|
1178 | + // now we got to make sure we add the new DTT_ID to the $saved_dtts array because it is possible there was a new one created for the autosave. |
|
1179 | + $saved_dtt = $DTT; |
|
1180 | + $success = ! $success ? $success : $DTT; |
|
1181 | + // if ANY of these updates fail then we want the appropriate global error message. |
|
1182 | + // //todo this is actually sucky we need a better error message but this is what it is for now. |
|
1183 | + } |
|
1184 | + // no dtts get deleted so we don't do any of that logic here. |
|
1185 | + // update tickets next |
|
1186 | + $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
1187 | + foreach ($data['edit_tickets'] as $row => $tkt) { |
|
1188 | + $incoming_date_formats = array('Y-m-d', 'h:i a'); |
|
1189 | + $update_prices = false; |
|
1190 | + $ticket_price = isset($data['edit_prices'][ $row ][1]['PRC_amount']) |
|
1191 | + ? $data['edit_prices'][ $row ][1]['PRC_amount'] : 0; |
|
1192 | + // trim inputs to ensure any excess whitespace is removed. |
|
1193 | + $tkt = array_map('trim', $tkt); |
|
1194 | + if (empty($tkt['TKT_start_date'])) { |
|
1195 | + // let's use now in the set timezone. |
|
1196 | + $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone())); |
|
1197 | + $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]); |
|
1198 | + } |
|
1199 | + if (empty($tkt['TKT_end_date'])) { |
|
1200 | + // use the start date of the first datetime |
|
1201 | + $dtt = $evtobj->first_datetime(); |
|
1202 | + $tkt['TKT_end_date'] = $dtt->start_date_and_time( |
|
1203 | + $incoming_date_formats[0], |
|
1204 | + $incoming_date_formats[1] |
|
1205 | + ); |
|
1206 | + } |
|
1207 | + $TKT_values = array( |
|
1208 | + 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
1209 | + 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
1210 | + 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
1211 | + 'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '', |
|
1212 | + 'TKT_start_date' => $tkt['TKT_start_date'], |
|
1213 | + 'TKT_end_date' => $tkt['TKT_end_date'], |
|
1214 | + 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'], |
|
1215 | + 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'], |
|
1216 | + 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
1217 | + 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
1218 | + 'TKT_row' => $row, |
|
1219 | + 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row, |
|
1220 | + 'TKT_price' => $ticket_price, |
|
1221 | + ); |
|
1222 | + // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well. |
|
1223 | + if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
1224 | + $TKT_values['TKT_ID'] = 0; |
|
1225 | + $TKT_values['TKT_is_default'] = 0; |
|
1226 | + $TKT_values['TKT_price'] = $ticket_price; |
|
1227 | + $update_prices = true; |
|
1228 | + } |
|
1229 | + // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
1230 | + // we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified. |
|
1231 | + // keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
1232 | + if (! empty($tkt['TKT_ID'])) { |
|
1233 | + $TKT = EE_Registry::instance() |
|
1234 | + ->load_model('Ticket', array($evtobj->get_timezone())) |
|
1235 | + ->get_one_by_ID($tkt['TKT_ID']); |
|
1236 | + if ($TKT instanceof EE_Ticket) { |
|
1237 | + $ticket_sold = $TKT->count_related( |
|
1238 | + 'Registration', |
|
1239 | + array( |
|
1240 | + array( |
|
1241 | + 'STS_ID' => array( |
|
1242 | + 'NOT IN', |
|
1243 | + array(EEM_Registration::status_id_incomplete), |
|
1244 | + ), |
|
1245 | + ), |
|
1246 | + ) |
|
1247 | + ) > 0 ? true : false; |
|
1248 | + // let's just check the total price for the existing ticket and determine if it matches the new total price. if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket. |
|
1249 | + $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price') |
|
1250 | + && ! $TKT->get('TKT_deleted'); |
|
1251 | + $TKT->set_date_format($incoming_date_formats[0]); |
|
1252 | + $TKT->set_time_format($incoming_date_formats[1]); |
|
1253 | + // set new values |
|
1254 | + foreach ($TKT_values as $field => $value) { |
|
1255 | + if ($field == 'TKT_qty') { |
|
1256 | + $TKT->set_qty($value); |
|
1257 | + } else { |
|
1258 | + $TKT->set($field, $value); |
|
1259 | + } |
|
1260 | + } |
|
1261 | + // if $create_new_TKT is false then we can safely update the existing ticket. Otherwise we have to create a new ticket. |
|
1262 | + if ($create_new_TKT) { |
|
1263 | + // archive the old ticket first |
|
1264 | + $TKT->set('TKT_deleted', 1); |
|
1265 | + $TKT->save(); |
|
1266 | + // make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine. |
|
1267 | + $saved_tickets[ $TKT->ID() ] = $TKT; |
|
1268 | + // create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it. |
|
1269 | + $TKT = clone $TKT; |
|
1270 | + $TKT->set('TKT_ID', 0); |
|
1271 | + $TKT->set('TKT_deleted', 0); |
|
1272 | + $TKT->set('TKT_price', $ticket_price); |
|
1273 | + $TKT->set('TKT_sold', 0); |
|
1274 | + // now we need to make sure that $new prices are created as well and attached to new ticket. |
|
1275 | + $update_prices = true; |
|
1276 | + } |
|
1277 | + // make sure price is set if it hasn't been already |
|
1278 | + $TKT->set('TKT_price', $ticket_price); |
|
1279 | + } |
|
1280 | + } else { |
|
1281 | + // no TKT_id so a new TKT |
|
1282 | + $TKT_values['TKT_price'] = $ticket_price; |
|
1283 | + $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false); |
|
1284 | + if ($TKT instanceof EE_Ticket) { |
|
1285 | + // need to reset values to properly account for the date formats |
|
1286 | + $TKT->set_date_format($incoming_date_formats[0]); |
|
1287 | + $TKT->set_time_format($incoming_date_formats[1]); |
|
1288 | + $TKT->set_timezone($evtobj->get_timezone()); |
|
1289 | + // set new values |
|
1290 | + foreach ($TKT_values as $field => $value) { |
|
1291 | + if ($field == 'TKT_qty') { |
|
1292 | + $TKT->set_qty($value); |
|
1293 | + } else { |
|
1294 | + $TKT->set($field, $value); |
|
1295 | + } |
|
1296 | + } |
|
1297 | + $update_prices = true; |
|
1298 | + } |
|
1299 | + } |
|
1300 | + // cap ticket qty by datetime reg limits |
|
1301 | + $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit'))); |
|
1302 | + // update ticket. |
|
1303 | + $TKT->save(); |
|
1304 | + // before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date. |
|
1305 | + if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) { |
|
1306 | + $TKT->set('TKT_end_date', $TKT->get('TKT_start_date')); |
|
1307 | + $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days'); |
|
1308 | + $TKT->save(); |
|
1309 | + } |
|
1310 | + // initially let's add the ticket to the dtt |
|
1311 | + $saved_dtt->_add_relation_to($TKT, 'Ticket'); |
|
1312 | + $saved_tickets[ $TKT->ID() ] = $TKT; |
|
1313 | + // add prices to ticket |
|
1314 | + $this->_add_prices_to_ticket($data['edit_prices'][ $row ], $TKT, $update_prices); |
|
1315 | + } |
|
1316 | + // however now we need to handle permanently deleting tickets via the ui. Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold. However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db. |
|
1317 | + $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets; |
|
1318 | + $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
1319 | + foreach ($tickets_removed as $id) { |
|
1320 | + $id = absint($id); |
|
1321 | + // get the ticket for this id |
|
1322 | + $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
1323 | + // need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold) |
|
1324 | + $dtts = $tkt_to_remove->get_many_related('Datetime'); |
|
1325 | + foreach ($dtts as $dtt) { |
|
1326 | + $tkt_to_remove->_remove_relation_to($dtt, 'Datetime'); |
|
1327 | + } |
|
1328 | + // need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
1329 | + $tkt_to_remove->delete_related_permanently('Price'); |
|
1330 | + // finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships) |
|
1331 | + $tkt_to_remove->delete_permanently(); |
|
1332 | + } |
|
1333 | + return array($saved_dtt, $saved_tickets); |
|
1334 | + } |
|
1335 | + |
|
1336 | + |
|
1337 | + /** |
|
1338 | + * This attaches a list of given prices to a ticket. |
|
1339 | + * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
1340 | + * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
1341 | + * price info and prices are automatically "archived" via the ticket. |
|
1342 | + * |
|
1343 | + * @access private |
|
1344 | + * @param array $prices Array of prices from the form. |
|
1345 | + * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
1346 | + * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
1347 | + * @return void |
|
1348 | + */ |
|
1349 | + private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false) |
|
1350 | + { |
|
1351 | + foreach ($prices as $row => $prc) { |
|
1352 | + $PRC_values = array( |
|
1353 | + 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
1354 | + 'PRT_ID' => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null, |
|
1355 | + 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
1356 | + 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
1357 | + 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
1358 | + 'PRC_is_default' => 0, // make sure prices are NOT set as default from this context |
|
1359 | + 'PRC_order' => $row, |
|
1360 | + ); |
|
1361 | + if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
1362 | + $PRC_values['PRC_ID'] = 0; |
|
1363 | + $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false); |
|
1364 | + } else { |
|
1365 | + $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
1366 | + // update this price with new values |
|
1367 | + foreach ($PRC_values as $field => $newprc) { |
|
1368 | + $PRC->set($field, $newprc); |
|
1369 | + } |
|
1370 | + $PRC->save(); |
|
1371 | + } |
|
1372 | + $ticket->_add_relation_to($PRC, 'Price'); |
|
1373 | + } |
|
1374 | + } |
|
1375 | + |
|
1376 | + |
|
1377 | + /** |
|
1378 | + * Add in our autosave ajax handlers |
|
1379 | + * |
|
1380 | + */ |
|
1381 | + protected function _ee_autosave_create_new() |
|
1382 | + { |
|
1383 | + } |
|
1384 | + |
|
1385 | + |
|
1386 | + /** |
|
1387 | + * More autosave handlers. |
|
1388 | + */ |
|
1389 | + protected function _ee_autosave_edit() |
|
1390 | + { |
|
1391 | + return; // TEMPORARILY EXITING CAUSE THIS IS A TODO |
|
1392 | + } |
|
1393 | + |
|
1394 | + |
|
1395 | + /** |
|
1396 | + * _generate_publish_box_extra_content |
|
1397 | + */ |
|
1398 | + private function _generate_publish_box_extra_content() |
|
1399 | + { |
|
1400 | + // load formatter helper |
|
1401 | + // args for getting related registrations |
|
1402 | + $approved_query_args = array( |
|
1403 | + array( |
|
1404 | + 'REG_deleted' => 0, |
|
1405 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
1406 | + ), |
|
1407 | + ); |
|
1408 | + $not_approved_query_args = array( |
|
1409 | + array( |
|
1410 | + 'REG_deleted' => 0, |
|
1411 | + 'STS_ID' => EEM_Registration::status_id_not_approved, |
|
1412 | + ), |
|
1413 | + ); |
|
1414 | + $pending_payment_query_args = array( |
|
1415 | + array( |
|
1416 | + 'REG_deleted' => 0, |
|
1417 | + 'STS_ID' => EEM_Registration::status_id_pending_payment, |
|
1418 | + ), |
|
1419 | + ); |
|
1420 | + // publish box |
|
1421 | + $publish_box_extra_args = array( |
|
1422 | + 'view_approved_reg_url' => add_query_arg( |
|
1423 | + array( |
|
1424 | + 'action' => 'default', |
|
1425 | + 'event_id' => $this->_cpt_model_obj->ID(), |
|
1426 | + '_reg_status' => EEM_Registration::status_id_approved, |
|
1427 | + ), |
|
1428 | + REG_ADMIN_URL |
|
1429 | + ), |
|
1430 | + 'view_not_approved_reg_url' => add_query_arg( |
|
1431 | + array( |
|
1432 | + 'action' => 'default', |
|
1433 | + 'event_id' => $this->_cpt_model_obj->ID(), |
|
1434 | + '_reg_status' => EEM_Registration::status_id_not_approved, |
|
1435 | + ), |
|
1436 | + REG_ADMIN_URL |
|
1437 | + ), |
|
1438 | + 'view_pending_payment_reg_url' => add_query_arg( |
|
1439 | + array( |
|
1440 | + 'action' => 'default', |
|
1441 | + 'event_id' => $this->_cpt_model_obj->ID(), |
|
1442 | + '_reg_status' => EEM_Registration::status_id_pending_payment, |
|
1443 | + ), |
|
1444 | + REG_ADMIN_URL |
|
1445 | + ), |
|
1446 | + 'approved_regs' => $this->_cpt_model_obj->count_related( |
|
1447 | + 'Registration', |
|
1448 | + $approved_query_args |
|
1449 | + ), |
|
1450 | + 'not_approved_regs' => $this->_cpt_model_obj->count_related( |
|
1451 | + 'Registration', |
|
1452 | + $not_approved_query_args |
|
1453 | + ), |
|
1454 | + 'pending_payment_regs' => $this->_cpt_model_obj->count_related( |
|
1455 | + 'Registration', |
|
1456 | + $pending_payment_query_args |
|
1457 | + ), |
|
1458 | + 'misc_pub_section_class' => apply_filters( |
|
1459 | + 'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class', |
|
1460 | + 'misc-pub-section' |
|
1461 | + ), |
|
1462 | + ); |
|
1463 | + ob_start(); |
|
1464 | + do_action( |
|
1465 | + 'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add', |
|
1466 | + $this->_cpt_model_obj |
|
1467 | + ); |
|
1468 | + $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean(); |
|
1469 | + // load template |
|
1470 | + EEH_Template::display_template( |
|
1471 | + EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php', |
|
1472 | + $publish_box_extra_args |
|
1473 | + ); |
|
1474 | + } |
|
1475 | + |
|
1476 | + |
|
1477 | + /** |
|
1478 | + * @return EE_Event |
|
1479 | + */ |
|
1480 | + public function get_event_object() |
|
1481 | + { |
|
1482 | + return $this->_cpt_model_obj; |
|
1483 | + } |
|
1484 | + |
|
1485 | + |
|
1486 | + |
|
1487 | + |
|
1488 | + /** METABOXES * */ |
|
1489 | + /** |
|
1490 | + * _register_event_editor_meta_boxes |
|
1491 | + * add all metaboxes related to the event_editor |
|
1492 | + * |
|
1493 | + * @return void |
|
1494 | + */ |
|
1495 | + protected function _register_event_editor_meta_boxes() |
|
1496 | + { |
|
1497 | + $this->verify_cpt_object(); |
|
1498 | + add_meta_box( |
|
1499 | + 'espresso_event_editor_tickets', |
|
1500 | + esc_html__('Event Datetime & Ticket', 'event_espresso'), |
|
1501 | + array($this, 'ticket_metabox'), |
|
1502 | + $this->page_slug, |
|
1503 | + 'normal', |
|
1504 | + 'high' |
|
1505 | + ); |
|
1506 | + add_meta_box( |
|
1507 | + 'espresso_event_editor_event_options', |
|
1508 | + esc_html__('Event Registration Options', 'event_espresso'), |
|
1509 | + array($this, 'registration_options_meta_box'), |
|
1510 | + $this->page_slug, |
|
1511 | + 'side', |
|
1512 | + 'default' |
|
1513 | + ); |
|
1514 | + // NOTE: if you're looking for other metaboxes in here, |
|
1515 | + // where a metabox has a related management page in the admin |
|
1516 | + // you will find it setup in the related management page's "_Hooks" file. |
|
1517 | + // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php". |
|
1518 | + } |
|
1519 | + |
|
1520 | + |
|
1521 | + /** |
|
1522 | + * @throws DomainException |
|
1523 | + * @throws EE_Error |
|
1524 | + */ |
|
1525 | + public function ticket_metabox() |
|
1526 | + { |
|
1527 | + $existing_datetime_ids = $existing_ticket_ids = array(); |
|
1528 | + // defaults for template args |
|
1529 | + $template_args = array( |
|
1530 | + 'existing_datetime_ids' => '', |
|
1531 | + 'event_datetime_help_link' => '', |
|
1532 | + 'ticket_options_help_link' => '', |
|
1533 | + 'time' => null, |
|
1534 | + 'ticket_rows' => '', |
|
1535 | + 'existing_ticket_ids' => '', |
|
1536 | + 'total_ticket_rows' => 1, |
|
1537 | + 'ticket_js_structure' => '', |
|
1538 | + 'trash_icon' => 'ee-lock-icon', |
|
1539 | + 'disabled' => '', |
|
1540 | + ); |
|
1541 | + $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null; |
|
1542 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1543 | + /** |
|
1544 | + * 1. Start with retrieving Datetimes |
|
1545 | + * 2. Fore each datetime get related tickets |
|
1546 | + * 3. For each ticket get related prices |
|
1547 | + */ |
|
1548 | + $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id); |
|
1549 | + /** @type EE_Datetime $first_datetime */ |
|
1550 | + $first_datetime = reset($times); |
|
1551 | + // do we get related tickets? |
|
1552 | + if ($first_datetime instanceof EE_Datetime |
|
1553 | + && $first_datetime->ID() !== 0 |
|
1554 | + ) { |
|
1555 | + $existing_datetime_ids[] = $first_datetime->get('DTT_ID'); |
|
1556 | + $template_args['time'] = $first_datetime; |
|
1557 | + $related_tickets = $first_datetime->tickets( |
|
1558 | + array( |
|
1559 | + array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)), |
|
1560 | + 'default_where_conditions' => 'none', |
|
1561 | + ) |
|
1562 | + ); |
|
1563 | + if (! empty($related_tickets)) { |
|
1564 | + $template_args['total_ticket_rows'] = count($related_tickets); |
|
1565 | + $row = 0; |
|
1566 | + foreach ($related_tickets as $ticket) { |
|
1567 | + $existing_ticket_ids[] = $ticket->get('TKT_ID'); |
|
1568 | + $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row); |
|
1569 | + $row++; |
|
1570 | + } |
|
1571 | + } else { |
|
1572 | + $template_args['total_ticket_rows'] = 1; |
|
1573 | + /** @type EE_Ticket $ticket */ |
|
1574 | + $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object(); |
|
1575 | + $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket); |
|
1576 | + } |
|
1577 | + } else { |
|
1578 | + $template_args['time'] = $times[0]; |
|
1579 | + /** @type EE_Ticket $ticket */ |
|
1580 | + $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets(); |
|
1581 | + $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]); |
|
1582 | + // NOTE: we're just sending the first default row |
|
1583 | + // (decaf can't manage default tickets so this should be sufficient); |
|
1584 | + } |
|
1585 | + $template_args['event_datetime_help_link'] = $this->_get_help_tab_link( |
|
1586 | + 'event_editor_event_datetimes_help_tab' |
|
1587 | + ); |
|
1588 | + $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info'); |
|
1589 | + $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
1590 | + $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
1591 | + $template_args['ticket_js_structure'] = $this->_get_ticket_row( |
|
1592 | + EE_Registry::instance()->load_model('Ticket')->create_default_object(), |
|
1593 | + true |
|
1594 | + ); |
|
1595 | + $template = apply_filters( |
|
1596 | + 'FHEE__Events_Admin_Page__ticket_metabox__template', |
|
1597 | + EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php' |
|
1598 | + ); |
|
1599 | + EEH_Template::display_template($template, $template_args); |
|
1600 | + } |
|
1601 | + |
|
1602 | + |
|
1603 | + /** |
|
1604 | + * Setup an individual ticket form for the decaf event editor page |
|
1605 | + * |
|
1606 | + * @access private |
|
1607 | + * @param EE_Ticket $ticket the ticket object |
|
1608 | + * @param boolean $skeleton whether we're generating a skeleton for js manipulation |
|
1609 | + * @param int $row |
|
1610 | + * @return string generated html for the ticket row. |
|
1611 | + */ |
|
1612 | + private function _get_ticket_row($ticket, $skeleton = false, $row = 0) |
|
1613 | + { |
|
1614 | + $template_args = array( |
|
1615 | + 'tkt_status_class' => ' tkt-status-' . $ticket->ticket_status(), |
|
1616 | + 'tkt_archive_class' => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived' |
|
1617 | + : '', |
|
1618 | + 'ticketrow' => $skeleton ? 'TICKETNUM' : $row, |
|
1619 | + 'TKT_ID' => $ticket->get('TKT_ID'), |
|
1620 | + 'TKT_name' => $ticket->get('TKT_name'), |
|
1621 | + 'TKT_start_date' => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'), |
|
1622 | + 'TKT_end_date' => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'), |
|
1623 | + 'TKT_is_default' => $ticket->get('TKT_is_default'), |
|
1624 | + 'TKT_qty' => $ticket->get_pretty('TKT_qty', 'input'), |
|
1625 | + 'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
1626 | + 'TKT_sold' => $skeleton ? 0 : $ticket->get('TKT_sold'), |
|
1627 | + 'trash_icon' => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted'))) |
|
1628 | + && (! empty($ticket) && $ticket->get('TKT_sold') === 0) |
|
1629 | + ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon', |
|
1630 | + 'disabled' => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? '' |
|
1631 | + : ' disabled=disabled', |
|
1632 | + ); |
|
1633 | + $price = $ticket->ID() !== 0 |
|
1634 | + ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none')) |
|
1635 | + : EE_Registry::instance()->load_model('Price')->create_default_object(); |
|
1636 | + $price_args = array( |
|
1637 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
1638 | + 'PRC_amount' => $price->get('PRC_amount'), |
|
1639 | + 'PRT_ID' => $price->get('PRT_ID'), |
|
1640 | + 'PRC_ID' => $price->get('PRC_ID'), |
|
1641 | + 'PRC_is_default' => $price->get('PRC_is_default'), |
|
1642 | + ); |
|
1643 | + // make sure we have default start and end dates if skeleton |
|
1644 | + // handle rows that should NOT be empty |
|
1645 | + if (empty($template_args['TKT_start_date'])) { |
|
1646 | + // if empty then the start date will be now. |
|
1647 | + $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp')); |
|
1648 | + } |
|
1649 | + if (empty($template_args['TKT_end_date'])) { |
|
1650 | + // get the earliest datetime (if present); |
|
1651 | + $earliest_dtt = $this->_cpt_model_obj->ID() > 0 |
|
1652 | + ? $this->_cpt_model_obj->get_first_related( |
|
1653 | + 'Datetime', |
|
1654 | + array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
1655 | + ) |
|
1656 | + : null; |
|
1657 | + if (! empty($earliest_dtt)) { |
|
1658 | + $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a'); |
|
1659 | + } else { |
|
1660 | + $template_args['TKT_end_date'] = date( |
|
1661 | + 'Y-m-d h:i a', |
|
1662 | + mktime(0, 0, 0, date("m"), date("d") + 7, date("Y")) |
|
1663 | + ); |
|
1664 | + } |
|
1665 | + } |
|
1666 | + $template_args = array_merge($template_args, $price_args); |
|
1667 | + $template = apply_filters( |
|
1668 | + 'FHEE__Events_Admin_Page__get_ticket_row__template', |
|
1669 | + EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php', |
|
1670 | + $ticket |
|
1671 | + ); |
|
1672 | + return EEH_Template::display_template($template, $template_args, true); |
|
1673 | + } |
|
1674 | + |
|
1675 | + |
|
1676 | + /** |
|
1677 | + * @throws DomainException |
|
1678 | + */ |
|
1679 | + public function registration_options_meta_box() |
|
1680 | + { |
|
1681 | + $yes_no_values = array( |
|
1682 | + array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')), |
|
1683 | + array('id' => false, 'text' => esc_html__('No', 'event_espresso')), |
|
1684 | + ); |
|
1685 | + $default_reg_status_values = EEM_Registration::reg_status_array( |
|
1686 | + array( |
|
1687 | + EEM_Registration::status_id_cancelled, |
|
1688 | + EEM_Registration::status_id_declined, |
|
1689 | + EEM_Registration::status_id_incomplete, |
|
1690 | + ), |
|
1691 | + true |
|
1692 | + ); |
|
1693 | + // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active()); |
|
1694 | + $template_args['_event'] = $this->_cpt_model_obj; |
|
1695 | + $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false); |
|
1696 | + $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit(); |
|
1697 | + $template_args['default_registration_status'] = EEH_Form_Fields::select_input( |
|
1698 | + 'default_reg_status', |
|
1699 | + $default_reg_status_values, |
|
1700 | + $this->_cpt_model_obj->default_registration_status() |
|
1701 | + ); |
|
1702 | + $template_args['display_description'] = EEH_Form_Fields::select_input( |
|
1703 | + 'display_desc', |
|
1704 | + $yes_no_values, |
|
1705 | + $this->_cpt_model_obj->display_description() |
|
1706 | + ); |
|
1707 | + $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input( |
|
1708 | + 'display_ticket_selector', |
|
1709 | + $yes_no_values, |
|
1710 | + $this->_cpt_model_obj->display_ticket_selector(), |
|
1711 | + '', |
|
1712 | + '', |
|
1713 | + false |
|
1714 | + ); |
|
1715 | + $template_args['additional_registration_options'] = apply_filters( |
|
1716 | + 'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options', |
|
1717 | + '', |
|
1718 | + $template_args, |
|
1719 | + $yes_no_values, |
|
1720 | + $default_reg_status_values |
|
1721 | + ); |
|
1722 | + EEH_Template::display_template( |
|
1723 | + EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php', |
|
1724 | + $template_args |
|
1725 | + ); |
|
1726 | + } |
|
1727 | + |
|
1728 | + |
|
1729 | + /** |
|
1730 | + * _get_events() |
|
1731 | + * This method simply returns all the events (for the given _view and paging) |
|
1732 | + * |
|
1733 | + * @access public |
|
1734 | + * @param int $per_page count of items per page (20 default); |
|
1735 | + * @param int $current_page what is the current page being viewed. |
|
1736 | + * @param bool $count if TRUE then we just return a count of ALL events matching the given _view. |
|
1737 | + * If FALSE then we return an array of event objects |
|
1738 | + * that match the given _view and paging parameters. |
|
1739 | + * @return array an array of event objects. |
|
1740 | + */ |
|
1741 | + public function get_events($per_page = 10, $current_page = 1, $count = false) |
|
1742 | + { |
|
1743 | + $EEME = $this->_event_model(); |
|
1744 | + $offset = ($current_page - 1) * $per_page; |
|
1745 | + $limit = $count ? null : $offset . ',' . $per_page; |
|
1746 | + $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID'; |
|
1747 | + $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC"; |
|
1748 | + if (isset($this->_req_data['month_range'])) { |
|
1749 | + $pieces = explode(' ', $this->_req_data['month_range'], 3); |
|
1750 | + // simulate the FIRST day of the month, that fixes issues for months like February |
|
1751 | + // where PHP doesn't know what to assume for date. |
|
1752 | + // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437 |
|
1753 | + $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : ''; |
|
1754 | + $year_r = ! empty($pieces[1]) ? $pieces[1] : ''; |
|
1755 | + } |
|
1756 | + $where = array(); |
|
1757 | + $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null; |
|
1758 | + // determine what post_status our condition will have for the query. |
|
1759 | + switch ($status) { |
|
1760 | + case 'month': |
|
1761 | + case 'today': |
|
1762 | + case null: |
|
1763 | + case 'all': |
|
1764 | + break; |
|
1765 | + case 'draft': |
|
1766 | + $where['status'] = array('IN', array('draft', 'auto-draft')); |
|
1767 | + break; |
|
1768 | + default: |
|
1769 | + $where['status'] = $status; |
|
1770 | + } |
|
1771 | + // categories? |
|
1772 | + $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0 |
|
1773 | + ? $this->_req_data['EVT_CAT'] : null; |
|
1774 | + if (! empty($category)) { |
|
1775 | + $where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
|
1776 | + $where['Term_Taxonomy.term_id'] = $category; |
|
1777 | + } |
|
1778 | + // date where conditions |
|
1779 | + $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start'); |
|
1780 | + if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') { |
|
1781 | + $DateTime = new DateTime( |
|
1782 | + $year_r . '-' . $month_r . '-01 00:00:00', |
|
1783 | + new DateTimeZone(EEM_Datetime::instance()->get_timezone()) |
|
1784 | + ); |
|
1785 | + $start = $DateTime->format(implode(' ', $start_formats)); |
|
1786 | + $end = $DateTime->setDate( |
|
1787 | + $year_r, |
|
1788 | + $month_r, |
|
1789 | + $DateTime |
|
1790 | + ->format('t') |
|
1791 | + )->setTime(23, 59, 59) |
|
1792 | + ->format(implode(' ', $start_formats)); |
|
1793 | + $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1794 | + } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') { |
|
1795 | + $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone())); |
|
1796 | + $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats)); |
|
1797 | + $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats)); |
|
1798 | + $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1799 | + } elseif (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') { |
|
1800 | + $now = date('Y-m-01'); |
|
1801 | + $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone())); |
|
1802 | + $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats)); |
|
1803 | + $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t')) |
|
1804 | + ->setTime(23, 59, 59) |
|
1805 | + ->format(implode(' ', $start_formats)); |
|
1806 | + $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end)); |
|
1807 | + } |
|
1808 | + if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) { |
|
1809 | + $where['EVT_wp_user'] = get_current_user_id(); |
|
1810 | + } else { |
|
1811 | + if (! isset($where['status'])) { |
|
1812 | + if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) { |
|
1813 | + $where['OR'] = array( |
|
1814 | + 'status*restrict_private' => array('!=', 'private'), |
|
1815 | + 'AND' => array( |
|
1816 | + 'status*inclusive' => array('=', 'private'), |
|
1817 | + 'EVT_wp_user' => get_current_user_id(), |
|
1818 | + ), |
|
1819 | + ); |
|
1820 | + } |
|
1821 | + } |
|
1822 | + } |
|
1823 | + if (isset($this->_req_data['EVT_wp_user'])) { |
|
1824 | + if ($this->_req_data['EVT_wp_user'] != get_current_user_id() |
|
1825 | + && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events') |
|
1826 | + ) { |
|
1827 | + $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user']; |
|
1828 | + } |
|
1829 | + } |
|
1830 | + // search query handling |
|
1831 | + if (isset($this->_req_data['s'])) { |
|
1832 | + $search_string = '%' . $this->_req_data['s'] . '%'; |
|
1833 | + $where['OR'] = array( |
|
1834 | + 'EVT_name' => array('LIKE', $search_string), |
|
1835 | + 'EVT_desc' => array('LIKE', $search_string), |
|
1836 | + 'EVT_short_desc' => array('LIKE', $search_string), |
|
1837 | + ); |
|
1838 | + } |
|
1839 | + $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data); |
|
1840 | + $query_params = apply_filters( |
|
1841 | + 'FHEE__Events_Admin_Page__get_events__query_params', |
|
1842 | + array( |
|
1843 | + $where, |
|
1844 | + 'limit' => $limit, |
|
1845 | + 'order_by' => $orderby, |
|
1846 | + 'order' => $order, |
|
1847 | + 'group_by' => 'EVT_ID', |
|
1848 | + ), |
|
1849 | + $this->_req_data |
|
1850 | + ); |
|
1851 | + // let's first check if we have special requests coming in. |
|
1852 | + if (isset($this->_req_data['active_status'])) { |
|
1853 | + switch ($this->_req_data['active_status']) { |
|
1854 | + case 'upcoming': |
|
1855 | + return $EEME->get_upcoming_events($query_params, $count); |
|
1856 | + break; |
|
1857 | + case 'expired': |
|
1858 | + return $EEME->get_expired_events($query_params, $count); |
|
1859 | + break; |
|
1860 | + case 'active': |
|
1861 | + return $EEME->get_active_events($query_params, $count); |
|
1862 | + break; |
|
1863 | + case 'inactive': |
|
1864 | + return $EEME->get_inactive_events($query_params, $count); |
|
1865 | + break; |
|
1866 | + } |
|
1867 | + } |
|
1868 | + $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params); |
|
1869 | + return $events; |
|
1870 | + } |
|
1871 | + |
|
1872 | + |
|
1873 | + /** |
|
1874 | + * handling for WordPress CPT actions (trash, restore, delete) |
|
1875 | + * |
|
1876 | + * @param string $post_id |
|
1877 | + */ |
|
1878 | + public function trash_cpt_item($post_id) |
|
1879 | + { |
|
1880 | + $this->_req_data['EVT_ID'] = $post_id; |
|
1881 | + $this->_trash_or_restore_event('trash', false); |
|
1882 | + } |
|
1883 | + |
|
1884 | + |
|
1885 | + /** |
|
1886 | + * @param string $post_id |
|
1887 | + */ |
|
1888 | + public function restore_cpt_item($post_id) |
|
1889 | + { |
|
1890 | + $this->_req_data['EVT_ID'] = $post_id; |
|
1891 | + $this->_trash_or_restore_event('draft', false); |
|
1892 | + } |
|
1893 | + |
|
1894 | + |
|
1895 | + /** |
|
1896 | + * @param string $post_id |
|
1897 | + */ |
|
1898 | + public function delete_cpt_item($post_id) |
|
1899 | + { |
|
1900 | + $this->_req_data['EVT_ID'] = $post_id; |
|
1901 | + $this->_delete_event(false); |
|
1902 | + } |
|
1903 | + |
|
1904 | + |
|
1905 | + /** |
|
1906 | + * _trash_or_restore_event |
|
1907 | + * |
|
1908 | + * @access protected |
|
1909 | + * @param string $event_status |
|
1910 | + * @param bool $redirect_after |
|
1911 | + */ |
|
1912 | + protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true) |
|
1913 | + { |
|
1914 | + // determine the event id and set to array. |
|
1915 | + $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false; |
|
1916 | + // loop thru events |
|
1917 | + if ($EVT_ID) { |
|
1918 | + // clean status |
|
1919 | + $event_status = sanitize_key($event_status); |
|
1920 | + // grab status |
|
1921 | + if (! empty($event_status)) { |
|
1922 | + $success = $this->_change_event_status($EVT_ID, $event_status); |
|
1923 | + } else { |
|
1924 | + $success = false; |
|
1925 | + $msg = esc_html__( |
|
1926 | + 'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.', |
|
1927 | + 'event_espresso' |
|
1928 | + ); |
|
1929 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1930 | + } |
|
1931 | + } else { |
|
1932 | + $success = false; |
|
1933 | + $msg = esc_html__( |
|
1934 | + 'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.', |
|
1935 | + 'event_espresso' |
|
1936 | + ); |
|
1937 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1938 | + } |
|
1939 | + $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash'; |
|
1940 | + if ($redirect_after) { |
|
1941 | + $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default')); |
|
1942 | + } |
|
1943 | + } |
|
1944 | + |
|
1945 | + |
|
1946 | + /** |
|
1947 | + * _trash_or_restore_events |
|
1948 | + * |
|
1949 | + * @access protected |
|
1950 | + * @param string $event_status |
|
1951 | + * @return void |
|
1952 | + */ |
|
1953 | + protected function _trash_or_restore_events($event_status = 'trash') |
|
1954 | + { |
|
1955 | + // clean status |
|
1956 | + $event_status = sanitize_key($event_status); |
|
1957 | + // grab status |
|
1958 | + if (! empty($event_status)) { |
|
1959 | + $success = true; |
|
1960 | + // determine the event id and set to array. |
|
1961 | + $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array(); |
|
1962 | + // loop thru events |
|
1963 | + foreach ($EVT_IDs as $EVT_ID) { |
|
1964 | + if ($EVT_ID = absint($EVT_ID)) { |
|
1965 | + $results = $this->_change_event_status($EVT_ID, $event_status); |
|
1966 | + $success = $results !== false ? $success : false; |
|
1967 | + } else { |
|
1968 | + $msg = sprintf( |
|
1969 | + esc_html__( |
|
1970 | + 'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.', |
|
1971 | + 'event_espresso' |
|
1972 | + ), |
|
1973 | + $EVT_ID |
|
1974 | + ); |
|
1975 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1976 | + $success = false; |
|
1977 | + } |
|
1978 | + } |
|
1979 | + } else { |
|
1980 | + $success = false; |
|
1981 | + $msg = esc_html__( |
|
1982 | + 'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.', |
|
1983 | + 'event_espresso' |
|
1984 | + ); |
|
1985 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1986 | + } |
|
1987 | + // in order to force a pluralized result message we need to send back a success status greater than 1 |
|
1988 | + $success = $success ? 2 : false; |
|
1989 | + $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash'; |
|
1990 | + $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default')); |
|
1991 | + } |
|
1992 | + |
|
1993 | + |
|
1994 | + /** |
|
1995 | + * _trash_or_restore_events |
|
1996 | + * |
|
1997 | + * @access private |
|
1998 | + * @param int $EVT_ID |
|
1999 | + * @param string $event_status |
|
2000 | + * @return bool |
|
2001 | + */ |
|
2002 | + private function _change_event_status($EVT_ID = 0, $event_status = '') |
|
2003 | + { |
|
2004 | + // grab event id |
|
2005 | + if (! $EVT_ID) { |
|
2006 | + $msg = esc_html__( |
|
2007 | + 'An error occurred. No Event ID or an invalid Event ID was received.', |
|
2008 | + 'event_espresso' |
|
2009 | + ); |
|
2010 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2011 | + return false; |
|
2012 | + } |
|
2013 | + $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
2014 | + // clean status |
|
2015 | + $event_status = sanitize_key($event_status); |
|
2016 | + // grab status |
|
2017 | + if (empty($event_status)) { |
|
2018 | + $msg = esc_html__( |
|
2019 | + 'An error occurred. No Event Status or an invalid Event Status was received.', |
|
2020 | + 'event_espresso' |
|
2021 | + ); |
|
2022 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2023 | + return false; |
|
2024 | + } |
|
2025 | + // was event trashed or restored ? |
|
2026 | + switch ($event_status) { |
|
2027 | + case 'draft': |
|
2028 | + $action = 'restored from the trash'; |
|
2029 | + $hook = 'AHEE_event_restored_from_trash'; |
|
2030 | + break; |
|
2031 | + case 'trash': |
|
2032 | + $action = 'moved to the trash'; |
|
2033 | + $hook = 'AHEE_event_moved_to_trash'; |
|
2034 | + break; |
|
2035 | + default: |
|
2036 | + $action = 'updated'; |
|
2037 | + $hook = false; |
|
2038 | + } |
|
2039 | + // use class to change status |
|
2040 | + $this->_cpt_model_obj->set_status($event_status); |
|
2041 | + $success = $this->_cpt_model_obj->save(); |
|
2042 | + if ($success === false) { |
|
2043 | + $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action); |
|
2044 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2045 | + return false; |
|
2046 | + } |
|
2047 | + if ($hook) { |
|
2048 | + do_action($hook); |
|
2049 | + } |
|
2050 | + return true; |
|
2051 | + } |
|
2052 | + |
|
2053 | + |
|
2054 | + /** |
|
2055 | + * _delete_event |
|
2056 | + * |
|
2057 | + * @access protected |
|
2058 | + * @param bool $redirect_after |
|
2059 | + */ |
|
2060 | + protected function _delete_event($redirect_after = true) |
|
2061 | + { |
|
2062 | + // determine the event id and set to array. |
|
2063 | + $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null; |
|
2064 | + $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID; |
|
2065 | + // loop thru events |
|
2066 | + if ($EVT_ID) { |
|
2067 | + $success = $this->_permanently_delete_event($EVT_ID); |
|
2068 | + // get list of events with no prices |
|
2069 | + $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array()); |
|
2070 | + // remove this event from the list of events with no prices |
|
2071 | + if (isset($espresso_no_ticket_prices[ $EVT_ID ])) { |
|
2072 | + unset($espresso_no_ticket_prices[ $EVT_ID ]); |
|
2073 | + } |
|
2074 | + update_option('ee_no_ticket_prices', $espresso_no_ticket_prices); |
|
2075 | + } else { |
|
2076 | + $success = false; |
|
2077 | + $msg = esc_html__( |
|
2078 | + 'An error occurred. An event could not be deleted because a valid event ID was not not supplied.', |
|
2079 | + 'event_espresso' |
|
2080 | + ); |
|
2081 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2082 | + } |
|
2083 | + if ($redirect_after) { |
|
2084 | + $this->_redirect_after_action( |
|
2085 | + $success, |
|
2086 | + 'Event', |
|
2087 | + 'deleted', |
|
2088 | + array('action' => 'default', 'status' => 'trash') |
|
2089 | + ); |
|
2090 | + } |
|
2091 | + } |
|
2092 | + |
|
2093 | + |
|
2094 | + /** |
|
2095 | + * _delete_events |
|
2096 | + * |
|
2097 | + * @access protected |
|
2098 | + * @return void |
|
2099 | + */ |
|
2100 | + protected function _delete_events() |
|
2101 | + { |
|
2102 | + $success = true; |
|
2103 | + // get list of events with no prices |
|
2104 | + $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array()); |
|
2105 | + // determine the event id and set to array. |
|
2106 | + $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array(); |
|
2107 | + // loop thru events |
|
2108 | + foreach ($EVT_IDs as $EVT_ID) { |
|
2109 | + $EVT_ID = absint($EVT_ID); |
|
2110 | + if ($EVT_ID) { |
|
2111 | + $results = $this->_permanently_delete_event($EVT_ID); |
|
2112 | + $success = $results !== false ? $success : false; |
|
2113 | + // remove this event from the list of events with no prices |
|
2114 | + unset($espresso_no_ticket_prices[ $EVT_ID ]); |
|
2115 | + } else { |
|
2116 | + $success = false; |
|
2117 | + $msg = esc_html__( |
|
2118 | + 'An error occurred. An event could not be deleted because a valid event ID was not not supplied.', |
|
2119 | + 'event_espresso' |
|
2120 | + ); |
|
2121 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2122 | + } |
|
2123 | + } |
|
2124 | + update_option('ee_no_ticket_prices', $espresso_no_ticket_prices); |
|
2125 | + // in order to force a pluralized result message we need to send back a success status greater than 1 |
|
2126 | + $success = $success ? 2 : false; |
|
2127 | + $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default')); |
|
2128 | + } |
|
2129 | + |
|
2130 | + |
|
2131 | + /** |
|
2132 | + * _permanently_delete_event |
|
2133 | + * |
|
2134 | + * @access private |
|
2135 | + * @param int $EVT_ID |
|
2136 | + * @return bool |
|
2137 | + */ |
|
2138 | + private function _permanently_delete_event($EVT_ID = 0) |
|
2139 | + { |
|
2140 | + // grab event id |
|
2141 | + if (! $EVT_ID) { |
|
2142 | + $msg = esc_html__( |
|
2143 | + 'An error occurred. No Event ID or an invalid Event ID was received.', |
|
2144 | + 'event_espresso' |
|
2145 | + ); |
|
2146 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2147 | + return false; |
|
2148 | + } |
|
2149 | + if (! $this->_cpt_model_obj instanceof EE_Event |
|
2150 | + || $this->_cpt_model_obj->ID() !== $EVT_ID |
|
2151 | + ) { |
|
2152 | + $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
2153 | + } |
|
2154 | + if (! $this->_cpt_model_obj instanceof EE_Event) { |
|
2155 | + return false; |
|
2156 | + } |
|
2157 | + // need to delete related tickets and prices first. |
|
2158 | + $datetimes = $this->_cpt_model_obj->get_many_related('Datetime'); |
|
2159 | + foreach ($datetimes as $datetime) { |
|
2160 | + $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime'); |
|
2161 | + $tickets = $datetime->get_many_related('Ticket'); |
|
2162 | + foreach ($tickets as $ticket) { |
|
2163 | + $ticket->_remove_relation_to($datetime, 'Datetime'); |
|
2164 | + $ticket->delete_related_permanently('Price'); |
|
2165 | + $ticket->delete_permanently(); |
|
2166 | + } |
|
2167 | + $datetime->delete(); |
|
2168 | + } |
|
2169 | + // what about related venues or terms? |
|
2170 | + $venues = $this->_cpt_model_obj->get_many_related('Venue'); |
|
2171 | + foreach ($venues as $venue) { |
|
2172 | + $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue'); |
|
2173 | + } |
|
2174 | + // any attached question groups? |
|
2175 | + $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group'); |
|
2176 | + if (! empty($question_groups)) { |
|
2177 | + foreach ($question_groups as $question_group) { |
|
2178 | + $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group'); |
|
2179 | + } |
|
2180 | + } |
|
2181 | + // Message Template Groups |
|
2182 | + $this->_cpt_model_obj->_remove_relations('Message_Template_Group'); |
|
2183 | + /** @type EE_Term_Taxonomy[] $term_taxonomies */ |
|
2184 | + $term_taxonomies = $this->_cpt_model_obj->term_taxonomies(); |
|
2185 | + foreach ($term_taxonomies as $term_taxonomy) { |
|
2186 | + $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy); |
|
2187 | + } |
|
2188 | + $success = $this->_cpt_model_obj->delete_permanently(); |
|
2189 | + // did it all go as planned ? |
|
2190 | + if ($success) { |
|
2191 | + $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID); |
|
2192 | + EE_Error::add_success($msg); |
|
2193 | + } else { |
|
2194 | + $msg = sprintf( |
|
2195 | + esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'), |
|
2196 | + $EVT_ID |
|
2197 | + ); |
|
2198 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2199 | + return false; |
|
2200 | + } |
|
2201 | + do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID); |
|
2202 | + return true; |
|
2203 | + } |
|
2204 | + |
|
2205 | + |
|
2206 | + /** |
|
2207 | + * get total number of events |
|
2208 | + * |
|
2209 | + * @access public |
|
2210 | + * @return int |
|
2211 | + */ |
|
2212 | + public function total_events() |
|
2213 | + { |
|
2214 | + $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true); |
|
2215 | + return $count; |
|
2216 | + } |
|
2217 | + |
|
2218 | + |
|
2219 | + /** |
|
2220 | + * get total number of draft events |
|
2221 | + * |
|
2222 | + * @access public |
|
2223 | + * @return int |
|
2224 | + */ |
|
2225 | + public function total_events_draft() |
|
2226 | + { |
|
2227 | + $where = array( |
|
2228 | + 'status' => array('IN', array('draft', 'auto-draft')), |
|
2229 | + ); |
|
2230 | + $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true); |
|
2231 | + return $count; |
|
2232 | + } |
|
2233 | + |
|
2234 | + |
|
2235 | + /** |
|
2236 | + * get total number of trashed events |
|
2237 | + * |
|
2238 | + * @access public |
|
2239 | + * @return int |
|
2240 | + */ |
|
2241 | + public function total_trashed_events() |
|
2242 | + { |
|
2243 | + $where = array( |
|
2244 | + 'status' => 'trash', |
|
2245 | + ); |
|
2246 | + $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true); |
|
2247 | + return $count; |
|
2248 | + } |
|
2249 | + |
|
2250 | + |
|
2251 | + /** |
|
2252 | + * _default_event_settings |
|
2253 | + * This generates the Default Settings Tab |
|
2254 | + * |
|
2255 | + * @return void |
|
2256 | + * @throws EE_Error |
|
2257 | + */ |
|
2258 | + protected function _default_event_settings() |
|
2259 | + { |
|
2260 | + $this->_set_add_edit_form_tags('update_default_event_settings'); |
|
2261 | + $this->_set_publish_post_box_vars(null, false, false, null, false); |
|
2262 | + $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html(); |
|
2263 | + $this->display_admin_page_with_sidebar(); |
|
2264 | + } |
|
2265 | + |
|
2266 | + |
|
2267 | + /** |
|
2268 | + * Return the form for event settings. |
|
2269 | + * |
|
2270 | + * @return EE_Form_Section_Proper |
|
2271 | + * @throws EE_Error |
|
2272 | + */ |
|
2273 | + protected function _default_event_settings_form() |
|
2274 | + { |
|
2275 | + $registration_config = EE_Registry::instance()->CFG->registration; |
|
2276 | + $registration_stati_for_selection = EEM_Registration::reg_status_array( |
|
2277 | + // exclude |
|
2278 | + array( |
|
2279 | + EEM_Registration::status_id_cancelled, |
|
2280 | + EEM_Registration::status_id_declined, |
|
2281 | + EEM_Registration::status_id_incomplete, |
|
2282 | + EEM_Registration::status_id_wait_list, |
|
2283 | + ), |
|
2284 | + true |
|
2285 | + ); |
|
2286 | + return new EE_Form_Section_Proper( |
|
2287 | + array( |
|
2288 | + 'name' => 'update_default_event_settings', |
|
2289 | + 'html_id' => 'update_default_event_settings', |
|
2290 | + 'html_class' => 'form-table', |
|
2291 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
2292 | + 'subsections' => apply_filters( |
|
2293 | + 'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections', |
|
2294 | + array( |
|
2295 | + 'default_reg_status' => new EE_Select_Input( |
|
2296 | + $registration_stati_for_selection, |
|
2297 | + array( |
|
2298 | + 'default' => isset($registration_config->default_STS_ID) |
|
2299 | + && array_key_exists( |
|
2300 | + $registration_config->default_STS_ID, |
|
2301 | + $registration_stati_for_selection |
|
2302 | + ) |
|
2303 | + ? sanitize_text_field($registration_config->default_STS_ID) |
|
2304 | + : EEM_Registration::status_id_pending_payment, |
|
2305 | + 'html_label_text' => esc_html__('Default Registration Status', 'event_espresso') |
|
2306 | + . EEH_Template::get_help_tab_link( |
|
2307 | + 'default_settings_status_help_tab' |
|
2308 | + ), |
|
2309 | + 'html_help_text' => esc_html__( |
|
2310 | + 'This setting allows you to preselect what the default registration status setting is when creating an event. Note that changing this setting does NOT retroactively apply it to existing events.', |
|
2311 | + 'event_espresso' |
|
2312 | + ), |
|
2313 | + ) |
|
2314 | + ), |
|
2315 | + 'default_max_tickets' => new EE_Integer_Input( |
|
2316 | + array( |
|
2317 | + 'default' => isset($registration_config->default_maximum_number_of_tickets) |
|
2318 | + ? $registration_config->default_maximum_number_of_tickets |
|
2319 | + : EEM_Event::get_default_additional_limit(), |
|
2320 | + 'html_label_text' => esc_html__( |
|
2321 | + 'Default Maximum Tickets Allowed Per Order:', |
|
2322 | + 'event_espresso' |
|
2323 | + ) |
|
2324 | + . EEH_Template::get_help_tab_link( |
|
2325 | + 'default_maximum_tickets_help_tab"' |
|
2326 | + ), |
|
2327 | + 'html_help_text' => esc_html__( |
|
2328 | + 'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.', |
|
2329 | + 'event_espresso' |
|
2330 | + ), |
|
2331 | + ) |
|
2332 | + ), |
|
2333 | + ) |
|
2334 | + ), |
|
2335 | + ) |
|
2336 | + ); |
|
2337 | + } |
|
2338 | + |
|
2339 | + |
|
2340 | + /** |
|
2341 | + * _update_default_event_settings |
|
2342 | + * |
|
2343 | + * @access protected |
|
2344 | + * @return void |
|
2345 | + * @throws EE_Error |
|
2346 | + */ |
|
2347 | + protected function _update_default_event_settings() |
|
2348 | + { |
|
2349 | + $registration_config = EE_Registry::instance()->CFG->registration; |
|
2350 | + $form = $this->_default_event_settings_form(); |
|
2351 | + if ($form->was_submitted()) { |
|
2352 | + $form->receive_form_submission(); |
|
2353 | + if ($form->is_valid()) { |
|
2354 | + $valid_data = $form->valid_data(); |
|
2355 | + if (isset($valid_data['default_reg_status'])) { |
|
2356 | + $registration_config->default_STS_ID = $valid_data['default_reg_status']; |
|
2357 | + } |
|
2358 | + if (isset($valid_data['default_max_tickets'])) { |
|
2359 | + $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets']; |
|
2360 | + } |
|
2361 | + // update because data was valid! |
|
2362 | + EE_Registry::instance()->CFG->update_espresso_config(); |
|
2363 | + EE_Error::overwrite_success(); |
|
2364 | + EE_Error::add_success( |
|
2365 | + __('Default Event Settings were updated', 'event_espresso') |
|
2366 | + ); |
|
2367 | + } |
|
2368 | + } |
|
2369 | + $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true); |
|
2370 | + } |
|
2371 | + |
|
2372 | + |
|
2373 | + /************* Templates *************/ |
|
2374 | + protected function _template_settings() |
|
2375 | + { |
|
2376 | + $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso'); |
|
2377 | + $this->_template_args['preview_img'] = '<img src="' |
|
2378 | + . EVENTS_ASSETS_URL |
|
2379 | + . DS |
|
2380 | + . 'images' |
|
2381 | + . DS |
|
2382 | + . 'caffeinated_template_features.jpg" alt="' |
|
2383 | + . esc_attr__('Template Settings Preview screenshot', 'event_espresso') |
|
2384 | + . '" />'; |
|
2385 | + $this->_template_args['preview_text'] = '<strong>' |
|
2386 | + . esc_html__( |
|
2387 | + 'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.', |
|
2388 | + 'event_espresso' |
|
2389 | + ) . '</strong>'; |
|
2390 | + $this->display_admin_caf_preview_page('template_settings_tab'); |
|
2391 | + } |
|
2392 | + |
|
2393 | + |
|
2394 | + /** Event Category Stuff **/ |
|
2395 | + /** |
|
2396 | + * set the _category property with the category object for the loaded page. |
|
2397 | + * |
|
2398 | + * @access private |
|
2399 | + * @return void |
|
2400 | + */ |
|
2401 | + private function _set_category_object() |
|
2402 | + { |
|
2403 | + if (isset($this->_category->id) && ! empty($this->_category->id)) { |
|
2404 | + return; |
|
2405 | + } //already have the category object so get out. |
|
2406 | + // set default category object |
|
2407 | + $this->_set_empty_category_object(); |
|
2408 | + // only set if we've got an id |
|
2409 | + if (! isset($this->_req_data['EVT_CAT_ID'])) { |
|
2410 | + return; |
|
2411 | + } |
|
2412 | + $category_id = absint($this->_req_data['EVT_CAT_ID']); |
|
2413 | + $term = get_term($category_id, 'espresso_event_categories'); |
|
2414 | + if (! empty($term)) { |
|
2415 | + $this->_category->category_name = $term->name; |
|
2416 | + $this->_category->category_identifier = $term->slug; |
|
2417 | + $this->_category->category_desc = $term->description; |
|
2418 | + $this->_category->id = $term->term_id; |
|
2419 | + $this->_category->parent = $term->parent; |
|
2420 | + } |
|
2421 | + } |
|
2422 | + |
|
2423 | + |
|
2424 | + /** |
|
2425 | + * Clears out category properties. |
|
2426 | + */ |
|
2427 | + private function _set_empty_category_object() |
|
2428 | + { |
|
2429 | + $this->_category = new stdClass(); |
|
2430 | + $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = ''; |
|
2431 | + $this->_category->id = $this->_category->parent = 0; |
|
2432 | + } |
|
2433 | + |
|
2434 | + |
|
2435 | + /** |
|
2436 | + * @throws EE_Error |
|
2437 | + */ |
|
2438 | + protected function _category_list_table() |
|
2439 | + { |
|
2440 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2441 | + $this->_search_btn_label = esc_html__('Categories', 'event_espresso'); |
|
2442 | + $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
2443 | + 'add_category', |
|
2444 | + 'add_category', |
|
2445 | + array(), |
|
2446 | + 'add-new-h2' |
|
2447 | + ); |
|
2448 | + $this->display_admin_list_table_page_with_sidebar(); |
|
2449 | + } |
|
2450 | + |
|
2451 | + |
|
2452 | + /** |
|
2453 | + * Output category details view. |
|
2454 | + */ |
|
2455 | + protected function _category_details($view) |
|
2456 | + { |
|
2457 | + // load formatter helper |
|
2458 | + // load field generator helper |
|
2459 | + $route = $view == 'edit' ? 'update_category' : 'insert_category'; |
|
2460 | + $this->_set_add_edit_form_tags($route); |
|
2461 | + $this->_set_category_object(); |
|
2462 | + $id = ! empty($this->_category->id) ? $this->_category->id : ''; |
|
2463 | + $delete_action = 'delete_category'; |
|
2464 | + // custom redirect |
|
2465 | + $redirect = EE_Admin_Page::add_query_args_and_nonce( |
|
2466 | + array('action' => 'category_list'), |
|
2467 | + $this->_admin_base_url |
|
2468 | + ); |
|
2469 | + $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect); |
|
2470 | + // take care of contents |
|
2471 | + $this->_template_args['admin_page_content'] = $this->_category_details_content(); |
|
2472 | + $this->display_admin_page_with_sidebar(); |
|
2473 | + } |
|
2474 | + |
|
2475 | + |
|
2476 | + /** |
|
2477 | + * Output category details content. |
|
2478 | + */ |
|
2479 | + protected function _category_details_content() |
|
2480 | + { |
|
2481 | + $editor_args['category_desc'] = array( |
|
2482 | + 'type' => 'wp_editor', |
|
2483 | + 'value' => EEH_Formatter::admin_format_content($this->_category->category_desc), |
|
2484 | + 'class' => 'my_editor_custom', |
|
2485 | + 'wpeditor_args' => array('media_buttons' => false), |
|
2486 | + ); |
|
2487 | + $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array'); |
|
2488 | + $all_terms = get_terms( |
|
2489 | + array('espresso_event_categories'), |
|
2490 | + array('hide_empty' => 0, 'exclude' => array($this->_category->id)) |
|
2491 | + ); |
|
2492 | + // setup category select for term parents. |
|
2493 | + $category_select_values[] = array( |
|
2494 | + 'text' => esc_html__('No Parent', 'event_espresso'), |
|
2495 | + 'id' => 0, |
|
2496 | + ); |
|
2497 | + foreach ($all_terms as $term) { |
|
2498 | + $category_select_values[] = array( |
|
2499 | + 'text' => $term->name, |
|
2500 | + 'id' => $term->term_id, |
|
2501 | + ); |
|
2502 | + } |
|
2503 | + $category_select = EEH_Form_Fields::select_input( |
|
2504 | + 'category_parent', |
|
2505 | + $category_select_values, |
|
2506 | + $this->_category->parent |
|
2507 | + ); |
|
2508 | + $template_args = array( |
|
2509 | + 'category' => $this->_category, |
|
2510 | + 'category_select' => $category_select, |
|
2511 | + 'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'), |
|
2512 | + 'category_desc_editor' => $_wp_editor['category_desc']['field'], |
|
2513 | + 'disable' => '', |
|
2514 | + 'disabled_message' => false, |
|
2515 | + ); |
|
2516 | + $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php'; |
|
2517 | + return EEH_Template::display_template($template, $template_args, true); |
|
2518 | + } |
|
2519 | + |
|
2520 | + |
|
2521 | + /** |
|
2522 | + * Handles deleting categories. |
|
2523 | + */ |
|
2524 | + protected function _delete_categories() |
|
2525 | + { |
|
2526 | + $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID'] |
|
2527 | + : (array) $this->_req_data['category_id']; |
|
2528 | + foreach ($cat_ids as $cat_id) { |
|
2529 | + $this->_delete_category($cat_id); |
|
2530 | + } |
|
2531 | + // doesn't matter what page we're coming from... we're going to the same place after delete. |
|
2532 | + $query_args = array( |
|
2533 | + 'action' => 'category_list', |
|
2534 | + ); |
|
2535 | + $this->_redirect_after_action(0, '', '', $query_args); |
|
2536 | + } |
|
2537 | + |
|
2538 | + |
|
2539 | + /** |
|
2540 | + * Handles deleting specific category. |
|
2541 | + * |
|
2542 | + * @param int $cat_id |
|
2543 | + */ |
|
2544 | + protected function _delete_category($cat_id) |
|
2545 | + { |
|
2546 | + $cat_id = absint($cat_id); |
|
2547 | + wp_delete_term($cat_id, 'espresso_event_categories'); |
|
2548 | + } |
|
2549 | + |
|
2550 | + |
|
2551 | + /** |
|
2552 | + * Handles triggering the update or insertion of a new category. |
|
2553 | + * |
|
2554 | + * @param bool $new_category true means we're triggering the insert of a new category. |
|
2555 | + */ |
|
2556 | + protected function _insert_or_update_category($new_category) |
|
2557 | + { |
|
2558 | + $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true); |
|
2559 | + $success = 0; // we already have a success message so lets not send another. |
|
2560 | + if ($cat_id) { |
|
2561 | + $query_args = array( |
|
2562 | + 'action' => 'edit_category', |
|
2563 | + 'EVT_CAT_ID' => $cat_id, |
|
2564 | + ); |
|
2565 | + } else { |
|
2566 | + $query_args = array('action' => 'add_category'); |
|
2567 | + } |
|
2568 | + $this->_redirect_after_action($success, '', '', $query_args, true); |
|
2569 | + } |
|
2570 | + |
|
2571 | + |
|
2572 | + /** |
|
2573 | + * Inserts or updates category |
|
2574 | + * |
|
2575 | + * @param bool $update (true indicates we're updating a category). |
|
2576 | + * @return bool|mixed|string |
|
2577 | + */ |
|
2578 | + private function _insert_category($update = false) |
|
2579 | + { |
|
2580 | + $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : ''; |
|
2581 | + $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : ''; |
|
2582 | + $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : ''; |
|
2583 | + $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0; |
|
2584 | + if (empty($category_name)) { |
|
2585 | + $msg = esc_html__('You must add a name for the category.', 'event_espresso'); |
|
2586 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2587 | + return false; |
|
2588 | + } |
|
2589 | + $term_args = array( |
|
2590 | + 'name' => $category_name, |
|
2591 | + 'description' => $category_desc, |
|
2592 | + 'parent' => $category_parent, |
|
2593 | + ); |
|
2594 | + // was the category_identifier input disabled? |
|
2595 | + if (isset($this->_req_data['category_identifier'])) { |
|
2596 | + $term_args['slug'] = $this->_req_data['category_identifier']; |
|
2597 | + } |
|
2598 | + $insert_ids = $update |
|
2599 | + ? wp_update_term($cat_id, 'espresso_event_categories', $term_args) |
|
2600 | + : wp_insert_term($category_name, 'espresso_event_categories', $term_args); |
|
2601 | + if (! is_array($insert_ids)) { |
|
2602 | + $msg = esc_html__( |
|
2603 | + 'An error occurred and the category has not been saved to the database.', |
|
2604 | + 'event_espresso' |
|
2605 | + ); |
|
2606 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
2607 | + } else { |
|
2608 | + $cat_id = $insert_ids['term_id']; |
|
2609 | + $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name); |
|
2610 | + EE_Error::add_success($msg); |
|
2611 | + } |
|
2612 | + return $cat_id; |
|
2613 | + } |
|
2614 | + |
|
2615 | + |
|
2616 | + /** |
|
2617 | + * Gets categories or count of categories matching the arguments in the request. |
|
2618 | + * |
|
2619 | + * @param int $per_page |
|
2620 | + * @param int $current_page |
|
2621 | + * @param bool $count |
|
2622 | + * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int |
|
2623 | + */ |
|
2624 | + public function get_categories($per_page = 10, $current_page = 1, $count = false) |
|
2625 | + { |
|
2626 | + // testing term stuff |
|
2627 | + $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id'; |
|
2628 | + $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC'; |
|
2629 | + $limit = ($current_page - 1) * $per_page; |
|
2630 | + $where = array('taxonomy' => 'espresso_event_categories'); |
|
2631 | + if (isset($this->_req_data['s'])) { |
|
2632 | + $sstr = '%' . $this->_req_data['s'] . '%'; |
|
2633 | + $where['OR'] = array( |
|
2634 | + 'Term.name' => array('LIKE', $sstr), |
|
2635 | + 'description' => array('LIKE', $sstr), |
|
2636 | + ); |
|
2637 | + } |
|
2638 | + $query_params = array( |
|
2639 | + $where, |
|
2640 | + 'order_by' => array($orderby => $order), |
|
2641 | + 'limit' => $limit . ',' . $per_page, |
|
2642 | + 'force_join' => array('Term'), |
|
2643 | + ); |
|
2644 | + $categories = $count |
|
2645 | + ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id') |
|
2646 | + : EEM_Term_Taxonomy::instance()->get_all($query_params); |
|
2647 | + return $categories; |
|
2648 | + } |
|
2649 | + |
|
2650 | + /* end category stuff */ |
|
2651 | + /**************/ |
|
2652 | + |
|
2653 | + |
|
2654 | + /** |
|
2655 | + * Callback for the `ee_save_timezone_setting` ajax action. |
|
2656 | + * |
|
2657 | + * @throws EE_Error |
|
2658 | + */ |
|
2659 | + public function save_timezonestring_setting() |
|
2660 | + { |
|
2661 | + $timezone_string = isset($this->_req_data['timezone_selected']) |
|
2662 | + ? $this->_req_data['timezone_selected'] |
|
2663 | + : ''; |
|
2664 | + if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) { |
|
2665 | + EE_Error::add_error( |
|
2666 | + esc_html__('An invalid timezone string submitted.', 'event_espresso'), |
|
2667 | + __FILE__, |
|
2668 | + __FUNCTION__, |
|
2669 | + __LINE__ |
|
2670 | + ); |
|
2671 | + $this->_template_args['error'] = true; |
|
2672 | + $this->_return_json(); |
|
2673 | + } |
|
2674 | + |
|
2675 | + update_option('timezone_string', $timezone_string); |
|
2676 | + EE_Error::add_success( |
|
2677 | + esc_html__('Your timezone string was updated.', 'event_espresso') |
|
2678 | + ); |
|
2679 | + $this->_template_args['success'] = true; |
|
2680 | + $this->_return_json(true, array('action' => 'create_new')); |
|
2681 | + } |
|
2682 | 2682 | } |
@@ -17,880 +17,880 @@ |
||
17 | 17 | { |
18 | 18 | |
19 | 19 | |
20 | - /** |
|
21 | - * @var EE_Form_Section_Proper |
|
22 | - */ |
|
23 | - protected $datetime_fix_offset_form; |
|
24 | - |
|
25 | - |
|
26 | - protected function _init_page_props() |
|
27 | - { |
|
28 | - $this->page_slug = EE_MAINTENANCE_PG_SLUG; |
|
29 | - $this->page_label = EE_MAINTENANCE_LABEL; |
|
30 | - $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL; |
|
31 | - $this->_admin_base_path = EE_MAINTENANCE_ADMIN; |
|
32 | - } |
|
33 | - |
|
34 | - |
|
35 | - protected function _ajax_hooks() |
|
36 | - { |
|
37 | - add_action('wp_ajax_migration_step', array($this, 'migration_step')); |
|
38 | - add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran')); |
|
39 | - } |
|
40 | - |
|
41 | - |
|
42 | - protected function _define_page_props() |
|
43 | - { |
|
44 | - $this->_admin_page_title = EE_MAINTENANCE_LABEL; |
|
45 | - $this->_labels = array( |
|
46 | - 'buttons' => array( |
|
47 | - 'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'), |
|
48 | - 'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'), |
|
49 | - ), |
|
50 | - ); |
|
51 | - } |
|
52 | - |
|
53 | - |
|
54 | - protected function _set_page_routes() |
|
55 | - { |
|
56 | - $this->_page_routes = array( |
|
57 | - 'default' => array( |
|
58 | - 'func' => '_maintenance', |
|
59 | - 'capability' => 'manage_options', |
|
60 | - ), |
|
61 | - 'change_maintenance_level' => array( |
|
62 | - 'func' => '_change_maintenance_level', |
|
63 | - 'capability' => 'manage_options', |
|
64 | - 'noheader' => true, |
|
65 | - ), |
|
66 | - 'system_status' => array( |
|
67 | - 'func' => '_system_status', |
|
68 | - 'capability' => 'manage_options', |
|
69 | - ), |
|
70 | - 'download_system_status' => array( |
|
71 | - 'func' => '_download_system_status', |
|
72 | - 'capability' => 'manage_options', |
|
73 | - 'noheader' => true, |
|
74 | - ), |
|
75 | - 'send_migration_crash_report' => array( |
|
76 | - 'func' => '_send_migration_crash_report', |
|
77 | - 'capability' => 'manage_options', |
|
78 | - 'noheader' => true, |
|
79 | - ), |
|
80 | - 'confirm_migration_crash_report_sent' => array( |
|
81 | - 'func' => '_confirm_migration_crash_report_sent', |
|
82 | - 'capability' => 'manage_options', |
|
83 | - ), |
|
84 | - 'data_reset' => array( |
|
85 | - 'func' => '_data_reset_and_delete', |
|
86 | - 'capability' => 'manage_options', |
|
87 | - ), |
|
88 | - 'reset_db' => array( |
|
89 | - 'func' => '_reset_db', |
|
90 | - 'capability' => 'manage_options', |
|
91 | - 'noheader' => true, |
|
92 | - 'args' => array('nuke_old_ee4_data' => true), |
|
93 | - ), |
|
94 | - 'start_with_fresh_ee4_db' => array( |
|
95 | - 'func' => '_reset_db', |
|
96 | - 'capability' => 'manage_options', |
|
97 | - 'noheader' => true, |
|
98 | - 'args' => array('nuke_old_ee4_data' => false), |
|
99 | - ), |
|
100 | - 'delete_db' => array( |
|
101 | - 'func' => '_delete_db', |
|
102 | - 'capability' => 'manage_options', |
|
103 | - 'noheader' => true, |
|
104 | - ), |
|
105 | - 'rerun_migration_from_ee3' => array( |
|
106 | - 'func' => '_rerun_migration_from_ee3', |
|
107 | - 'capability' => 'manage_options', |
|
108 | - 'noheader' => true, |
|
109 | - ), |
|
110 | - 'reset_reservations' => array( |
|
111 | - 'func' => '_reset_reservations', |
|
112 | - 'capability' => 'manage_options', |
|
113 | - 'noheader' => true, |
|
114 | - ), |
|
115 | - 'reset_capabilities' => array( |
|
116 | - 'func' => '_reset_capabilities', |
|
117 | - 'capability' => 'manage_options', |
|
118 | - 'noheader' => true, |
|
119 | - ), |
|
120 | - 'reattempt_migration' => array( |
|
121 | - 'func' => '_reattempt_migration', |
|
122 | - 'capability' => 'manage_options', |
|
123 | - 'noheader' => true, |
|
124 | - ), |
|
125 | - 'datetime_tools' => array( |
|
126 | - 'func' => '_datetime_tools', |
|
127 | - 'capability' => 'manage_options', |
|
128 | - ), |
|
129 | - 'run_datetime_offset_fix' => array( |
|
130 | - 'func' => '_apply_datetime_offset', |
|
131 | - 'noheader' => true, |
|
132 | - 'headers_sent_route' => 'datetime_tools', |
|
133 | - 'capability' => 'manage_options', |
|
134 | - ), |
|
135 | - ); |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - protected function _set_page_config() |
|
140 | - { |
|
141 | - $this->_page_config = array( |
|
142 | - 'default' => array( |
|
143 | - 'nav' => array( |
|
144 | - 'label' => esc_html__('Maintenance', 'event_espresso'), |
|
145 | - 'order' => 10, |
|
146 | - ), |
|
147 | - 'require_nonce' => false, |
|
148 | - ), |
|
149 | - 'data_reset' => array( |
|
150 | - 'nav' => array( |
|
151 | - 'label' => esc_html__('Reset/Delete Data', 'event_espresso'), |
|
152 | - 'order' => 20, |
|
153 | - ), |
|
154 | - 'require_nonce' => false, |
|
155 | - ), |
|
156 | - 'datetime_tools' => array( |
|
157 | - 'nav' => array( |
|
158 | - 'label' => esc_html__('Datetime Utilities', 'event_espresso'), |
|
159 | - 'order' => 25, |
|
160 | - ), |
|
161 | - 'require_nonce' => false, |
|
162 | - ), |
|
163 | - 'system_status' => array( |
|
164 | - 'nav' => array( |
|
165 | - 'label' => esc_html__("System Information", "event_espresso"), |
|
166 | - 'order' => 30, |
|
167 | - ), |
|
168 | - 'require_nonce' => false, |
|
169 | - ), |
|
170 | - ); |
|
171 | - } |
|
172 | - |
|
173 | - |
|
174 | - /** |
|
175 | - * default maintenance page. If we're in maintenance mode level 2, then we need to show |
|
176 | - * the migration scripts and all that UI. |
|
177 | - */ |
|
178 | - public function _maintenance() |
|
179 | - { |
|
180 | - // it all depends if we're in maintenance model level 1 (frontend-only) or |
|
181 | - // level 2 (everything except maintenance page) |
|
182 | - try { |
|
183 | - // get the current maintenance level and check if |
|
184 | - // we are removed |
|
185 | - $mm = EE_Maintenance_Mode::instance()->level(); |
|
186 | - $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
|
187 | - if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) { |
|
188 | - // we just took the site out of maintenance mode, so notify the user. |
|
189 | - // unfortunately this message appears to be echoed on the NEXT page load... |
|
190 | - // oh well, we should really be checking for this on addon deactivation anyways |
|
191 | - EE_Error::add_attention( |
|
192 | - __( |
|
193 | - 'Site taken out of maintenance mode because no data migration scripts are required', |
|
194 | - 'event_espresso' |
|
195 | - ) |
|
196 | - ); |
|
197 | - $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false); |
|
198 | - } |
|
199 | - // in case an exception is thrown while trying to handle migrations |
|
200 | - switch (EE_Maintenance_Mode::instance()->level()) { |
|
201 | - case EE_Maintenance_Mode::level_0_not_in_maintenance: |
|
202 | - case EE_Maintenance_Mode::level_1_frontend_only_maintenance: |
|
203 | - $show_maintenance_switch = true; |
|
204 | - $show_backup_db_text = false; |
|
205 | - $show_migration_progress = false; |
|
206 | - $script_names = array(); |
|
207 | - $addons_should_be_upgraded_first = false; |
|
208 | - break; |
|
209 | - case EE_Maintenance_Mode::level_2_complete_maintenance: |
|
210 | - $show_maintenance_switch = false; |
|
211 | - $show_migration_progress = true; |
|
212 | - if (isset($this->_req_data['continue_migration'])) { |
|
213 | - $show_backup_db_text = false; |
|
214 | - } else { |
|
215 | - $show_backup_db_text = true; |
|
216 | - } |
|
217 | - $scripts_needing_to_run = EE_Data_Migration_Manager::instance() |
|
218 | - ->check_for_applicable_data_migration_scripts(); |
|
219 | - $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating(); |
|
220 | - $script_names = array(); |
|
221 | - $current_script = null; |
|
222 | - foreach ($scripts_needing_to_run as $script) { |
|
223 | - if ($script instanceof EE_Data_Migration_Script_Base) { |
|
224 | - if (! $current_script) { |
|
225 | - $current_script = $script; |
|
226 | - $current_script->migration_page_hooks(); |
|
227 | - } |
|
228 | - $script_names[] = $script->pretty_name(); |
|
229 | - } |
|
230 | - } |
|
231 | - break; |
|
232 | - } |
|
233 | - $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true); |
|
234 | - $exception_thrown = false; |
|
235 | - } catch (EE_Error $e) { |
|
236 | - EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage()); |
|
237 | - // now, just so we can display the page correctly, make a error migration script stage object |
|
238 | - // and also put the error on it. It only persists for the duration of this request |
|
239 | - $most_recent_migration = new EE_DMS_Unknown_1_0_0(); |
|
240 | - $most_recent_migration->add_error($e->getMessage()); |
|
241 | - $exception_thrown = true; |
|
242 | - } |
|
243 | - $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set(); |
|
244 | - $current_db_state = str_replace('.decaf', '', $current_db_state); |
|
245 | - if ($exception_thrown |
|
246 | - || ($most_recent_migration |
|
247 | - && $most_recent_migration instanceof EE_Data_Migration_Script_Base |
|
248 | - && $most_recent_migration->is_broken() |
|
249 | - ) |
|
250 | - ) { |
|
251 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php'; |
|
252 | - $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/'; |
|
253 | - $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce( |
|
254 | - array( |
|
255 | - 'action' => 'confirm_migration_crash_report_sent', |
|
256 | - 'success' => '0', |
|
257 | - ), |
|
258 | - EE_MAINTENANCE_ADMIN_URL |
|
259 | - ); |
|
260 | - } elseif ($addons_should_be_upgraded_first) { |
|
261 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php'; |
|
262 | - } else { |
|
263 | - if ($most_recent_migration |
|
264 | - && $most_recent_migration instanceof EE_Data_Migration_Script_Base |
|
265 | - && $most_recent_migration->can_continue() |
|
266 | - ) { |
|
267 | - $show_backup_db_text = false; |
|
268 | - $show_continue_current_migration_script = true; |
|
269 | - $show_most_recent_migration = true; |
|
270 | - } elseif (isset($this->_req_data['continue_migration'])) { |
|
271 | - $show_most_recent_migration = true; |
|
272 | - $show_continue_current_migration_script = false; |
|
273 | - } else { |
|
274 | - $show_most_recent_migration = false; |
|
275 | - $show_continue_current_migration_script = false; |
|
276 | - } |
|
277 | - if (isset($current_script)) { |
|
278 | - $migrates_to = $current_script->migrates_to_version(); |
|
279 | - $plugin_slug = $migrates_to['slug']; |
|
280 | - $new_version = $migrates_to['version']; |
|
281 | - $this->_template_args = array_merge( |
|
282 | - $this->_template_args, |
|
283 | - array( |
|
284 | - 'current_db_state' => sprintf( |
|
285 | - __("EE%s (%s)", "event_espresso"), |
|
286 | - isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3, |
|
287 | - $plugin_slug |
|
288 | - ), |
|
289 | - 'next_db_state' => isset($current_script) ? sprintf( |
|
290 | - __("EE%s (%s)", 'event_espresso'), |
|
291 | - $new_version, |
|
292 | - $plugin_slug |
|
293 | - ) : null, |
|
294 | - ) |
|
295 | - ); |
|
296 | - } else { |
|
297 | - $this->_template_args['current_db_state'] = null; |
|
298 | - $this->_template_args['next_db_state'] = null; |
|
299 | - } |
|
300 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php'; |
|
301 | - $this->_template_args = array_merge( |
|
302 | - $this->_template_args, |
|
303 | - array( |
|
304 | - 'show_most_recent_migration' => $show_most_recent_migration, |
|
305 | - // flag for showing the most recent migration's status and/or errors |
|
306 | - 'show_migration_progress' => $show_migration_progress, |
|
307 | - // flag for showing the option to run migrations and see their progress |
|
308 | - 'show_backup_db_text' => $show_backup_db_text, |
|
309 | - // flag for showing text telling the user to backup their DB |
|
310 | - 'show_maintenance_switch' => $show_maintenance_switch, |
|
311 | - // flag for showing the option to change maintenance mode between levels 0 and 1 |
|
312 | - 'script_names' => $script_names, |
|
313 | - // array of names of scripts that have run |
|
314 | - 'show_continue_current_migration_script' => $show_continue_current_migration_script, |
|
315 | - // flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0 |
|
316 | - 'reset_db_page_link' => EE_Admin_Page::add_query_args_and_nonce( |
|
317 | - array('action' => 'reset_db'), |
|
318 | - EE_MAINTENANCE_ADMIN_URL |
|
319 | - ), |
|
320 | - 'data_reset_page' => EE_Admin_Page::add_query_args_and_nonce( |
|
321 | - array('action' => 'data_reset'), |
|
322 | - EE_MAINTENANCE_ADMIN_URL |
|
323 | - ), |
|
324 | - 'update_migration_script_page_link' => EE_Admin_Page::add_query_args_and_nonce( |
|
325 | - array('action' => 'change_maintenance_level'), |
|
326 | - EE_MAINTENANCE_ADMIN_URL |
|
327 | - ), |
|
328 | - 'ultimate_db_state' => sprintf( |
|
329 | - __("EE%s", 'event_espresso'), |
|
330 | - espresso_version() |
|
331 | - ), |
|
332 | - ) |
|
333 | - ); |
|
334 | - // make sure we have the form fields helper available. It usually is, but sometimes it isn't |
|
335 | - } |
|
336 | - $this->_template_args['most_recent_migration'] = $most_recent_migration;// the actual most recently ran migration |
|
337 | - // now render the migration options part, and put it in a variable |
|
338 | - $migration_options_template_file = apply_filters( |
|
339 | - 'FHEE__ee_migration_page__migration_options_template', |
|
340 | - EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php' |
|
341 | - ); |
|
342 | - $migration_options_html = EEH_Template::display_template( |
|
343 | - $migration_options_template_file, |
|
344 | - $this->_template_args, |
|
345 | - true |
|
346 | - ); |
|
347 | - $this->_template_args['migration_options_html'] = $migration_options_html; |
|
348 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
349 | - $this->_template_path, |
|
350 | - $this->_template_args, |
|
351 | - true |
|
352 | - ); |
|
353 | - $this->display_admin_page_with_sidebar(); |
|
354 | - } |
|
355 | - |
|
356 | - |
|
357 | - /** |
|
358 | - * returns JSON and executes another step of the currently-executing data migration (called via ajax) |
|
359 | - */ |
|
360 | - public function migration_step() |
|
361 | - { |
|
362 | - $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request(); |
|
363 | - $this->_return_json(); |
|
364 | - } |
|
365 | - |
|
366 | - |
|
367 | - /** |
|
368 | - * Can be used by js when it notices a response with HTML in it in order |
|
369 | - * to log the malformed response |
|
370 | - */ |
|
371 | - public function add_error_to_migrations_ran() |
|
372 | - { |
|
373 | - EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']); |
|
374 | - $this->_template_args['data'] = array('ok' => true); |
|
375 | - $this->_return_json(); |
|
376 | - } |
|
377 | - |
|
378 | - |
|
379 | - /** |
|
380 | - * changes the maintenance level, provided there are still no migration scripts that should run |
|
381 | - */ |
|
382 | - public function _change_maintenance_level() |
|
383 | - { |
|
384 | - $new_level = absint($this->_req_data['maintenance_mode_level']); |
|
385 | - if (! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) { |
|
386 | - EE_Maintenance_Mode::instance()->set_maintenance_level($new_level); |
|
387 | - $success = true; |
|
388 | - } else { |
|
389 | - EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
|
390 | - $success = false; |
|
391 | - } |
|
392 | - $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso")); |
|
393 | - } |
|
394 | - |
|
395 | - |
|
396 | - /** |
|
397 | - * a tab with options for resetting and/or deleting EE data |
|
398 | - * |
|
399 | - * @throws \EE_Error |
|
400 | - * @throws \DomainException |
|
401 | - */ |
|
402 | - public function _data_reset_and_delete() |
|
403 | - { |
|
404 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php'; |
|
405 | - $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button( |
|
406 | - 'reset_reservations', |
|
407 | - 'reset_reservations', |
|
408 | - array(), |
|
409 | - 'button button-primary ee-confirm', |
|
410 | - '', |
|
411 | - false |
|
412 | - ); |
|
413 | - $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button( |
|
414 | - 'reset_capabilities', |
|
415 | - 'reset_capabilities', |
|
416 | - array(), |
|
417 | - 'button button-primary ee-confirm', |
|
418 | - '', |
|
419 | - false |
|
420 | - ); |
|
421 | - $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
422 | - array('action' => 'delete_db'), |
|
423 | - EE_MAINTENANCE_ADMIN_URL |
|
424 | - ); |
|
425 | - $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
426 | - array('action' => 'reset_db'), |
|
427 | - EE_MAINTENANCE_ADMIN_URL |
|
428 | - ); |
|
429 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
430 | - $this->_template_path, |
|
431 | - $this->_template_args, |
|
432 | - true |
|
433 | - ); |
|
434 | - $this->display_admin_page_with_sidebar(); |
|
435 | - } |
|
436 | - |
|
437 | - |
|
438 | - protected function _reset_reservations() |
|
439 | - { |
|
440 | - if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) { |
|
441 | - EE_Error::add_success( |
|
442 | - __( |
|
443 | - 'Ticket and datetime reserved counts have been successfully reset.', |
|
444 | - 'event_espresso' |
|
445 | - ) |
|
446 | - ); |
|
447 | - } else { |
|
448 | - EE_Error::add_success( |
|
449 | - __( |
|
450 | - 'Ticket and datetime reserved counts were correct and did not need resetting.', |
|
451 | - 'event_espresso' |
|
452 | - ) |
|
453 | - ); |
|
454 | - } |
|
455 | - $this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true); |
|
456 | - } |
|
457 | - |
|
458 | - |
|
459 | - protected function _reset_capabilities() |
|
460 | - { |
|
461 | - EE_Registry::instance()->CAP->init_caps(true); |
|
462 | - EE_Error::add_success( |
|
463 | - __( |
|
464 | - 'Default Event Espresso capabilities have been restored for all current roles.', |
|
465 | - 'event_espresso' |
|
466 | - ) |
|
467 | - ); |
|
468 | - $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true); |
|
469 | - } |
|
470 | - |
|
471 | - |
|
472 | - /** |
|
473 | - * resets the DMSs so we can attempt to continue migrating after a fatal error |
|
474 | - * (only a good idea when someone has somehow tried ot fix whatever caused |
|
475 | - * the fatal error in teh first place) |
|
476 | - */ |
|
477 | - protected function _reattempt_migration() |
|
478 | - { |
|
479 | - EE_Data_Migration_Manager::instance()->reattempt(); |
|
480 | - $this->_redirect_after_action(false, '', '', array('action' => 'default'), true); |
|
481 | - } |
|
482 | - |
|
483 | - |
|
484 | - /** |
|
485 | - * shows the big ol' System Information page |
|
486 | - */ |
|
487 | - public function _system_status() |
|
488 | - { |
|
489 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php'; |
|
490 | - $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati(); |
|
491 | - $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
492 | - array( |
|
493 | - 'action' => 'download_system_status', |
|
494 | - ), |
|
495 | - EE_MAINTENANCE_ADMIN_URL |
|
496 | - ); |
|
497 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
498 | - $this->_template_path, |
|
499 | - $this->_template_args, |
|
500 | - true |
|
501 | - ); |
|
502 | - $this->display_admin_page_with_sidebar(); |
|
503 | - } |
|
504 | - |
|
505 | - /** |
|
506 | - * Downloads an HTML file of the system status that can be easily stored or emailed |
|
507 | - */ |
|
508 | - public function _download_system_status() |
|
509 | - { |
|
510 | - $status_info = EEM_System_Status::instance()->get_system_stati(); |
|
511 | - header('Content-Disposition: attachment'); |
|
512 | - header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html"); |
|
513 | - echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>"; |
|
514 | - echo "<h1>System Information for " . site_url() . "</h1>"; |
|
515 | - echo EEH_Template::layout_array_as_table($status_info); |
|
516 | - die; |
|
517 | - } |
|
518 | - |
|
519 | - |
|
520 | - public function _send_migration_crash_report() |
|
521 | - { |
|
522 | - $from = $this->_req_data['from']; |
|
523 | - $from_name = $this->_req_data['from_name']; |
|
524 | - $body = $this->_req_data['body']; |
|
525 | - try { |
|
526 | - $success = wp_mail( |
|
527 | - EE_SUPPORT_EMAIL, |
|
528 | - 'Migration Crash Report', |
|
529 | - $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true), |
|
530 | - array( |
|
531 | - "from:$from_name<$from>", |
|
532 | - ) |
|
533 | - ); |
|
534 | - } catch (Exception $e) { |
|
535 | - $success = false; |
|
536 | - } |
|
537 | - $this->_redirect_after_action( |
|
538 | - $success, |
|
539 | - esc_html__("Migration Crash Report", "event_espresso"), |
|
540 | - esc_html__("sent", "event_espresso"), |
|
541 | - array('success' => $success, 'action' => 'confirm_migration_crash_report_sent') |
|
542 | - ); |
|
543 | - } |
|
544 | - |
|
545 | - |
|
546 | - public function _confirm_migration_crash_report_sent() |
|
547 | - { |
|
548 | - try { |
|
549 | - $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true); |
|
550 | - } catch (EE_Error $e) { |
|
551 | - EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage()); |
|
552 | - // now, just so we can display the page correctly, make a error migration script stage object |
|
553 | - // and also put the error on it. It only persists for the duration of this request |
|
554 | - $most_recent_migration = new EE_DMS_Unknown_1_0_0(); |
|
555 | - $most_recent_migration->add_error($e->getMessage()); |
|
556 | - } |
|
557 | - $success = $this->_req_data['success'] == '1' ? true : false; |
|
558 | - $this->_template_args['success'] = $success; |
|
559 | - $this->_template_args['most_recent_migration'] = $most_recent_migration; |
|
560 | - $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
561 | - array('action' => 'reset_db'), |
|
562 | - EE_MAINTENANCE_ADMIN_URL |
|
563 | - ); |
|
564 | - $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
565 | - array('action' => 'data_reset'), |
|
566 | - EE_MAINTENANCE_ADMIN_URL |
|
567 | - ); |
|
568 | - $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
569 | - array('action' => 'reattempt_migration'), |
|
570 | - EE_MAINTENANCE_ADMIN_URL |
|
571 | - ); |
|
572 | - $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php'; |
|
573 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
574 | - $this->_template_path, |
|
575 | - $this->_template_args, |
|
576 | - true |
|
577 | - ); |
|
578 | - $this->display_admin_page_with_sidebar(); |
|
579 | - } |
|
580 | - |
|
581 | - |
|
582 | - /** |
|
583 | - * Resets the entire EE4 database. |
|
584 | - * Currently basically only sets up ee4 database for a fresh install- doesn't |
|
585 | - * actually clean out the old wp options, or cpts (although does erase old ee table data) |
|
586 | - * |
|
587 | - * @param boolean $nuke_old_ee4_data controls whether or not we |
|
588 | - * destroy the old ee4 data, or just try initializing ee4 default data |
|
589 | - */ |
|
590 | - public function _reset_db($nuke_old_ee4_data = true) |
|
591 | - { |
|
592 | - EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
593 | - if ($nuke_old_ee4_data) { |
|
594 | - EEH_Activation::delete_all_espresso_cpt_data(); |
|
595 | - EEH_Activation::delete_all_espresso_tables_and_data(false); |
|
596 | - EEH_Activation::remove_cron_tasks(); |
|
597 | - } |
|
598 | - // make sure when we reset the registry's config that it |
|
599 | - // switches to using the new singleton |
|
600 | - EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true); |
|
601 | - EE_System::instance()->initialize_db_if_no_migrations_required(true); |
|
602 | - EE_System::instance()->redirect_to_about_ee(); |
|
603 | - } |
|
604 | - |
|
605 | - |
|
606 | - /** |
|
607 | - * Deletes ALL EE tables, Records, and Options from the database. |
|
608 | - */ |
|
609 | - public function _delete_db() |
|
610 | - { |
|
611 | - EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
612 | - EEH_Activation::delete_all_espresso_cpt_data(); |
|
613 | - EEH_Activation::delete_all_espresso_tables_and_data(); |
|
614 | - EEH_Activation::remove_cron_tasks(); |
|
615 | - EEH_Activation::deactivate_event_espresso(); |
|
616 | - wp_safe_redirect(admin_url('plugins.php')); |
|
617 | - exit; |
|
618 | - } |
|
619 | - |
|
620 | - |
|
621 | - /** |
|
622 | - * sets up EE4 to rerun the migrations from ee3 to ee4 |
|
623 | - */ |
|
624 | - public function _rerun_migration_from_ee3() |
|
625 | - { |
|
626 | - EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
627 | - EEH_Activation::delete_all_espresso_cpt_data(); |
|
628 | - EEH_Activation::delete_all_espresso_tables_and_data(false); |
|
629 | - // set the db state to something that will require migrations |
|
630 | - update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0'); |
|
631 | - EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance); |
|
632 | - $this->_redirect_after_action( |
|
633 | - true, |
|
634 | - esc_html__("Database", 'event_espresso'), |
|
635 | - esc_html__("reset", 'event_espresso') |
|
636 | - ); |
|
637 | - } |
|
638 | - |
|
639 | - |
|
640 | - // none of the below group are currently used for Gateway Settings |
|
641 | - protected function _add_screen_options() |
|
642 | - { |
|
643 | - } |
|
644 | - |
|
645 | - |
|
646 | - protected function _add_feature_pointers() |
|
647 | - { |
|
648 | - } |
|
649 | - |
|
650 | - |
|
651 | - public function admin_init() |
|
652 | - { |
|
653 | - } |
|
654 | - |
|
655 | - |
|
656 | - public function admin_notices() |
|
657 | - { |
|
658 | - } |
|
659 | - |
|
660 | - |
|
661 | - public function admin_footer_scripts() |
|
662 | - { |
|
663 | - } |
|
664 | - |
|
665 | - |
|
666 | - public function load_scripts_styles() |
|
667 | - { |
|
668 | - wp_enqueue_script('ee_admin_js'); |
|
669 | - wp_enqueue_script( |
|
670 | - 'ee-maintenance', |
|
671 | - EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js', |
|
672 | - array('jquery'), |
|
673 | - EVENT_ESPRESSO_VERSION, |
|
674 | - true |
|
675 | - ); |
|
676 | - wp_register_style( |
|
677 | - 'espresso_maintenance', |
|
678 | - EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', |
|
679 | - array(), |
|
680 | - EVENT_ESPRESSO_VERSION |
|
681 | - ); |
|
682 | - wp_enqueue_style('espresso_maintenance'); |
|
683 | - // localize script stuff |
|
684 | - wp_localize_script( |
|
685 | - 'ee-maintenance', |
|
686 | - 'ee_maintenance', |
|
687 | - array( |
|
688 | - 'migrating' => esc_html__("Updating Database...", "event_espresso"), |
|
689 | - 'next' => esc_html__("Next", "event_espresso"), |
|
690 | - 'fatal_error' => esc_html__("A Fatal Error Has Occurred", "event_espresso"), |
|
691 | - 'click_next_when_ready' => esc_html__( |
|
692 | - "The current Database Update has ended. Click 'next' when ready to proceed", |
|
693 | - "event_espresso" |
|
694 | - ), |
|
695 | - 'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts, |
|
696 | - 'status_fatal_error' => EE_Data_Migration_Manager::status_fatal_error, |
|
697 | - 'status_completed' => EE_Data_Migration_Manager::status_completed, |
|
698 | - 'confirm' => esc_html__( |
|
699 | - 'Are you sure you want to do this? It CANNOT be undone!', |
|
700 | - 'event_espresso' |
|
701 | - ), |
|
702 | - 'confirm_skip_migration' => esc_html__( |
|
703 | - 'You have chosen to NOT migrate your existing data. Are you sure you want to continue?', |
|
704 | - 'event_espresso' |
|
705 | - ), |
|
706 | - ) |
|
707 | - ); |
|
708 | - } |
|
709 | - |
|
710 | - |
|
711 | - public function load_scripts_styles_default() |
|
712 | - { |
|
713 | - } |
|
714 | - |
|
715 | - |
|
716 | - /** |
|
717 | - * Enqueue scripts and styles for the datetime tools page. |
|
718 | - */ |
|
719 | - public function load_scripts_styles_datetime_tools() |
|
720 | - { |
|
721 | - EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
722 | - } |
|
723 | - |
|
724 | - |
|
725 | - protected function _datetime_tools() |
|
726 | - { |
|
727 | - $form_action = EE_Admin_Page::add_query_args_and_nonce( |
|
728 | - array( |
|
729 | - 'action' => 'run_datetime_offset_fix', |
|
730 | - 'return_action' => $this->_req_action, |
|
731 | - ), |
|
732 | - EE_MAINTENANCE_ADMIN_URL |
|
733 | - ); |
|
734 | - $form = $this->_get_datetime_offset_fix_form(); |
|
735 | - $this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso'); |
|
736 | - $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post') |
|
737 | - . $form->get_html_and_js() |
|
738 | - . $form->form_close(); |
|
739 | - $this->display_admin_page_with_no_sidebar(); |
|
740 | - } |
|
741 | - |
|
742 | - |
|
743 | - protected function _get_datetime_offset_fix_form() |
|
744 | - { |
|
745 | - if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) { |
|
746 | - $this->datetime_fix_offset_form = new EE_Form_Section_Proper( |
|
747 | - array( |
|
748 | - 'name' => 'datetime_offset_fix_option', |
|
749 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
750 | - 'subsections' => array( |
|
751 | - 'title' => new EE_Form_Section_HTML( |
|
752 | - EEH_HTML::h2( |
|
753 | - esc_html__('Datetime Offset Tool', 'event_espresso') |
|
754 | - ) |
|
755 | - ), |
|
756 | - 'explanation' => new EE_Form_Section_HTML( |
|
757 | - EEH_HTML::p( |
|
758 | - esc_html__( |
|
759 | - 'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.', |
|
760 | - 'event_espresso' |
|
761 | - ) |
|
762 | - ) |
|
763 | - . EEH_HTML::p( |
|
764 | - esc_html__( |
|
765 | - 'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied. Decimals represent the fraction of hours, not minutes.', |
|
766 | - 'event_espresso' |
|
767 | - ) |
|
768 | - ) |
|
769 | - ), |
|
770 | - 'offset_input' => new EE_Float_Input( |
|
771 | - array( |
|
772 | - 'html_name' => 'offset_for_datetimes', |
|
773 | - 'html_label_text' => esc_html__( |
|
774 | - 'Offset to apply (in hours):', |
|
775 | - 'event_espresso' |
|
776 | - ), |
|
777 | - 'min_value' => '-12', |
|
778 | - 'max_value' => '14', |
|
779 | - 'step_value' => '.25', |
|
780 | - 'default' => DatetimeOffsetFix::getOffset(), |
|
781 | - ) |
|
782 | - ), |
|
783 | - 'date_range_explanation' => new EE_Form_Section_HTML( |
|
784 | - EEH_HTML::p( |
|
785 | - esc_html__( |
|
786 | - 'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.', |
|
787 | - 'event_espresso' |
|
788 | - ) |
|
789 | - ) |
|
790 | - . EEH_HTML::p( |
|
791 | - EEH_HTML::strong( |
|
792 | - sprintf( |
|
793 | - esc_html__( |
|
794 | - 'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).', |
|
795 | - 'event_espresso' |
|
796 | - ), |
|
797 | - '<a href="https://www.timeanddate.com/worldclock/converter.html">', |
|
798 | - '</a>' |
|
799 | - ) |
|
800 | - ) |
|
801 | - ) |
|
802 | - ), |
|
803 | - 'date_range_start_date' => new EE_Datepicker_Input( |
|
804 | - array( |
|
805 | - 'html_name' => 'offset_date_start_range', |
|
806 | - 'html_label_text' => esc_html__( |
|
807 | - 'Start Date for dates the offset applied to:', |
|
808 | - 'event_espresso' |
|
809 | - ), |
|
810 | - ) |
|
811 | - ), |
|
812 | - 'date_range_end_date' => new EE_Datepicker_Input( |
|
813 | - array( |
|
814 | - 'html_name' => 'offset_date_end_range', |
|
815 | - 'html_label_text' => esc_html__( |
|
816 | - 'End Date for dates the offset is applied to:', |
|
817 | - 'event_espresso' |
|
818 | - ), |
|
819 | - ) |
|
820 | - ), |
|
821 | - 'submit' => new EE_Submit_Input( |
|
822 | - array( |
|
823 | - 'html_label_text' => '', |
|
824 | - 'default' => esc_html__('Apply Offset', 'event_espresso'), |
|
825 | - ) |
|
826 | - ), |
|
827 | - ), |
|
828 | - ) |
|
829 | - ); |
|
830 | - } |
|
831 | - return $this->datetime_fix_offset_form; |
|
832 | - } |
|
833 | - |
|
834 | - |
|
835 | - /** |
|
836 | - * Callback for the run_datetime_offset_fix route. |
|
837 | - * |
|
838 | - * @throws EE_Error |
|
839 | - */ |
|
840 | - protected function _apply_datetime_offset() |
|
841 | - { |
|
842 | - if ($_SERVER['REQUEST_METHOD'] === 'POST') { |
|
843 | - $form = $this->_get_datetime_offset_fix_form(); |
|
844 | - $form->receive_form_submission($this->_req_data); |
|
845 | - if ($form->is_valid()) { |
|
846 | - // save offset data so batch processor can get it. |
|
847 | - DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input')); |
|
848 | - $utc_timezone = new DateTimeZone('UTC'); |
|
849 | - $date_range_start_date = DateTime::createFromFormat( |
|
850 | - 'm/d/Y H:i:s', |
|
851 | - $form->get_input_value('date_range_start_date') . ' 00:00:00', |
|
852 | - $utc_timezone |
|
853 | - ); |
|
854 | - $date_range_end_date = DateTime::createFromFormat( |
|
855 | - 'm/d/Y H:i:s', |
|
856 | - $form->get_input_value('date_range_end_date') . ' 23:59:59', |
|
857 | - $utc_timezone |
|
858 | - ); |
|
859 | - if ($date_range_start_date instanceof DateTime) { |
|
860 | - DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date)); |
|
861 | - } |
|
862 | - if ($date_range_end_date instanceof DateTime) { |
|
863 | - DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date)); |
|
864 | - } |
|
865 | - // redirect to batch tool |
|
866 | - wp_redirect( |
|
867 | - EE_Admin_Page::add_query_args_and_nonce( |
|
868 | - array( |
|
869 | - 'page' => 'espresso_batch', |
|
870 | - 'batch' => 'job', |
|
871 | - 'label' => esc_html__('Applying Offset', 'event_espresso'), |
|
872 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'), |
|
873 | - 'return_url' => urlencode( |
|
874 | - add_query_arg( |
|
875 | - array( |
|
876 | - 'action' => 'datetime_tools', |
|
877 | - ), |
|
878 | - EEH_URL::current_url_without_query_paramaters( |
|
879 | - array( |
|
880 | - 'return_action', |
|
881 | - 'run_datetime_offset_fix_nonce', |
|
882 | - 'return', |
|
883 | - 'datetime_tools_nonce', |
|
884 | - ) |
|
885 | - ) |
|
886 | - ) |
|
887 | - ), |
|
888 | - ), |
|
889 | - admin_url() |
|
890 | - ) |
|
891 | - ); |
|
892 | - exit; |
|
893 | - } |
|
894 | - } |
|
895 | - } |
|
20 | + /** |
|
21 | + * @var EE_Form_Section_Proper |
|
22 | + */ |
|
23 | + protected $datetime_fix_offset_form; |
|
24 | + |
|
25 | + |
|
26 | + protected function _init_page_props() |
|
27 | + { |
|
28 | + $this->page_slug = EE_MAINTENANCE_PG_SLUG; |
|
29 | + $this->page_label = EE_MAINTENANCE_LABEL; |
|
30 | + $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL; |
|
31 | + $this->_admin_base_path = EE_MAINTENANCE_ADMIN; |
|
32 | + } |
|
33 | + |
|
34 | + |
|
35 | + protected function _ajax_hooks() |
|
36 | + { |
|
37 | + add_action('wp_ajax_migration_step', array($this, 'migration_step')); |
|
38 | + add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran')); |
|
39 | + } |
|
40 | + |
|
41 | + |
|
42 | + protected function _define_page_props() |
|
43 | + { |
|
44 | + $this->_admin_page_title = EE_MAINTENANCE_LABEL; |
|
45 | + $this->_labels = array( |
|
46 | + 'buttons' => array( |
|
47 | + 'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'), |
|
48 | + 'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'), |
|
49 | + ), |
|
50 | + ); |
|
51 | + } |
|
52 | + |
|
53 | + |
|
54 | + protected function _set_page_routes() |
|
55 | + { |
|
56 | + $this->_page_routes = array( |
|
57 | + 'default' => array( |
|
58 | + 'func' => '_maintenance', |
|
59 | + 'capability' => 'manage_options', |
|
60 | + ), |
|
61 | + 'change_maintenance_level' => array( |
|
62 | + 'func' => '_change_maintenance_level', |
|
63 | + 'capability' => 'manage_options', |
|
64 | + 'noheader' => true, |
|
65 | + ), |
|
66 | + 'system_status' => array( |
|
67 | + 'func' => '_system_status', |
|
68 | + 'capability' => 'manage_options', |
|
69 | + ), |
|
70 | + 'download_system_status' => array( |
|
71 | + 'func' => '_download_system_status', |
|
72 | + 'capability' => 'manage_options', |
|
73 | + 'noheader' => true, |
|
74 | + ), |
|
75 | + 'send_migration_crash_report' => array( |
|
76 | + 'func' => '_send_migration_crash_report', |
|
77 | + 'capability' => 'manage_options', |
|
78 | + 'noheader' => true, |
|
79 | + ), |
|
80 | + 'confirm_migration_crash_report_sent' => array( |
|
81 | + 'func' => '_confirm_migration_crash_report_sent', |
|
82 | + 'capability' => 'manage_options', |
|
83 | + ), |
|
84 | + 'data_reset' => array( |
|
85 | + 'func' => '_data_reset_and_delete', |
|
86 | + 'capability' => 'manage_options', |
|
87 | + ), |
|
88 | + 'reset_db' => array( |
|
89 | + 'func' => '_reset_db', |
|
90 | + 'capability' => 'manage_options', |
|
91 | + 'noheader' => true, |
|
92 | + 'args' => array('nuke_old_ee4_data' => true), |
|
93 | + ), |
|
94 | + 'start_with_fresh_ee4_db' => array( |
|
95 | + 'func' => '_reset_db', |
|
96 | + 'capability' => 'manage_options', |
|
97 | + 'noheader' => true, |
|
98 | + 'args' => array('nuke_old_ee4_data' => false), |
|
99 | + ), |
|
100 | + 'delete_db' => array( |
|
101 | + 'func' => '_delete_db', |
|
102 | + 'capability' => 'manage_options', |
|
103 | + 'noheader' => true, |
|
104 | + ), |
|
105 | + 'rerun_migration_from_ee3' => array( |
|
106 | + 'func' => '_rerun_migration_from_ee3', |
|
107 | + 'capability' => 'manage_options', |
|
108 | + 'noheader' => true, |
|
109 | + ), |
|
110 | + 'reset_reservations' => array( |
|
111 | + 'func' => '_reset_reservations', |
|
112 | + 'capability' => 'manage_options', |
|
113 | + 'noheader' => true, |
|
114 | + ), |
|
115 | + 'reset_capabilities' => array( |
|
116 | + 'func' => '_reset_capabilities', |
|
117 | + 'capability' => 'manage_options', |
|
118 | + 'noheader' => true, |
|
119 | + ), |
|
120 | + 'reattempt_migration' => array( |
|
121 | + 'func' => '_reattempt_migration', |
|
122 | + 'capability' => 'manage_options', |
|
123 | + 'noheader' => true, |
|
124 | + ), |
|
125 | + 'datetime_tools' => array( |
|
126 | + 'func' => '_datetime_tools', |
|
127 | + 'capability' => 'manage_options', |
|
128 | + ), |
|
129 | + 'run_datetime_offset_fix' => array( |
|
130 | + 'func' => '_apply_datetime_offset', |
|
131 | + 'noheader' => true, |
|
132 | + 'headers_sent_route' => 'datetime_tools', |
|
133 | + 'capability' => 'manage_options', |
|
134 | + ), |
|
135 | + ); |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + protected function _set_page_config() |
|
140 | + { |
|
141 | + $this->_page_config = array( |
|
142 | + 'default' => array( |
|
143 | + 'nav' => array( |
|
144 | + 'label' => esc_html__('Maintenance', 'event_espresso'), |
|
145 | + 'order' => 10, |
|
146 | + ), |
|
147 | + 'require_nonce' => false, |
|
148 | + ), |
|
149 | + 'data_reset' => array( |
|
150 | + 'nav' => array( |
|
151 | + 'label' => esc_html__('Reset/Delete Data', 'event_espresso'), |
|
152 | + 'order' => 20, |
|
153 | + ), |
|
154 | + 'require_nonce' => false, |
|
155 | + ), |
|
156 | + 'datetime_tools' => array( |
|
157 | + 'nav' => array( |
|
158 | + 'label' => esc_html__('Datetime Utilities', 'event_espresso'), |
|
159 | + 'order' => 25, |
|
160 | + ), |
|
161 | + 'require_nonce' => false, |
|
162 | + ), |
|
163 | + 'system_status' => array( |
|
164 | + 'nav' => array( |
|
165 | + 'label' => esc_html__("System Information", "event_espresso"), |
|
166 | + 'order' => 30, |
|
167 | + ), |
|
168 | + 'require_nonce' => false, |
|
169 | + ), |
|
170 | + ); |
|
171 | + } |
|
172 | + |
|
173 | + |
|
174 | + /** |
|
175 | + * default maintenance page. If we're in maintenance mode level 2, then we need to show |
|
176 | + * the migration scripts and all that UI. |
|
177 | + */ |
|
178 | + public function _maintenance() |
|
179 | + { |
|
180 | + // it all depends if we're in maintenance model level 1 (frontend-only) or |
|
181 | + // level 2 (everything except maintenance page) |
|
182 | + try { |
|
183 | + // get the current maintenance level and check if |
|
184 | + // we are removed |
|
185 | + $mm = EE_Maintenance_Mode::instance()->level(); |
|
186 | + $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
|
187 | + if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) { |
|
188 | + // we just took the site out of maintenance mode, so notify the user. |
|
189 | + // unfortunately this message appears to be echoed on the NEXT page load... |
|
190 | + // oh well, we should really be checking for this on addon deactivation anyways |
|
191 | + EE_Error::add_attention( |
|
192 | + __( |
|
193 | + 'Site taken out of maintenance mode because no data migration scripts are required', |
|
194 | + 'event_espresso' |
|
195 | + ) |
|
196 | + ); |
|
197 | + $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false); |
|
198 | + } |
|
199 | + // in case an exception is thrown while trying to handle migrations |
|
200 | + switch (EE_Maintenance_Mode::instance()->level()) { |
|
201 | + case EE_Maintenance_Mode::level_0_not_in_maintenance: |
|
202 | + case EE_Maintenance_Mode::level_1_frontend_only_maintenance: |
|
203 | + $show_maintenance_switch = true; |
|
204 | + $show_backup_db_text = false; |
|
205 | + $show_migration_progress = false; |
|
206 | + $script_names = array(); |
|
207 | + $addons_should_be_upgraded_first = false; |
|
208 | + break; |
|
209 | + case EE_Maintenance_Mode::level_2_complete_maintenance: |
|
210 | + $show_maintenance_switch = false; |
|
211 | + $show_migration_progress = true; |
|
212 | + if (isset($this->_req_data['continue_migration'])) { |
|
213 | + $show_backup_db_text = false; |
|
214 | + } else { |
|
215 | + $show_backup_db_text = true; |
|
216 | + } |
|
217 | + $scripts_needing_to_run = EE_Data_Migration_Manager::instance() |
|
218 | + ->check_for_applicable_data_migration_scripts(); |
|
219 | + $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating(); |
|
220 | + $script_names = array(); |
|
221 | + $current_script = null; |
|
222 | + foreach ($scripts_needing_to_run as $script) { |
|
223 | + if ($script instanceof EE_Data_Migration_Script_Base) { |
|
224 | + if (! $current_script) { |
|
225 | + $current_script = $script; |
|
226 | + $current_script->migration_page_hooks(); |
|
227 | + } |
|
228 | + $script_names[] = $script->pretty_name(); |
|
229 | + } |
|
230 | + } |
|
231 | + break; |
|
232 | + } |
|
233 | + $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true); |
|
234 | + $exception_thrown = false; |
|
235 | + } catch (EE_Error $e) { |
|
236 | + EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage()); |
|
237 | + // now, just so we can display the page correctly, make a error migration script stage object |
|
238 | + // and also put the error on it. It only persists for the duration of this request |
|
239 | + $most_recent_migration = new EE_DMS_Unknown_1_0_0(); |
|
240 | + $most_recent_migration->add_error($e->getMessage()); |
|
241 | + $exception_thrown = true; |
|
242 | + } |
|
243 | + $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set(); |
|
244 | + $current_db_state = str_replace('.decaf', '', $current_db_state); |
|
245 | + if ($exception_thrown |
|
246 | + || ($most_recent_migration |
|
247 | + && $most_recent_migration instanceof EE_Data_Migration_Script_Base |
|
248 | + && $most_recent_migration->is_broken() |
|
249 | + ) |
|
250 | + ) { |
|
251 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php'; |
|
252 | + $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/'; |
|
253 | + $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce( |
|
254 | + array( |
|
255 | + 'action' => 'confirm_migration_crash_report_sent', |
|
256 | + 'success' => '0', |
|
257 | + ), |
|
258 | + EE_MAINTENANCE_ADMIN_URL |
|
259 | + ); |
|
260 | + } elseif ($addons_should_be_upgraded_first) { |
|
261 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php'; |
|
262 | + } else { |
|
263 | + if ($most_recent_migration |
|
264 | + && $most_recent_migration instanceof EE_Data_Migration_Script_Base |
|
265 | + && $most_recent_migration->can_continue() |
|
266 | + ) { |
|
267 | + $show_backup_db_text = false; |
|
268 | + $show_continue_current_migration_script = true; |
|
269 | + $show_most_recent_migration = true; |
|
270 | + } elseif (isset($this->_req_data['continue_migration'])) { |
|
271 | + $show_most_recent_migration = true; |
|
272 | + $show_continue_current_migration_script = false; |
|
273 | + } else { |
|
274 | + $show_most_recent_migration = false; |
|
275 | + $show_continue_current_migration_script = false; |
|
276 | + } |
|
277 | + if (isset($current_script)) { |
|
278 | + $migrates_to = $current_script->migrates_to_version(); |
|
279 | + $plugin_slug = $migrates_to['slug']; |
|
280 | + $new_version = $migrates_to['version']; |
|
281 | + $this->_template_args = array_merge( |
|
282 | + $this->_template_args, |
|
283 | + array( |
|
284 | + 'current_db_state' => sprintf( |
|
285 | + __("EE%s (%s)", "event_espresso"), |
|
286 | + isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3, |
|
287 | + $plugin_slug |
|
288 | + ), |
|
289 | + 'next_db_state' => isset($current_script) ? sprintf( |
|
290 | + __("EE%s (%s)", 'event_espresso'), |
|
291 | + $new_version, |
|
292 | + $plugin_slug |
|
293 | + ) : null, |
|
294 | + ) |
|
295 | + ); |
|
296 | + } else { |
|
297 | + $this->_template_args['current_db_state'] = null; |
|
298 | + $this->_template_args['next_db_state'] = null; |
|
299 | + } |
|
300 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php'; |
|
301 | + $this->_template_args = array_merge( |
|
302 | + $this->_template_args, |
|
303 | + array( |
|
304 | + 'show_most_recent_migration' => $show_most_recent_migration, |
|
305 | + // flag for showing the most recent migration's status and/or errors |
|
306 | + 'show_migration_progress' => $show_migration_progress, |
|
307 | + // flag for showing the option to run migrations and see their progress |
|
308 | + 'show_backup_db_text' => $show_backup_db_text, |
|
309 | + // flag for showing text telling the user to backup their DB |
|
310 | + 'show_maintenance_switch' => $show_maintenance_switch, |
|
311 | + // flag for showing the option to change maintenance mode between levels 0 and 1 |
|
312 | + 'script_names' => $script_names, |
|
313 | + // array of names of scripts that have run |
|
314 | + 'show_continue_current_migration_script' => $show_continue_current_migration_script, |
|
315 | + // flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0 |
|
316 | + 'reset_db_page_link' => EE_Admin_Page::add_query_args_and_nonce( |
|
317 | + array('action' => 'reset_db'), |
|
318 | + EE_MAINTENANCE_ADMIN_URL |
|
319 | + ), |
|
320 | + 'data_reset_page' => EE_Admin_Page::add_query_args_and_nonce( |
|
321 | + array('action' => 'data_reset'), |
|
322 | + EE_MAINTENANCE_ADMIN_URL |
|
323 | + ), |
|
324 | + 'update_migration_script_page_link' => EE_Admin_Page::add_query_args_and_nonce( |
|
325 | + array('action' => 'change_maintenance_level'), |
|
326 | + EE_MAINTENANCE_ADMIN_URL |
|
327 | + ), |
|
328 | + 'ultimate_db_state' => sprintf( |
|
329 | + __("EE%s", 'event_espresso'), |
|
330 | + espresso_version() |
|
331 | + ), |
|
332 | + ) |
|
333 | + ); |
|
334 | + // make sure we have the form fields helper available. It usually is, but sometimes it isn't |
|
335 | + } |
|
336 | + $this->_template_args['most_recent_migration'] = $most_recent_migration;// the actual most recently ran migration |
|
337 | + // now render the migration options part, and put it in a variable |
|
338 | + $migration_options_template_file = apply_filters( |
|
339 | + 'FHEE__ee_migration_page__migration_options_template', |
|
340 | + EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php' |
|
341 | + ); |
|
342 | + $migration_options_html = EEH_Template::display_template( |
|
343 | + $migration_options_template_file, |
|
344 | + $this->_template_args, |
|
345 | + true |
|
346 | + ); |
|
347 | + $this->_template_args['migration_options_html'] = $migration_options_html; |
|
348 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
349 | + $this->_template_path, |
|
350 | + $this->_template_args, |
|
351 | + true |
|
352 | + ); |
|
353 | + $this->display_admin_page_with_sidebar(); |
|
354 | + } |
|
355 | + |
|
356 | + |
|
357 | + /** |
|
358 | + * returns JSON and executes another step of the currently-executing data migration (called via ajax) |
|
359 | + */ |
|
360 | + public function migration_step() |
|
361 | + { |
|
362 | + $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request(); |
|
363 | + $this->_return_json(); |
|
364 | + } |
|
365 | + |
|
366 | + |
|
367 | + /** |
|
368 | + * Can be used by js when it notices a response with HTML in it in order |
|
369 | + * to log the malformed response |
|
370 | + */ |
|
371 | + public function add_error_to_migrations_ran() |
|
372 | + { |
|
373 | + EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']); |
|
374 | + $this->_template_args['data'] = array('ok' => true); |
|
375 | + $this->_return_json(); |
|
376 | + } |
|
377 | + |
|
378 | + |
|
379 | + /** |
|
380 | + * changes the maintenance level, provided there are still no migration scripts that should run |
|
381 | + */ |
|
382 | + public function _change_maintenance_level() |
|
383 | + { |
|
384 | + $new_level = absint($this->_req_data['maintenance_mode_level']); |
|
385 | + if (! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) { |
|
386 | + EE_Maintenance_Mode::instance()->set_maintenance_level($new_level); |
|
387 | + $success = true; |
|
388 | + } else { |
|
389 | + EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
|
390 | + $success = false; |
|
391 | + } |
|
392 | + $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso")); |
|
393 | + } |
|
394 | + |
|
395 | + |
|
396 | + /** |
|
397 | + * a tab with options for resetting and/or deleting EE data |
|
398 | + * |
|
399 | + * @throws \EE_Error |
|
400 | + * @throws \DomainException |
|
401 | + */ |
|
402 | + public function _data_reset_and_delete() |
|
403 | + { |
|
404 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php'; |
|
405 | + $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button( |
|
406 | + 'reset_reservations', |
|
407 | + 'reset_reservations', |
|
408 | + array(), |
|
409 | + 'button button-primary ee-confirm', |
|
410 | + '', |
|
411 | + false |
|
412 | + ); |
|
413 | + $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button( |
|
414 | + 'reset_capabilities', |
|
415 | + 'reset_capabilities', |
|
416 | + array(), |
|
417 | + 'button button-primary ee-confirm', |
|
418 | + '', |
|
419 | + false |
|
420 | + ); |
|
421 | + $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
422 | + array('action' => 'delete_db'), |
|
423 | + EE_MAINTENANCE_ADMIN_URL |
|
424 | + ); |
|
425 | + $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
426 | + array('action' => 'reset_db'), |
|
427 | + EE_MAINTENANCE_ADMIN_URL |
|
428 | + ); |
|
429 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
430 | + $this->_template_path, |
|
431 | + $this->_template_args, |
|
432 | + true |
|
433 | + ); |
|
434 | + $this->display_admin_page_with_sidebar(); |
|
435 | + } |
|
436 | + |
|
437 | + |
|
438 | + protected function _reset_reservations() |
|
439 | + { |
|
440 | + if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) { |
|
441 | + EE_Error::add_success( |
|
442 | + __( |
|
443 | + 'Ticket and datetime reserved counts have been successfully reset.', |
|
444 | + 'event_espresso' |
|
445 | + ) |
|
446 | + ); |
|
447 | + } else { |
|
448 | + EE_Error::add_success( |
|
449 | + __( |
|
450 | + 'Ticket and datetime reserved counts were correct and did not need resetting.', |
|
451 | + 'event_espresso' |
|
452 | + ) |
|
453 | + ); |
|
454 | + } |
|
455 | + $this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true); |
|
456 | + } |
|
457 | + |
|
458 | + |
|
459 | + protected function _reset_capabilities() |
|
460 | + { |
|
461 | + EE_Registry::instance()->CAP->init_caps(true); |
|
462 | + EE_Error::add_success( |
|
463 | + __( |
|
464 | + 'Default Event Espresso capabilities have been restored for all current roles.', |
|
465 | + 'event_espresso' |
|
466 | + ) |
|
467 | + ); |
|
468 | + $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true); |
|
469 | + } |
|
470 | + |
|
471 | + |
|
472 | + /** |
|
473 | + * resets the DMSs so we can attempt to continue migrating after a fatal error |
|
474 | + * (only a good idea when someone has somehow tried ot fix whatever caused |
|
475 | + * the fatal error in teh first place) |
|
476 | + */ |
|
477 | + protected function _reattempt_migration() |
|
478 | + { |
|
479 | + EE_Data_Migration_Manager::instance()->reattempt(); |
|
480 | + $this->_redirect_after_action(false, '', '', array('action' => 'default'), true); |
|
481 | + } |
|
482 | + |
|
483 | + |
|
484 | + /** |
|
485 | + * shows the big ol' System Information page |
|
486 | + */ |
|
487 | + public function _system_status() |
|
488 | + { |
|
489 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php'; |
|
490 | + $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati(); |
|
491 | + $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
492 | + array( |
|
493 | + 'action' => 'download_system_status', |
|
494 | + ), |
|
495 | + EE_MAINTENANCE_ADMIN_URL |
|
496 | + ); |
|
497 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
498 | + $this->_template_path, |
|
499 | + $this->_template_args, |
|
500 | + true |
|
501 | + ); |
|
502 | + $this->display_admin_page_with_sidebar(); |
|
503 | + } |
|
504 | + |
|
505 | + /** |
|
506 | + * Downloads an HTML file of the system status that can be easily stored or emailed |
|
507 | + */ |
|
508 | + public function _download_system_status() |
|
509 | + { |
|
510 | + $status_info = EEM_System_Status::instance()->get_system_stati(); |
|
511 | + header('Content-Disposition: attachment'); |
|
512 | + header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html"); |
|
513 | + echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>"; |
|
514 | + echo "<h1>System Information for " . site_url() . "</h1>"; |
|
515 | + echo EEH_Template::layout_array_as_table($status_info); |
|
516 | + die; |
|
517 | + } |
|
518 | + |
|
519 | + |
|
520 | + public function _send_migration_crash_report() |
|
521 | + { |
|
522 | + $from = $this->_req_data['from']; |
|
523 | + $from_name = $this->_req_data['from_name']; |
|
524 | + $body = $this->_req_data['body']; |
|
525 | + try { |
|
526 | + $success = wp_mail( |
|
527 | + EE_SUPPORT_EMAIL, |
|
528 | + 'Migration Crash Report', |
|
529 | + $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true), |
|
530 | + array( |
|
531 | + "from:$from_name<$from>", |
|
532 | + ) |
|
533 | + ); |
|
534 | + } catch (Exception $e) { |
|
535 | + $success = false; |
|
536 | + } |
|
537 | + $this->_redirect_after_action( |
|
538 | + $success, |
|
539 | + esc_html__("Migration Crash Report", "event_espresso"), |
|
540 | + esc_html__("sent", "event_espresso"), |
|
541 | + array('success' => $success, 'action' => 'confirm_migration_crash_report_sent') |
|
542 | + ); |
|
543 | + } |
|
544 | + |
|
545 | + |
|
546 | + public function _confirm_migration_crash_report_sent() |
|
547 | + { |
|
548 | + try { |
|
549 | + $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true); |
|
550 | + } catch (EE_Error $e) { |
|
551 | + EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage()); |
|
552 | + // now, just so we can display the page correctly, make a error migration script stage object |
|
553 | + // and also put the error on it. It only persists for the duration of this request |
|
554 | + $most_recent_migration = new EE_DMS_Unknown_1_0_0(); |
|
555 | + $most_recent_migration->add_error($e->getMessage()); |
|
556 | + } |
|
557 | + $success = $this->_req_data['success'] == '1' ? true : false; |
|
558 | + $this->_template_args['success'] = $success; |
|
559 | + $this->_template_args['most_recent_migration'] = $most_recent_migration; |
|
560 | + $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
561 | + array('action' => 'reset_db'), |
|
562 | + EE_MAINTENANCE_ADMIN_URL |
|
563 | + ); |
|
564 | + $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
565 | + array('action' => 'data_reset'), |
|
566 | + EE_MAINTENANCE_ADMIN_URL |
|
567 | + ); |
|
568 | + $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce( |
|
569 | + array('action' => 'reattempt_migration'), |
|
570 | + EE_MAINTENANCE_ADMIN_URL |
|
571 | + ); |
|
572 | + $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php'; |
|
573 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
574 | + $this->_template_path, |
|
575 | + $this->_template_args, |
|
576 | + true |
|
577 | + ); |
|
578 | + $this->display_admin_page_with_sidebar(); |
|
579 | + } |
|
580 | + |
|
581 | + |
|
582 | + /** |
|
583 | + * Resets the entire EE4 database. |
|
584 | + * Currently basically only sets up ee4 database for a fresh install- doesn't |
|
585 | + * actually clean out the old wp options, or cpts (although does erase old ee table data) |
|
586 | + * |
|
587 | + * @param boolean $nuke_old_ee4_data controls whether or not we |
|
588 | + * destroy the old ee4 data, or just try initializing ee4 default data |
|
589 | + */ |
|
590 | + public function _reset_db($nuke_old_ee4_data = true) |
|
591 | + { |
|
592 | + EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
593 | + if ($nuke_old_ee4_data) { |
|
594 | + EEH_Activation::delete_all_espresso_cpt_data(); |
|
595 | + EEH_Activation::delete_all_espresso_tables_and_data(false); |
|
596 | + EEH_Activation::remove_cron_tasks(); |
|
597 | + } |
|
598 | + // make sure when we reset the registry's config that it |
|
599 | + // switches to using the new singleton |
|
600 | + EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true); |
|
601 | + EE_System::instance()->initialize_db_if_no_migrations_required(true); |
|
602 | + EE_System::instance()->redirect_to_about_ee(); |
|
603 | + } |
|
604 | + |
|
605 | + |
|
606 | + /** |
|
607 | + * Deletes ALL EE tables, Records, and Options from the database. |
|
608 | + */ |
|
609 | + public function _delete_db() |
|
610 | + { |
|
611 | + EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
612 | + EEH_Activation::delete_all_espresso_cpt_data(); |
|
613 | + EEH_Activation::delete_all_espresso_tables_and_data(); |
|
614 | + EEH_Activation::remove_cron_tasks(); |
|
615 | + EEH_Activation::deactivate_event_espresso(); |
|
616 | + wp_safe_redirect(admin_url('plugins.php')); |
|
617 | + exit; |
|
618 | + } |
|
619 | + |
|
620 | + |
|
621 | + /** |
|
622 | + * sets up EE4 to rerun the migrations from ee3 to ee4 |
|
623 | + */ |
|
624 | + public function _rerun_migration_from_ee3() |
|
625 | + { |
|
626 | + EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
627 | + EEH_Activation::delete_all_espresso_cpt_data(); |
|
628 | + EEH_Activation::delete_all_espresso_tables_and_data(false); |
|
629 | + // set the db state to something that will require migrations |
|
630 | + update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0'); |
|
631 | + EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance); |
|
632 | + $this->_redirect_after_action( |
|
633 | + true, |
|
634 | + esc_html__("Database", 'event_espresso'), |
|
635 | + esc_html__("reset", 'event_espresso') |
|
636 | + ); |
|
637 | + } |
|
638 | + |
|
639 | + |
|
640 | + // none of the below group are currently used for Gateway Settings |
|
641 | + protected function _add_screen_options() |
|
642 | + { |
|
643 | + } |
|
644 | + |
|
645 | + |
|
646 | + protected function _add_feature_pointers() |
|
647 | + { |
|
648 | + } |
|
649 | + |
|
650 | + |
|
651 | + public function admin_init() |
|
652 | + { |
|
653 | + } |
|
654 | + |
|
655 | + |
|
656 | + public function admin_notices() |
|
657 | + { |
|
658 | + } |
|
659 | + |
|
660 | + |
|
661 | + public function admin_footer_scripts() |
|
662 | + { |
|
663 | + } |
|
664 | + |
|
665 | + |
|
666 | + public function load_scripts_styles() |
|
667 | + { |
|
668 | + wp_enqueue_script('ee_admin_js'); |
|
669 | + wp_enqueue_script( |
|
670 | + 'ee-maintenance', |
|
671 | + EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js', |
|
672 | + array('jquery'), |
|
673 | + EVENT_ESPRESSO_VERSION, |
|
674 | + true |
|
675 | + ); |
|
676 | + wp_register_style( |
|
677 | + 'espresso_maintenance', |
|
678 | + EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', |
|
679 | + array(), |
|
680 | + EVENT_ESPRESSO_VERSION |
|
681 | + ); |
|
682 | + wp_enqueue_style('espresso_maintenance'); |
|
683 | + // localize script stuff |
|
684 | + wp_localize_script( |
|
685 | + 'ee-maintenance', |
|
686 | + 'ee_maintenance', |
|
687 | + array( |
|
688 | + 'migrating' => esc_html__("Updating Database...", "event_espresso"), |
|
689 | + 'next' => esc_html__("Next", "event_espresso"), |
|
690 | + 'fatal_error' => esc_html__("A Fatal Error Has Occurred", "event_espresso"), |
|
691 | + 'click_next_when_ready' => esc_html__( |
|
692 | + "The current Database Update has ended. Click 'next' when ready to proceed", |
|
693 | + "event_espresso" |
|
694 | + ), |
|
695 | + 'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts, |
|
696 | + 'status_fatal_error' => EE_Data_Migration_Manager::status_fatal_error, |
|
697 | + 'status_completed' => EE_Data_Migration_Manager::status_completed, |
|
698 | + 'confirm' => esc_html__( |
|
699 | + 'Are you sure you want to do this? It CANNOT be undone!', |
|
700 | + 'event_espresso' |
|
701 | + ), |
|
702 | + 'confirm_skip_migration' => esc_html__( |
|
703 | + 'You have chosen to NOT migrate your existing data. Are you sure you want to continue?', |
|
704 | + 'event_espresso' |
|
705 | + ), |
|
706 | + ) |
|
707 | + ); |
|
708 | + } |
|
709 | + |
|
710 | + |
|
711 | + public function load_scripts_styles_default() |
|
712 | + { |
|
713 | + } |
|
714 | + |
|
715 | + |
|
716 | + /** |
|
717 | + * Enqueue scripts and styles for the datetime tools page. |
|
718 | + */ |
|
719 | + public function load_scripts_styles_datetime_tools() |
|
720 | + { |
|
721 | + EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
722 | + } |
|
723 | + |
|
724 | + |
|
725 | + protected function _datetime_tools() |
|
726 | + { |
|
727 | + $form_action = EE_Admin_Page::add_query_args_and_nonce( |
|
728 | + array( |
|
729 | + 'action' => 'run_datetime_offset_fix', |
|
730 | + 'return_action' => $this->_req_action, |
|
731 | + ), |
|
732 | + EE_MAINTENANCE_ADMIN_URL |
|
733 | + ); |
|
734 | + $form = $this->_get_datetime_offset_fix_form(); |
|
735 | + $this->_admin_page_title = esc_html__('Datetime Utilities', 'event_espresso'); |
|
736 | + $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post') |
|
737 | + . $form->get_html_and_js() |
|
738 | + . $form->form_close(); |
|
739 | + $this->display_admin_page_with_no_sidebar(); |
|
740 | + } |
|
741 | + |
|
742 | + |
|
743 | + protected function _get_datetime_offset_fix_form() |
|
744 | + { |
|
745 | + if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) { |
|
746 | + $this->datetime_fix_offset_form = new EE_Form_Section_Proper( |
|
747 | + array( |
|
748 | + 'name' => 'datetime_offset_fix_option', |
|
749 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
750 | + 'subsections' => array( |
|
751 | + 'title' => new EE_Form_Section_HTML( |
|
752 | + EEH_HTML::h2( |
|
753 | + esc_html__('Datetime Offset Tool', 'event_espresso') |
|
754 | + ) |
|
755 | + ), |
|
756 | + 'explanation' => new EE_Form_Section_HTML( |
|
757 | + EEH_HTML::p( |
|
758 | + esc_html__( |
|
759 | + 'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.', |
|
760 | + 'event_espresso' |
|
761 | + ) |
|
762 | + ) |
|
763 | + . EEH_HTML::p( |
|
764 | + esc_html__( |
|
765 | + 'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied. Decimals represent the fraction of hours, not minutes.', |
|
766 | + 'event_espresso' |
|
767 | + ) |
|
768 | + ) |
|
769 | + ), |
|
770 | + 'offset_input' => new EE_Float_Input( |
|
771 | + array( |
|
772 | + 'html_name' => 'offset_for_datetimes', |
|
773 | + 'html_label_text' => esc_html__( |
|
774 | + 'Offset to apply (in hours):', |
|
775 | + 'event_espresso' |
|
776 | + ), |
|
777 | + 'min_value' => '-12', |
|
778 | + 'max_value' => '14', |
|
779 | + 'step_value' => '.25', |
|
780 | + 'default' => DatetimeOffsetFix::getOffset(), |
|
781 | + ) |
|
782 | + ), |
|
783 | + 'date_range_explanation' => new EE_Form_Section_HTML( |
|
784 | + EEH_HTML::p( |
|
785 | + esc_html__( |
|
786 | + 'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.', |
|
787 | + 'event_espresso' |
|
788 | + ) |
|
789 | + ) |
|
790 | + . EEH_HTML::p( |
|
791 | + EEH_HTML::strong( |
|
792 | + sprintf( |
|
793 | + esc_html__( |
|
794 | + 'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).', |
|
795 | + 'event_espresso' |
|
796 | + ), |
|
797 | + '<a href="https://www.timeanddate.com/worldclock/converter.html">', |
|
798 | + '</a>' |
|
799 | + ) |
|
800 | + ) |
|
801 | + ) |
|
802 | + ), |
|
803 | + 'date_range_start_date' => new EE_Datepicker_Input( |
|
804 | + array( |
|
805 | + 'html_name' => 'offset_date_start_range', |
|
806 | + 'html_label_text' => esc_html__( |
|
807 | + 'Start Date for dates the offset applied to:', |
|
808 | + 'event_espresso' |
|
809 | + ), |
|
810 | + ) |
|
811 | + ), |
|
812 | + 'date_range_end_date' => new EE_Datepicker_Input( |
|
813 | + array( |
|
814 | + 'html_name' => 'offset_date_end_range', |
|
815 | + 'html_label_text' => esc_html__( |
|
816 | + 'End Date for dates the offset is applied to:', |
|
817 | + 'event_espresso' |
|
818 | + ), |
|
819 | + ) |
|
820 | + ), |
|
821 | + 'submit' => new EE_Submit_Input( |
|
822 | + array( |
|
823 | + 'html_label_text' => '', |
|
824 | + 'default' => esc_html__('Apply Offset', 'event_espresso'), |
|
825 | + ) |
|
826 | + ), |
|
827 | + ), |
|
828 | + ) |
|
829 | + ); |
|
830 | + } |
|
831 | + return $this->datetime_fix_offset_form; |
|
832 | + } |
|
833 | + |
|
834 | + |
|
835 | + /** |
|
836 | + * Callback for the run_datetime_offset_fix route. |
|
837 | + * |
|
838 | + * @throws EE_Error |
|
839 | + */ |
|
840 | + protected function _apply_datetime_offset() |
|
841 | + { |
|
842 | + if ($_SERVER['REQUEST_METHOD'] === 'POST') { |
|
843 | + $form = $this->_get_datetime_offset_fix_form(); |
|
844 | + $form->receive_form_submission($this->_req_data); |
|
845 | + if ($form->is_valid()) { |
|
846 | + // save offset data so batch processor can get it. |
|
847 | + DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input')); |
|
848 | + $utc_timezone = new DateTimeZone('UTC'); |
|
849 | + $date_range_start_date = DateTime::createFromFormat( |
|
850 | + 'm/d/Y H:i:s', |
|
851 | + $form->get_input_value('date_range_start_date') . ' 00:00:00', |
|
852 | + $utc_timezone |
|
853 | + ); |
|
854 | + $date_range_end_date = DateTime::createFromFormat( |
|
855 | + 'm/d/Y H:i:s', |
|
856 | + $form->get_input_value('date_range_end_date') . ' 23:59:59', |
|
857 | + $utc_timezone |
|
858 | + ); |
|
859 | + if ($date_range_start_date instanceof DateTime) { |
|
860 | + DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date)); |
|
861 | + } |
|
862 | + if ($date_range_end_date instanceof DateTime) { |
|
863 | + DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date)); |
|
864 | + } |
|
865 | + // redirect to batch tool |
|
866 | + wp_redirect( |
|
867 | + EE_Admin_Page::add_query_args_and_nonce( |
|
868 | + array( |
|
869 | + 'page' => 'espresso_batch', |
|
870 | + 'batch' => 'job', |
|
871 | + 'label' => esc_html__('Applying Offset', 'event_espresso'), |
|
872 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'), |
|
873 | + 'return_url' => urlencode( |
|
874 | + add_query_arg( |
|
875 | + array( |
|
876 | + 'action' => 'datetime_tools', |
|
877 | + ), |
|
878 | + EEH_URL::current_url_without_query_paramaters( |
|
879 | + array( |
|
880 | + 'return_action', |
|
881 | + 'run_datetime_offset_fix_nonce', |
|
882 | + 'return', |
|
883 | + 'datetime_tools_nonce', |
|
884 | + ) |
|
885 | + ) |
|
886 | + ) |
|
887 | + ), |
|
888 | + ), |
|
889 | + admin_url() |
|
890 | + ) |
|
891 | + ); |
|
892 | + exit; |
|
893 | + } |
|
894 | + } |
|
895 | + } |
|
896 | 896 | } |
@@ -24,108 +24,108 @@ |
||
24 | 24 | */ |
25 | 25 | class Registration extends RegistrationCalculationBase |
26 | 26 | { |
27 | - /** |
|
28 | - * @var EEM_Registration |
|
29 | - */ |
|
30 | - protected $registration_model; |
|
27 | + /** |
|
28 | + * @var EEM_Registration |
|
29 | + */ |
|
30 | + protected $registration_model; |
|
31 | 31 | |
32 | - /** |
|
33 | - * Registration constructor. |
|
34 | - * @param EEM_Registration $registration_model |
|
35 | - */ |
|
36 | - public function __construct(EEM_Registration $registration_model) |
|
37 | - { |
|
38 | - $this->registration_model = $registration_model; |
|
39 | - } |
|
32 | + /** |
|
33 | + * Registration constructor. |
|
34 | + * @param EEM_Registration $registration_model |
|
35 | + */ |
|
36 | + public function __construct(EEM_Registration $registration_model) |
|
37 | + { |
|
38 | + $this->registration_model = $registration_model; |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * Calculates the checkin status for each datetime this registration has access to |
|
43 | - * |
|
44 | - * @param array $wpdb_row |
|
45 | - * @param WP_REST_Request $request |
|
46 | - * @param RegistrationControllerBase $controller |
|
47 | - * @return array |
|
48 | - * @throws EE_Error |
|
49 | - * @throws InvalidDataTypeException |
|
50 | - * @throws InvalidInterfaceException |
|
51 | - * @throws InvalidArgumentException |
|
52 | - */ |
|
53 | - public function datetimeCheckinStati($wpdb_row, $request, $controller) |
|
54 | - { |
|
55 | - if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) { |
|
56 | - $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']); |
|
57 | - } else { |
|
58 | - $reg = null; |
|
59 | - } |
|
60 | - if (! $reg instanceof EE_Registration |
|
61 | - ) { |
|
62 | - throw new EE_Error( |
|
63 | - sprintf( |
|
64 | - __( |
|
65 | - // @codingStandardsIgnoreStart |
|
66 | - 'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found', |
|
67 | - // @codingStandardsIgnoreEnd |
|
68 | - 'event_espresso' |
|
69 | - ), |
|
70 | - $wpdb_row['Registration.REG_ID'], |
|
71 | - print_r($wpdb_row, true) |
|
72 | - ) |
|
73 | - ); |
|
74 | - } |
|
75 | - $datetime_ids = EEM_Datetime::instance()->get_col( |
|
76 | - [ |
|
77 | - [ |
|
78 | - 'Ticket.TKT_ID' => $reg->ticket_ID(), |
|
79 | - ], |
|
80 | - 'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all, |
|
81 | - ] |
|
82 | - ); |
|
83 | - $checkin_stati = array(); |
|
84 | - foreach ($datetime_ids as $datetime_id) { |
|
85 | - $status = $reg->check_in_status_for_datetime($datetime_id); |
|
86 | - switch ($status) { |
|
87 | - case EE_Checkin::status_checked_out: |
|
88 | - $status_pretty = 'OUT'; |
|
89 | - break; |
|
90 | - case EE_Checkin::status_checked_in: |
|
91 | - $status_pretty = 'IN'; |
|
92 | - break; |
|
93 | - case EE_Checkin::status_checked_never: |
|
94 | - default: |
|
95 | - $status_pretty = 'NEVER'; |
|
96 | - break; |
|
97 | - } |
|
98 | - $checkin_stati[ $datetime_id ] = $status_pretty; |
|
99 | - } |
|
100 | - return $checkin_stati; |
|
101 | - } |
|
41 | + /** |
|
42 | + * Calculates the checkin status for each datetime this registration has access to |
|
43 | + * |
|
44 | + * @param array $wpdb_row |
|
45 | + * @param WP_REST_Request $request |
|
46 | + * @param RegistrationControllerBase $controller |
|
47 | + * @return array |
|
48 | + * @throws EE_Error |
|
49 | + * @throws InvalidDataTypeException |
|
50 | + * @throws InvalidInterfaceException |
|
51 | + * @throws InvalidArgumentException |
|
52 | + */ |
|
53 | + public function datetimeCheckinStati($wpdb_row, $request, $controller) |
|
54 | + { |
|
55 | + if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) { |
|
56 | + $reg = $this->registration_model->get_one_by_ID($wpdb_row['Registration.REG_ID']); |
|
57 | + } else { |
|
58 | + $reg = null; |
|
59 | + } |
|
60 | + if (! $reg instanceof EE_Registration |
|
61 | + ) { |
|
62 | + throw new EE_Error( |
|
63 | + sprintf( |
|
64 | + __( |
|
65 | + // @codingStandardsIgnoreStart |
|
66 | + 'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found', |
|
67 | + // @codingStandardsIgnoreEnd |
|
68 | + 'event_espresso' |
|
69 | + ), |
|
70 | + $wpdb_row['Registration.REG_ID'], |
|
71 | + print_r($wpdb_row, true) |
|
72 | + ) |
|
73 | + ); |
|
74 | + } |
|
75 | + $datetime_ids = EEM_Datetime::instance()->get_col( |
|
76 | + [ |
|
77 | + [ |
|
78 | + 'Ticket.TKT_ID' => $reg->ticket_ID(), |
|
79 | + ], |
|
80 | + 'default_where_conditions' => EEM_Base::default_where_conditions_minimum_all, |
|
81 | + ] |
|
82 | + ); |
|
83 | + $checkin_stati = array(); |
|
84 | + foreach ($datetime_ids as $datetime_id) { |
|
85 | + $status = $reg->check_in_status_for_datetime($datetime_id); |
|
86 | + switch ($status) { |
|
87 | + case EE_Checkin::status_checked_out: |
|
88 | + $status_pretty = 'OUT'; |
|
89 | + break; |
|
90 | + case EE_Checkin::status_checked_in: |
|
91 | + $status_pretty = 'IN'; |
|
92 | + break; |
|
93 | + case EE_Checkin::status_checked_never: |
|
94 | + default: |
|
95 | + $status_pretty = 'NEVER'; |
|
96 | + break; |
|
97 | + } |
|
98 | + $checkin_stati[ $datetime_id ] = $status_pretty; |
|
99 | + } |
|
100 | + return $checkin_stati; |
|
101 | + } |
|
102 | 102 | |
103 | 103 | |
104 | - /** |
|
105 | - * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
106 | - * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
107 | - * |
|
108 | - * @since 4.9.68.p |
|
109 | - * @return array |
|
110 | - */ |
|
111 | - public function schemaForCalculations() |
|
112 | - { |
|
113 | - return array( |
|
114 | - 'datetime_checkin_stati' => array( |
|
115 | - 'description' => esc_html__( |
|
116 | - 'Returns the checkin status for each datetime this registration has access to.', |
|
117 | - 'event_espresso' |
|
118 | - ), |
|
119 | - 'type' => 'object', |
|
120 | - 'properties' => array(), |
|
121 | - 'additionalProperties' => array( |
|
122 | - 'description' => esc_html__( |
|
123 | - 'Keys are date-time ids and values are the check-in status', |
|
124 | - 'event_espresso' |
|
125 | - ), |
|
126 | - 'type' => 'string' |
|
127 | - ), |
|
128 | - ), |
|
129 | - ); |
|
130 | - } |
|
104 | + /** |
|
105 | + * Provides an array for all the calculations possible that outlines a json schema for those calculations. |
|
106 | + * Array is indexed by calculation (snake case) and value is the schema for that calculation. |
|
107 | + * |
|
108 | + * @since 4.9.68.p |
|
109 | + * @return array |
|
110 | + */ |
|
111 | + public function schemaForCalculations() |
|
112 | + { |
|
113 | + return array( |
|
114 | + 'datetime_checkin_stati' => array( |
|
115 | + 'description' => esc_html__( |
|
116 | + 'Returns the checkin status for each datetime this registration has access to.', |
|
117 | + 'event_espresso' |
|
118 | + ), |
|
119 | + 'type' => 'object', |
|
120 | + 'properties' => array(), |
|
121 | + 'additionalProperties' => array( |
|
122 | + 'description' => esc_html__( |
|
123 | + 'Keys are date-time ids and values are the check-in status', |
|
124 | + 'event_espresso' |
|
125 | + ), |
|
126 | + 'type' => 'string' |
|
127 | + ), |
|
128 | + ), |
|
129 | + ); |
|
130 | + } |
|
131 | 131 | } |
@@ -44,531 +44,531 @@ |
||
44 | 44 | class OrganizationSettings extends FormHandler |
45 | 45 | { |
46 | 46 | |
47 | - /** |
|
48 | - * @var EE_Organization_Config |
|
49 | - */ |
|
50 | - protected $organization_config; |
|
47 | + /** |
|
48 | + * @var EE_Organization_Config |
|
49 | + */ |
|
50 | + protected $organization_config; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @var EE_Core_Config |
|
54 | - */ |
|
55 | - protected $core_config; |
|
52 | + /** |
|
53 | + * @var EE_Core_Config |
|
54 | + */ |
|
55 | + protected $core_config; |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * @var EE_Network_Core_Config |
|
60 | - */ |
|
61 | - protected $network_core_config; |
|
58 | + /** |
|
59 | + * @var EE_Network_Core_Config |
|
60 | + */ |
|
61 | + protected $network_core_config; |
|
62 | 62 | |
63 | - /** |
|
64 | - * @var CountrySubRegionDao $countrySubRegionDao |
|
65 | - */ |
|
66 | - protected $countrySubRegionDao; |
|
63 | + /** |
|
64 | + * @var CountrySubRegionDao $countrySubRegionDao |
|
65 | + */ |
|
66 | + protected $countrySubRegionDao; |
|
67 | 67 | |
68 | - /** |
|
69 | - * Form constructor. |
|
70 | - * |
|
71 | - * @param EE_Registry $registry |
|
72 | - * @param EE_Organization_Config $organization_config |
|
73 | - * @param EE_Core_Config $core_config |
|
74 | - * @param EE_Network_Core_Config $network_core_config |
|
75 | - * @param CountrySubRegionDao $countrySubRegionDao |
|
76 | - * @throws InvalidArgumentException |
|
77 | - * @throws InvalidDataTypeException |
|
78 | - * @throws DomainException |
|
79 | - */ |
|
80 | - public function __construct( |
|
81 | - EE_Registry $registry, |
|
82 | - EE_Organization_Config $organization_config, |
|
83 | - EE_Core_Config $core_config, |
|
84 | - EE_Network_Core_Config $network_core_config, |
|
85 | - CountrySubRegionDao $countrySubRegionDao |
|
86 | - ) { |
|
87 | - $this->organization_config = $organization_config; |
|
88 | - $this->core_config = $core_config; |
|
89 | - $this->network_core_config = $network_core_config; |
|
90 | - $this->countrySubRegionDao = $countrySubRegionDao; |
|
91 | - parent::__construct( |
|
92 | - esc_html__('Your Organization Settings', 'event_espresso'), |
|
93 | - esc_html__('Your Organization Settings', 'event_espresso'), |
|
94 | - 'organization_settings', |
|
95 | - '', |
|
96 | - FormHandler::DO_NOT_SETUP_FORM, |
|
97 | - $registry |
|
98 | - ); |
|
99 | - } |
|
68 | + /** |
|
69 | + * Form constructor. |
|
70 | + * |
|
71 | + * @param EE_Registry $registry |
|
72 | + * @param EE_Organization_Config $organization_config |
|
73 | + * @param EE_Core_Config $core_config |
|
74 | + * @param EE_Network_Core_Config $network_core_config |
|
75 | + * @param CountrySubRegionDao $countrySubRegionDao |
|
76 | + * @throws InvalidArgumentException |
|
77 | + * @throws InvalidDataTypeException |
|
78 | + * @throws DomainException |
|
79 | + */ |
|
80 | + public function __construct( |
|
81 | + EE_Registry $registry, |
|
82 | + EE_Organization_Config $organization_config, |
|
83 | + EE_Core_Config $core_config, |
|
84 | + EE_Network_Core_Config $network_core_config, |
|
85 | + CountrySubRegionDao $countrySubRegionDao |
|
86 | + ) { |
|
87 | + $this->organization_config = $organization_config; |
|
88 | + $this->core_config = $core_config; |
|
89 | + $this->network_core_config = $network_core_config; |
|
90 | + $this->countrySubRegionDao = $countrySubRegionDao; |
|
91 | + parent::__construct( |
|
92 | + esc_html__('Your Organization Settings', 'event_espresso'), |
|
93 | + esc_html__('Your Organization Settings', 'event_espresso'), |
|
94 | + 'organization_settings', |
|
95 | + '', |
|
96 | + FormHandler::DO_NOT_SETUP_FORM, |
|
97 | + $registry |
|
98 | + ); |
|
99 | + } |
|
100 | 100 | |
101 | 101 | |
102 | - /** |
|
103 | - * creates and returns the actual form |
|
104 | - * |
|
105 | - * @return EE_Form_Section_Proper |
|
106 | - * @throws EE_Error |
|
107 | - * @throws InvalidArgumentException |
|
108 | - * @throws InvalidDataTypeException |
|
109 | - * @throws InvalidInterfaceException |
|
110 | - * @throws ReflectionException |
|
111 | - */ |
|
112 | - public function generate() |
|
113 | - { |
|
114 | - $has_sub_regions = EEM_State::instance()->count( |
|
115 | - array(array('Country.CNT_ISO' => $this->organization_config->CNT_ISO)) |
|
116 | - ); |
|
117 | - $form = new EE_Form_Section_Proper( |
|
118 | - array( |
|
119 | - 'name' => 'organization_settings', |
|
120 | - 'html_id' => 'organization_settings', |
|
121 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
122 | - 'subsections' => array( |
|
123 | - 'contact_information_hdr' => new EE_Form_Section_HTML( |
|
124 | - EEH_HTML::h2( |
|
125 | - esc_html__('Contact Information', 'event_espresso') |
|
126 | - . ' ' |
|
127 | - . EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')), |
|
128 | - '', |
|
129 | - 'contact-information-hdr' |
|
130 | - ) |
|
131 | - ), |
|
132 | - 'organization_name' => new EE_Text_Input( |
|
133 | - array( |
|
134 | - 'html_name' => 'organization_name', |
|
135 | - 'html_label_text' => esc_html__('Organization Name', 'event_espresso'), |
|
136 | - 'html_help_text' => esc_html__( |
|
137 | - 'Displayed on all emails and invoices.', |
|
138 | - 'event_espresso' |
|
139 | - ), |
|
140 | - 'default' => $this->organization_config->get_pretty('name'), |
|
141 | - 'required' => false, |
|
142 | - ) |
|
143 | - ), |
|
144 | - 'organization_address_1' => new EE_Text_Input( |
|
145 | - array( |
|
146 | - 'html_name' => 'organization_address_1', |
|
147 | - 'html_label_text' => esc_html__('Street Address', 'event_espresso'), |
|
148 | - 'default' => $this->organization_config->get_pretty('address_1'), |
|
149 | - 'required' => false, |
|
150 | - ) |
|
151 | - ), |
|
152 | - 'organization_address_2' => new EE_Text_Input( |
|
153 | - array( |
|
154 | - 'html_name' => 'organization_address_2', |
|
155 | - 'html_label_text' => esc_html__('Street Address 2', 'event_espresso'), |
|
156 | - 'default' => $this->organization_config->get_pretty('address_2'), |
|
157 | - 'required' => false, |
|
158 | - ) |
|
159 | - ), |
|
160 | - 'organization_city' => new EE_Text_Input( |
|
161 | - array( |
|
162 | - 'html_name' => 'organization_city', |
|
163 | - 'html_label_text' => esc_html__('City', 'event_espresso'), |
|
164 | - 'default' => $this->organization_config->get_pretty('city'), |
|
165 | - 'required' => false, |
|
166 | - ) |
|
167 | - ), |
|
168 | - 'organization_country' => new EE_Country_Select_Input( |
|
169 | - null, |
|
170 | - array( |
|
171 | - EE_Country_Select_Input::OPTION_GET_KEY => EE_Country_Select_Input::OPTION_GET_ALL, |
|
172 | - 'html_name' => 'organization_country', |
|
173 | - 'html_label_text' => esc_html__('Country', 'event_espresso'), |
|
174 | - 'default' => $this->organization_config->CNT_ISO, |
|
175 | - 'required' => false, |
|
176 | - 'html_help_text' => sprintf( |
|
177 | - esc_html__( |
|
178 | - '%1$sThe Country set here will have the effect of setting the currency used for all ticket prices.%2$s', |
|
179 | - 'event_espresso' |
|
180 | - ), |
|
181 | - '<span class="reminder-spn">', |
|
182 | - '</span>' |
|
183 | - ), |
|
184 | - ) |
|
185 | - ), |
|
186 | - 'organization_state' => new EE_State_Select_Input( |
|
187 | - null, |
|
188 | - array( |
|
189 | - 'html_name' => 'organization_state', |
|
190 | - 'html_label_text' => esc_html__('State/Province', 'event_espresso'), |
|
191 | - 'default' => $this->organization_config->STA_ID, |
|
192 | - 'required' => false, |
|
193 | - 'html_help_text' => empty($this->organization_config->STA_ID) || ! $has_sub_regions |
|
194 | - ? sprintf( |
|
195 | - esc_html__( |
|
196 | - 'If the States/Provinces for the selected Country do not appear in this list, then click "Save".%3$sIf data exists, then the list will be populated when the page reloads and you will be able to make a selection at that time.%3$s%1$sMake sure you click "Save" again after selecting a State/Province that has just been loaded in order to keep that selection.%2$s', |
|
197 | - 'event_espresso' |
|
198 | - ), |
|
199 | - '<span class="reminder-spn">', |
|
200 | - '</span>', |
|
201 | - '<br />' |
|
202 | - ) |
|
203 | - : '', |
|
204 | - ) |
|
205 | - ), |
|
206 | - 'organization_zip' => new EE_Text_Input( |
|
207 | - array( |
|
208 | - 'html_name' => 'organization_zip', |
|
209 | - 'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'), |
|
210 | - 'default' => $this->organization_config->get_pretty('zip'), |
|
211 | - 'required' => false, |
|
212 | - ) |
|
213 | - ), |
|
214 | - 'organization_email' => new EE_Text_Input( |
|
215 | - array( |
|
216 | - 'html_name' => 'organization_email', |
|
217 | - 'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'), |
|
218 | - 'html_help_text' => sprintf( |
|
219 | - esc_html__( |
|
220 | - 'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.', |
|
221 | - 'event_espresso' |
|
222 | - ), |
|
223 | - '<code>[CO_FORMATTED_EMAIL]</code>', |
|
224 | - '<code>[CO_EMAIL]</code>' |
|
225 | - ), |
|
226 | - 'default' => $this->organization_config->get_pretty('email'), |
|
227 | - 'required' => false, |
|
228 | - ) |
|
229 | - ), |
|
230 | - 'organization_phone' => new EE_Text_Input( |
|
231 | - array( |
|
232 | - 'html_name' => 'organization_phone', |
|
233 | - 'html_label_text' => esc_html__('Phone Number', 'event_espresso'), |
|
234 | - 'html_help_text' => esc_html__( |
|
235 | - 'The phone number for your organization.', |
|
236 | - 'event_espresso' |
|
237 | - ), |
|
238 | - 'default' => $this->organization_config->get_pretty('phone'), |
|
239 | - 'required' => false, |
|
240 | - ) |
|
241 | - ), |
|
242 | - 'organization_vat' => new EE_Text_Input( |
|
243 | - array( |
|
244 | - 'html_name' => 'organization_vat', |
|
245 | - 'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'), |
|
246 | - 'html_help_text' => esc_html__( |
|
247 | - 'The VAT/Tax Number may be displayed on invoices and receipts.', |
|
248 | - 'event_espresso' |
|
249 | - ), |
|
250 | - 'default' => $this->organization_config->get_pretty('vat'), |
|
251 | - 'required' => false, |
|
252 | - ) |
|
253 | - ), |
|
254 | - 'company_logo_hdr' => new EE_Form_Section_HTML( |
|
255 | - EEH_HTML::h2( |
|
256 | - esc_html__('Company Logo', 'event_espresso') |
|
257 | - . ' ' |
|
258 | - . EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')), |
|
259 | - '', |
|
260 | - 'company-logo-hdr' |
|
261 | - ) |
|
262 | - ), |
|
263 | - 'organization_logo_url' => new EE_Admin_File_Uploader_Input( |
|
264 | - array( |
|
265 | - 'html_name' => 'organization_logo_url', |
|
266 | - 'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'), |
|
267 | - 'html_help_text' => esc_html__( |
|
268 | - 'Your logo will be used on custom invoices, tickets, certificates, and payment templates.', |
|
269 | - 'event_espresso' |
|
270 | - ), |
|
271 | - 'default' => $this->organization_config->get_pretty('logo_url'), |
|
272 | - 'required' => false, |
|
273 | - ) |
|
274 | - ), |
|
275 | - 'social_links_hdr' => new EE_Form_Section_HTML( |
|
276 | - EEH_HTML::h2( |
|
277 | - esc_html__('Social Links', 'event_espresso') |
|
278 | - . ' ' |
|
279 | - . EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info')) |
|
280 | - . EEH_HTML::br() |
|
281 | - . EEH_HTML::p( |
|
282 | - esc_html__( |
|
283 | - 'Enter any links to social accounts for your organization here', |
|
284 | - 'event_espresso' |
|
285 | - ), |
|
286 | - '', |
|
287 | - 'description' |
|
288 | - ), |
|
289 | - '', |
|
290 | - 'social-links-hdr' |
|
291 | - ) |
|
292 | - ), |
|
293 | - 'organization_facebook' => new EE_Text_Input( |
|
294 | - array( |
|
295 | - 'html_name' => 'organization_facebook', |
|
296 | - 'html_label_text' => esc_html__('Facebook', 'event_espresso'), |
|
297 | - 'other_html_attributes' => ' placeholder="facebook.com/profile.name"', |
|
298 | - 'default' => $this->organization_config->get_pretty('facebook'), |
|
299 | - 'required' => false, |
|
300 | - ) |
|
301 | - ), |
|
302 | - 'organization_twitter' => new EE_Text_Input( |
|
303 | - array( |
|
304 | - 'html_name' => 'organization_twitter', |
|
305 | - 'html_label_text' => esc_html__('Twitter', 'event_espresso'), |
|
306 | - 'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"', |
|
307 | - 'default' => $this->organization_config->get_pretty('twitter'), |
|
308 | - 'required' => false, |
|
309 | - ) |
|
310 | - ), |
|
311 | - 'organization_linkedin' => new EE_Text_Input( |
|
312 | - array( |
|
313 | - 'html_name' => 'organization_linkedin', |
|
314 | - 'html_label_text' => esc_html__('LinkedIn', 'event_espresso'), |
|
315 | - 'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"', |
|
316 | - 'default' => $this->organization_config->get_pretty('linkedin'), |
|
317 | - 'required' => false, |
|
318 | - ) |
|
319 | - ), |
|
320 | - 'organization_pinterest' => new EE_Text_Input( |
|
321 | - array( |
|
322 | - 'html_name' => 'organization_pinterest', |
|
323 | - 'html_label_text' => esc_html__('Pinterest', 'event_espresso'), |
|
324 | - 'other_html_attributes' => ' placeholder="pinterest.com/profilename"', |
|
325 | - 'default' => $this->organization_config->get_pretty('pinterest'), |
|
326 | - 'required' => false, |
|
327 | - ) |
|
328 | - ), |
|
329 | - 'organization_instagram' => new EE_Text_Input( |
|
330 | - array( |
|
331 | - 'html_name' => 'organization_instagram', |
|
332 | - 'html_label_text' => esc_html__('Instagram', 'event_espresso'), |
|
333 | - 'other_html_attributes' => ' placeholder="instagram.com/handle"', |
|
334 | - 'default' => $this->organization_config->get_pretty('instagram'), |
|
335 | - 'required' => false, |
|
336 | - ) |
|
337 | - ), |
|
338 | - ), |
|
339 | - ) |
|
340 | - ); |
|
341 | - if (is_main_site()) { |
|
342 | - $form->add_subsections( |
|
343 | - array( |
|
344 | - 'site_license_key_hdr' => new EE_Form_Section_HTML( |
|
345 | - EEH_HTML::h2( |
|
346 | - esc_html__('Your Event Espresso License Key', 'event_espresso') |
|
347 | - . ' ' |
|
348 | - . EEH_HTML::span( |
|
349 | - EEH_Template::get_help_tab_link('site_license_key_info'), |
|
350 | - 'help_tour_activation' |
|
351 | - ), |
|
352 | - '', |
|
353 | - 'site-license-key-hdr' |
|
354 | - ) |
|
355 | - ), |
|
356 | - 'site_license_key' => $this->getSiteLicenseKeyField() |
|
357 | - ) |
|
358 | - ); |
|
359 | - $form->add_subsections( |
|
360 | - array( |
|
361 | - 'uxip_optin_hdr' => new EE_Form_Section_HTML( |
|
362 | - $this->uxipOptinText() |
|
363 | - ), |
|
364 | - 'ueip_optin' => new EE_Checkbox_Multi_Input( |
|
365 | - array( |
|
366 | - true => __('Yes! I want to help improve Event Espresso!', 'event_espresso') |
|
367 | - ), |
|
368 | - array( |
|
369 | - 'html_name' => EE_Core_Config::OPTION_NAME_UXIP, |
|
370 | - 'html_label_text' => esc_html__( |
|
371 | - 'UXIP Opt In?', |
|
372 | - 'event_espresso' |
|
373 | - ), |
|
374 | - 'default' => isset($this->core_config->ee_ueip_optin) |
|
375 | - ? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN) |
|
376 | - : false, |
|
377 | - 'required' => false, |
|
378 | - ) |
|
379 | - ), |
|
380 | - ), |
|
381 | - 'organization_instagram', |
|
382 | - false |
|
383 | - ); |
|
384 | - } |
|
385 | - return $form; |
|
386 | - } |
|
102 | + /** |
|
103 | + * creates and returns the actual form |
|
104 | + * |
|
105 | + * @return EE_Form_Section_Proper |
|
106 | + * @throws EE_Error |
|
107 | + * @throws InvalidArgumentException |
|
108 | + * @throws InvalidDataTypeException |
|
109 | + * @throws InvalidInterfaceException |
|
110 | + * @throws ReflectionException |
|
111 | + */ |
|
112 | + public function generate() |
|
113 | + { |
|
114 | + $has_sub_regions = EEM_State::instance()->count( |
|
115 | + array(array('Country.CNT_ISO' => $this->organization_config->CNT_ISO)) |
|
116 | + ); |
|
117 | + $form = new EE_Form_Section_Proper( |
|
118 | + array( |
|
119 | + 'name' => 'organization_settings', |
|
120 | + 'html_id' => 'organization_settings', |
|
121 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
122 | + 'subsections' => array( |
|
123 | + 'contact_information_hdr' => new EE_Form_Section_HTML( |
|
124 | + EEH_HTML::h2( |
|
125 | + esc_html__('Contact Information', 'event_espresso') |
|
126 | + . ' ' |
|
127 | + . EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')), |
|
128 | + '', |
|
129 | + 'contact-information-hdr' |
|
130 | + ) |
|
131 | + ), |
|
132 | + 'organization_name' => new EE_Text_Input( |
|
133 | + array( |
|
134 | + 'html_name' => 'organization_name', |
|
135 | + 'html_label_text' => esc_html__('Organization Name', 'event_espresso'), |
|
136 | + 'html_help_text' => esc_html__( |
|
137 | + 'Displayed on all emails and invoices.', |
|
138 | + 'event_espresso' |
|
139 | + ), |
|
140 | + 'default' => $this->organization_config->get_pretty('name'), |
|
141 | + 'required' => false, |
|
142 | + ) |
|
143 | + ), |
|
144 | + 'organization_address_1' => new EE_Text_Input( |
|
145 | + array( |
|
146 | + 'html_name' => 'organization_address_1', |
|
147 | + 'html_label_text' => esc_html__('Street Address', 'event_espresso'), |
|
148 | + 'default' => $this->organization_config->get_pretty('address_1'), |
|
149 | + 'required' => false, |
|
150 | + ) |
|
151 | + ), |
|
152 | + 'organization_address_2' => new EE_Text_Input( |
|
153 | + array( |
|
154 | + 'html_name' => 'organization_address_2', |
|
155 | + 'html_label_text' => esc_html__('Street Address 2', 'event_espresso'), |
|
156 | + 'default' => $this->organization_config->get_pretty('address_2'), |
|
157 | + 'required' => false, |
|
158 | + ) |
|
159 | + ), |
|
160 | + 'organization_city' => new EE_Text_Input( |
|
161 | + array( |
|
162 | + 'html_name' => 'organization_city', |
|
163 | + 'html_label_text' => esc_html__('City', 'event_espresso'), |
|
164 | + 'default' => $this->organization_config->get_pretty('city'), |
|
165 | + 'required' => false, |
|
166 | + ) |
|
167 | + ), |
|
168 | + 'organization_country' => new EE_Country_Select_Input( |
|
169 | + null, |
|
170 | + array( |
|
171 | + EE_Country_Select_Input::OPTION_GET_KEY => EE_Country_Select_Input::OPTION_GET_ALL, |
|
172 | + 'html_name' => 'organization_country', |
|
173 | + 'html_label_text' => esc_html__('Country', 'event_espresso'), |
|
174 | + 'default' => $this->organization_config->CNT_ISO, |
|
175 | + 'required' => false, |
|
176 | + 'html_help_text' => sprintf( |
|
177 | + esc_html__( |
|
178 | + '%1$sThe Country set here will have the effect of setting the currency used for all ticket prices.%2$s', |
|
179 | + 'event_espresso' |
|
180 | + ), |
|
181 | + '<span class="reminder-spn">', |
|
182 | + '</span>' |
|
183 | + ), |
|
184 | + ) |
|
185 | + ), |
|
186 | + 'organization_state' => new EE_State_Select_Input( |
|
187 | + null, |
|
188 | + array( |
|
189 | + 'html_name' => 'organization_state', |
|
190 | + 'html_label_text' => esc_html__('State/Province', 'event_espresso'), |
|
191 | + 'default' => $this->organization_config->STA_ID, |
|
192 | + 'required' => false, |
|
193 | + 'html_help_text' => empty($this->organization_config->STA_ID) || ! $has_sub_regions |
|
194 | + ? sprintf( |
|
195 | + esc_html__( |
|
196 | + 'If the States/Provinces for the selected Country do not appear in this list, then click "Save".%3$sIf data exists, then the list will be populated when the page reloads and you will be able to make a selection at that time.%3$s%1$sMake sure you click "Save" again after selecting a State/Province that has just been loaded in order to keep that selection.%2$s', |
|
197 | + 'event_espresso' |
|
198 | + ), |
|
199 | + '<span class="reminder-spn">', |
|
200 | + '</span>', |
|
201 | + '<br />' |
|
202 | + ) |
|
203 | + : '', |
|
204 | + ) |
|
205 | + ), |
|
206 | + 'organization_zip' => new EE_Text_Input( |
|
207 | + array( |
|
208 | + 'html_name' => 'organization_zip', |
|
209 | + 'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'), |
|
210 | + 'default' => $this->organization_config->get_pretty('zip'), |
|
211 | + 'required' => false, |
|
212 | + ) |
|
213 | + ), |
|
214 | + 'organization_email' => new EE_Text_Input( |
|
215 | + array( |
|
216 | + 'html_name' => 'organization_email', |
|
217 | + 'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'), |
|
218 | + 'html_help_text' => sprintf( |
|
219 | + esc_html__( |
|
220 | + 'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.', |
|
221 | + 'event_espresso' |
|
222 | + ), |
|
223 | + '<code>[CO_FORMATTED_EMAIL]</code>', |
|
224 | + '<code>[CO_EMAIL]</code>' |
|
225 | + ), |
|
226 | + 'default' => $this->organization_config->get_pretty('email'), |
|
227 | + 'required' => false, |
|
228 | + ) |
|
229 | + ), |
|
230 | + 'organization_phone' => new EE_Text_Input( |
|
231 | + array( |
|
232 | + 'html_name' => 'organization_phone', |
|
233 | + 'html_label_text' => esc_html__('Phone Number', 'event_espresso'), |
|
234 | + 'html_help_text' => esc_html__( |
|
235 | + 'The phone number for your organization.', |
|
236 | + 'event_espresso' |
|
237 | + ), |
|
238 | + 'default' => $this->organization_config->get_pretty('phone'), |
|
239 | + 'required' => false, |
|
240 | + ) |
|
241 | + ), |
|
242 | + 'organization_vat' => new EE_Text_Input( |
|
243 | + array( |
|
244 | + 'html_name' => 'organization_vat', |
|
245 | + 'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'), |
|
246 | + 'html_help_text' => esc_html__( |
|
247 | + 'The VAT/Tax Number may be displayed on invoices and receipts.', |
|
248 | + 'event_espresso' |
|
249 | + ), |
|
250 | + 'default' => $this->organization_config->get_pretty('vat'), |
|
251 | + 'required' => false, |
|
252 | + ) |
|
253 | + ), |
|
254 | + 'company_logo_hdr' => new EE_Form_Section_HTML( |
|
255 | + EEH_HTML::h2( |
|
256 | + esc_html__('Company Logo', 'event_espresso') |
|
257 | + . ' ' |
|
258 | + . EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')), |
|
259 | + '', |
|
260 | + 'company-logo-hdr' |
|
261 | + ) |
|
262 | + ), |
|
263 | + 'organization_logo_url' => new EE_Admin_File_Uploader_Input( |
|
264 | + array( |
|
265 | + 'html_name' => 'organization_logo_url', |
|
266 | + 'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'), |
|
267 | + 'html_help_text' => esc_html__( |
|
268 | + 'Your logo will be used on custom invoices, tickets, certificates, and payment templates.', |
|
269 | + 'event_espresso' |
|
270 | + ), |
|
271 | + 'default' => $this->organization_config->get_pretty('logo_url'), |
|
272 | + 'required' => false, |
|
273 | + ) |
|
274 | + ), |
|
275 | + 'social_links_hdr' => new EE_Form_Section_HTML( |
|
276 | + EEH_HTML::h2( |
|
277 | + esc_html__('Social Links', 'event_espresso') |
|
278 | + . ' ' |
|
279 | + . EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info')) |
|
280 | + . EEH_HTML::br() |
|
281 | + . EEH_HTML::p( |
|
282 | + esc_html__( |
|
283 | + 'Enter any links to social accounts for your organization here', |
|
284 | + 'event_espresso' |
|
285 | + ), |
|
286 | + '', |
|
287 | + 'description' |
|
288 | + ), |
|
289 | + '', |
|
290 | + 'social-links-hdr' |
|
291 | + ) |
|
292 | + ), |
|
293 | + 'organization_facebook' => new EE_Text_Input( |
|
294 | + array( |
|
295 | + 'html_name' => 'organization_facebook', |
|
296 | + 'html_label_text' => esc_html__('Facebook', 'event_espresso'), |
|
297 | + 'other_html_attributes' => ' placeholder="facebook.com/profile.name"', |
|
298 | + 'default' => $this->organization_config->get_pretty('facebook'), |
|
299 | + 'required' => false, |
|
300 | + ) |
|
301 | + ), |
|
302 | + 'organization_twitter' => new EE_Text_Input( |
|
303 | + array( |
|
304 | + 'html_name' => 'organization_twitter', |
|
305 | + 'html_label_text' => esc_html__('Twitter', 'event_espresso'), |
|
306 | + 'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"', |
|
307 | + 'default' => $this->organization_config->get_pretty('twitter'), |
|
308 | + 'required' => false, |
|
309 | + ) |
|
310 | + ), |
|
311 | + 'organization_linkedin' => new EE_Text_Input( |
|
312 | + array( |
|
313 | + 'html_name' => 'organization_linkedin', |
|
314 | + 'html_label_text' => esc_html__('LinkedIn', 'event_espresso'), |
|
315 | + 'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"', |
|
316 | + 'default' => $this->organization_config->get_pretty('linkedin'), |
|
317 | + 'required' => false, |
|
318 | + ) |
|
319 | + ), |
|
320 | + 'organization_pinterest' => new EE_Text_Input( |
|
321 | + array( |
|
322 | + 'html_name' => 'organization_pinterest', |
|
323 | + 'html_label_text' => esc_html__('Pinterest', 'event_espresso'), |
|
324 | + 'other_html_attributes' => ' placeholder="pinterest.com/profilename"', |
|
325 | + 'default' => $this->organization_config->get_pretty('pinterest'), |
|
326 | + 'required' => false, |
|
327 | + ) |
|
328 | + ), |
|
329 | + 'organization_instagram' => new EE_Text_Input( |
|
330 | + array( |
|
331 | + 'html_name' => 'organization_instagram', |
|
332 | + 'html_label_text' => esc_html__('Instagram', 'event_espresso'), |
|
333 | + 'other_html_attributes' => ' placeholder="instagram.com/handle"', |
|
334 | + 'default' => $this->organization_config->get_pretty('instagram'), |
|
335 | + 'required' => false, |
|
336 | + ) |
|
337 | + ), |
|
338 | + ), |
|
339 | + ) |
|
340 | + ); |
|
341 | + if (is_main_site()) { |
|
342 | + $form->add_subsections( |
|
343 | + array( |
|
344 | + 'site_license_key_hdr' => new EE_Form_Section_HTML( |
|
345 | + EEH_HTML::h2( |
|
346 | + esc_html__('Your Event Espresso License Key', 'event_espresso') |
|
347 | + . ' ' |
|
348 | + . EEH_HTML::span( |
|
349 | + EEH_Template::get_help_tab_link('site_license_key_info'), |
|
350 | + 'help_tour_activation' |
|
351 | + ), |
|
352 | + '', |
|
353 | + 'site-license-key-hdr' |
|
354 | + ) |
|
355 | + ), |
|
356 | + 'site_license_key' => $this->getSiteLicenseKeyField() |
|
357 | + ) |
|
358 | + ); |
|
359 | + $form->add_subsections( |
|
360 | + array( |
|
361 | + 'uxip_optin_hdr' => new EE_Form_Section_HTML( |
|
362 | + $this->uxipOptinText() |
|
363 | + ), |
|
364 | + 'ueip_optin' => new EE_Checkbox_Multi_Input( |
|
365 | + array( |
|
366 | + true => __('Yes! I want to help improve Event Espresso!', 'event_espresso') |
|
367 | + ), |
|
368 | + array( |
|
369 | + 'html_name' => EE_Core_Config::OPTION_NAME_UXIP, |
|
370 | + 'html_label_text' => esc_html__( |
|
371 | + 'UXIP Opt In?', |
|
372 | + 'event_espresso' |
|
373 | + ), |
|
374 | + 'default' => isset($this->core_config->ee_ueip_optin) |
|
375 | + ? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN) |
|
376 | + : false, |
|
377 | + 'required' => false, |
|
378 | + ) |
|
379 | + ), |
|
380 | + ), |
|
381 | + 'organization_instagram', |
|
382 | + false |
|
383 | + ); |
|
384 | + } |
|
385 | + return $form; |
|
386 | + } |
|
387 | 387 | |
388 | 388 | |
389 | - /** |
|
390 | - * takes the generated form and displays it along with ony other non-form HTML that may be required |
|
391 | - * returns a string of HTML that can be directly echoed in a template |
|
392 | - * |
|
393 | - * @return string |
|
394 | - * @throws EE_Error |
|
395 | - * @throws InvalidArgumentException |
|
396 | - * @throws InvalidDataTypeException |
|
397 | - * @throws InvalidInterfaceException |
|
398 | - * @throws LogicException |
|
399 | - */ |
|
400 | - public function display() |
|
401 | - { |
|
402 | - $this->form()->enqueue_js(); |
|
403 | - return parent::display(); |
|
404 | - } |
|
389 | + /** |
|
390 | + * takes the generated form and displays it along with ony other non-form HTML that may be required |
|
391 | + * returns a string of HTML that can be directly echoed in a template |
|
392 | + * |
|
393 | + * @return string |
|
394 | + * @throws EE_Error |
|
395 | + * @throws InvalidArgumentException |
|
396 | + * @throws InvalidDataTypeException |
|
397 | + * @throws InvalidInterfaceException |
|
398 | + * @throws LogicException |
|
399 | + */ |
|
400 | + public function display() |
|
401 | + { |
|
402 | + $this->form()->enqueue_js(); |
|
403 | + return parent::display(); |
|
404 | + } |
|
405 | 405 | |
406 | 406 | |
407 | - /** |
|
408 | - * handles processing the form submission |
|
409 | - * returns true or false depending on whether the form was processed successfully or not |
|
410 | - * |
|
411 | - * @param array $form_data |
|
412 | - * @return bool |
|
413 | - * @throws InvalidFormSubmissionException |
|
414 | - * @throws EE_Error |
|
415 | - * @throws LogicException |
|
416 | - * @throws InvalidArgumentException |
|
417 | - * @throws InvalidDataTypeException |
|
418 | - * @throws ReflectionException |
|
419 | - */ |
|
420 | - public function process($form_data = array()) |
|
421 | - { |
|
422 | - // process form |
|
423 | - $valid_data = (array) parent::process($form_data); |
|
424 | - if (empty($valid_data)) { |
|
425 | - return false; |
|
426 | - } |
|
407 | + /** |
|
408 | + * handles processing the form submission |
|
409 | + * returns true or false depending on whether the form was processed successfully or not |
|
410 | + * |
|
411 | + * @param array $form_data |
|
412 | + * @return bool |
|
413 | + * @throws InvalidFormSubmissionException |
|
414 | + * @throws EE_Error |
|
415 | + * @throws LogicException |
|
416 | + * @throws InvalidArgumentException |
|
417 | + * @throws InvalidDataTypeException |
|
418 | + * @throws ReflectionException |
|
419 | + */ |
|
420 | + public function process($form_data = array()) |
|
421 | + { |
|
422 | + // process form |
|
423 | + $valid_data = (array) parent::process($form_data); |
|
424 | + if (empty($valid_data)) { |
|
425 | + return false; |
|
426 | + } |
|
427 | 427 | |
428 | - if (is_main_site()) { |
|
429 | - $this->network_core_config->site_license_key = isset($form_data['ee_site_license_key']) |
|
430 | - ? sanitize_text_field($form_data['ee_site_license_key']) |
|
431 | - : $this->network_core_config->site_license_key; |
|
432 | - } |
|
433 | - $this->organization_config->name = isset($form_data['organization_name']) |
|
434 | - ? sanitize_text_field($form_data['organization_name']) |
|
435 | - : $this->organization_config->name; |
|
436 | - $this->organization_config->address_1 = isset($form_data['organization_address_1']) |
|
437 | - ? sanitize_text_field($form_data['organization_address_1']) |
|
438 | - : $this->organization_config->address_1; |
|
439 | - $this->organization_config->address_2 = isset($form_data['organization_address_2']) |
|
440 | - ? sanitize_text_field($form_data['organization_address_2']) |
|
441 | - : $this->organization_config->address_2; |
|
442 | - $this->organization_config->city = isset($form_data['organization_city']) |
|
443 | - ? sanitize_text_field($form_data['organization_city']) |
|
444 | - : $this->organization_config->city; |
|
445 | - $this->organization_config->STA_ID = isset($form_data['organization_state']) |
|
446 | - ? absint($form_data['organization_state']) |
|
447 | - : $this->organization_config->STA_ID; |
|
448 | - $this->organization_config->CNT_ISO = isset($form_data['organization_country']) |
|
449 | - ? sanitize_text_field($form_data['organization_country']) |
|
450 | - : $this->organization_config->CNT_ISO; |
|
451 | - $this->organization_config->zip = isset($form_data['organization_zip']) |
|
452 | - ? sanitize_text_field($form_data['organization_zip']) |
|
453 | - : $this->organization_config->zip; |
|
454 | - $this->organization_config->email = isset($form_data['organization_email']) |
|
455 | - ? sanitize_email($form_data['organization_email']) |
|
456 | - : $this->organization_config->email; |
|
457 | - $this->organization_config->vat = isset($form_data['organization_vat']) |
|
458 | - ? sanitize_text_field($form_data['organization_vat']) |
|
459 | - : $this->organization_config->vat; |
|
460 | - $this->organization_config->phone = isset($form_data['organization_phone']) |
|
461 | - ? sanitize_text_field($form_data['organization_phone']) |
|
462 | - : $this->organization_config->phone; |
|
463 | - $this->organization_config->logo_url = isset($form_data['organization_logo_url']) |
|
464 | - ? esc_url_raw($form_data['organization_logo_url']) |
|
465 | - : $this->organization_config->logo_url; |
|
466 | - $this->organization_config->facebook = isset($form_data['organization_facebook']) |
|
467 | - ? esc_url_raw($form_data['organization_facebook']) |
|
468 | - : $this->organization_config->facebook; |
|
469 | - $this->organization_config->twitter = isset($form_data['organization_twitter']) |
|
470 | - ? esc_url_raw($form_data['organization_twitter']) |
|
471 | - : $this->organization_config->twitter; |
|
472 | - $this->organization_config->linkedin = isset($form_data['organization_linkedin']) |
|
473 | - ? esc_url_raw($form_data['organization_linkedin']) |
|
474 | - : $this->organization_config->linkedin; |
|
475 | - $this->organization_config->pinterest = isset($form_data['organization_pinterest']) |
|
476 | - ? esc_url_raw($form_data['organization_pinterest']) |
|
477 | - : $this->organization_config->pinterest; |
|
478 | - $this->organization_config->google = isset($form_data['organization_google']) |
|
479 | - ? esc_url_raw($form_data['organization_google']) |
|
480 | - : $this->organization_config->google; |
|
481 | - $this->organization_config->instagram = isset($form_data['organization_instagram']) |
|
482 | - ? esc_url_raw($form_data['organization_instagram']) |
|
483 | - : $this->organization_config->instagram; |
|
484 | - $this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0]) |
|
485 | - ? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN) |
|
486 | - : false; |
|
487 | - $this->core_config->ee_ueip_has_notified = true; |
|
428 | + if (is_main_site()) { |
|
429 | + $this->network_core_config->site_license_key = isset($form_data['ee_site_license_key']) |
|
430 | + ? sanitize_text_field($form_data['ee_site_license_key']) |
|
431 | + : $this->network_core_config->site_license_key; |
|
432 | + } |
|
433 | + $this->organization_config->name = isset($form_data['organization_name']) |
|
434 | + ? sanitize_text_field($form_data['organization_name']) |
|
435 | + : $this->organization_config->name; |
|
436 | + $this->organization_config->address_1 = isset($form_data['organization_address_1']) |
|
437 | + ? sanitize_text_field($form_data['organization_address_1']) |
|
438 | + : $this->organization_config->address_1; |
|
439 | + $this->organization_config->address_2 = isset($form_data['organization_address_2']) |
|
440 | + ? sanitize_text_field($form_data['organization_address_2']) |
|
441 | + : $this->organization_config->address_2; |
|
442 | + $this->organization_config->city = isset($form_data['organization_city']) |
|
443 | + ? sanitize_text_field($form_data['organization_city']) |
|
444 | + : $this->organization_config->city; |
|
445 | + $this->organization_config->STA_ID = isset($form_data['organization_state']) |
|
446 | + ? absint($form_data['organization_state']) |
|
447 | + : $this->organization_config->STA_ID; |
|
448 | + $this->organization_config->CNT_ISO = isset($form_data['organization_country']) |
|
449 | + ? sanitize_text_field($form_data['organization_country']) |
|
450 | + : $this->organization_config->CNT_ISO; |
|
451 | + $this->organization_config->zip = isset($form_data['organization_zip']) |
|
452 | + ? sanitize_text_field($form_data['organization_zip']) |
|
453 | + : $this->organization_config->zip; |
|
454 | + $this->organization_config->email = isset($form_data['organization_email']) |
|
455 | + ? sanitize_email($form_data['organization_email']) |
|
456 | + : $this->organization_config->email; |
|
457 | + $this->organization_config->vat = isset($form_data['organization_vat']) |
|
458 | + ? sanitize_text_field($form_data['organization_vat']) |
|
459 | + : $this->organization_config->vat; |
|
460 | + $this->organization_config->phone = isset($form_data['organization_phone']) |
|
461 | + ? sanitize_text_field($form_data['organization_phone']) |
|
462 | + : $this->organization_config->phone; |
|
463 | + $this->organization_config->logo_url = isset($form_data['organization_logo_url']) |
|
464 | + ? esc_url_raw($form_data['organization_logo_url']) |
|
465 | + : $this->organization_config->logo_url; |
|
466 | + $this->organization_config->facebook = isset($form_data['organization_facebook']) |
|
467 | + ? esc_url_raw($form_data['organization_facebook']) |
|
468 | + : $this->organization_config->facebook; |
|
469 | + $this->organization_config->twitter = isset($form_data['organization_twitter']) |
|
470 | + ? esc_url_raw($form_data['organization_twitter']) |
|
471 | + : $this->organization_config->twitter; |
|
472 | + $this->organization_config->linkedin = isset($form_data['organization_linkedin']) |
|
473 | + ? esc_url_raw($form_data['organization_linkedin']) |
|
474 | + : $this->organization_config->linkedin; |
|
475 | + $this->organization_config->pinterest = isset($form_data['organization_pinterest']) |
|
476 | + ? esc_url_raw($form_data['organization_pinterest']) |
|
477 | + : $this->organization_config->pinterest; |
|
478 | + $this->organization_config->google = isset($form_data['organization_google']) |
|
479 | + ? esc_url_raw($form_data['organization_google']) |
|
480 | + : $this->organization_config->google; |
|
481 | + $this->organization_config->instagram = isset($form_data['organization_instagram']) |
|
482 | + ? esc_url_raw($form_data['organization_instagram']) |
|
483 | + : $this->organization_config->instagram; |
|
484 | + $this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0]) |
|
485 | + ? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN) |
|
486 | + : false; |
|
487 | + $this->core_config->ee_ueip_has_notified = true; |
|
488 | 488 | |
489 | - $this->registry->CFG->currency = new EE_Currency_Config( |
|
490 | - $this->organization_config->CNT_ISO |
|
491 | - ); |
|
492 | - /** @var EE_Country $country */ |
|
493 | - $country = EEM_Country::instance()->get_one_by_ID($this->organization_config->CNT_ISO); |
|
494 | - if ($country instanceof EE_Country) { |
|
495 | - $country->set('CNT_active', 1); |
|
496 | - $country->save(); |
|
497 | - $this->countrySubRegionDao->saveCountrySubRegions($country); |
|
498 | - } |
|
499 | - return true; |
|
500 | - } |
|
489 | + $this->registry->CFG->currency = new EE_Currency_Config( |
|
490 | + $this->organization_config->CNT_ISO |
|
491 | + ); |
|
492 | + /** @var EE_Country $country */ |
|
493 | + $country = EEM_Country::instance()->get_one_by_ID($this->organization_config->CNT_ISO); |
|
494 | + if ($country instanceof EE_Country) { |
|
495 | + $country->set('CNT_active', 1); |
|
496 | + $country->save(); |
|
497 | + $this->countrySubRegionDao->saveCountrySubRegions($country); |
|
498 | + } |
|
499 | + return true; |
|
500 | + } |
|
501 | 501 | |
502 | 502 | |
503 | - /** |
|
504 | - * @return string |
|
505 | - */ |
|
506 | - private function uxipOptinText() |
|
507 | - { |
|
508 | - ob_start(); |
|
509 | - Stats::optinText(false); |
|
510 | - return ob_get_clean(); |
|
511 | - } |
|
503 | + /** |
|
504 | + * @return string |
|
505 | + */ |
|
506 | + private function uxipOptinText() |
|
507 | + { |
|
508 | + ob_start(); |
|
509 | + Stats::optinText(false); |
|
510 | + return ob_get_clean(); |
|
511 | + } |
|
512 | 512 | |
513 | 513 | |
514 | - /** |
|
515 | - * Return whether the site license key has been verified or not. |
|
516 | - * @return bool |
|
517 | - */ |
|
518 | - private function licenseKeyVerified() |
|
519 | - { |
|
520 | - if (empty($this->network_core_config->site_license_key)) { |
|
521 | - return false; |
|
522 | - } |
|
523 | - $ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME); |
|
524 | - $verify_fail = get_option($ver_option_key, false); |
|
525 | - return $verify_fail === false |
|
526 | - || (! empty($this->network_core_config->site_license_key) |
|
527 | - && $verify_fail === false |
|
528 | - ); |
|
529 | - } |
|
514 | + /** |
|
515 | + * Return whether the site license key has been verified or not. |
|
516 | + * @return bool |
|
517 | + */ |
|
518 | + private function licenseKeyVerified() |
|
519 | + { |
|
520 | + if (empty($this->network_core_config->site_license_key)) { |
|
521 | + return false; |
|
522 | + } |
|
523 | + $ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME); |
|
524 | + $verify_fail = get_option($ver_option_key, false); |
|
525 | + return $verify_fail === false |
|
526 | + || (! empty($this->network_core_config->site_license_key) |
|
527 | + && $verify_fail === false |
|
528 | + ); |
|
529 | + } |
|
530 | 530 | |
531 | 531 | |
532 | - /** |
|
533 | - * @return EE_Text_Input |
|
534 | - */ |
|
535 | - private function getSiteLicenseKeyField() |
|
536 | - { |
|
537 | - $text_input = new EE_Text_Input( |
|
538 | - array( |
|
539 | - 'html_name' => 'ee_site_license_key', |
|
540 | - 'html_id' => 'site_license_key', |
|
541 | - 'html_label_text' => esc_html__('Support License Key', 'event_espresso'), |
|
542 | - /** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */ |
|
543 | - 'html_help_text' => sprintf( |
|
544 | - esc_html__( |
|
545 | - 'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.', |
|
546 | - 'event_espresso' |
|
547 | - ), |
|
548 | - '<strong>', |
|
549 | - '</strong>' |
|
550 | - ), |
|
551 | - /** phpcs:enable */ |
|
552 | - 'default' => isset($this->network_core_config->site_license_key) |
|
553 | - ? $this->network_core_config->site_license_key |
|
554 | - : '', |
|
555 | - 'required' => false, |
|
556 | - 'form_html_filter' => new VsprintfFilter( |
|
557 | - '%2$s %1$s', |
|
558 | - array($this->getValidationIndicator()) |
|
559 | - ) |
|
560 | - ) |
|
561 | - ); |
|
562 | - return $text_input; |
|
563 | - } |
|
532 | + /** |
|
533 | + * @return EE_Text_Input |
|
534 | + */ |
|
535 | + private function getSiteLicenseKeyField() |
|
536 | + { |
|
537 | + $text_input = new EE_Text_Input( |
|
538 | + array( |
|
539 | + 'html_name' => 'ee_site_license_key', |
|
540 | + 'html_id' => 'site_license_key', |
|
541 | + 'html_label_text' => esc_html__('Support License Key', 'event_espresso'), |
|
542 | + /** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */ |
|
543 | + 'html_help_text' => sprintf( |
|
544 | + esc_html__( |
|
545 | + 'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.', |
|
546 | + 'event_espresso' |
|
547 | + ), |
|
548 | + '<strong>', |
|
549 | + '</strong>' |
|
550 | + ), |
|
551 | + /** phpcs:enable */ |
|
552 | + 'default' => isset($this->network_core_config->site_license_key) |
|
553 | + ? $this->network_core_config->site_license_key |
|
554 | + : '', |
|
555 | + 'required' => false, |
|
556 | + 'form_html_filter' => new VsprintfFilter( |
|
557 | + '%2$s %1$s', |
|
558 | + array($this->getValidationIndicator()) |
|
559 | + ) |
|
560 | + ) |
|
561 | + ); |
|
562 | + return $text_input; |
|
563 | + } |
|
564 | 564 | |
565 | 565 | |
566 | - /** |
|
567 | - * @return string |
|
568 | - */ |
|
569 | - private function getValidationIndicator() |
|
570 | - { |
|
571 | - $verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red'; |
|
572 | - return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>'; |
|
573 | - } |
|
566 | + /** |
|
567 | + * @return string |
|
568 | + */ |
|
569 | + private function getValidationIndicator() |
|
570 | + { |
|
571 | + $verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red'; |
|
572 | + return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>'; |
|
573 | + } |
|
574 | 574 | } |
@@ -38,103 +38,103 @@ |
||
38 | 38 | * @since 4.0 |
39 | 39 | */ |
40 | 40 | if (function_exists('espresso_version')) { |
41 | - if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | - /** |
|
43 | - * espresso_duplicate_plugin_error |
|
44 | - * displays if more than one version of EE is activated at the same time |
|
45 | - */ |
|
46 | - function espresso_duplicate_plugin_error() |
|
47 | - { |
|
48 | - ?> |
|
41 | + if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | + /** |
|
43 | + * espresso_duplicate_plugin_error |
|
44 | + * displays if more than one version of EE is activated at the same time |
|
45 | + */ |
|
46 | + function espresso_duplicate_plugin_error() |
|
47 | + { |
|
48 | + ?> |
|
49 | 49 | <div class="error"> |
50 | 50 | <p> |
51 | 51 | <?php |
52 | - echo esc_html__( |
|
53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | - 'event_espresso' |
|
55 | - ); ?> |
|
52 | + echo esc_html__( |
|
53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | + 'event_espresso' |
|
55 | + ); ?> |
|
56 | 56 | </p> |
57 | 57 | </div> |
58 | 58 | <?php |
59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | - } |
|
61 | - } |
|
62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | + } |
|
61 | + } |
|
62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
63 | 63 | } else { |
64 | - define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
65 | - if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | - /** |
|
67 | - * espresso_minimum_php_version_error |
|
68 | - * |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - function espresso_minimum_php_version_error() |
|
72 | - { |
|
73 | - ?> |
|
64 | + define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
65 | + if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | + /** |
|
67 | + * espresso_minimum_php_version_error |
|
68 | + * |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + function espresso_minimum_php_version_error() |
|
72 | + { |
|
73 | + ?> |
|
74 | 74 | <div class="error"> |
75 | 75 | <p> |
76 | 76 | <?php |
77 | - printf( |
|
78 | - esc_html__( |
|
79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | - 'event_espresso' |
|
81 | - ), |
|
82 | - EE_MIN_PHP_VER_REQUIRED, |
|
83 | - PHP_VERSION, |
|
84 | - '<br/>', |
|
85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | - ); |
|
87 | - ?> |
|
77 | + printf( |
|
78 | + esc_html__( |
|
79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | + 'event_espresso' |
|
81 | + ), |
|
82 | + EE_MIN_PHP_VER_REQUIRED, |
|
83 | + PHP_VERSION, |
|
84 | + '<br/>', |
|
85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | + ); |
|
87 | + ?> |
|
88 | 88 | </p> |
89 | 89 | </div> |
90 | 90 | <?php |
91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | - } |
|
91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | + } |
|
93 | 93 | |
94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | - } else { |
|
96 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | - /** |
|
98 | - * espresso_version |
|
99 | - * Returns the plugin version |
|
100 | - * |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - function espresso_version() |
|
104 | - { |
|
105 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.012'); |
|
106 | - } |
|
94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | + } else { |
|
96 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | + /** |
|
98 | + * espresso_version |
|
99 | + * Returns the plugin version |
|
100 | + * |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + function espresso_version() |
|
104 | + { |
|
105 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.012'); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * espresso_plugin_activation |
|
110 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | - */ |
|
112 | - function espresso_plugin_activation() |
|
113 | - { |
|
114 | - update_option('ee_espresso_activation', true); |
|
115 | - } |
|
108 | + /** |
|
109 | + * espresso_plugin_activation |
|
110 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | + */ |
|
112 | + function espresso_plugin_activation() |
|
113 | + { |
|
114 | + update_option('ee_espresso_activation', true); |
|
115 | + } |
|
116 | 116 | |
117 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
117 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
118 | 118 | |
119 | - require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | - bootstrap_espresso(); |
|
121 | - } |
|
119 | + require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | + bootstrap_espresso(); |
|
121 | + } |
|
122 | 122 | } |
123 | 123 | if (! function_exists('espresso_deactivate_plugin')) { |
124 | - /** |
|
125 | - * deactivate_plugin |
|
126 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | - * |
|
128 | - * @access public |
|
129 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | - { |
|
134 | - if (! function_exists('deactivate_plugins')) { |
|
135 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | - } |
|
137 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | - deactivate_plugins($plugin_basename); |
|
139 | - } |
|
124 | + /** |
|
125 | + * deactivate_plugin |
|
126 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | + * |
|
128 | + * @access public |
|
129 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | + { |
|
134 | + if (! function_exists('deactivate_plugins')) { |
|
135 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | + } |
|
137 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | + deactivate_plugins($plugin_basename); |
|
139 | + } |
|
140 | 140 | } |