@@ -303,7 +303,7 @@ discard block |
||
| 303 | 303 | * ATT_address column |
| 304 | 304 | * |
| 305 | 305 | * @param EE_Attendee $attendee |
| 306 | - * @return mixed |
|
| 306 | + * @return string |
|
| 307 | 307 | * @throws EE_Error |
| 308 | 308 | */ |
| 309 | 309 | public function column_ATT_address(EE_Attendee $attendee) |
@@ -316,7 +316,7 @@ discard block |
||
| 316 | 316 | * ATT_city column |
| 317 | 317 | * |
| 318 | 318 | * @param EE_Attendee $attendee |
| 319 | - * @return mixed |
|
| 319 | + * @return string |
|
| 320 | 320 | * @throws EE_Error |
| 321 | 321 | */ |
| 322 | 322 | public function column_ATT_city(EE_Attendee $attendee) |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | * Phone Number column |
| 370 | 370 | * |
| 371 | 371 | * @param EE_Attendee $attendee |
| 372 | - * @return mixed |
|
| 372 | + * @return string |
|
| 373 | 373 | * @throws EE_Error |
| 374 | 374 | */ |
| 375 | 375 | public function column_ATT_phone(EE_Attendee $attendee) |
@@ -12,374 +12,374 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Initial setup of data (called by parent). |
|
| 17 | - */ |
|
| 18 | - protected function _setup_data() |
|
| 19 | - { |
|
| 20 | - $this->_data = $this->_view !== 'trash' |
|
| 21 | - ? $this->_admin_page->get_attendees($this->_per_page) |
|
| 22 | - : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
| 23 | - $this->_all_data_count = $this->_view !== 'trash' |
|
| 24 | - ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
| 25 | - : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 26 | - } |
|
| 27 | - |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Initial setup of properties. |
|
| 31 | - */ |
|
| 32 | - protected function _set_properties() |
|
| 33 | - { |
|
| 34 | - $this->_wp_list_args = array( |
|
| 35 | - 'singular' => esc_html__('attendee', 'event_espresso'), |
|
| 36 | - 'plural' => esc_html__('attendees', 'event_espresso'), |
|
| 37 | - 'ajax' => true, |
|
| 38 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 39 | - ); |
|
| 40 | - |
|
| 41 | - $this->_columns = array( |
|
| 42 | - 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
| 43 | - 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
| 44 | - 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
| 45 | - 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
| 46 | - 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
| 47 | - 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
| 48 | - 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
| 49 | - 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
| 50 | - 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
| 51 | - 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
| 52 | - 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
| 53 | - ); |
|
| 54 | - |
|
| 55 | - $this->_sortable_columns = array( |
|
| 56 | - 'ATT_ID' => array('ATT_ID' => false), |
|
| 57 | - 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
| 58 | - 'ATT_fname' => array('ATT_fname' => false), |
|
| 59 | - 'ATT_email' => array('ATT_email' => false), |
|
| 60 | - 'Registration_Count' => array('Registration_Count' => false), |
|
| 61 | - 'ATT_city' => array('ATT_city' => false), |
|
| 62 | - 'STA_ID' => array('STA_ID' => false), |
|
| 63 | - 'CNT_ISO' => array('CNT_ISO' => false), |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - $this->_hidden_columns = array( |
|
| 67 | - 'ATT_phone', |
|
| 68 | - 'ATT_address', |
|
| 69 | - 'ATT_city', |
|
| 70 | - 'STA_ID', |
|
| 71 | - 'CNT_ISO', |
|
| 72 | - ); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Initial setup of filters |
|
| 78 | - * |
|
| 79 | - * @return array |
|
| 80 | - */ |
|
| 81 | - protected function _get_table_filters() |
|
| 82 | - { |
|
| 83 | - return array(); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Initial setup of counts for views |
|
| 89 | - * |
|
| 90 | - * @throws InvalidArgumentException |
|
| 91 | - * @throws InvalidDataTypeException |
|
| 92 | - * @throws InvalidInterfaceException |
|
| 93 | - */ |
|
| 94 | - protected function _add_view_counts() |
|
| 95 | - { |
|
| 96 | - $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
| 97 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 98 | - 'ee_delete_contacts', |
|
| 99 | - 'espresso_registrations_delete_registration' |
|
| 100 | - )) { |
|
| 101 | - $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 102 | - } |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Get count of attendees. |
|
| 108 | - * |
|
| 109 | - * @return int |
|
| 110 | - * @throws EE_Error |
|
| 111 | - * @throws InvalidArgumentException |
|
| 112 | - * @throws InvalidDataTypeException |
|
| 113 | - * @throws InvalidInterfaceException |
|
| 114 | - */ |
|
| 115 | - protected function _get_attendees_count() |
|
| 116 | - { |
|
| 117 | - return EEM_Attendee::instance()->count(); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * Checkbox column |
|
| 123 | - * |
|
| 124 | - * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
| 125 | - * @return string |
|
| 126 | - * @throws EE_Error |
|
| 127 | - */ |
|
| 128 | - public function column_cb($attendee) |
|
| 129 | - { |
|
| 130 | - if (! $attendee instanceof EE_Attendee) { |
|
| 131 | - return ''; |
|
| 132 | - } |
|
| 133 | - return sprintf( |
|
| 134 | - '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
| 135 | - $attendee->ID() |
|
| 136 | - ); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * ATT_ID column |
|
| 142 | - * |
|
| 143 | - * @param EE_Attendee $attendee |
|
| 144 | - * @return string |
|
| 145 | - * @throws EE_Error |
|
| 146 | - */ |
|
| 147 | - public function column_ATT_ID(EE_Attendee $attendee) |
|
| 148 | - { |
|
| 149 | - $content = $attendee->ID(); |
|
| 150 | - $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
| 151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 152 | - return $content; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * ATT_lname column |
|
| 158 | - * |
|
| 159 | - * @param EE_Attendee $attendee |
|
| 160 | - * @return string |
|
| 161 | - * @throws InvalidArgumentException |
|
| 162 | - * @throws InvalidDataTypeException |
|
| 163 | - * @throws InvalidInterfaceException |
|
| 164 | - * @throws EE_Error |
|
| 165 | - */ |
|
| 166 | - public function column_ATT_lname(EE_Attendee $attendee) |
|
| 167 | - { |
|
| 168 | - // edit attendee link |
|
| 169 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 170 | - array( |
|
| 171 | - 'action' => 'edit_attendee', |
|
| 172 | - 'post' => $attendee->ID(), |
|
| 173 | - ), |
|
| 174 | - REG_ADMIN_URL |
|
| 175 | - ); |
|
| 176 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 177 | - 'ee_edit_contacts', |
|
| 178 | - 'espresso_registrations_edit_attendee' |
|
| 179 | - ) |
|
| 180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | - . $attendee->lname() . '</a>' |
|
| 183 | - : $attendee->lname(); |
|
| 184 | - return $name_link; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * ATT_fname column |
|
| 190 | - * |
|
| 191 | - * @param EE_Attendee $attendee |
|
| 192 | - * @return string |
|
| 193 | - * @throws InvalidArgumentException |
|
| 194 | - * @throws InvalidDataTypeException |
|
| 195 | - * @throws InvalidInterfaceException |
|
| 196 | - * @throws EE_Error |
|
| 197 | - */ |
|
| 198 | - public function column_ATT_fname(EE_Attendee $attendee) |
|
| 199 | - { |
|
| 200 | - // Build row actions |
|
| 201 | - $actions = array(); |
|
| 202 | - // edit attendee link |
|
| 203 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 204 | - 'ee_edit_contacts', |
|
| 205 | - 'espresso_registrations_edit_attendee' |
|
| 206 | - )) { |
|
| 207 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 208 | - array( |
|
| 209 | - 'action' => 'edit_attendee', |
|
| 210 | - 'post' => $attendee->ID(), |
|
| 211 | - ), |
|
| 212 | - REG_ADMIN_URL |
|
| 213 | - ); |
|
| 214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - if ($this->_view === 'in_use') { |
|
| 220 | - // trash attendee link |
|
| 221 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 222 | - 'ee_delete_contacts', |
|
| 223 | - 'espresso_registrations_trash_attendees' |
|
| 224 | - )) { |
|
| 225 | - $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 226 | - array( |
|
| 227 | - 'action' => 'trash_attendee', |
|
| 228 | - 'ATT_ID' => $attendee->ID(), |
|
| 229 | - ), |
|
| 230 | - REG_ADMIN_URL |
|
| 231 | - ); |
|
| 232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 233 | - . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
| 234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 235 | - } |
|
| 236 | - } else { |
|
| 237 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 238 | - 'ee_delete_contacts', |
|
| 239 | - 'espresso_registrations_restore_attendees' |
|
| 240 | - )) { |
|
| 241 | - // restore attendee link |
|
| 242 | - $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 243 | - array( |
|
| 244 | - 'action' => 'restore_attendees', |
|
| 245 | - 'ATT_ID' => $attendee->ID(), |
|
| 246 | - ), |
|
| 247 | - REG_ADMIN_URL |
|
| 248 | - ); |
|
| 249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 252 | - } |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 256 | - array( |
|
| 257 | - 'action' => 'edit_attendee', |
|
| 258 | - 'post' => $attendee->ID(), |
|
| 259 | - ), |
|
| 260 | - REG_ADMIN_URL |
|
| 261 | - ); |
|
| 262 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 263 | - 'ee_edit_contacts', |
|
| 264 | - 'espresso_registrations_edit_attendee' |
|
| 265 | - ) |
|
| 266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 268 | - : $attendee->fname(); |
|
| 269 | - |
|
| 270 | - // Return the name contents |
|
| 271 | - return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - |
|
| 275 | - /** |
|
| 276 | - * Email Column |
|
| 277 | - * |
|
| 278 | - * @param EE_Attendee $attendee |
|
| 279 | - * @return string |
|
| 280 | - * @throws EE_Error |
|
| 281 | - */ |
|
| 282 | - public function column_ATT_email(EE_Attendee $attendee) |
|
| 283 | - { |
|
| 284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Column displaying count of registrations attached to Attendee. |
|
| 290 | - * |
|
| 291 | - * @param EE_Attendee $attendee |
|
| 292 | - * @return string |
|
| 293 | - * @throws EE_Error |
|
| 294 | - */ |
|
| 295 | - public function column_Registration_Count(EE_Attendee $attendee) |
|
| 296 | - { |
|
| 297 | - $link = EEH_URL::add_query_args_and_nonce( |
|
| 298 | - array( |
|
| 299 | - 'action' => 'default', |
|
| 300 | - 'ATT_ID' => $attendee->ID(), |
|
| 301 | - ), |
|
| 302 | - REG_ADMIN_URL |
|
| 303 | - ); |
|
| 304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * ATT_address column |
|
| 310 | - * |
|
| 311 | - * @param EE_Attendee $attendee |
|
| 312 | - * @return mixed |
|
| 313 | - * @throws EE_Error |
|
| 314 | - */ |
|
| 315 | - public function column_ATT_address(EE_Attendee $attendee) |
|
| 316 | - { |
|
| 317 | - return $attendee->address(); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - |
|
| 321 | - /** |
|
| 322 | - * ATT_city column |
|
| 323 | - * |
|
| 324 | - * @param EE_Attendee $attendee |
|
| 325 | - * @return mixed |
|
| 326 | - * @throws EE_Error |
|
| 327 | - */ |
|
| 328 | - public function column_ATT_city(EE_Attendee $attendee) |
|
| 329 | - { |
|
| 330 | - return $attendee->city(); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * State Column |
|
| 336 | - * |
|
| 337 | - * @param EE_Attendee $attendee |
|
| 338 | - * @return string |
|
| 339 | - * @throws EE_Error |
|
| 340 | - * @throws InvalidArgumentException |
|
| 341 | - * @throws InvalidDataTypeException |
|
| 342 | - * @throws InvalidInterfaceException |
|
| 343 | - */ |
|
| 344 | - public function column_STA_ID(EE_Attendee $attendee) |
|
| 345 | - { |
|
| 346 | - $states = EEM_State::instance()->get_all_states(); |
|
| 347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 349 | - : $attendee->state_ID(); |
|
| 350 | - return ! is_numeric($state) ? $state : ''; |
|
| 351 | - } |
|
| 352 | - |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * Country Column |
|
| 356 | - * |
|
| 357 | - * @param EE_Attendee $attendee |
|
| 358 | - * @return string |
|
| 359 | - * @throws EE_Error |
|
| 360 | - * @throws InvalidArgumentException |
|
| 361 | - * @throws InvalidDataTypeException |
|
| 362 | - * @throws InvalidInterfaceException |
|
| 363 | - */ |
|
| 364 | - public function column_CNT_ISO(EE_Attendee $attendee) |
|
| 365 | - { |
|
| 366 | - $countries = EEM_Country::instance()->get_all_countries(); |
|
| 367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 369 | - : $attendee->country_ID(); |
|
| 370 | - return ! is_numeric($country) ? $country : ''; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Phone Number column |
|
| 376 | - * |
|
| 377 | - * @param EE_Attendee $attendee |
|
| 378 | - * @return mixed |
|
| 379 | - * @throws EE_Error |
|
| 380 | - */ |
|
| 381 | - public function column_ATT_phone(EE_Attendee $attendee) |
|
| 382 | - { |
|
| 383 | - return $attendee->phone(); |
|
| 384 | - } |
|
| 15 | + /** |
|
| 16 | + * Initial setup of data (called by parent). |
|
| 17 | + */ |
|
| 18 | + protected function _setup_data() |
|
| 19 | + { |
|
| 20 | + $this->_data = $this->_view !== 'trash' |
|
| 21 | + ? $this->_admin_page->get_attendees($this->_per_page) |
|
| 22 | + : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
| 23 | + $this->_all_data_count = $this->_view !== 'trash' |
|
| 24 | + ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
| 25 | + : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 26 | + } |
|
| 27 | + |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Initial setup of properties. |
|
| 31 | + */ |
|
| 32 | + protected function _set_properties() |
|
| 33 | + { |
|
| 34 | + $this->_wp_list_args = array( |
|
| 35 | + 'singular' => esc_html__('attendee', 'event_espresso'), |
|
| 36 | + 'plural' => esc_html__('attendees', 'event_espresso'), |
|
| 37 | + 'ajax' => true, |
|
| 38 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 39 | + ); |
|
| 40 | + |
|
| 41 | + $this->_columns = array( |
|
| 42 | + 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
| 43 | + 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
| 44 | + 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
| 45 | + 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
| 46 | + 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
| 47 | + 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
| 48 | + 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
| 49 | + 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
| 50 | + 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
| 51 | + 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
| 52 | + 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
| 53 | + ); |
|
| 54 | + |
|
| 55 | + $this->_sortable_columns = array( |
|
| 56 | + 'ATT_ID' => array('ATT_ID' => false), |
|
| 57 | + 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
| 58 | + 'ATT_fname' => array('ATT_fname' => false), |
|
| 59 | + 'ATT_email' => array('ATT_email' => false), |
|
| 60 | + 'Registration_Count' => array('Registration_Count' => false), |
|
| 61 | + 'ATT_city' => array('ATT_city' => false), |
|
| 62 | + 'STA_ID' => array('STA_ID' => false), |
|
| 63 | + 'CNT_ISO' => array('CNT_ISO' => false), |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + $this->_hidden_columns = array( |
|
| 67 | + 'ATT_phone', |
|
| 68 | + 'ATT_address', |
|
| 69 | + 'ATT_city', |
|
| 70 | + 'STA_ID', |
|
| 71 | + 'CNT_ISO', |
|
| 72 | + ); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Initial setup of filters |
|
| 78 | + * |
|
| 79 | + * @return array |
|
| 80 | + */ |
|
| 81 | + protected function _get_table_filters() |
|
| 82 | + { |
|
| 83 | + return array(); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Initial setup of counts for views |
|
| 89 | + * |
|
| 90 | + * @throws InvalidArgumentException |
|
| 91 | + * @throws InvalidDataTypeException |
|
| 92 | + * @throws InvalidInterfaceException |
|
| 93 | + */ |
|
| 94 | + protected function _add_view_counts() |
|
| 95 | + { |
|
| 96 | + $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
| 97 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 98 | + 'ee_delete_contacts', |
|
| 99 | + 'espresso_registrations_delete_registration' |
|
| 100 | + )) { |
|
| 101 | + $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 102 | + } |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Get count of attendees. |
|
| 108 | + * |
|
| 109 | + * @return int |
|
| 110 | + * @throws EE_Error |
|
| 111 | + * @throws InvalidArgumentException |
|
| 112 | + * @throws InvalidDataTypeException |
|
| 113 | + * @throws InvalidInterfaceException |
|
| 114 | + */ |
|
| 115 | + protected function _get_attendees_count() |
|
| 116 | + { |
|
| 117 | + return EEM_Attendee::instance()->count(); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * Checkbox column |
|
| 123 | + * |
|
| 124 | + * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
| 125 | + * @return string |
|
| 126 | + * @throws EE_Error |
|
| 127 | + */ |
|
| 128 | + public function column_cb($attendee) |
|
| 129 | + { |
|
| 130 | + if (! $attendee instanceof EE_Attendee) { |
|
| 131 | + return ''; |
|
| 132 | + } |
|
| 133 | + return sprintf( |
|
| 134 | + '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
| 135 | + $attendee->ID() |
|
| 136 | + ); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * ATT_ID column |
|
| 142 | + * |
|
| 143 | + * @param EE_Attendee $attendee |
|
| 144 | + * @return string |
|
| 145 | + * @throws EE_Error |
|
| 146 | + */ |
|
| 147 | + public function column_ATT_ID(EE_Attendee $attendee) |
|
| 148 | + { |
|
| 149 | + $content = $attendee->ID(); |
|
| 150 | + $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
| 151 | + $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 152 | + return $content; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * ATT_lname column |
|
| 158 | + * |
|
| 159 | + * @param EE_Attendee $attendee |
|
| 160 | + * @return string |
|
| 161 | + * @throws InvalidArgumentException |
|
| 162 | + * @throws InvalidDataTypeException |
|
| 163 | + * @throws InvalidInterfaceException |
|
| 164 | + * @throws EE_Error |
|
| 165 | + */ |
|
| 166 | + public function column_ATT_lname(EE_Attendee $attendee) |
|
| 167 | + { |
|
| 168 | + // edit attendee link |
|
| 169 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 170 | + array( |
|
| 171 | + 'action' => 'edit_attendee', |
|
| 172 | + 'post' => $attendee->ID(), |
|
| 173 | + ), |
|
| 174 | + REG_ADMIN_URL |
|
| 175 | + ); |
|
| 176 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 177 | + 'ee_edit_contacts', |
|
| 178 | + 'espresso_registrations_edit_attendee' |
|
| 179 | + ) |
|
| 180 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | + . $attendee->lname() . '</a>' |
|
| 183 | + : $attendee->lname(); |
|
| 184 | + return $name_link; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * ATT_fname column |
|
| 190 | + * |
|
| 191 | + * @param EE_Attendee $attendee |
|
| 192 | + * @return string |
|
| 193 | + * @throws InvalidArgumentException |
|
| 194 | + * @throws InvalidDataTypeException |
|
| 195 | + * @throws InvalidInterfaceException |
|
| 196 | + * @throws EE_Error |
|
| 197 | + */ |
|
| 198 | + public function column_ATT_fname(EE_Attendee $attendee) |
|
| 199 | + { |
|
| 200 | + // Build row actions |
|
| 201 | + $actions = array(); |
|
| 202 | + // edit attendee link |
|
| 203 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 204 | + 'ee_edit_contacts', |
|
| 205 | + 'espresso_registrations_edit_attendee' |
|
| 206 | + )) { |
|
| 207 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 208 | + array( |
|
| 209 | + 'action' => 'edit_attendee', |
|
| 210 | + 'post' => $attendee->ID(), |
|
| 211 | + ), |
|
| 212 | + REG_ADMIN_URL |
|
| 213 | + ); |
|
| 214 | + $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | + . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + if ($this->_view === 'in_use') { |
|
| 220 | + // trash attendee link |
|
| 221 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 222 | + 'ee_delete_contacts', |
|
| 223 | + 'espresso_registrations_trash_attendees' |
|
| 224 | + )) { |
|
| 225 | + $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 226 | + array( |
|
| 227 | + 'action' => 'trash_attendee', |
|
| 228 | + 'ATT_ID' => $attendee->ID(), |
|
| 229 | + ), |
|
| 230 | + REG_ADMIN_URL |
|
| 231 | + ); |
|
| 232 | + $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 233 | + . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
| 234 | + . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 235 | + } |
|
| 236 | + } else { |
|
| 237 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 238 | + 'ee_delete_contacts', |
|
| 239 | + 'espresso_registrations_restore_attendees' |
|
| 240 | + )) { |
|
| 241 | + // restore attendee link |
|
| 242 | + $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 243 | + array( |
|
| 244 | + 'action' => 'restore_attendees', |
|
| 245 | + 'ATT_ID' => $attendee->ID(), |
|
| 246 | + ), |
|
| 247 | + REG_ADMIN_URL |
|
| 248 | + ); |
|
| 249 | + $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | + . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | + . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 252 | + } |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 256 | + array( |
|
| 257 | + 'action' => 'edit_attendee', |
|
| 258 | + 'post' => $attendee->ID(), |
|
| 259 | + ), |
|
| 260 | + REG_ADMIN_URL |
|
| 261 | + ); |
|
| 262 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 263 | + 'ee_edit_contacts', |
|
| 264 | + 'espresso_registrations_edit_attendee' |
|
| 265 | + ) |
|
| 266 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 268 | + : $attendee->fname(); |
|
| 269 | + |
|
| 270 | + // Return the name contents |
|
| 271 | + return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + |
|
| 275 | + /** |
|
| 276 | + * Email Column |
|
| 277 | + * |
|
| 278 | + * @param EE_Attendee $attendee |
|
| 279 | + * @return string |
|
| 280 | + * @throws EE_Error |
|
| 281 | + */ |
|
| 282 | + public function column_ATT_email(EE_Attendee $attendee) |
|
| 283 | + { |
|
| 284 | + return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Column displaying count of registrations attached to Attendee. |
|
| 290 | + * |
|
| 291 | + * @param EE_Attendee $attendee |
|
| 292 | + * @return string |
|
| 293 | + * @throws EE_Error |
|
| 294 | + */ |
|
| 295 | + public function column_Registration_Count(EE_Attendee $attendee) |
|
| 296 | + { |
|
| 297 | + $link = EEH_URL::add_query_args_and_nonce( |
|
| 298 | + array( |
|
| 299 | + 'action' => 'default', |
|
| 300 | + 'ATT_ID' => $attendee->ID(), |
|
| 301 | + ), |
|
| 302 | + REG_ADMIN_URL |
|
| 303 | + ); |
|
| 304 | + return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * ATT_address column |
|
| 310 | + * |
|
| 311 | + * @param EE_Attendee $attendee |
|
| 312 | + * @return mixed |
|
| 313 | + * @throws EE_Error |
|
| 314 | + */ |
|
| 315 | + public function column_ATT_address(EE_Attendee $attendee) |
|
| 316 | + { |
|
| 317 | + return $attendee->address(); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + |
|
| 321 | + /** |
|
| 322 | + * ATT_city column |
|
| 323 | + * |
|
| 324 | + * @param EE_Attendee $attendee |
|
| 325 | + * @return mixed |
|
| 326 | + * @throws EE_Error |
|
| 327 | + */ |
|
| 328 | + public function column_ATT_city(EE_Attendee $attendee) |
|
| 329 | + { |
|
| 330 | + return $attendee->city(); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * State Column |
|
| 336 | + * |
|
| 337 | + * @param EE_Attendee $attendee |
|
| 338 | + * @return string |
|
| 339 | + * @throws EE_Error |
|
| 340 | + * @throws InvalidArgumentException |
|
| 341 | + * @throws InvalidDataTypeException |
|
| 342 | + * @throws InvalidInterfaceException |
|
| 343 | + */ |
|
| 344 | + public function column_STA_ID(EE_Attendee $attendee) |
|
| 345 | + { |
|
| 346 | + $states = EEM_State::instance()->get_all_states(); |
|
| 347 | + $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | + ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 349 | + : $attendee->state_ID(); |
|
| 350 | + return ! is_numeric($state) ? $state : ''; |
|
| 351 | + } |
|
| 352 | + |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * Country Column |
|
| 356 | + * |
|
| 357 | + * @param EE_Attendee $attendee |
|
| 358 | + * @return string |
|
| 359 | + * @throws EE_Error |
|
| 360 | + * @throws InvalidArgumentException |
|
| 361 | + * @throws InvalidDataTypeException |
|
| 362 | + * @throws InvalidInterfaceException |
|
| 363 | + */ |
|
| 364 | + public function column_CNT_ISO(EE_Attendee $attendee) |
|
| 365 | + { |
|
| 366 | + $countries = EEM_Country::instance()->get_all_countries(); |
|
| 367 | + $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | + ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 369 | + : $attendee->country_ID(); |
|
| 370 | + return ! is_numeric($country) ? $country : ''; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Phone Number column |
|
| 376 | + * |
|
| 377 | + * @param EE_Attendee $attendee |
|
| 378 | + * @return mixed |
|
| 379 | + * @throws EE_Error |
|
| 380 | + */ |
|
| 381 | + public function column_ATT_phone(EE_Attendee $attendee) |
|
| 382 | + { |
|
| 383 | + return $attendee->phone(); |
|
| 384 | + } |
|
| 385 | 385 | } |
@@ -127,7 +127,7 @@ discard block |
||
| 127 | 127 | */ |
| 128 | 128 | public function column_cb($attendee) |
| 129 | 129 | { |
| 130 | - if (! $attendee instanceof EE_Attendee) { |
|
| 130 | + if ( ! $attendee instanceof EE_Attendee) { |
|
| 131 | 131 | return ''; |
| 132 | 132 | } |
| 133 | 133 | return sprintf( |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | { |
| 149 | 149 | $content = $attendee->ID(); |
| 150 | 150 | $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
| 151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 151 | + $content .= ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>'; |
|
| 152 | 152 | return $content; |
| 153 | 153 | } |
| 154 | 154 | |
@@ -177,9 +177,9 @@ discard block |
||
| 177 | 177 | 'ee_edit_contacts', |
| 178 | 178 | 'espresso_registrations_edit_attendee' |
| 179 | 179 | ) |
| 180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | - . $attendee->lname() . '</a>' |
|
| 180 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
| 181 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
| 182 | + . $attendee->lname().'</a>' |
|
| 183 | 183 | : $attendee->lname(); |
| 184 | 184 | return $name_link; |
| 185 | 185 | } |
@@ -211,9 +211,9 @@ discard block |
||
| 211 | 211 | ), |
| 212 | 212 | REG_ADMIN_URL |
| 213 | 213 | ); |
| 214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 214 | + $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="' |
|
| 215 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
| 216 | + . esc_html__('Edit', 'event_espresso').'</a>'; |
|
| 217 | 217 | } |
| 218 | 218 | |
| 219 | 219 | if ($this->_view === 'in_use') { |
@@ -229,9 +229,9 @@ discard block |
||
| 229 | 229 | ), |
| 230 | 230 | REG_ADMIN_URL |
| 231 | 231 | ); |
| 232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 232 | + $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="' |
|
| 233 | 233 | . esc_attr__('Move Contact to Trash', 'event_espresso') |
| 234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 234 | + . '">'.esc_html__('Trash', 'event_espresso').'</a>'; |
|
| 235 | 235 | } |
| 236 | 236 | } else { |
| 237 | 237 | if (EE_Registry::instance()->CAP->current_user_can( |
@@ -246,9 +246,9 @@ discard block |
||
| 246 | 246 | ), |
| 247 | 247 | REG_ADMIN_URL |
| 248 | 248 | ); |
| 249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 249 | + $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="' |
|
| 250 | + . esc_attr__('Restore Contact', 'event_espresso').'">' |
|
| 251 | + . esc_html__('Restore', 'event_espresso').'</a>'; |
|
| 252 | 252 | } |
| 253 | 253 | } |
| 254 | 254 | |
@@ -263,8 +263,8 @@ discard block |
||
| 263 | 263 | 'ee_edit_contacts', |
| 264 | 264 | 'espresso_registrations_edit_attendee' |
| 265 | 265 | ) |
| 266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 266 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
| 267 | + . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>' |
|
| 268 | 268 | : $attendee->fname(); |
| 269 | 269 | |
| 270 | 270 | // Return the name contents |
@@ -281,7 +281,7 @@ discard block |
||
| 281 | 281 | */ |
| 282 | 282 | public function column_ATT_email(EE_Attendee $attendee) |
| 283 | 283 | { |
| 284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 284 | + return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>'; |
|
| 285 | 285 | } |
| 286 | 286 | |
| 287 | 287 | |
@@ -301,7 +301,7 @@ discard block |
||
| 301 | 301 | ), |
| 302 | 302 | REG_ADMIN_URL |
| 303 | 303 | ); |
| 304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 304 | + return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>'; |
|
| 305 | 305 | } |
| 306 | 306 | |
| 307 | 307 | |
@@ -344,8 +344,8 @@ discard block |
||
| 344 | 344 | public function column_STA_ID(EE_Attendee $attendee) |
| 345 | 345 | { |
| 346 | 346 | $states = EEM_State::instance()->get_all_states(); |
| 347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 347 | + $state = isset($states[$attendee->state_ID()]) |
|
| 348 | + ? $states[$attendee->state_ID()]->get('STA_name') |
|
| 349 | 349 | : $attendee->state_ID(); |
| 350 | 350 | return ! is_numeric($state) ? $state : ''; |
| 351 | 351 | } |
@@ -364,8 +364,8 @@ discard block |
||
| 364 | 364 | public function column_CNT_ISO(EE_Attendee $attendee) |
| 365 | 365 | { |
| 366 | 366 | $countries = EEM_Country::instance()->get_all_countries(); |
| 367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 367 | + $country = isset($countries[$attendee->country_ID()]) |
|
| 368 | + ? $countries[$attendee->country_ID()]->get('CNT_name') |
|
| 369 | 369 | : $attendee->country_ID(); |
| 370 | 370 | return ! is_numeric($country) ? $country : ''; |
| 371 | 371 | } |
@@ -25,17 +25,17 @@ |
||
| 25 | 25 | class ModelFactory |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $model_name |
|
| 30 | - * @return bool|EEM_Base |
|
| 31 | - * @throws EE_Error |
|
| 32 | - * @throws InvalidDataTypeException |
|
| 33 | - * @throws InvalidInterfaceException |
|
| 34 | - * @throws InvalidArgumentException |
|
| 35 | - * @throws ReflectionException |
|
| 36 | - */ |
|
| 37 | - public static function getModel($model_name) |
|
| 38 | - { |
|
| 39 | - return EE_Registry::instance()->load_model($model_name); |
|
| 40 | - } |
|
| 28 | + /** |
|
| 29 | + * @param string $model_name |
|
| 30 | + * @return bool|EEM_Base |
|
| 31 | + * @throws EE_Error |
|
| 32 | + * @throws InvalidDataTypeException |
|
| 33 | + * @throws InvalidInterfaceException |
|
| 34 | + * @throws InvalidArgumentException |
|
| 35 | + * @throws ReflectionException |
|
| 36 | + */ |
|
| 37 | + public static function getModel($model_name) |
|
| 38 | + { |
|
| 39 | + return EE_Registry::instance()->load_model($model_name); |
|
| 40 | + } |
|
| 41 | 41 | } |
@@ -66,24 +66,24 @@ discard block |
||
| 66 | 66 | public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
| 67 | 67 | { |
| 68 | 68 | // if the $_available_spaces array has not been set up yet... |
| 69 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 69 | + if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 70 | 70 | $this->setInitialTicketDatetimeAvailability($ticket); |
| 71 | 71 | } |
| 72 | 72 | $available_spaces = $ticket->qty() - $ticket->sold(); |
| 73 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 73 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 74 | 74 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
| 75 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 75 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
| 76 | 76 | // if we want the original datetime availability BEFORE we started subtracting tickets ? |
| 77 | 77 | if ($get_original_ticket_spaces) { |
| 78 | 78 | // then grab the available spaces from the "tickets" array |
| 79 | 79 | // and compare with the above to get the lowest number |
| 80 | 80 | $available_spaces = min( |
| 81 | 81 | $available_spaces, |
| 82 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 82 | + $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
| 83 | 83 | ); |
| 84 | 84 | } else { |
| 85 | 85 | // we want the updated ticket availability as stored in the "datetimes" array |
| 86 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 86 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]); |
|
| 87 | 87 | } |
| 88 | 88 | } |
| 89 | 89 | } |
@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | 'order_by' => array('DTT_EVT_start' => 'ASC'), |
| 115 | 115 | ) |
| 116 | 116 | ); |
| 117 | - if (! empty($datetimes)) { |
|
| 117 | + if ( ! empty($datetimes)) { |
|
| 118 | 118 | // now loop thru all of the datetimes |
| 119 | 119 | foreach ($datetimes as $datetime) { |
| 120 | 120 | if ($datetime instanceof EE_Datetime) { |
@@ -122,17 +122,17 @@ discard block |
||
| 122 | 122 | $spaces_remaining = $datetime->spaces_remaining(); |
| 123 | 123 | // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
| 124 | 124 | // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
| 125 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 125 | + $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
| 126 | 126 | $ticket->qty() - $ticket->sold(), |
| 127 | 127 | $spaces_remaining |
| 128 | 128 | ); |
| 129 | 129 | // if the remaining spaces for this datetime is already set, |
| 130 | 130 | // then compare that against the datetime spaces remaining, and take the lowest number, |
| 131 | 131 | // else just take the datetime spaces remaining, and assign to the datetimes array |
| 132 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 133 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 132 | + $this->available_spaces['datetimes'][$datetime->ID()] = isset( |
|
| 133 | + $this->available_spaces['datetimes'][$datetime->ID()] |
|
| 134 | 134 | ) |
| 135 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 135 | + ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
| 136 | 136 | : $spaces_remaining; |
| 137 | 137 | } |
| 138 | 138 | } |
@@ -148,11 +148,11 @@ discard block |
||
| 148 | 148 | */ |
| 149 | 149 | public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
| 150 | 150 | { |
| 151 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 151 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 152 | 152 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
| 153 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 153 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
| 154 | 154 | // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
| 155 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 155 | + $this->available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
| 156 | 156 | } |
| 157 | 157 | } |
| 158 | 158 | } |
@@ -22,215 +22,215 @@ |
||
| 22 | 22 | class TicketDatetimeAvailabilityTracker |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * array of datetimes and the spaces available for them |
|
| 27 | - * |
|
| 28 | - * @var array[][] |
|
| 29 | - */ |
|
| 30 | - private $available_spaces = array(); |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var EEM_Datetime $datetime_model |
|
| 34 | - */ |
|
| 35 | - private $datetime_model; |
|
| 36 | - |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * TicketDatetimeAvailabilityTracker constructor. |
|
| 40 | - * |
|
| 41 | - * @param EEM_Datetime $datetime_model |
|
| 42 | - */ |
|
| 43 | - public function __construct(EEM_Datetime $datetime_model) |
|
| 44 | - { |
|
| 45 | - $this->datetime_model = $datetime_model; |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * ticketDatetimeAvailability |
|
| 51 | - * creates an array of tickets plus all of the datetimes available to each ticket |
|
| 52 | - * and tracks the spaces remaining for each of those datetimes |
|
| 53 | - * |
|
| 54 | - * @param EE_Ticket $ticket - selected ticket |
|
| 55 | - * @param bool $get_original_ticket_spaces |
|
| 56 | - * @return int |
|
| 57 | - * @throws EE_Error |
|
| 58 | - * @throws InvalidArgumentException |
|
| 59 | - * @throws InvalidDataTypeException |
|
| 60 | - * @throws InvalidInterfaceException |
|
| 61 | - */ |
|
| 62 | - public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
| 63 | - { |
|
| 64 | - // if the $_available_spaces array has not been set up yet... |
|
| 65 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 66 | - $this->setInitialTicketDatetimeAvailability($ticket); |
|
| 67 | - } |
|
| 68 | - $available_spaces = $ticket->qty() - $ticket->sold(); |
|
| 69 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 70 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 71 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 72 | - // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
| 73 | - if ($get_original_ticket_spaces) { |
|
| 74 | - // then grab the available spaces from the "tickets" array |
|
| 75 | - // and compare with the above to get the lowest number |
|
| 76 | - $available_spaces = min( |
|
| 77 | - $available_spaces, |
|
| 78 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 79 | - ); |
|
| 80 | - } else { |
|
| 81 | - // we want the updated ticket availability as stored in the "datetimes" array |
|
| 82 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 83 | - } |
|
| 84 | - } |
|
| 85 | - } |
|
| 86 | - return $available_spaces; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @param EE_Ticket $ticket |
|
| 92 | - * @return void |
|
| 93 | - * @throws InvalidArgumentException |
|
| 94 | - * @throws InvalidInterfaceException |
|
| 95 | - * @throws InvalidDataTypeException |
|
| 96 | - * @throws EE_Error |
|
| 97 | - */ |
|
| 98 | - private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
| 99 | - { |
|
| 100 | - // first, get all of the datetimes that are available to this ticket |
|
| 101 | - $datetimes = $ticket->get_many_related( |
|
| 102 | - 'Datetime', |
|
| 103 | - array( |
|
| 104 | - array( |
|
| 105 | - 'DTT_EVT_end' => array( |
|
| 106 | - '>=', |
|
| 107 | - $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
| 108 | - ), |
|
| 109 | - ), |
|
| 110 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 111 | - ) |
|
| 112 | - ); |
|
| 113 | - if (! empty($datetimes)) { |
|
| 114 | - // now loop thru all of the datetimes |
|
| 115 | - foreach ($datetimes as $datetime) { |
|
| 116 | - if ($datetime instanceof EE_Datetime) { |
|
| 117 | - // the number of spaces available for the datetime without considering individual ticket quantities |
|
| 118 | - $spaces_remaining = $datetime->spaces_remaining(); |
|
| 119 | - // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
| 120 | - // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
| 121 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 122 | - $ticket->qty() - $ticket->sold(), |
|
| 123 | - $spaces_remaining |
|
| 124 | - ); |
|
| 125 | - // if the remaining spaces for this datetime is already set, |
|
| 126 | - // then compare that against the datetime spaces remaining, and take the lowest number, |
|
| 127 | - // else just take the datetime spaces remaining, and assign to the datetimes array |
|
| 128 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 129 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 130 | - ) |
|
| 131 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 132 | - : $spaces_remaining; |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - } |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @param EE_Ticket $ticket |
|
| 141 | - * @param int $qty |
|
| 142 | - * @return void |
|
| 143 | - * @throws EE_Error |
|
| 144 | - */ |
|
| 145 | - public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
| 146 | - { |
|
| 147 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 148 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 149 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 150 | - // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
| 151 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 152 | - } |
|
| 153 | - } |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @param EE_Ticket $ticket |
|
| 159 | - * @param $qty |
|
| 160 | - * @param int $total_ticket_count |
|
| 161 | - * @throws EE_Error |
|
| 162 | - * @throws InvalidArgumentException |
|
| 163 | - * @throws InvalidDataTypeException |
|
| 164 | - * @throws InvalidInterfaceException |
|
| 165 | - */ |
|
| 166 | - public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
| 167 | - { |
|
| 168 | - // tickets can not be purchased but let's find the exact number left |
|
| 169 | - // for the last ticket selected PRIOR to subtracting tickets |
|
| 170 | - $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
| 171 | - // greedy greedy greedy eh? |
|
| 172 | - if ($available_spaces > 0) { |
|
| 173 | - if (apply_filters( |
|
| 174 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
| 175 | - true, |
|
| 176 | - $ticket, |
|
| 177 | - $qty, |
|
| 178 | - $available_spaces |
|
| 179 | - )) { |
|
| 180 | - $this->availabilityError( |
|
| 181 | - $available_spaces, |
|
| 182 | - $total_ticket_count |
|
| 183 | - ); |
|
| 184 | - } |
|
| 185 | - } else { |
|
| 186 | - EE_Error::add_error( |
|
| 187 | - esc_html__( |
|
| 188 | - 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
| 189 | - 'event_espresso' |
|
| 190 | - ), |
|
| 191 | - __FILE__, |
|
| 192 | - __FUNCTION__, |
|
| 193 | - __LINE__ |
|
| 194 | - ); |
|
| 195 | - } |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * @param int $available_spaces |
|
| 201 | - * @param int $total_ticket_count |
|
| 202 | - */ |
|
| 203 | - private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
| 204 | - { |
|
| 205 | - // add error messaging - we're using the _n function that will generate |
|
| 206 | - // the appropriate singular or plural message based on the number of $available_spaces |
|
| 207 | - if ($total_ticket_count) { |
|
| 208 | - $msg = sprintf( |
|
| 209 | - esc_html( |
|
| 210 | - _n( |
|
| 211 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 212 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 213 | - $available_spaces, |
|
| 214 | - 'event_espresso' |
|
| 215 | - ) |
|
| 216 | - ), |
|
| 217 | - $available_spaces, |
|
| 218 | - '<br />' |
|
| 219 | - ); |
|
| 220 | - } else { |
|
| 221 | - $msg = sprintf( |
|
| 222 | - esc_html( |
|
| 223 | - _n( |
|
| 224 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 225 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 226 | - $available_spaces, |
|
| 227 | - 'event_espresso' |
|
| 228 | - ) |
|
| 229 | - ), |
|
| 230 | - $available_spaces, |
|
| 231 | - '<br />' |
|
| 232 | - ); |
|
| 233 | - } |
|
| 234 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 235 | - } |
|
| 25 | + /** |
|
| 26 | + * array of datetimes and the spaces available for them |
|
| 27 | + * |
|
| 28 | + * @var array[][] |
|
| 29 | + */ |
|
| 30 | + private $available_spaces = array(); |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var EEM_Datetime $datetime_model |
|
| 34 | + */ |
|
| 35 | + private $datetime_model; |
|
| 36 | + |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * TicketDatetimeAvailabilityTracker constructor. |
|
| 40 | + * |
|
| 41 | + * @param EEM_Datetime $datetime_model |
|
| 42 | + */ |
|
| 43 | + public function __construct(EEM_Datetime $datetime_model) |
|
| 44 | + { |
|
| 45 | + $this->datetime_model = $datetime_model; |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * ticketDatetimeAvailability |
|
| 51 | + * creates an array of tickets plus all of the datetimes available to each ticket |
|
| 52 | + * and tracks the spaces remaining for each of those datetimes |
|
| 53 | + * |
|
| 54 | + * @param EE_Ticket $ticket - selected ticket |
|
| 55 | + * @param bool $get_original_ticket_spaces |
|
| 56 | + * @return int |
|
| 57 | + * @throws EE_Error |
|
| 58 | + * @throws InvalidArgumentException |
|
| 59 | + * @throws InvalidDataTypeException |
|
| 60 | + * @throws InvalidInterfaceException |
|
| 61 | + */ |
|
| 62 | + public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
| 63 | + { |
|
| 64 | + // if the $_available_spaces array has not been set up yet... |
|
| 65 | + if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 66 | + $this->setInitialTicketDatetimeAvailability($ticket); |
|
| 67 | + } |
|
| 68 | + $available_spaces = $ticket->qty() - $ticket->sold(); |
|
| 69 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 70 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 71 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 72 | + // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
| 73 | + if ($get_original_ticket_spaces) { |
|
| 74 | + // then grab the available spaces from the "tickets" array |
|
| 75 | + // and compare with the above to get the lowest number |
|
| 76 | + $available_spaces = min( |
|
| 77 | + $available_spaces, |
|
| 78 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 79 | + ); |
|
| 80 | + } else { |
|
| 81 | + // we want the updated ticket availability as stored in the "datetimes" array |
|
| 82 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 83 | + } |
|
| 84 | + } |
|
| 85 | + } |
|
| 86 | + return $available_spaces; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @param EE_Ticket $ticket |
|
| 92 | + * @return void |
|
| 93 | + * @throws InvalidArgumentException |
|
| 94 | + * @throws InvalidInterfaceException |
|
| 95 | + * @throws InvalidDataTypeException |
|
| 96 | + * @throws EE_Error |
|
| 97 | + */ |
|
| 98 | + private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
| 99 | + { |
|
| 100 | + // first, get all of the datetimes that are available to this ticket |
|
| 101 | + $datetimes = $ticket->get_many_related( |
|
| 102 | + 'Datetime', |
|
| 103 | + array( |
|
| 104 | + array( |
|
| 105 | + 'DTT_EVT_end' => array( |
|
| 106 | + '>=', |
|
| 107 | + $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
| 108 | + ), |
|
| 109 | + ), |
|
| 110 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 111 | + ) |
|
| 112 | + ); |
|
| 113 | + if (! empty($datetimes)) { |
|
| 114 | + // now loop thru all of the datetimes |
|
| 115 | + foreach ($datetimes as $datetime) { |
|
| 116 | + if ($datetime instanceof EE_Datetime) { |
|
| 117 | + // the number of spaces available for the datetime without considering individual ticket quantities |
|
| 118 | + $spaces_remaining = $datetime->spaces_remaining(); |
|
| 119 | + // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
| 120 | + // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
| 121 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 122 | + $ticket->qty() - $ticket->sold(), |
|
| 123 | + $spaces_remaining |
|
| 124 | + ); |
|
| 125 | + // if the remaining spaces for this datetime is already set, |
|
| 126 | + // then compare that against the datetime spaces remaining, and take the lowest number, |
|
| 127 | + // else just take the datetime spaces remaining, and assign to the datetimes array |
|
| 128 | + $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 129 | + $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 130 | + ) |
|
| 131 | + ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 132 | + : $spaces_remaining; |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @param EE_Ticket $ticket |
|
| 141 | + * @param int $qty |
|
| 142 | + * @return void |
|
| 143 | + * @throws EE_Error |
|
| 144 | + */ |
|
| 145 | + public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
| 146 | + { |
|
| 147 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 148 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 149 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 150 | + // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
| 151 | + $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @param EE_Ticket $ticket |
|
| 159 | + * @param $qty |
|
| 160 | + * @param int $total_ticket_count |
|
| 161 | + * @throws EE_Error |
|
| 162 | + * @throws InvalidArgumentException |
|
| 163 | + * @throws InvalidDataTypeException |
|
| 164 | + * @throws InvalidInterfaceException |
|
| 165 | + */ |
|
| 166 | + public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
| 167 | + { |
|
| 168 | + // tickets can not be purchased but let's find the exact number left |
|
| 169 | + // for the last ticket selected PRIOR to subtracting tickets |
|
| 170 | + $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
| 171 | + // greedy greedy greedy eh? |
|
| 172 | + if ($available_spaces > 0) { |
|
| 173 | + if (apply_filters( |
|
| 174 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
| 175 | + true, |
|
| 176 | + $ticket, |
|
| 177 | + $qty, |
|
| 178 | + $available_spaces |
|
| 179 | + )) { |
|
| 180 | + $this->availabilityError( |
|
| 181 | + $available_spaces, |
|
| 182 | + $total_ticket_count |
|
| 183 | + ); |
|
| 184 | + } |
|
| 185 | + } else { |
|
| 186 | + EE_Error::add_error( |
|
| 187 | + esc_html__( |
|
| 188 | + 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
| 189 | + 'event_espresso' |
|
| 190 | + ), |
|
| 191 | + __FILE__, |
|
| 192 | + __FUNCTION__, |
|
| 193 | + __LINE__ |
|
| 194 | + ); |
|
| 195 | + } |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * @param int $available_spaces |
|
| 201 | + * @param int $total_ticket_count |
|
| 202 | + */ |
|
| 203 | + private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
| 204 | + { |
|
| 205 | + // add error messaging - we're using the _n function that will generate |
|
| 206 | + // the appropriate singular or plural message based on the number of $available_spaces |
|
| 207 | + if ($total_ticket_count) { |
|
| 208 | + $msg = sprintf( |
|
| 209 | + esc_html( |
|
| 210 | + _n( |
|
| 211 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 212 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 213 | + $available_spaces, |
|
| 214 | + 'event_espresso' |
|
| 215 | + ) |
|
| 216 | + ), |
|
| 217 | + $available_spaces, |
|
| 218 | + '<br />' |
|
| 219 | + ); |
|
| 220 | + } else { |
|
| 221 | + $msg = sprintf( |
|
| 222 | + esc_html( |
|
| 223 | + _n( |
|
| 224 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 225 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 226 | + $available_spaces, |
|
| 227 | + 'event_espresso' |
|
| 228 | + ) |
|
| 229 | + ), |
|
| 230 | + $available_spaces, |
|
| 231 | + '<br />' |
|
| 232 | + ); |
|
| 233 | + } |
|
| 234 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 235 | + } |
|
| 236 | 236 | } |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | */ |
| 131 | 131 | private function setName($name) |
| 132 | 132 | { |
| 133 | - if (! is_string($name)) { |
|
| 133 | + if ( ! is_string($name)) { |
|
| 134 | 134 | throw new InvalidDataTypeException('$name', $name, 'string'); |
| 135 | 135 | } |
| 136 | 136 | $this->name = sanitize_key($name); |
@@ -154,7 +154,7 @@ discard block |
||
| 154 | 154 | */ |
| 155 | 155 | private function setMessage($message) |
| 156 | 156 | { |
| 157 | - if (! is_string($message)) { |
|
| 157 | + if ( ! is_string($message)) { |
|
| 158 | 158 | throw new InvalidDataTypeException('$message', $message, 'string'); |
| 159 | 159 | } |
| 160 | 160 | global $allowedtags; |
@@ -200,7 +200,7 @@ discard block |
||
| 200 | 200 | */ |
| 201 | 201 | private function setCapability($capability) |
| 202 | 202 | { |
| 203 | - if (! is_string($capability)) { |
|
| 203 | + if ( ! is_string($capability)) { |
|
| 204 | 204 | throw new InvalidDataTypeException('$capability', $capability, 'string'); |
| 205 | 205 | } |
| 206 | 206 | $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | */ |
| 225 | 225 | private function setCapContext($cap_context) |
| 226 | 226 | { |
| 227 | - if (! is_string($cap_context)) { |
|
| 227 | + if ( ! is_string($cap_context)) { |
|
| 228 | 228 | throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
| 229 | 229 | } |
| 230 | 230 | $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | */ |
| 259 | 259 | public function getCapCheck() |
| 260 | 260 | { |
| 261 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 261 | + if ( ! $this->cap_check instanceof CapCheckInterface) { |
|
| 262 | 262 | $this->setCapCheck( |
| 263 | 263 | new CapCheck( |
| 264 | 264 | $this->capability, |
@@ -343,10 +343,10 @@ discard block |
||
| 343 | 343 | */ |
| 344 | 344 | public function confirmRegistered() |
| 345 | 345 | { |
| 346 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 346 | + if ( ! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 347 | 347 | PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
| 348 | 348 | } |
| 349 | - if (! $this->registered && WP_DEBUG) { |
|
| 349 | + if ( ! $this->registered && WP_DEBUG) { |
|
| 350 | 350 | throw new DomainException( |
| 351 | 351 | sprintf( |
| 352 | 352 | esc_html__( |
@@ -25,316 +25,316 @@ |
||
| 25 | 25 | class PersistentAdminNotice implements RequiresCapCheckInterface |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string $name |
|
| 30 | - */ |
|
| 31 | - protected $name = ''; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var string $message |
|
| 35 | - */ |
|
| 36 | - protected $message = ''; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var boolean $force_update |
|
| 40 | - */ |
|
| 41 | - protected $force_update = false; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @var string $capability |
|
| 45 | - */ |
|
| 46 | - protected $capability = 'manage_options'; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @var string $cap_context |
|
| 50 | - */ |
|
| 51 | - protected $cap_context = 'view persistent admin notice'; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @var boolean $dismissed |
|
| 55 | - */ |
|
| 56 | - protected $dismissed = false; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @var CapCheckInterface $cap_check |
|
| 60 | - */ |
|
| 61 | - protected $cap_check; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * if true, then this notice will be deleted from the database |
|
| 65 | - * |
|
| 66 | - * @var boolean $purge |
|
| 67 | - */ |
|
| 68 | - protected $purge = false; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
| 72 | - * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
| 73 | - * |
|
| 74 | - * @var boolean $registered |
|
| 75 | - */ |
|
| 76 | - private $registered = false; |
|
| 77 | - |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * PersistentAdminNotice constructor |
|
| 81 | - * |
|
| 82 | - * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
| 83 | - * @param string $message [required] the message to be stored persistently until dismissed |
|
| 84 | - * @param bool $force_update enforce the reappearance of a persistent message |
|
| 85 | - * @param string $capability user capability required to view this notice |
|
| 86 | - * @param string $cap_context description for why the cap check is being performed |
|
| 87 | - * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
| 88 | - * @throws InvalidDataTypeException |
|
| 89 | - */ |
|
| 90 | - public function __construct( |
|
| 91 | - $name, |
|
| 92 | - $message, |
|
| 93 | - $force_update = false, |
|
| 94 | - $capability = 'manage_options', |
|
| 95 | - $cap_context = 'view persistent admin notice', |
|
| 96 | - $dismissed = false |
|
| 97 | - ) { |
|
| 98 | - $this->setName($name); |
|
| 99 | - $this->setMessage($message); |
|
| 100 | - $this->setForceUpdate($force_update); |
|
| 101 | - $this->setCapability($capability); |
|
| 102 | - $this->setCapContext($cap_context); |
|
| 103 | - $this->setDismissed($dismissed); |
|
| 104 | - add_action( |
|
| 105 | - 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
| 106 | - array($this, 'registerPersistentAdminNotice') |
|
| 107 | - ); |
|
| 108 | - add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * @return string |
|
| 114 | - */ |
|
| 115 | - public function getName() |
|
| 116 | - { |
|
| 117 | - return $this->name; |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * @param string $name |
|
| 123 | - * @throws InvalidDataTypeException |
|
| 124 | - */ |
|
| 125 | - private function setName($name) |
|
| 126 | - { |
|
| 127 | - if (! is_string($name)) { |
|
| 128 | - throw new InvalidDataTypeException('$name', $name, 'string'); |
|
| 129 | - } |
|
| 130 | - $this->name = sanitize_key($name); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * @return string |
|
| 136 | - */ |
|
| 137 | - public function getMessage() |
|
| 138 | - { |
|
| 139 | - return $this->message; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @param string $message |
|
| 145 | - * @throws InvalidDataTypeException |
|
| 146 | - */ |
|
| 147 | - private function setMessage($message) |
|
| 148 | - { |
|
| 149 | - if (! is_string($message)) { |
|
| 150 | - throw new InvalidDataTypeException('$message', $message, 'string'); |
|
| 151 | - } |
|
| 152 | - global $allowedtags; |
|
| 153 | - $allowedtags['br'] = array(); |
|
| 154 | - $this->message = wp_kses($message, $allowedtags); |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * @return bool |
|
| 160 | - */ |
|
| 161 | - public function getForceUpdate() |
|
| 162 | - { |
|
| 163 | - return $this->force_update; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * @param bool $force_update |
|
| 169 | - */ |
|
| 170 | - private function setForceUpdate($force_update) |
|
| 171 | - { |
|
| 172 | - $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * @return string |
|
| 178 | - */ |
|
| 179 | - public function getCapability() |
|
| 180 | - { |
|
| 181 | - return $this->capability; |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * @param string $capability |
|
| 187 | - * @throws InvalidDataTypeException |
|
| 188 | - */ |
|
| 189 | - private function setCapability($capability) |
|
| 190 | - { |
|
| 191 | - if (! is_string($capability)) { |
|
| 192 | - throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
| 193 | - } |
|
| 194 | - $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * @return string |
|
| 200 | - */ |
|
| 201 | - public function getCapContext() |
|
| 202 | - { |
|
| 203 | - return $this->cap_context; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @param string $cap_context |
|
| 209 | - * @throws InvalidDataTypeException |
|
| 210 | - */ |
|
| 211 | - private function setCapContext($cap_context) |
|
| 212 | - { |
|
| 213 | - if (! is_string($cap_context)) { |
|
| 214 | - throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
| 215 | - } |
|
| 216 | - $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * @return bool |
|
| 222 | - */ |
|
| 223 | - public function getDismissed() |
|
| 224 | - { |
|
| 225 | - return $this->dismissed; |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * @param bool $dismissed |
|
| 231 | - */ |
|
| 232 | - public function setDismissed($dismissed) |
|
| 233 | - { |
|
| 234 | - $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * @return CapCheckInterface |
|
| 240 | - * @throws InvalidDataTypeException |
|
| 241 | - */ |
|
| 242 | - public function getCapCheck() |
|
| 243 | - { |
|
| 244 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 245 | - $this->setCapCheck( |
|
| 246 | - new CapCheck( |
|
| 247 | - $this->capability, |
|
| 248 | - $this->cap_context |
|
| 249 | - ) |
|
| 250 | - ); |
|
| 251 | - } |
|
| 252 | - return $this->cap_check; |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * @param CapCheckInterface $cap_check |
|
| 258 | - */ |
|
| 259 | - private function setCapCheck(CapCheckInterface $cap_check) |
|
| 260 | - { |
|
| 261 | - $this->cap_check = $cap_check; |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - |
|
| 265 | - /** |
|
| 266 | - * @return bool |
|
| 267 | - */ |
|
| 268 | - public function getPurge() |
|
| 269 | - { |
|
| 270 | - return $this->purge; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * @param bool $purge |
|
| 276 | - */ |
|
| 277 | - public function setPurge($purge) |
|
| 278 | - { |
|
| 279 | - $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - /** |
|
| 284 | - * given a valid PersistentAdminNotice Collection, |
|
| 285 | - * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
| 286 | - * if an existing notice is found that has already been dismissed, |
|
| 287 | - * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
| 288 | - * so that the notice is displayed again |
|
| 289 | - * |
|
| 290 | - * @param Collection $persistent_admin_notice_collection |
|
| 291 | - * @throws InvalidEntityException |
|
| 292 | - * @throws InvalidDataTypeException |
|
| 293 | - * @throws DuplicateCollectionIdentifierException |
|
| 294 | - */ |
|
| 295 | - public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
| 296 | - { |
|
| 297 | - if ($this->registered) { |
|
| 298 | - return; |
|
| 299 | - } |
|
| 300 | - // first check if this notice has already been added to the collection |
|
| 301 | - if ($persistent_admin_notice_collection->has($this->name)) { |
|
| 302 | - /** @var PersistentAdminNotice $existing */ |
|
| 303 | - $existing = $persistent_admin_notice_collection->get($this->name); |
|
| 304 | - // we don't need to add it again (we can't actually) |
|
| 305 | - // but if it has already been dismissed, and we are overriding with a forced update |
|
| 306 | - if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
| 307 | - // then toggle the notice's dismissed state to true |
|
| 308 | - // so that it gets displayed again |
|
| 309 | - $existing->setDismissed(false); |
|
| 310 | - // and make sure the message is set |
|
| 311 | - $existing->setMessage($this->message); |
|
| 312 | - } |
|
| 313 | - } else { |
|
| 314 | - $persistent_admin_notice_collection->add($this, $this->name); |
|
| 315 | - } |
|
| 316 | - $this->registered = true; |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * @throws Exception |
|
| 322 | - */ |
|
| 323 | - public function confirmRegistered() |
|
| 324 | - { |
|
| 325 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 326 | - PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
| 327 | - } |
|
| 328 | - if (! $this->registered && WP_DEBUG) { |
|
| 329 | - throw new DomainException( |
|
| 330 | - sprintf( |
|
| 331 | - esc_html__( |
|
| 332 | - 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
| 333 | - 'event_espresso' |
|
| 334 | - ), |
|
| 335 | - $this->name |
|
| 336 | - ) |
|
| 337 | - ); |
|
| 338 | - } |
|
| 339 | - } |
|
| 28 | + /** |
|
| 29 | + * @var string $name |
|
| 30 | + */ |
|
| 31 | + protected $name = ''; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var string $message |
|
| 35 | + */ |
|
| 36 | + protected $message = ''; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var boolean $force_update |
|
| 40 | + */ |
|
| 41 | + protected $force_update = false; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @var string $capability |
|
| 45 | + */ |
|
| 46 | + protected $capability = 'manage_options'; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @var string $cap_context |
|
| 50 | + */ |
|
| 51 | + protected $cap_context = 'view persistent admin notice'; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @var boolean $dismissed |
|
| 55 | + */ |
|
| 56 | + protected $dismissed = false; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @var CapCheckInterface $cap_check |
|
| 60 | + */ |
|
| 61 | + protected $cap_check; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * if true, then this notice will be deleted from the database |
|
| 65 | + * |
|
| 66 | + * @var boolean $purge |
|
| 67 | + */ |
|
| 68 | + protected $purge = false; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
| 72 | + * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
| 73 | + * |
|
| 74 | + * @var boolean $registered |
|
| 75 | + */ |
|
| 76 | + private $registered = false; |
|
| 77 | + |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * PersistentAdminNotice constructor |
|
| 81 | + * |
|
| 82 | + * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
| 83 | + * @param string $message [required] the message to be stored persistently until dismissed |
|
| 84 | + * @param bool $force_update enforce the reappearance of a persistent message |
|
| 85 | + * @param string $capability user capability required to view this notice |
|
| 86 | + * @param string $cap_context description for why the cap check is being performed |
|
| 87 | + * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
| 88 | + * @throws InvalidDataTypeException |
|
| 89 | + */ |
|
| 90 | + public function __construct( |
|
| 91 | + $name, |
|
| 92 | + $message, |
|
| 93 | + $force_update = false, |
|
| 94 | + $capability = 'manage_options', |
|
| 95 | + $cap_context = 'view persistent admin notice', |
|
| 96 | + $dismissed = false |
|
| 97 | + ) { |
|
| 98 | + $this->setName($name); |
|
| 99 | + $this->setMessage($message); |
|
| 100 | + $this->setForceUpdate($force_update); |
|
| 101 | + $this->setCapability($capability); |
|
| 102 | + $this->setCapContext($cap_context); |
|
| 103 | + $this->setDismissed($dismissed); |
|
| 104 | + add_action( |
|
| 105 | + 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
| 106 | + array($this, 'registerPersistentAdminNotice') |
|
| 107 | + ); |
|
| 108 | + add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * @return string |
|
| 114 | + */ |
|
| 115 | + public function getName() |
|
| 116 | + { |
|
| 117 | + return $this->name; |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * @param string $name |
|
| 123 | + * @throws InvalidDataTypeException |
|
| 124 | + */ |
|
| 125 | + private function setName($name) |
|
| 126 | + { |
|
| 127 | + if (! is_string($name)) { |
|
| 128 | + throw new InvalidDataTypeException('$name', $name, 'string'); |
|
| 129 | + } |
|
| 130 | + $this->name = sanitize_key($name); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * @return string |
|
| 136 | + */ |
|
| 137 | + public function getMessage() |
|
| 138 | + { |
|
| 139 | + return $this->message; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @param string $message |
|
| 145 | + * @throws InvalidDataTypeException |
|
| 146 | + */ |
|
| 147 | + private function setMessage($message) |
|
| 148 | + { |
|
| 149 | + if (! is_string($message)) { |
|
| 150 | + throw new InvalidDataTypeException('$message', $message, 'string'); |
|
| 151 | + } |
|
| 152 | + global $allowedtags; |
|
| 153 | + $allowedtags['br'] = array(); |
|
| 154 | + $this->message = wp_kses($message, $allowedtags); |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * @return bool |
|
| 160 | + */ |
|
| 161 | + public function getForceUpdate() |
|
| 162 | + { |
|
| 163 | + return $this->force_update; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * @param bool $force_update |
|
| 169 | + */ |
|
| 170 | + private function setForceUpdate($force_update) |
|
| 171 | + { |
|
| 172 | + $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * @return string |
|
| 178 | + */ |
|
| 179 | + public function getCapability() |
|
| 180 | + { |
|
| 181 | + return $this->capability; |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * @param string $capability |
|
| 187 | + * @throws InvalidDataTypeException |
|
| 188 | + */ |
|
| 189 | + private function setCapability($capability) |
|
| 190 | + { |
|
| 191 | + if (! is_string($capability)) { |
|
| 192 | + throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
| 193 | + } |
|
| 194 | + $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * @return string |
|
| 200 | + */ |
|
| 201 | + public function getCapContext() |
|
| 202 | + { |
|
| 203 | + return $this->cap_context; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @param string $cap_context |
|
| 209 | + * @throws InvalidDataTypeException |
|
| 210 | + */ |
|
| 211 | + private function setCapContext($cap_context) |
|
| 212 | + { |
|
| 213 | + if (! is_string($cap_context)) { |
|
| 214 | + throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
| 215 | + } |
|
| 216 | + $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * @return bool |
|
| 222 | + */ |
|
| 223 | + public function getDismissed() |
|
| 224 | + { |
|
| 225 | + return $this->dismissed; |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * @param bool $dismissed |
|
| 231 | + */ |
|
| 232 | + public function setDismissed($dismissed) |
|
| 233 | + { |
|
| 234 | + $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * @return CapCheckInterface |
|
| 240 | + * @throws InvalidDataTypeException |
|
| 241 | + */ |
|
| 242 | + public function getCapCheck() |
|
| 243 | + { |
|
| 244 | + if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 245 | + $this->setCapCheck( |
|
| 246 | + new CapCheck( |
|
| 247 | + $this->capability, |
|
| 248 | + $this->cap_context |
|
| 249 | + ) |
|
| 250 | + ); |
|
| 251 | + } |
|
| 252 | + return $this->cap_check; |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * @param CapCheckInterface $cap_check |
|
| 258 | + */ |
|
| 259 | + private function setCapCheck(CapCheckInterface $cap_check) |
|
| 260 | + { |
|
| 261 | + $this->cap_check = $cap_check; |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + |
|
| 265 | + /** |
|
| 266 | + * @return bool |
|
| 267 | + */ |
|
| 268 | + public function getPurge() |
|
| 269 | + { |
|
| 270 | + return $this->purge; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * @param bool $purge |
|
| 276 | + */ |
|
| 277 | + public function setPurge($purge) |
|
| 278 | + { |
|
| 279 | + $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + /** |
|
| 284 | + * given a valid PersistentAdminNotice Collection, |
|
| 285 | + * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
| 286 | + * if an existing notice is found that has already been dismissed, |
|
| 287 | + * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
| 288 | + * so that the notice is displayed again |
|
| 289 | + * |
|
| 290 | + * @param Collection $persistent_admin_notice_collection |
|
| 291 | + * @throws InvalidEntityException |
|
| 292 | + * @throws InvalidDataTypeException |
|
| 293 | + * @throws DuplicateCollectionIdentifierException |
|
| 294 | + */ |
|
| 295 | + public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
| 296 | + { |
|
| 297 | + if ($this->registered) { |
|
| 298 | + return; |
|
| 299 | + } |
|
| 300 | + // first check if this notice has already been added to the collection |
|
| 301 | + if ($persistent_admin_notice_collection->has($this->name)) { |
|
| 302 | + /** @var PersistentAdminNotice $existing */ |
|
| 303 | + $existing = $persistent_admin_notice_collection->get($this->name); |
|
| 304 | + // we don't need to add it again (we can't actually) |
|
| 305 | + // but if it has already been dismissed, and we are overriding with a forced update |
|
| 306 | + if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
| 307 | + // then toggle the notice's dismissed state to true |
|
| 308 | + // so that it gets displayed again |
|
| 309 | + $existing->setDismissed(false); |
|
| 310 | + // and make sure the message is set |
|
| 311 | + $existing->setMessage($this->message); |
|
| 312 | + } |
|
| 313 | + } else { |
|
| 314 | + $persistent_admin_notice_collection->add($this, $this->name); |
|
| 315 | + } |
|
| 316 | + $this->registered = true; |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * @throws Exception |
|
| 322 | + */ |
|
| 323 | + public function confirmRegistered() |
|
| 324 | + { |
|
| 325 | + if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 326 | + PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
| 327 | + } |
|
| 328 | + if (! $this->registered && WP_DEBUG) { |
|
| 329 | + throw new DomainException( |
|
| 330 | + sprintf( |
|
| 331 | + esc_html__( |
|
| 332 | + 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
| 333 | + 'event_espresso' |
|
| 334 | + ), |
|
| 335 | + $this->name |
|
| 336 | + ) |
|
| 337 | + ); |
|
| 338 | + } |
|
| 339 | + } |
|
| 340 | 340 | } |
@@ -14,133 +14,133 @@ |
||
| 14 | 14 | trait EventsAdmin |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @param string $additional_params |
|
| 19 | - */ |
|
| 20 | - public function amOnDefaultEventsListTablePage($additional_params = '') |
|
| 21 | - { |
|
| 22 | - $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
| 23 | - } |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Triggers the publishing of the Event. |
|
| 28 | - */ |
|
| 29 | - public function publishEvent() |
|
| 30 | - { |
|
| 31 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 32 | - $this->actor()->wait(3); |
|
| 33 | - $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
| 34 | - $this->actor()->waitForText('Event published.', 30); |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Triggers saving the Event. |
|
| 40 | - */ |
|
| 41 | - public function saveEvent() |
|
| 42 | - { |
|
| 43 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 44 | - $this->actor()->wait(2); |
|
| 45 | - $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
| 51 | - * First this will search using the given title and then attempt to edit from the results of the search. |
|
| 52 | - * |
|
| 53 | - * Assumes actor is already logged in. |
|
| 54 | - * @param $event_title |
|
| 55 | - */ |
|
| 56 | - public function amEditingTheEventWithTitle($event_title) |
|
| 57 | - { |
|
| 58 | - $this->amOnDefaultEventsListTablePage(); |
|
| 59 | - $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
| 60 | - $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
| 61 | - $this->actor()->waitForText($event_title, 15); |
|
| 62 | - $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
| 68 | - * link for the event in the event list table. |
|
| 69 | - * Assumes the actor is already logged in and on the Event list table page. |
|
| 70 | - * |
|
| 71 | - * @param string $event_title |
|
| 72 | - */ |
|
| 73 | - public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
| 74 | - { |
|
| 75 | - $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 76 | - $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * Used to retrieve the event id for the event via the list table and for the given event. |
|
| 82 | - * @param string $event_title |
|
| 83 | - */ |
|
| 84 | - public function observeEventIdInListTableForEvent($event_title) |
|
| 85 | - { |
|
| 86 | - return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
| 92 | - * Assumes the actor is already logged in and editing an event. |
|
| 93 | - * |
|
| 94 | - * @param int $row_number What ticket row to toggle open/close. |
|
| 95 | - */ |
|
| 96 | - public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
| 97 | - { |
|
| 98 | - $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
| 104 | - * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
| 105 | - * ticket is "open". |
|
| 106 | - * |
|
| 107 | - * @param int $row_number What ticket row to toggle the checkbox for. |
|
| 108 | - */ |
|
| 109 | - public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
| 110 | - { |
|
| 111 | - $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Use to change the default registration status for the event. |
|
| 117 | - * Assumes the view is already on the event editor. |
|
| 118 | - * @param $registration_status |
|
| 119 | - */ |
|
| 120 | - public function changeDefaultRegistrationStatusTo($registration_status) |
|
| 121 | - { |
|
| 122 | - $this->actor()->selectOption( |
|
| 123 | - EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
| 124 | - $registration_status |
|
| 125 | - ); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Use this from the context of the event editor to select the given custom template for a given message type and |
|
| 131 | - * messenger. |
|
| 132 | - * |
|
| 133 | - * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
| 134 | - * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
| 135 | - * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
| 136 | - * selected. |
|
| 137 | - */ |
|
| 138 | - public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
| 139 | - { |
|
| 140 | - $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
| 141 | - $this->actor()->selectOption( |
|
| 142 | - EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
| 143 | - $custom_template_label |
|
| 144 | - ); |
|
| 145 | - } |
|
| 17 | + /** |
|
| 18 | + * @param string $additional_params |
|
| 19 | + */ |
|
| 20 | + public function amOnDefaultEventsListTablePage($additional_params = '') |
|
| 21 | + { |
|
| 22 | + $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
| 23 | + } |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Triggers the publishing of the Event. |
|
| 28 | + */ |
|
| 29 | + public function publishEvent() |
|
| 30 | + { |
|
| 31 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 32 | + $this->actor()->wait(3); |
|
| 33 | + $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
| 34 | + $this->actor()->waitForText('Event published.', 30); |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Triggers saving the Event. |
|
| 40 | + */ |
|
| 41 | + public function saveEvent() |
|
| 42 | + { |
|
| 43 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 44 | + $this->actor()->wait(2); |
|
| 45 | + $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
| 51 | + * First this will search using the given title and then attempt to edit from the results of the search. |
|
| 52 | + * |
|
| 53 | + * Assumes actor is already logged in. |
|
| 54 | + * @param $event_title |
|
| 55 | + */ |
|
| 56 | + public function amEditingTheEventWithTitle($event_title) |
|
| 57 | + { |
|
| 58 | + $this->amOnDefaultEventsListTablePage(); |
|
| 59 | + $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
| 60 | + $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
| 61 | + $this->actor()->waitForText($event_title, 15); |
|
| 62 | + $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
| 68 | + * link for the event in the event list table. |
|
| 69 | + * Assumes the actor is already logged in and on the Event list table page. |
|
| 70 | + * |
|
| 71 | + * @param string $event_title |
|
| 72 | + */ |
|
| 73 | + public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
| 74 | + { |
|
| 75 | + $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 76 | + $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * Used to retrieve the event id for the event via the list table and for the given event. |
|
| 82 | + * @param string $event_title |
|
| 83 | + */ |
|
| 84 | + public function observeEventIdInListTableForEvent($event_title) |
|
| 85 | + { |
|
| 86 | + return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
| 92 | + * Assumes the actor is already logged in and editing an event. |
|
| 93 | + * |
|
| 94 | + * @param int $row_number What ticket row to toggle open/close. |
|
| 95 | + */ |
|
| 96 | + public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
| 97 | + { |
|
| 98 | + $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
| 104 | + * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
| 105 | + * ticket is "open". |
|
| 106 | + * |
|
| 107 | + * @param int $row_number What ticket row to toggle the checkbox for. |
|
| 108 | + */ |
|
| 109 | + public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
| 110 | + { |
|
| 111 | + $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Use to change the default registration status for the event. |
|
| 117 | + * Assumes the view is already on the event editor. |
|
| 118 | + * @param $registration_status |
|
| 119 | + */ |
|
| 120 | + public function changeDefaultRegistrationStatusTo($registration_status) |
|
| 121 | + { |
|
| 122 | + $this->actor()->selectOption( |
|
| 123 | + EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
| 124 | + $registration_status |
|
| 125 | + ); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Use this from the context of the event editor to select the given custom template for a given message type and |
|
| 131 | + * messenger. |
|
| 132 | + * |
|
| 133 | + * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
| 134 | + * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
| 135 | + * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
| 136 | + * selected. |
|
| 137 | + */ |
|
| 138 | + public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
| 139 | + { |
|
| 140 | + $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
| 141 | + $this->actor()->selectOption( |
|
| 142 | + EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
| 143 | + $custom_template_label |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | 146 | } |
| 147 | 147 | \ No newline at end of file |
@@ -101,7 +101,7 @@ |
||
| 101 | 101 | /** |
| 102 | 102 | * _get_table_filters |
| 103 | 103 | * |
| 104 | - * @return array |
|
| 104 | + * @return string[] |
|
| 105 | 105 | */ |
| 106 | 106 | protected function _get_table_filters() |
| 107 | 107 | { |
@@ -56,7 +56,7 @@ |
||
| 56 | 56 | . __( |
| 57 | 57 | 'Download Results', |
| 58 | 58 | 'event_espresso' |
| 59 | - ) . "'>"; |
|
| 59 | + )."'>"; |
|
| 60 | 60 | } |
| 61 | 61 | |
| 62 | 62 | |
@@ -13,111 +13,111 @@ discard block |
||
| 13 | 13 | class Payment_Log_Admin_List_Table extends EE_Admin_List_Table |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @param \EE_Admin_Page $admin_page |
|
| 18 | - * @return Payment_Log_Admin_List_Table |
|
| 19 | - */ |
|
| 20 | - public function __construct($admin_page) |
|
| 21 | - { |
|
| 22 | - parent::__construct($admin_page); |
|
| 23 | - } |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * _setup_data |
|
| 28 | - * |
|
| 29 | - * @return void |
|
| 30 | - */ |
|
| 31 | - protected function _setup_data() |
|
| 32 | - { |
|
| 33 | - $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
| 34 | - // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
| 35 | - // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
| 36 | - // } else { |
|
| 37 | - // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
| 38 | - // } |
|
| 39 | - $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
| 40 | - add_action( |
|
| 41 | - 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 42 | - array($this, 'add_download_logs_checkbox') |
|
| 43 | - ); |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * add_download_logs_checkbox |
|
| 49 | - * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
| 50 | - * |
|
| 51 | - * @return void |
|
| 52 | - */ |
|
| 53 | - public function add_download_logs_checkbox() |
|
| 54 | - { |
|
| 55 | - echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
| 56 | - . __( |
|
| 57 | - 'Download Results', |
|
| 58 | - 'event_espresso' |
|
| 59 | - ) . "'>"; |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * _set_properties |
|
| 65 | - * |
|
| 66 | - * @return void |
|
| 67 | - */ |
|
| 68 | - protected function _set_properties() |
|
| 69 | - { |
|
| 70 | - $this->_wp_list_args = array( |
|
| 71 | - 'singular' => __('payment log', 'event_espresso'), |
|
| 72 | - 'plural' => __('payment logs', 'event_espresso'), |
|
| 73 | - 'ajax' => true, // for now, |
|
| 74 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 75 | - ); |
|
| 76 | - $this->_columns = array( |
|
| 77 | - 'cb' => '<input type="checkbox" />', |
|
| 78 | - 'id' => __('ID', 'event_espresso'), |
|
| 79 | - 'LOG_time' => __('Time', 'event_espresso'), |
|
| 80 | - 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
| 81 | - 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
| 82 | - ); |
|
| 83 | - $this->_sortable_columns = array( |
|
| 84 | - 'LOG_time' => array('LOG_time' => true), |
|
| 85 | - ); |
|
| 86 | - $this->_hidden_columns = array(); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * _get_table_filters |
|
| 92 | - * |
|
| 93 | - * @return array |
|
| 94 | - */ |
|
| 95 | - protected function _get_table_filters() |
|
| 96 | - { |
|
| 97 | - $filters = array(); |
|
| 98 | - // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
| 99 | - $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
| 100 | - $payment_method_names = array( |
|
| 101 | - array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
| 102 | - array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
| 103 | - ); |
|
| 104 | - foreach ($payment_methods as $payment_method) { |
|
| 105 | - $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
| 106 | - } |
|
| 107 | - $filters[] = EEH_Form_Fields::select_input( |
|
| 108 | - '_payment_method', |
|
| 109 | - $payment_method_names, |
|
| 110 | - isset($this->_req_data['_payment_method']) |
|
| 111 | - ? $this->_req_data['_payment_method'] : 'all' |
|
| 112 | - ); |
|
| 113 | - $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
| 114 | - $this->_req_data['payment-filter-start-date'] |
|
| 115 | - ) : date('m/d/Y', strtotime('-6 months')); |
|
| 116 | - $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
| 117 | - $this->_req_data['payment-filter-end-date'] |
|
| 118 | - ) : date('m/d/Y'); |
|
| 119 | - ob_start(); |
|
| 120 | - ?> |
|
| 16 | + /** |
|
| 17 | + * @param \EE_Admin_Page $admin_page |
|
| 18 | + * @return Payment_Log_Admin_List_Table |
|
| 19 | + */ |
|
| 20 | + public function __construct($admin_page) |
|
| 21 | + { |
|
| 22 | + parent::__construct($admin_page); |
|
| 23 | + } |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * _setup_data |
|
| 28 | + * |
|
| 29 | + * @return void |
|
| 30 | + */ |
|
| 31 | + protected function _setup_data() |
|
| 32 | + { |
|
| 33 | + $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
| 34 | + // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
| 35 | + // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
| 36 | + // } else { |
|
| 37 | + // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
| 38 | + // } |
|
| 39 | + $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
| 40 | + add_action( |
|
| 41 | + 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 42 | + array($this, 'add_download_logs_checkbox') |
|
| 43 | + ); |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * add_download_logs_checkbox |
|
| 49 | + * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
| 50 | + * |
|
| 51 | + * @return void |
|
| 52 | + */ |
|
| 53 | + public function add_download_logs_checkbox() |
|
| 54 | + { |
|
| 55 | + echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
| 56 | + . __( |
|
| 57 | + 'Download Results', |
|
| 58 | + 'event_espresso' |
|
| 59 | + ) . "'>"; |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * _set_properties |
|
| 65 | + * |
|
| 66 | + * @return void |
|
| 67 | + */ |
|
| 68 | + protected function _set_properties() |
|
| 69 | + { |
|
| 70 | + $this->_wp_list_args = array( |
|
| 71 | + 'singular' => __('payment log', 'event_espresso'), |
|
| 72 | + 'plural' => __('payment logs', 'event_espresso'), |
|
| 73 | + 'ajax' => true, // for now, |
|
| 74 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 75 | + ); |
|
| 76 | + $this->_columns = array( |
|
| 77 | + 'cb' => '<input type="checkbox" />', |
|
| 78 | + 'id' => __('ID', 'event_espresso'), |
|
| 79 | + 'LOG_time' => __('Time', 'event_espresso'), |
|
| 80 | + 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
| 81 | + 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
| 82 | + ); |
|
| 83 | + $this->_sortable_columns = array( |
|
| 84 | + 'LOG_time' => array('LOG_time' => true), |
|
| 85 | + ); |
|
| 86 | + $this->_hidden_columns = array(); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * _get_table_filters |
|
| 92 | + * |
|
| 93 | + * @return array |
|
| 94 | + */ |
|
| 95 | + protected function _get_table_filters() |
|
| 96 | + { |
|
| 97 | + $filters = array(); |
|
| 98 | + // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
| 99 | + $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
| 100 | + $payment_method_names = array( |
|
| 101 | + array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
| 102 | + array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
| 103 | + ); |
|
| 104 | + foreach ($payment_methods as $payment_method) { |
|
| 105 | + $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
| 106 | + } |
|
| 107 | + $filters[] = EEH_Form_Fields::select_input( |
|
| 108 | + '_payment_method', |
|
| 109 | + $payment_method_names, |
|
| 110 | + isset($this->_req_data['_payment_method']) |
|
| 111 | + ? $this->_req_data['_payment_method'] : 'all' |
|
| 112 | + ); |
|
| 113 | + $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
| 114 | + $this->_req_data['payment-filter-start-date'] |
|
| 115 | + ) : date('m/d/Y', strtotime('-6 months')); |
|
| 116 | + $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
| 117 | + $this->_req_data['payment-filter-end-date'] |
|
| 118 | + ) : date('m/d/Y'); |
|
| 119 | + ob_start(); |
|
| 120 | + ?> |
|
| 121 | 121 | <label for="txn-filter-start-date"><?php _e('Display Transactions from ', 'event_espresso'); ?></label> |
| 122 | 122 | <input id="payment-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>" |
| 123 | 123 | name="payment-filter-start-date" size="15"/> |
@@ -125,124 +125,124 @@ discard block |
||
| 125 | 125 | <input id="payment-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>" |
| 126 | 126 | name="payment-filter-end-date" size="15"/> |
| 127 | 127 | <?php |
| 128 | - $filters[] = ob_get_clean(); |
|
| 129 | - return $filters; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * _add_view_counts |
|
| 135 | - * |
|
| 136 | - * @return void |
|
| 137 | - */ |
|
| 138 | - protected function _add_view_counts() |
|
| 139 | - { |
|
| 140 | - $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
| 141 | - $this->_per_page, |
|
| 142 | - $this->_current_page, |
|
| 143 | - true |
|
| 144 | - ); |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * column_cb |
|
| 150 | - * |
|
| 151 | - * @param \EE_Change_Log $item |
|
| 152 | - * @return string |
|
| 153 | - */ |
|
| 154 | - public function column_cb($item) |
|
| 155 | - { |
|
| 156 | - return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * column_id |
|
| 162 | - * |
|
| 163 | - * @param \EE_Change_Log $item |
|
| 164 | - * @return string |
|
| 165 | - */ |
|
| 166 | - public function column_id(EE_Change_Log $item) |
|
| 167 | - { |
|
| 168 | - $details_query_args = array( |
|
| 169 | - 'action' => 'payment_log_details', |
|
| 170 | - 'ID' => $item->ID(), |
|
| 171 | - ); |
|
| 172 | - $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
| 173 | - return "<a href='$url'>{$item->ID()}</a>"; |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * column_LOG_time |
|
| 179 | - * |
|
| 180 | - * @param \EE_Change_Log $item |
|
| 181 | - * @return string |
|
| 182 | - */ |
|
| 183 | - public function column_LOG_time(EE_Change_Log $item) |
|
| 184 | - { |
|
| 185 | - return $item->get_datetime('LOG_time'); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * column_PMD_ID |
|
| 191 | - * |
|
| 192 | - * @param \EE_Change_Log $item |
|
| 193 | - * @return string |
|
| 194 | - */ |
|
| 195 | - public function column_PMD_ID(EE_Change_Log $item) |
|
| 196 | - { |
|
| 197 | - if ($item->object() instanceof EE_Payment_Method) { |
|
| 198 | - return $item->object()->admin_name(); |
|
| 199 | - } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
| 200 | - return $item->object()->payment_method()->admin_name(); |
|
| 201 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
| 202 | - return esc_html__('Unknown', 'event_espresso'); |
|
| 203 | - } else { |
|
| 204 | - return esc_html__("No longer exists", 'event_espresso'); |
|
| 205 | - } |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * column_TXN_ID |
|
| 211 | - * |
|
| 212 | - * @param \EE_Change_Log $item |
|
| 213 | - * @return string |
|
| 214 | - */ |
|
| 215 | - public function column_TXN_ID(EE_Change_Log $item) |
|
| 216 | - { |
|
| 217 | - if ($item->object() instanceof EE_Payment) { |
|
| 218 | - $transaction_id = $item->object()->TXN_ID(); |
|
| 219 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
| 220 | - $transaction_id = $item->object()->ID(); |
|
| 221 | - } else { |
|
| 222 | - $transaction_id = null; |
|
| 223 | - } |
|
| 224 | - if ($transaction_id |
|
| 225 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 226 | - 'ee_read_transaction', |
|
| 227 | - 'espresso_transactions_view_transaction', |
|
| 228 | - $transaction_id |
|
| 229 | - )) { |
|
| 230 | - $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 231 | - array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
| 232 | - TXN_ADMIN_URL |
|
| 233 | - ); |
|
| 234 | - return '<a href="' |
|
| 235 | - . $view_txn_lnk_url |
|
| 236 | - . '" title="' |
|
| 237 | - . sprintf( |
|
| 238 | - esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
| 239 | - $transaction_id |
|
| 240 | - ) |
|
| 241 | - . '">' |
|
| 242 | - . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
| 243 | - . '</a>'; |
|
| 244 | - } |
|
| 245 | - // No transaction id or use can not view the transaction. |
|
| 246 | - return __("Unable to find transaction", 'event_espresso'); |
|
| 247 | - } |
|
| 128 | + $filters[] = ob_get_clean(); |
|
| 129 | + return $filters; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * _add_view_counts |
|
| 135 | + * |
|
| 136 | + * @return void |
|
| 137 | + */ |
|
| 138 | + protected function _add_view_counts() |
|
| 139 | + { |
|
| 140 | + $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
| 141 | + $this->_per_page, |
|
| 142 | + $this->_current_page, |
|
| 143 | + true |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * column_cb |
|
| 150 | + * |
|
| 151 | + * @param \EE_Change_Log $item |
|
| 152 | + * @return string |
|
| 153 | + */ |
|
| 154 | + public function column_cb($item) |
|
| 155 | + { |
|
| 156 | + return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * column_id |
|
| 162 | + * |
|
| 163 | + * @param \EE_Change_Log $item |
|
| 164 | + * @return string |
|
| 165 | + */ |
|
| 166 | + public function column_id(EE_Change_Log $item) |
|
| 167 | + { |
|
| 168 | + $details_query_args = array( |
|
| 169 | + 'action' => 'payment_log_details', |
|
| 170 | + 'ID' => $item->ID(), |
|
| 171 | + ); |
|
| 172 | + $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
| 173 | + return "<a href='$url'>{$item->ID()}</a>"; |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * column_LOG_time |
|
| 179 | + * |
|
| 180 | + * @param \EE_Change_Log $item |
|
| 181 | + * @return string |
|
| 182 | + */ |
|
| 183 | + public function column_LOG_time(EE_Change_Log $item) |
|
| 184 | + { |
|
| 185 | + return $item->get_datetime('LOG_time'); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * column_PMD_ID |
|
| 191 | + * |
|
| 192 | + * @param \EE_Change_Log $item |
|
| 193 | + * @return string |
|
| 194 | + */ |
|
| 195 | + public function column_PMD_ID(EE_Change_Log $item) |
|
| 196 | + { |
|
| 197 | + if ($item->object() instanceof EE_Payment_Method) { |
|
| 198 | + return $item->object()->admin_name(); |
|
| 199 | + } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
| 200 | + return $item->object()->payment_method()->admin_name(); |
|
| 201 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
| 202 | + return esc_html__('Unknown', 'event_espresso'); |
|
| 203 | + } else { |
|
| 204 | + return esc_html__("No longer exists", 'event_espresso'); |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * column_TXN_ID |
|
| 211 | + * |
|
| 212 | + * @param \EE_Change_Log $item |
|
| 213 | + * @return string |
|
| 214 | + */ |
|
| 215 | + public function column_TXN_ID(EE_Change_Log $item) |
|
| 216 | + { |
|
| 217 | + if ($item->object() instanceof EE_Payment) { |
|
| 218 | + $transaction_id = $item->object()->TXN_ID(); |
|
| 219 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
| 220 | + $transaction_id = $item->object()->ID(); |
|
| 221 | + } else { |
|
| 222 | + $transaction_id = null; |
|
| 223 | + } |
|
| 224 | + if ($transaction_id |
|
| 225 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 226 | + 'ee_read_transaction', |
|
| 227 | + 'espresso_transactions_view_transaction', |
|
| 228 | + $transaction_id |
|
| 229 | + )) { |
|
| 230 | + $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 231 | + array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
| 232 | + TXN_ADMIN_URL |
|
| 233 | + ); |
|
| 234 | + return '<a href="' |
|
| 235 | + . $view_txn_lnk_url |
|
| 236 | + . '" title="' |
|
| 237 | + . sprintf( |
|
| 238 | + esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
| 239 | + $transaction_id |
|
| 240 | + ) |
|
| 241 | + . '">' |
|
| 242 | + . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
| 243 | + . '</a>'; |
|
| 244 | + } |
|
| 245 | + // No transaction id or use can not view the transaction. |
|
| 246 | + return __("Unable to find transaction", 'event_espresso'); |
|
| 247 | + } |
|
| 248 | 248 | } |
@@ -1163,8 +1163,8 @@ discard block |
||
| 1163 | 1163 | * @param array $datetime_tickets |
| 1164 | 1164 | * @param array $all_tickets |
| 1165 | 1165 | * @param bool $default |
| 1166 | - * @param array $all_datetimes |
|
| 1167 | - * @return mixed |
|
| 1166 | + * @param EE_Datetime[] $all_datetimes |
|
| 1167 | + * @return string |
|
| 1168 | 1168 | * @throws DomainException |
| 1169 | 1169 | * @throws EE_Error |
| 1170 | 1170 | */ |
@@ -1275,7 +1275,7 @@ discard block |
||
| 1275 | 1275 | * @param array $datetime_tickets |
| 1276 | 1276 | * @param array $all_tickets |
| 1277 | 1277 | * @param bool $default |
| 1278 | - * @return mixed |
|
| 1278 | + * @return string |
|
| 1279 | 1279 | * @throws DomainException |
| 1280 | 1280 | * @throws EE_Error |
| 1281 | 1281 | */ |
@@ -1343,7 +1343,7 @@ discard block |
||
| 1343 | 1343 | * @param EE_Ticket $ticket |
| 1344 | 1344 | * @param array $datetime_tickets |
| 1345 | 1345 | * @param bool $default |
| 1346 | - * @return mixed |
|
| 1346 | + * @return string |
|
| 1347 | 1347 | * @throws DomainException |
| 1348 | 1348 | * @throws EE_Error |
| 1349 | 1349 | */ |
@@ -1413,7 +1413,7 @@ discard block |
||
| 1413 | 1413 | * @param bool $default Whether default row being generated or not. |
| 1414 | 1414 | * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
| 1415 | 1415 | * (or empty in the case of defaults) |
| 1416 | - * @return mixed |
|
| 1416 | + * @return string |
|
| 1417 | 1417 | * @throws InvalidArgumentException |
| 1418 | 1418 | * @throws InvalidInterfaceException |
| 1419 | 1419 | * @throws InvalidDataTypeException |
@@ -1737,7 +1737,7 @@ discard block |
||
| 1737 | 1737 | * @param EE_Ticket|null $ticket |
| 1738 | 1738 | * @param bool $show_trash |
| 1739 | 1739 | * @param bool $show_create |
| 1740 | - * @return mixed |
|
| 1740 | + * @return string |
|
| 1741 | 1741 | * @throws InvalidArgumentException |
| 1742 | 1742 | * @throws InvalidInterfaceException |
| 1743 | 1743 | * @throws InvalidDataTypeException |
@@ -1840,7 +1840,7 @@ discard block |
||
| 1840 | 1840 | * @param EE_Price $price |
| 1841 | 1841 | * @param bool $default |
| 1842 | 1842 | * @param bool $disabled |
| 1843 | - * @return mixed |
|
| 1843 | + * @return string |
|
| 1844 | 1844 | * @throws ReflectionException |
| 1845 | 1845 | * @throws InvalidArgumentException |
| 1846 | 1846 | * @throws InvalidInterfaceException |
@@ -1873,7 +1873,7 @@ discard block |
||
| 1873 | 1873 | * @param int $price_row |
| 1874 | 1874 | * @param EE_Price $price |
| 1875 | 1875 | * @param bool $default |
| 1876 | - * @return mixed |
|
| 1876 | + * @return string |
|
| 1877 | 1877 | * @throws DomainException |
| 1878 | 1878 | * @throws EE_Error |
| 1879 | 1879 | */ |
@@ -1910,7 +1910,7 @@ discard block |
||
| 1910 | 1910 | * @param EE_Price $price |
| 1911 | 1911 | * @param bool $default |
| 1912 | 1912 | * @param bool $disabled |
| 1913 | - * @return mixed |
|
| 1913 | + * @return string |
|
| 1914 | 1914 | * @throws ReflectionException |
| 1915 | 1915 | * @throws InvalidArgumentException |
| 1916 | 1916 | * @throws InvalidInterfaceException |
@@ -2012,7 +2012,7 @@ discard block |
||
| 2012 | 2012 | * @param EE_Ticket|null $ticket |
| 2013 | 2013 | * @param array $ticket_datetimes |
| 2014 | 2014 | * @param bool $default |
| 2015 | - * @return mixed |
|
| 2015 | + * @return string |
|
| 2016 | 2016 | * @throws DomainException |
| 2017 | 2017 | * @throws EE_Error |
| 2018 | 2018 | */ |
@@ -2065,9 +2065,9 @@ discard block |
||
| 2065 | 2065 | |
| 2066 | 2066 | |
| 2067 | 2067 | /** |
| 2068 | - * @param array $all_datetimes |
|
| 2068 | + * @param EE_Datetime[] $all_datetimes |
|
| 2069 | 2069 | * @param array $all_tickets |
| 2070 | - * @return mixed |
|
| 2070 | + * @return string |
|
| 2071 | 2071 | * @throws ReflectionException |
| 2072 | 2072 | * @throws InvalidArgumentException |
| 2073 | 2073 | * @throws InvalidInterfaceException |
@@ -15,2196 +15,2196 @@ |
||
| 15 | 15 | class espresso_events_Pricing_Hooks extends EE_Admin_Hooks |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * This property is just used to hold the status of whether an event is currently being |
|
| 20 | - * created (true) or edited (false) |
|
| 21 | - * |
|
| 22 | - * @access protected |
|
| 23 | - * @var bool |
|
| 24 | - */ |
|
| 25 | - protected $_is_creating_event; |
|
| 18 | + /** |
|
| 19 | + * This property is just used to hold the status of whether an event is currently being |
|
| 20 | + * created (true) or edited (false) |
|
| 21 | + * |
|
| 22 | + * @access protected |
|
| 23 | + * @var bool |
|
| 24 | + */ |
|
| 25 | + protected $_is_creating_event; |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Used to contain the format strings for date and time that will be used for php date and |
|
| 29 | - * time. |
|
| 30 | - * Is set in the _set_hooks_properties() method. |
|
| 31 | - * |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 34 | - protected $_date_format_strings; |
|
| 27 | + /** |
|
| 28 | + * Used to contain the format strings for date and time that will be used for php date and |
|
| 29 | + * time. |
|
| 30 | + * Is set in the _set_hooks_properties() method. |
|
| 31 | + * |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | + protected $_date_format_strings; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string $_date_time_format |
|
| 38 | - */ |
|
| 39 | - protected $_date_time_format; |
|
| 36 | + /** |
|
| 37 | + * @var string $_date_time_format |
|
| 38 | + */ |
|
| 39 | + protected $_date_time_format; |
|
| 40 | 40 | |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @throws InvalidArgumentException |
|
| 44 | - * @throws InvalidInterfaceException |
|
| 45 | - * @throws InvalidDataTypeException |
|
| 46 | - */ |
|
| 47 | - protected function _set_hooks_properties() |
|
| 48 | - { |
|
| 49 | - $this->_name = 'pricing'; |
|
| 50 | - // capability check |
|
| 51 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 52 | - 'ee_read_default_prices', |
|
| 53 | - 'advanced_ticket_datetime_metabox' |
|
| 54 | - )) { |
|
| 55 | - return; |
|
| 56 | - } |
|
| 57 | - $this->_setup_metaboxes(); |
|
| 58 | - $this->_set_date_time_formats(); |
|
| 59 | - $this->_validate_format_strings(); |
|
| 60 | - $this->_set_scripts_styles(); |
|
| 61 | - // commented out temporarily until logic is implemented in callback |
|
| 62 | - // add_action( |
|
| 63 | - // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
| 64 | - // array($this, 'autosave_handling') |
|
| 65 | - // ); |
|
| 66 | - add_filter( |
|
| 67 | - 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
| 68 | - array($this, 'caf_updates') |
|
| 69 | - ); |
|
| 70 | - } |
|
| 42 | + /** |
|
| 43 | + * @throws InvalidArgumentException |
|
| 44 | + * @throws InvalidInterfaceException |
|
| 45 | + * @throws InvalidDataTypeException |
|
| 46 | + */ |
|
| 47 | + protected function _set_hooks_properties() |
|
| 48 | + { |
|
| 49 | + $this->_name = 'pricing'; |
|
| 50 | + // capability check |
|
| 51 | + if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 52 | + 'ee_read_default_prices', |
|
| 53 | + 'advanced_ticket_datetime_metabox' |
|
| 54 | + )) { |
|
| 55 | + return; |
|
| 56 | + } |
|
| 57 | + $this->_setup_metaboxes(); |
|
| 58 | + $this->_set_date_time_formats(); |
|
| 59 | + $this->_validate_format_strings(); |
|
| 60 | + $this->_set_scripts_styles(); |
|
| 61 | + // commented out temporarily until logic is implemented in callback |
|
| 62 | + // add_action( |
|
| 63 | + // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
| 64 | + // array($this, 'autosave_handling') |
|
| 65 | + // ); |
|
| 66 | + add_filter( |
|
| 67 | + 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
| 68 | + array($this, 'caf_updates') |
|
| 69 | + ); |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @return void |
|
| 75 | - */ |
|
| 76 | - protected function _setup_metaboxes() |
|
| 77 | - { |
|
| 78 | - // if we were going to add our own metaboxes we'd use the below. |
|
| 79 | - $this->_metaboxes = array( |
|
| 80 | - 0 => array( |
|
| 81 | - 'page_route' => array('edit', 'create_new'), |
|
| 82 | - 'func' => 'pricing_metabox', |
|
| 83 | - 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
| 84 | - 'priority' => 'high', |
|
| 85 | - 'context' => 'normal', |
|
| 86 | - ), |
|
| 87 | - ); |
|
| 88 | - $this->_remove_metaboxes = array( |
|
| 89 | - 0 => array( |
|
| 90 | - 'page_route' => array('edit', 'create_new'), |
|
| 91 | - 'id' => 'espresso_event_editor_tickets', |
|
| 92 | - 'context' => 'normal', |
|
| 93 | - ), |
|
| 94 | - ); |
|
| 95 | - } |
|
| 73 | + /** |
|
| 74 | + * @return void |
|
| 75 | + */ |
|
| 76 | + protected function _setup_metaboxes() |
|
| 77 | + { |
|
| 78 | + // if we were going to add our own metaboxes we'd use the below. |
|
| 79 | + $this->_metaboxes = array( |
|
| 80 | + 0 => array( |
|
| 81 | + 'page_route' => array('edit', 'create_new'), |
|
| 82 | + 'func' => 'pricing_metabox', |
|
| 83 | + 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
| 84 | + 'priority' => 'high', |
|
| 85 | + 'context' => 'normal', |
|
| 86 | + ), |
|
| 87 | + ); |
|
| 88 | + $this->_remove_metaboxes = array( |
|
| 89 | + 0 => array( |
|
| 90 | + 'page_route' => array('edit', 'create_new'), |
|
| 91 | + 'id' => 'espresso_event_editor_tickets', |
|
| 92 | + 'context' => 'normal', |
|
| 93 | + ), |
|
| 94 | + ); |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * @return void |
|
| 100 | - */ |
|
| 101 | - protected function _set_date_time_formats() |
|
| 102 | - { |
|
| 103 | - /** |
|
| 104 | - * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
| 105 | - * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
| 106 | - * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
| 107 | - * |
|
| 108 | - * @since 4.6.7 |
|
| 109 | - * @var array Expected an array returned with 'date' and 'time' keys. |
|
| 110 | - */ |
|
| 111 | - $this->_date_format_strings = apply_filters( |
|
| 112 | - 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
| 113 | - array( |
|
| 114 | - 'date' => 'Y-m-d', |
|
| 115 | - 'time' => 'h:i a', |
|
| 116 | - ) |
|
| 117 | - ); |
|
| 118 | - // validate |
|
| 119 | - $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
| 120 | - ? $this->_date_format_strings['date'] |
|
| 121 | - : null; |
|
| 122 | - $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
| 123 | - ? $this->_date_format_strings['time'] |
|
| 124 | - : null; |
|
| 125 | - $this->_date_time_format = $this->_date_format_strings['date'] |
|
| 126 | - . ' ' |
|
| 127 | - . $this->_date_format_strings['time']; |
|
| 128 | - } |
|
| 98 | + /** |
|
| 99 | + * @return void |
|
| 100 | + */ |
|
| 101 | + protected function _set_date_time_formats() |
|
| 102 | + { |
|
| 103 | + /** |
|
| 104 | + * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
| 105 | + * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
| 106 | + * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
| 107 | + * |
|
| 108 | + * @since 4.6.7 |
|
| 109 | + * @var array Expected an array returned with 'date' and 'time' keys. |
|
| 110 | + */ |
|
| 111 | + $this->_date_format_strings = apply_filters( |
|
| 112 | + 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
| 113 | + array( |
|
| 114 | + 'date' => 'Y-m-d', |
|
| 115 | + 'time' => 'h:i a', |
|
| 116 | + ) |
|
| 117 | + ); |
|
| 118 | + // validate |
|
| 119 | + $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
| 120 | + ? $this->_date_format_strings['date'] |
|
| 121 | + : null; |
|
| 122 | + $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
| 123 | + ? $this->_date_format_strings['time'] |
|
| 124 | + : null; |
|
| 125 | + $this->_date_time_format = $this->_date_format_strings['date'] |
|
| 126 | + . ' ' |
|
| 127 | + . $this->_date_format_strings['time']; |
|
| 128 | + } |
|
| 129 | 129 | |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * @return void |
|
| 133 | - */ |
|
| 134 | - protected function _validate_format_strings() |
|
| 135 | - { |
|
| 136 | - // validate format strings |
|
| 137 | - $format_validation = EEH_DTT_Helper::validate_format_string( |
|
| 138 | - $this->_date_time_format |
|
| 139 | - ); |
|
| 140 | - if (is_array($format_validation)) { |
|
| 141 | - $msg = '<p>'; |
|
| 142 | - $msg .= sprintf( |
|
| 143 | - esc_html__( |
|
| 144 | - 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
| 145 | - 'event_espresso' |
|
| 146 | - ), |
|
| 147 | - $this->_date_time_format |
|
| 148 | - ); |
|
| 149 | - $msg .= '</p><ul>'; |
|
| 150 | - foreach ($format_validation as $error) { |
|
| 151 | - $msg .= '<li>' . $error . '</li>'; |
|
| 152 | - } |
|
| 153 | - $msg .= '</ul><p>'; |
|
| 154 | - $msg .= sprintf( |
|
| 155 | - esc_html__( |
|
| 156 | - '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
| 157 | - 'event_espresso' |
|
| 158 | - ), |
|
| 159 | - '<span style="color:#D54E21;">', |
|
| 160 | - '</span>' |
|
| 161 | - ); |
|
| 162 | - $msg .= '</p>'; |
|
| 163 | - EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 164 | - $this->_date_format_strings = array( |
|
| 165 | - 'date' => 'Y-m-d', |
|
| 166 | - 'time' => 'h:i a', |
|
| 167 | - ); |
|
| 168 | - } |
|
| 169 | - } |
|
| 131 | + /** |
|
| 132 | + * @return void |
|
| 133 | + */ |
|
| 134 | + protected function _validate_format_strings() |
|
| 135 | + { |
|
| 136 | + // validate format strings |
|
| 137 | + $format_validation = EEH_DTT_Helper::validate_format_string( |
|
| 138 | + $this->_date_time_format |
|
| 139 | + ); |
|
| 140 | + if (is_array($format_validation)) { |
|
| 141 | + $msg = '<p>'; |
|
| 142 | + $msg .= sprintf( |
|
| 143 | + esc_html__( |
|
| 144 | + 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
| 145 | + 'event_espresso' |
|
| 146 | + ), |
|
| 147 | + $this->_date_time_format |
|
| 148 | + ); |
|
| 149 | + $msg .= '</p><ul>'; |
|
| 150 | + foreach ($format_validation as $error) { |
|
| 151 | + $msg .= '<li>' . $error . '</li>'; |
|
| 152 | + } |
|
| 153 | + $msg .= '</ul><p>'; |
|
| 154 | + $msg .= sprintf( |
|
| 155 | + esc_html__( |
|
| 156 | + '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
| 157 | + 'event_espresso' |
|
| 158 | + ), |
|
| 159 | + '<span style="color:#D54E21;">', |
|
| 160 | + '</span>' |
|
| 161 | + ); |
|
| 162 | + $msg .= '</p>'; |
|
| 163 | + EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 164 | + $this->_date_format_strings = array( |
|
| 165 | + 'date' => 'Y-m-d', |
|
| 166 | + 'time' => 'h:i a', |
|
| 167 | + ); |
|
| 168 | + } |
|
| 169 | + } |
|
| 170 | 170 | |
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * @return void |
|
| 174 | - */ |
|
| 175 | - protected function _set_scripts_styles() |
|
| 176 | - { |
|
| 177 | - $this->_scripts_styles = array( |
|
| 178 | - 'registers' => array( |
|
| 179 | - 'ee-tickets-datetimes-css' => array( |
|
| 180 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 181 | - 'type' => 'css', |
|
| 182 | - ), |
|
| 183 | - 'ee-dtt-ticket-metabox' => array( |
|
| 184 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 185 | - 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
| 186 | - ), |
|
| 187 | - ), |
|
| 188 | - 'deregisters' => array( |
|
| 189 | - 'event-editor-css' => array('type' => 'css'), |
|
| 190 | - 'event-datetime-metabox' => array('type' => 'js'), |
|
| 191 | - ), |
|
| 192 | - 'enqueues' => array( |
|
| 193 | - 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
| 194 | - 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
| 195 | - ), |
|
| 196 | - 'localize' => array( |
|
| 197 | - 'ee-dtt-ticket-metabox' => array( |
|
| 198 | - 'DTT_TRASH_BLOCK' => array( |
|
| 199 | - 'main_warning' => esc_html__( |
|
| 200 | - 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
| 201 | - 'event_espresso' |
|
| 202 | - ), |
|
| 203 | - 'after_warning' => esc_html__( |
|
| 204 | - 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
| 205 | - 'event_espresso' |
|
| 206 | - ), |
|
| 207 | - 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 208 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 209 | - 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 210 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 211 | - 'single_warning_from_tkt' => esc_html__( |
|
| 212 | - 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 213 | - 'event_espresso' |
|
| 214 | - ), |
|
| 215 | - 'single_warning_from_dtt' => esc_html__( |
|
| 216 | - 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 217 | - 'event_espresso' |
|
| 218 | - ), |
|
| 219 | - 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 220 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 221 | - ), |
|
| 222 | - 'DTT_ERROR_MSG' => array( |
|
| 223 | - 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
| 224 | - 'dismiss_button' => '<div class="save-cancel-button-container">' |
|
| 225 | - . '<button class="button-secondary ee-modal-cancel">' |
|
| 226 | - . esc_html__('Dismiss', 'event_espresso') |
|
| 227 | - . '</button></div>', |
|
| 228 | - ), |
|
| 229 | - 'DTT_OVERSELL_WARNING' => array( |
|
| 230 | - 'datetime_ticket' => esc_html__( |
|
| 231 | - 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
| 232 | - 'event_espresso' |
|
| 233 | - ), |
|
| 234 | - 'ticket_datetime' => esc_html__( |
|
| 235 | - 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
| 236 | - 'event_espresso' |
|
| 237 | - ), |
|
| 238 | - ), |
|
| 239 | - 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
| 240 | - $this->_date_format_strings['date'], |
|
| 241 | - $this->_date_format_strings['time'] |
|
| 242 | - ), |
|
| 243 | - 'DTT_START_OF_WEEK' => array('dayValue' => (int) get_option('start_of_week')), |
|
| 244 | - ), |
|
| 245 | - ), |
|
| 246 | - ); |
|
| 247 | - } |
|
| 172 | + /** |
|
| 173 | + * @return void |
|
| 174 | + */ |
|
| 175 | + protected function _set_scripts_styles() |
|
| 176 | + { |
|
| 177 | + $this->_scripts_styles = array( |
|
| 178 | + 'registers' => array( |
|
| 179 | + 'ee-tickets-datetimes-css' => array( |
|
| 180 | + 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 181 | + 'type' => 'css', |
|
| 182 | + ), |
|
| 183 | + 'ee-dtt-ticket-metabox' => array( |
|
| 184 | + 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 185 | + 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
| 186 | + ), |
|
| 187 | + ), |
|
| 188 | + 'deregisters' => array( |
|
| 189 | + 'event-editor-css' => array('type' => 'css'), |
|
| 190 | + 'event-datetime-metabox' => array('type' => 'js'), |
|
| 191 | + ), |
|
| 192 | + 'enqueues' => array( |
|
| 193 | + 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
| 194 | + 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
| 195 | + ), |
|
| 196 | + 'localize' => array( |
|
| 197 | + 'ee-dtt-ticket-metabox' => array( |
|
| 198 | + 'DTT_TRASH_BLOCK' => array( |
|
| 199 | + 'main_warning' => esc_html__( |
|
| 200 | + 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
| 201 | + 'event_espresso' |
|
| 202 | + ), |
|
| 203 | + 'after_warning' => esc_html__( |
|
| 204 | + 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
| 205 | + 'event_espresso' |
|
| 206 | + ), |
|
| 207 | + 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 208 | + . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 209 | + 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 210 | + . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 211 | + 'single_warning_from_tkt' => esc_html__( |
|
| 212 | + 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 213 | + 'event_espresso' |
|
| 214 | + ), |
|
| 215 | + 'single_warning_from_dtt' => esc_html__( |
|
| 216 | + 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 217 | + 'event_espresso' |
|
| 218 | + ), |
|
| 219 | + 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 220 | + . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 221 | + ), |
|
| 222 | + 'DTT_ERROR_MSG' => array( |
|
| 223 | + 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
| 224 | + 'dismiss_button' => '<div class="save-cancel-button-container">' |
|
| 225 | + . '<button class="button-secondary ee-modal-cancel">' |
|
| 226 | + . esc_html__('Dismiss', 'event_espresso') |
|
| 227 | + . '</button></div>', |
|
| 228 | + ), |
|
| 229 | + 'DTT_OVERSELL_WARNING' => array( |
|
| 230 | + 'datetime_ticket' => esc_html__( |
|
| 231 | + 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
| 232 | + 'event_espresso' |
|
| 233 | + ), |
|
| 234 | + 'ticket_datetime' => esc_html__( |
|
| 235 | + 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
| 236 | + 'event_espresso' |
|
| 237 | + ), |
|
| 238 | + ), |
|
| 239 | + 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
| 240 | + $this->_date_format_strings['date'], |
|
| 241 | + $this->_date_format_strings['time'] |
|
| 242 | + ), |
|
| 243 | + 'DTT_START_OF_WEEK' => array('dayValue' => (int) get_option('start_of_week')), |
|
| 244 | + ), |
|
| 245 | + ), |
|
| 246 | + ); |
|
| 247 | + } |
|
| 248 | 248 | |
| 249 | 249 | |
| 250 | - /** |
|
| 251 | - * @param array $update_callbacks |
|
| 252 | - * @return array |
|
| 253 | - */ |
|
| 254 | - public function caf_updates(array $update_callbacks) |
|
| 255 | - { |
|
| 256 | - foreach ($update_callbacks as $key => $callback) { |
|
| 257 | - if ($callback[1] === '_default_tickets_update') { |
|
| 258 | - unset($update_callbacks[ $key ]); |
|
| 259 | - } |
|
| 260 | - } |
|
| 261 | - $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
| 262 | - return $update_callbacks; |
|
| 263 | - } |
|
| 250 | + /** |
|
| 251 | + * @param array $update_callbacks |
|
| 252 | + * @return array |
|
| 253 | + */ |
|
| 254 | + public function caf_updates(array $update_callbacks) |
|
| 255 | + { |
|
| 256 | + foreach ($update_callbacks as $key => $callback) { |
|
| 257 | + if ($callback[1] === '_default_tickets_update') { |
|
| 258 | + unset($update_callbacks[ $key ]); |
|
| 259 | + } |
|
| 260 | + } |
|
| 261 | + $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
| 262 | + return $update_callbacks; |
|
| 263 | + } |
|
| 264 | 264 | |
| 265 | 265 | |
| 266 | - /** |
|
| 267 | - * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
| 268 | - * |
|
| 269 | - * @param EE_Event $event The Event object we're attaching data to |
|
| 270 | - * @param array $data The request data from the form |
|
| 271 | - * @throws ReflectionException |
|
| 272 | - * @throws Exception |
|
| 273 | - * @throws InvalidInterfaceException |
|
| 274 | - * @throws InvalidDataTypeException |
|
| 275 | - * @throws EE_Error |
|
| 276 | - * @throws InvalidArgumentException |
|
| 277 | - */ |
|
| 278 | - public function datetime_and_tickets_caf_update($event, $data) |
|
| 279 | - { |
|
| 280 | - // first we need to start with datetimes cause they are the "root" items attached to events. |
|
| 281 | - $saved_datetimes = $this->_update_datetimes($event, $data); |
|
| 282 | - // next tackle the tickets (and prices?) |
|
| 283 | - $this->_update_tickets($event, $saved_datetimes, $data); |
|
| 284 | - } |
|
| 266 | + /** |
|
| 267 | + * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
| 268 | + * |
|
| 269 | + * @param EE_Event $event The Event object we're attaching data to |
|
| 270 | + * @param array $data The request data from the form |
|
| 271 | + * @throws ReflectionException |
|
| 272 | + * @throws Exception |
|
| 273 | + * @throws InvalidInterfaceException |
|
| 274 | + * @throws InvalidDataTypeException |
|
| 275 | + * @throws EE_Error |
|
| 276 | + * @throws InvalidArgumentException |
|
| 277 | + */ |
|
| 278 | + public function datetime_and_tickets_caf_update($event, $data) |
|
| 279 | + { |
|
| 280 | + // first we need to start with datetimes cause they are the "root" items attached to events. |
|
| 281 | + $saved_datetimes = $this->_update_datetimes($event, $data); |
|
| 282 | + // next tackle the tickets (and prices?) |
|
| 283 | + $this->_update_tickets($event, $saved_datetimes, $data); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | 286 | |
| 287 | - /** |
|
| 288 | - * update event_datetimes |
|
| 289 | - * |
|
| 290 | - * @param EE_Event $event Event being updated |
|
| 291 | - * @param array $data the request data from the form |
|
| 292 | - * @return EE_Datetime[] |
|
| 293 | - * @throws Exception |
|
| 294 | - * @throws ReflectionException |
|
| 295 | - * @throws InvalidInterfaceException |
|
| 296 | - * @throws InvalidDataTypeException |
|
| 297 | - * @throws InvalidArgumentException |
|
| 298 | - * @throws EE_Error |
|
| 299 | - */ |
|
| 300 | - protected function _update_datetimes($event, $data) |
|
| 301 | - { |
|
| 302 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 303 | - $saved_dtt_ids = array(); |
|
| 304 | - $saved_dtt_objs = array(); |
|
| 305 | - if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) { |
|
| 306 | - throw new InvalidArgumentException( |
|
| 307 | - esc_html__( |
|
| 308 | - 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
| 309 | - 'event_espresso' |
|
| 310 | - ) |
|
| 311 | - ); |
|
| 312 | - } |
|
| 313 | - foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
| 314 | - // trim all values to ensure any excess whitespace is removed. |
|
| 315 | - $datetime_data = array_map( |
|
| 316 | - function ($datetime_data) { |
|
| 317 | - return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
| 318 | - }, |
|
| 319 | - $datetime_data |
|
| 320 | - ); |
|
| 321 | - $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
| 322 | - && ! empty($datetime_data['DTT_EVT_end']) |
|
| 323 | - ? $datetime_data['DTT_EVT_end'] |
|
| 324 | - : $datetime_data['DTT_EVT_start']; |
|
| 325 | - $datetime_values = array( |
|
| 326 | - 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
| 327 | - ? $datetime_data['DTT_ID'] |
|
| 328 | - : null, |
|
| 329 | - 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
| 330 | - ? $datetime_data['DTT_name'] |
|
| 331 | - : '', |
|
| 332 | - 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
| 333 | - ? $datetime_data['DTT_description'] |
|
| 334 | - : '', |
|
| 335 | - 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
| 336 | - 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
| 337 | - 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
| 338 | - ? EE_INF |
|
| 339 | - : $datetime_data['DTT_reg_limit'], |
|
| 340 | - 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
| 341 | - ? $row |
|
| 342 | - : $datetime_data['DTT_order'], |
|
| 343 | - ); |
|
| 344 | - // if we have an id then let's get existing object first and then set the new values. |
|
| 345 | - // Otherwise we instantiate a new object for save. |
|
| 346 | - if (! empty($datetime_data['DTT_ID'])) { |
|
| 347 | - $datetime = EE_Registry::instance() |
|
| 348 | - ->load_model('Datetime', array($timezone)) |
|
| 349 | - ->get_one_by_ID($datetime_data['DTT_ID']); |
|
| 350 | - // set date and time format according to what is set in this class. |
|
| 351 | - $datetime->set_date_format($this->_date_format_strings['date']); |
|
| 352 | - $datetime->set_time_format($this->_date_format_strings['time']); |
|
| 353 | - foreach ($datetime_values as $field => $value) { |
|
| 354 | - $datetime->set($field, $value); |
|
| 355 | - } |
|
| 356 | - // make sure the $dtt_id here is saved just in case |
|
| 357 | - // after the add_relation_to() the autosave replaces it. |
|
| 358 | - // We need to do this so we dont' TRASH the parent DTT. |
|
| 359 | - // (save the ID for both key and value to avoid duplications) |
|
| 360 | - $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
| 361 | - } else { |
|
| 362 | - $datetime = EE_Registry::instance()->load_class( |
|
| 363 | - 'Datetime', |
|
| 364 | - array( |
|
| 365 | - $datetime_values, |
|
| 366 | - $timezone, |
|
| 367 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
| 368 | - ), |
|
| 369 | - false, |
|
| 370 | - false |
|
| 371 | - ); |
|
| 372 | - foreach ($datetime_values as $field => $value) { |
|
| 373 | - $datetime->set($field, $value); |
|
| 374 | - } |
|
| 375 | - } |
|
| 376 | - $datetime->save(); |
|
| 377 | - $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
| 378 | - // before going any further make sure our dates are setup correctly |
|
| 379 | - // so that the end date is always equal or greater than the start date. |
|
| 380 | - if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
| 381 | - $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
| 382 | - $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
| 383 | - $datetime->save(); |
|
| 384 | - } |
|
| 385 | - // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
| 386 | - // because it is possible there was a new one created for the autosave. |
|
| 387 | - // (save the ID for both key and value to avoid duplications) |
|
| 388 | - $DTT_ID = $datetime->ID(); |
|
| 389 | - $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
| 390 | - $saved_dtt_objs[ $row ] = $datetime; |
|
| 391 | - // @todo if ANY of these updates fail then we want the appropriate global error message. |
|
| 392 | - } |
|
| 393 | - $event->save(); |
|
| 394 | - // now we need to REMOVE any datetimes that got deleted. |
|
| 395 | - // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
| 396 | - // So its safe to permanently delete at this point. |
|
| 397 | - $old_datetimes = explode(',', $data['datetime_IDs']); |
|
| 398 | - $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
| 399 | - if (is_array($old_datetimes)) { |
|
| 400 | - $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
| 401 | - foreach ($datetimes_to_delete as $id) { |
|
| 402 | - $id = absint($id); |
|
| 403 | - if (empty($id)) { |
|
| 404 | - continue; |
|
| 405 | - } |
|
| 406 | - $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
| 407 | - // remove tkt relationships. |
|
| 408 | - $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
| 409 | - foreach ($related_tickets as $tkt) { |
|
| 410 | - $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
| 411 | - } |
|
| 412 | - $event->_remove_relation_to($id, 'Datetime'); |
|
| 413 | - $dtt_to_remove->refresh_cache_of_related_objects(); |
|
| 414 | - } |
|
| 415 | - } |
|
| 416 | - return $saved_dtt_objs; |
|
| 417 | - } |
|
| 287 | + /** |
|
| 288 | + * update event_datetimes |
|
| 289 | + * |
|
| 290 | + * @param EE_Event $event Event being updated |
|
| 291 | + * @param array $data the request data from the form |
|
| 292 | + * @return EE_Datetime[] |
|
| 293 | + * @throws Exception |
|
| 294 | + * @throws ReflectionException |
|
| 295 | + * @throws InvalidInterfaceException |
|
| 296 | + * @throws InvalidDataTypeException |
|
| 297 | + * @throws InvalidArgumentException |
|
| 298 | + * @throws EE_Error |
|
| 299 | + */ |
|
| 300 | + protected function _update_datetimes($event, $data) |
|
| 301 | + { |
|
| 302 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 303 | + $saved_dtt_ids = array(); |
|
| 304 | + $saved_dtt_objs = array(); |
|
| 305 | + if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) { |
|
| 306 | + throw new InvalidArgumentException( |
|
| 307 | + esc_html__( |
|
| 308 | + 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
| 309 | + 'event_espresso' |
|
| 310 | + ) |
|
| 311 | + ); |
|
| 312 | + } |
|
| 313 | + foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
| 314 | + // trim all values to ensure any excess whitespace is removed. |
|
| 315 | + $datetime_data = array_map( |
|
| 316 | + function ($datetime_data) { |
|
| 317 | + return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
| 318 | + }, |
|
| 319 | + $datetime_data |
|
| 320 | + ); |
|
| 321 | + $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
| 322 | + && ! empty($datetime_data['DTT_EVT_end']) |
|
| 323 | + ? $datetime_data['DTT_EVT_end'] |
|
| 324 | + : $datetime_data['DTT_EVT_start']; |
|
| 325 | + $datetime_values = array( |
|
| 326 | + 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
| 327 | + ? $datetime_data['DTT_ID'] |
|
| 328 | + : null, |
|
| 329 | + 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
| 330 | + ? $datetime_data['DTT_name'] |
|
| 331 | + : '', |
|
| 332 | + 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
| 333 | + ? $datetime_data['DTT_description'] |
|
| 334 | + : '', |
|
| 335 | + 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
| 336 | + 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
| 337 | + 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
| 338 | + ? EE_INF |
|
| 339 | + : $datetime_data['DTT_reg_limit'], |
|
| 340 | + 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
| 341 | + ? $row |
|
| 342 | + : $datetime_data['DTT_order'], |
|
| 343 | + ); |
|
| 344 | + // if we have an id then let's get existing object first and then set the new values. |
|
| 345 | + // Otherwise we instantiate a new object for save. |
|
| 346 | + if (! empty($datetime_data['DTT_ID'])) { |
|
| 347 | + $datetime = EE_Registry::instance() |
|
| 348 | + ->load_model('Datetime', array($timezone)) |
|
| 349 | + ->get_one_by_ID($datetime_data['DTT_ID']); |
|
| 350 | + // set date and time format according to what is set in this class. |
|
| 351 | + $datetime->set_date_format($this->_date_format_strings['date']); |
|
| 352 | + $datetime->set_time_format($this->_date_format_strings['time']); |
|
| 353 | + foreach ($datetime_values as $field => $value) { |
|
| 354 | + $datetime->set($field, $value); |
|
| 355 | + } |
|
| 356 | + // make sure the $dtt_id here is saved just in case |
|
| 357 | + // after the add_relation_to() the autosave replaces it. |
|
| 358 | + // We need to do this so we dont' TRASH the parent DTT. |
|
| 359 | + // (save the ID for both key and value to avoid duplications) |
|
| 360 | + $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
| 361 | + } else { |
|
| 362 | + $datetime = EE_Registry::instance()->load_class( |
|
| 363 | + 'Datetime', |
|
| 364 | + array( |
|
| 365 | + $datetime_values, |
|
| 366 | + $timezone, |
|
| 367 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
| 368 | + ), |
|
| 369 | + false, |
|
| 370 | + false |
|
| 371 | + ); |
|
| 372 | + foreach ($datetime_values as $field => $value) { |
|
| 373 | + $datetime->set($field, $value); |
|
| 374 | + } |
|
| 375 | + } |
|
| 376 | + $datetime->save(); |
|
| 377 | + $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
| 378 | + // before going any further make sure our dates are setup correctly |
|
| 379 | + // so that the end date is always equal or greater than the start date. |
|
| 380 | + if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
| 381 | + $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
| 382 | + $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
| 383 | + $datetime->save(); |
|
| 384 | + } |
|
| 385 | + // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
| 386 | + // because it is possible there was a new one created for the autosave. |
|
| 387 | + // (save the ID for both key and value to avoid duplications) |
|
| 388 | + $DTT_ID = $datetime->ID(); |
|
| 389 | + $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
| 390 | + $saved_dtt_objs[ $row ] = $datetime; |
|
| 391 | + // @todo if ANY of these updates fail then we want the appropriate global error message. |
|
| 392 | + } |
|
| 393 | + $event->save(); |
|
| 394 | + // now we need to REMOVE any datetimes that got deleted. |
|
| 395 | + // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
| 396 | + // So its safe to permanently delete at this point. |
|
| 397 | + $old_datetimes = explode(',', $data['datetime_IDs']); |
|
| 398 | + $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
| 399 | + if (is_array($old_datetimes)) { |
|
| 400 | + $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
| 401 | + foreach ($datetimes_to_delete as $id) { |
|
| 402 | + $id = absint($id); |
|
| 403 | + if (empty($id)) { |
|
| 404 | + continue; |
|
| 405 | + } |
|
| 406 | + $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
| 407 | + // remove tkt relationships. |
|
| 408 | + $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
| 409 | + foreach ($related_tickets as $tkt) { |
|
| 410 | + $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
| 411 | + } |
|
| 412 | + $event->_remove_relation_to($id, 'Datetime'); |
|
| 413 | + $dtt_to_remove->refresh_cache_of_related_objects(); |
|
| 414 | + } |
|
| 415 | + } |
|
| 416 | + return $saved_dtt_objs; |
|
| 417 | + } |
|
| 418 | 418 | |
| 419 | 419 | |
| 420 | - /** |
|
| 421 | - * update tickets |
|
| 422 | - * |
|
| 423 | - * @param EE_Event $event Event object being updated |
|
| 424 | - * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
| 425 | - * @param array $data incoming request data |
|
| 426 | - * @return EE_Ticket[] |
|
| 427 | - * @throws Exception |
|
| 428 | - * @throws ReflectionException |
|
| 429 | - * @throws InvalidInterfaceException |
|
| 430 | - * @throws InvalidDataTypeException |
|
| 431 | - * @throws InvalidArgumentException |
|
| 432 | - * @throws EE_Error |
|
| 433 | - */ |
|
| 434 | - protected function _update_tickets($event, $saved_datetimes, $data) |
|
| 435 | - { |
|
| 436 | - $new_tkt = null; |
|
| 437 | - $new_default = null; |
|
| 438 | - // stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
| 439 | - $data = stripslashes_deep($data); |
|
| 440 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 441 | - $saved_tickets = $datetimes_on_existing = array(); |
|
| 442 | - $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
| 443 | - if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) { |
|
| 444 | - throw new InvalidArgumentException( |
|
| 445 | - esc_html__( |
|
| 446 | - 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
| 447 | - 'event_espresso' |
|
| 448 | - ) |
|
| 449 | - ); |
|
| 450 | - } |
|
| 451 | - foreach ($data['edit_tickets'] as $row => $tkt) { |
|
| 452 | - $update_prices = $create_new_TKT = false; |
|
| 453 | - // figure out what datetimes were added to the ticket |
|
| 454 | - // and what datetimes were removed from the ticket in the session. |
|
| 455 | - $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
| 456 | - $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
| 457 | - $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
| 458 | - $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
| 459 | - // trim inputs to ensure any excess whitespace is removed. |
|
| 460 | - $tkt = array_map( |
|
| 461 | - function ($ticket_data) { |
|
| 462 | - return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
| 463 | - }, |
|
| 464 | - $tkt |
|
| 465 | - ); |
|
| 466 | - // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
| 467 | - // because we're doing calculations prior to using the models. |
|
| 468 | - // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
| 469 | - $ticket_price = isset($tkt['TKT_price']) |
|
| 470 | - ? round((float) $tkt['TKT_price'], 3) |
|
| 471 | - : 0; |
|
| 472 | - // note incoming base price needs converted from localized value. |
|
| 473 | - $base_price = isset($tkt['TKT_base_price']) |
|
| 474 | - ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
| 475 | - : 0; |
|
| 476 | - // if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
| 477 | - $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
| 478 | - ? $base_price |
|
| 479 | - : $ticket_price; |
|
| 480 | - $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
| 481 | - ? $tkt['TKT_base_price_ID'] |
|
| 482 | - : 0; |
|
| 483 | - $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
| 484 | - ? $data['edit_prices'][ $row ] |
|
| 485 | - : array(); |
|
| 486 | - $now = null; |
|
| 487 | - if (empty($tkt['TKT_start_date'])) { |
|
| 488 | - // lets' use now in the set timezone. |
|
| 489 | - $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
| 490 | - $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
| 491 | - } |
|
| 492 | - if (empty($tkt['TKT_end_date'])) { |
|
| 493 | - /** |
|
| 494 | - * set the TKT_end_date to the first datetime attached to the ticket. |
|
| 495 | - */ |
|
| 496 | - $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
| 497 | - $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
| 498 | - } |
|
| 499 | - $TKT_values = array( |
|
| 500 | - 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
| 501 | - 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
| 502 | - 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
| 503 | - 'TKT_description' => ! empty($tkt['TKT_description']) |
|
| 504 | - && $tkt['TKT_description'] !== esc_html__( |
|
| 505 | - 'You can modify this description', |
|
| 506 | - 'event_espresso' |
|
| 507 | - ) |
|
| 508 | - ? $tkt['TKT_description'] |
|
| 509 | - : '', |
|
| 510 | - 'TKT_start_date' => $tkt['TKT_start_date'], |
|
| 511 | - 'TKT_end_date' => $tkt['TKT_end_date'], |
|
| 512 | - 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
| 513 | - ? EE_INF |
|
| 514 | - : $tkt['TKT_qty'], |
|
| 515 | - 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
| 516 | - ? EE_INF |
|
| 517 | - : $tkt['TKT_uses'], |
|
| 518 | - 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
| 519 | - 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
| 520 | - 'TKT_row' => $row, |
|
| 521 | - 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
| 522 | - 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
| 523 | - 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
| 524 | - 'TKT_price' => $ticket_price, |
|
| 525 | - ); |
|
| 526 | - // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
| 527 | - // which means in turn that the prices will become new prices as well. |
|
| 528 | - if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
| 529 | - $TKT_values['TKT_ID'] = 0; |
|
| 530 | - $TKT_values['TKT_is_default'] = 0; |
|
| 531 | - $update_prices = true; |
|
| 532 | - } |
|
| 533 | - // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
| 534 | - // we actually do our saves ahead of doing any add_relations to |
|
| 535 | - // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
| 536 | - // but DID have it's items modified. |
|
| 537 | - // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
| 538 | - // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
| 539 | - if (absint($TKT_values['TKT_ID'])) { |
|
| 540 | - $ticket = EE_Registry::instance() |
|
| 541 | - ->load_model('Ticket', array($timezone)) |
|
| 542 | - ->get_one_by_ID($tkt['TKT_ID']); |
|
| 543 | - if ($ticket instanceof EE_Ticket) { |
|
| 544 | - $ticket = $this->_update_ticket_datetimes( |
|
| 545 | - $ticket, |
|
| 546 | - $saved_datetimes, |
|
| 547 | - $datetimes_added, |
|
| 548 | - $datetimes_removed |
|
| 549 | - ); |
|
| 550 | - // are there any registrations using this ticket ? |
|
| 551 | - $tickets_sold = $ticket->count_related( |
|
| 552 | - 'Registration', |
|
| 553 | - array( |
|
| 554 | - array( |
|
| 555 | - 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
| 556 | - ), |
|
| 557 | - ) |
|
| 558 | - ); |
|
| 559 | - // set ticket formats |
|
| 560 | - $ticket->set_date_format($this->_date_format_strings['date']); |
|
| 561 | - $ticket->set_time_format($this->_date_format_strings['time']); |
|
| 562 | - // let's just check the total price for the existing ticket |
|
| 563 | - // and determine if it matches the new total price. |
|
| 564 | - // if they are different then we create a new ticket (if tickets sold) |
|
| 565 | - // if they aren't different then we go ahead and modify existing ticket. |
|
| 566 | - $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
| 567 | - // set new values |
|
| 568 | - foreach ($TKT_values as $field => $value) { |
|
| 569 | - if ($field === 'TKT_qty') { |
|
| 570 | - $ticket->set_qty($value); |
|
| 571 | - } else { |
|
| 572 | - $ticket->set($field, $value); |
|
| 573 | - } |
|
| 574 | - } |
|
| 575 | - // if $create_new_TKT is false then we can safely update the existing ticket. |
|
| 576 | - // Otherwise we have to create a new ticket. |
|
| 577 | - if ($create_new_TKT) { |
|
| 578 | - $new_tkt = $this->_duplicate_ticket( |
|
| 579 | - $ticket, |
|
| 580 | - $price_rows, |
|
| 581 | - $ticket_price, |
|
| 582 | - $base_price, |
|
| 583 | - $base_price_id |
|
| 584 | - ); |
|
| 585 | - } |
|
| 586 | - } |
|
| 587 | - } else { |
|
| 588 | - // no TKT_id so a new TKT |
|
| 589 | - $ticket = EE_Ticket::new_instance( |
|
| 590 | - $TKT_values, |
|
| 591 | - $timezone, |
|
| 592 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
| 593 | - ); |
|
| 594 | - if ($ticket instanceof EE_Ticket) { |
|
| 595 | - // make sure ticket has an ID of setting relations won't work |
|
| 596 | - $ticket->save(); |
|
| 597 | - $ticket = $this->_update_ticket_datetimes( |
|
| 598 | - $ticket, |
|
| 599 | - $saved_datetimes, |
|
| 600 | - $datetimes_added, |
|
| 601 | - $datetimes_removed |
|
| 602 | - ); |
|
| 603 | - $update_prices = true; |
|
| 604 | - } |
|
| 605 | - } |
|
| 606 | - // make sure any current values have been saved. |
|
| 607 | - // $ticket->save(); |
|
| 608 | - // before going any further make sure our dates are setup correctly |
|
| 609 | - // so that the end date is always equal or greater than the start date. |
|
| 610 | - if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
| 611 | - $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
| 612 | - $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
| 613 | - } |
|
| 614 | - // let's make sure the base price is handled |
|
| 615 | - $ticket = ! $create_new_TKT |
|
| 616 | - ? $this->_add_prices_to_ticket( |
|
| 617 | - array(), |
|
| 618 | - $ticket, |
|
| 619 | - $update_prices, |
|
| 620 | - $base_price, |
|
| 621 | - $base_price_id |
|
| 622 | - ) |
|
| 623 | - : $ticket; |
|
| 624 | - // add/update price_modifiers |
|
| 625 | - $ticket = ! $create_new_TKT |
|
| 626 | - ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) |
|
| 627 | - : $ticket; |
|
| 628 | - // need to make sue that the TKT_price is accurate after saving the prices. |
|
| 629 | - $ticket->ensure_TKT_Price_correct(); |
|
| 630 | - // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
| 631 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 632 | - $update_prices = true; |
|
| 633 | - $new_default = clone $ticket; |
|
| 634 | - $new_default->set('TKT_ID', 0); |
|
| 635 | - $new_default->set('TKT_is_default', 1); |
|
| 636 | - $new_default->set('TKT_row', 1); |
|
| 637 | - $new_default->set('TKT_price', $ticket_price); |
|
| 638 | - // remove any dtt relations cause we DON'T want dtt relations attached |
|
| 639 | - // (note this is just removing the cached relations in the object) |
|
| 640 | - $new_default->_remove_relations('Datetime'); |
|
| 641 | - // @todo we need to add the current attached prices as new prices to the new default ticket. |
|
| 642 | - $new_default = $this->_add_prices_to_ticket( |
|
| 643 | - $price_rows, |
|
| 644 | - $new_default, |
|
| 645 | - $update_prices |
|
| 646 | - ); |
|
| 647 | - // don't forget the base price! |
|
| 648 | - $new_default = $this->_add_prices_to_ticket( |
|
| 649 | - array(), |
|
| 650 | - $new_default, |
|
| 651 | - $update_prices, |
|
| 652 | - $base_price, |
|
| 653 | - $base_price_id |
|
| 654 | - ); |
|
| 655 | - $new_default->save(); |
|
| 656 | - do_action( |
|
| 657 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
| 658 | - $new_default, |
|
| 659 | - $row, |
|
| 660 | - $ticket, |
|
| 661 | - $data |
|
| 662 | - ); |
|
| 663 | - } |
|
| 664 | - // DO ALL dtt relationships for both current tickets and any archived tickets |
|
| 665 | - // for the given dtt that are related to the current ticket. |
|
| 666 | - // TODO... not sure exactly how we're going to do this considering we don't know |
|
| 667 | - // what current ticket the archived tickets are related to |
|
| 668 | - // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
| 669 | - // let's assign any tickets that have been setup to the saved_tickets tracker |
|
| 670 | - // save existing TKT |
|
| 671 | - $ticket->save(); |
|
| 672 | - if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
| 673 | - // save new TKT |
|
| 674 | - $new_tkt->save(); |
|
| 675 | - // add new ticket to array |
|
| 676 | - $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
| 677 | - do_action( |
|
| 678 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
| 679 | - $new_tkt, |
|
| 680 | - $row, |
|
| 681 | - $tkt, |
|
| 682 | - $data |
|
| 683 | - ); |
|
| 684 | - } else { |
|
| 685 | - // add tkt to saved tkts |
|
| 686 | - $saved_tickets[ $ticket->ID() ] = $ticket; |
|
| 687 | - do_action( |
|
| 688 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
| 689 | - $ticket, |
|
| 690 | - $row, |
|
| 691 | - $tkt, |
|
| 692 | - $data |
|
| 693 | - ); |
|
| 694 | - } |
|
| 695 | - } |
|
| 696 | - // now we need to handle tickets actually "deleted permanently". |
|
| 697 | - // There are cases where we'd want this to happen |
|
| 698 | - // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
| 699 | - // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
| 700 | - // No sense in keeping all the related data in the db! |
|
| 701 | - $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
| 702 | - $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
| 703 | - foreach ($tickets_removed as $id) { |
|
| 704 | - $id = absint($id); |
|
| 705 | - // get the ticket for this id |
|
| 706 | - $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
| 707 | - // if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
| 708 | - if ($tkt_to_remove->get('TKT_is_default')) { |
|
| 709 | - continue; |
|
| 710 | - } |
|
| 711 | - // if this tkt has any registrations attached so then we just ARCHIVE |
|
| 712 | - // because we don't actually permanently delete these tickets. |
|
| 713 | - if ($tkt_to_remove->count_related('Registration') > 0) { |
|
| 714 | - $tkt_to_remove->delete(); |
|
| 715 | - continue; |
|
| 716 | - } |
|
| 717 | - // need to get all the related datetimes on this ticket and remove from every single one of them |
|
| 718 | - // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
| 719 | - $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
| 720 | - foreach ($datetimes as $datetime) { |
|
| 721 | - $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
| 722 | - } |
|
| 723 | - // need to do the same for prices (except these prices can also be deleted because again, |
|
| 724 | - // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
| 725 | - $tkt_to_remove->delete_related_permanently('Price'); |
|
| 726 | - do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
| 727 | - // finally let's delete this ticket |
|
| 728 | - // (which should not be blocked at this point b/c we've removed all our relationships) |
|
| 729 | - $tkt_to_remove->delete_permanently(); |
|
| 730 | - } |
|
| 731 | - return $saved_tickets; |
|
| 732 | - } |
|
| 420 | + /** |
|
| 421 | + * update tickets |
|
| 422 | + * |
|
| 423 | + * @param EE_Event $event Event object being updated |
|
| 424 | + * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
| 425 | + * @param array $data incoming request data |
|
| 426 | + * @return EE_Ticket[] |
|
| 427 | + * @throws Exception |
|
| 428 | + * @throws ReflectionException |
|
| 429 | + * @throws InvalidInterfaceException |
|
| 430 | + * @throws InvalidDataTypeException |
|
| 431 | + * @throws InvalidArgumentException |
|
| 432 | + * @throws EE_Error |
|
| 433 | + */ |
|
| 434 | + protected function _update_tickets($event, $saved_datetimes, $data) |
|
| 435 | + { |
|
| 436 | + $new_tkt = null; |
|
| 437 | + $new_default = null; |
|
| 438 | + // stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
| 439 | + $data = stripslashes_deep($data); |
|
| 440 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 441 | + $saved_tickets = $datetimes_on_existing = array(); |
|
| 442 | + $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
| 443 | + if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) { |
|
| 444 | + throw new InvalidArgumentException( |
|
| 445 | + esc_html__( |
|
| 446 | + 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
| 447 | + 'event_espresso' |
|
| 448 | + ) |
|
| 449 | + ); |
|
| 450 | + } |
|
| 451 | + foreach ($data['edit_tickets'] as $row => $tkt) { |
|
| 452 | + $update_prices = $create_new_TKT = false; |
|
| 453 | + // figure out what datetimes were added to the ticket |
|
| 454 | + // and what datetimes were removed from the ticket in the session. |
|
| 455 | + $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
| 456 | + $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
| 457 | + $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
| 458 | + $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
| 459 | + // trim inputs to ensure any excess whitespace is removed. |
|
| 460 | + $tkt = array_map( |
|
| 461 | + function ($ticket_data) { |
|
| 462 | + return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
| 463 | + }, |
|
| 464 | + $tkt |
|
| 465 | + ); |
|
| 466 | + // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
| 467 | + // because we're doing calculations prior to using the models. |
|
| 468 | + // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
| 469 | + $ticket_price = isset($tkt['TKT_price']) |
|
| 470 | + ? round((float) $tkt['TKT_price'], 3) |
|
| 471 | + : 0; |
|
| 472 | + // note incoming base price needs converted from localized value. |
|
| 473 | + $base_price = isset($tkt['TKT_base_price']) |
|
| 474 | + ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
| 475 | + : 0; |
|
| 476 | + // if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
| 477 | + $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
| 478 | + ? $base_price |
|
| 479 | + : $ticket_price; |
|
| 480 | + $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
| 481 | + ? $tkt['TKT_base_price_ID'] |
|
| 482 | + : 0; |
|
| 483 | + $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
| 484 | + ? $data['edit_prices'][ $row ] |
|
| 485 | + : array(); |
|
| 486 | + $now = null; |
|
| 487 | + if (empty($tkt['TKT_start_date'])) { |
|
| 488 | + // lets' use now in the set timezone. |
|
| 489 | + $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
| 490 | + $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
| 491 | + } |
|
| 492 | + if (empty($tkt['TKT_end_date'])) { |
|
| 493 | + /** |
|
| 494 | + * set the TKT_end_date to the first datetime attached to the ticket. |
|
| 495 | + */ |
|
| 496 | + $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
| 497 | + $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
| 498 | + } |
|
| 499 | + $TKT_values = array( |
|
| 500 | + 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
| 501 | + 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
| 502 | + 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
| 503 | + 'TKT_description' => ! empty($tkt['TKT_description']) |
|
| 504 | + && $tkt['TKT_description'] !== esc_html__( |
|
| 505 | + 'You can modify this description', |
|
| 506 | + 'event_espresso' |
|
| 507 | + ) |
|
| 508 | + ? $tkt['TKT_description'] |
|
| 509 | + : '', |
|
| 510 | + 'TKT_start_date' => $tkt['TKT_start_date'], |
|
| 511 | + 'TKT_end_date' => $tkt['TKT_end_date'], |
|
| 512 | + 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
| 513 | + ? EE_INF |
|
| 514 | + : $tkt['TKT_qty'], |
|
| 515 | + 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
| 516 | + ? EE_INF |
|
| 517 | + : $tkt['TKT_uses'], |
|
| 518 | + 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
| 519 | + 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
| 520 | + 'TKT_row' => $row, |
|
| 521 | + 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
| 522 | + 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
| 523 | + 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
| 524 | + 'TKT_price' => $ticket_price, |
|
| 525 | + ); |
|
| 526 | + // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
| 527 | + // which means in turn that the prices will become new prices as well. |
|
| 528 | + if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
| 529 | + $TKT_values['TKT_ID'] = 0; |
|
| 530 | + $TKT_values['TKT_is_default'] = 0; |
|
| 531 | + $update_prices = true; |
|
| 532 | + } |
|
| 533 | + // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
| 534 | + // we actually do our saves ahead of doing any add_relations to |
|
| 535 | + // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
| 536 | + // but DID have it's items modified. |
|
| 537 | + // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
| 538 | + // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
| 539 | + if (absint($TKT_values['TKT_ID'])) { |
|
| 540 | + $ticket = EE_Registry::instance() |
|
| 541 | + ->load_model('Ticket', array($timezone)) |
|
| 542 | + ->get_one_by_ID($tkt['TKT_ID']); |
|
| 543 | + if ($ticket instanceof EE_Ticket) { |
|
| 544 | + $ticket = $this->_update_ticket_datetimes( |
|
| 545 | + $ticket, |
|
| 546 | + $saved_datetimes, |
|
| 547 | + $datetimes_added, |
|
| 548 | + $datetimes_removed |
|
| 549 | + ); |
|
| 550 | + // are there any registrations using this ticket ? |
|
| 551 | + $tickets_sold = $ticket->count_related( |
|
| 552 | + 'Registration', |
|
| 553 | + array( |
|
| 554 | + array( |
|
| 555 | + 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
| 556 | + ), |
|
| 557 | + ) |
|
| 558 | + ); |
|
| 559 | + // set ticket formats |
|
| 560 | + $ticket->set_date_format($this->_date_format_strings['date']); |
|
| 561 | + $ticket->set_time_format($this->_date_format_strings['time']); |
|
| 562 | + // let's just check the total price for the existing ticket |
|
| 563 | + // and determine if it matches the new total price. |
|
| 564 | + // if they are different then we create a new ticket (if tickets sold) |
|
| 565 | + // if they aren't different then we go ahead and modify existing ticket. |
|
| 566 | + $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
| 567 | + // set new values |
|
| 568 | + foreach ($TKT_values as $field => $value) { |
|
| 569 | + if ($field === 'TKT_qty') { |
|
| 570 | + $ticket->set_qty($value); |
|
| 571 | + } else { |
|
| 572 | + $ticket->set($field, $value); |
|
| 573 | + } |
|
| 574 | + } |
|
| 575 | + // if $create_new_TKT is false then we can safely update the existing ticket. |
|
| 576 | + // Otherwise we have to create a new ticket. |
|
| 577 | + if ($create_new_TKT) { |
|
| 578 | + $new_tkt = $this->_duplicate_ticket( |
|
| 579 | + $ticket, |
|
| 580 | + $price_rows, |
|
| 581 | + $ticket_price, |
|
| 582 | + $base_price, |
|
| 583 | + $base_price_id |
|
| 584 | + ); |
|
| 585 | + } |
|
| 586 | + } |
|
| 587 | + } else { |
|
| 588 | + // no TKT_id so a new TKT |
|
| 589 | + $ticket = EE_Ticket::new_instance( |
|
| 590 | + $TKT_values, |
|
| 591 | + $timezone, |
|
| 592 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
| 593 | + ); |
|
| 594 | + if ($ticket instanceof EE_Ticket) { |
|
| 595 | + // make sure ticket has an ID of setting relations won't work |
|
| 596 | + $ticket->save(); |
|
| 597 | + $ticket = $this->_update_ticket_datetimes( |
|
| 598 | + $ticket, |
|
| 599 | + $saved_datetimes, |
|
| 600 | + $datetimes_added, |
|
| 601 | + $datetimes_removed |
|
| 602 | + ); |
|
| 603 | + $update_prices = true; |
|
| 604 | + } |
|
| 605 | + } |
|
| 606 | + // make sure any current values have been saved. |
|
| 607 | + // $ticket->save(); |
|
| 608 | + // before going any further make sure our dates are setup correctly |
|
| 609 | + // so that the end date is always equal or greater than the start date. |
|
| 610 | + if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
| 611 | + $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
| 612 | + $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
| 613 | + } |
|
| 614 | + // let's make sure the base price is handled |
|
| 615 | + $ticket = ! $create_new_TKT |
|
| 616 | + ? $this->_add_prices_to_ticket( |
|
| 617 | + array(), |
|
| 618 | + $ticket, |
|
| 619 | + $update_prices, |
|
| 620 | + $base_price, |
|
| 621 | + $base_price_id |
|
| 622 | + ) |
|
| 623 | + : $ticket; |
|
| 624 | + // add/update price_modifiers |
|
| 625 | + $ticket = ! $create_new_TKT |
|
| 626 | + ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) |
|
| 627 | + : $ticket; |
|
| 628 | + // need to make sue that the TKT_price is accurate after saving the prices. |
|
| 629 | + $ticket->ensure_TKT_Price_correct(); |
|
| 630 | + // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
| 631 | + if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 632 | + $update_prices = true; |
|
| 633 | + $new_default = clone $ticket; |
|
| 634 | + $new_default->set('TKT_ID', 0); |
|
| 635 | + $new_default->set('TKT_is_default', 1); |
|
| 636 | + $new_default->set('TKT_row', 1); |
|
| 637 | + $new_default->set('TKT_price', $ticket_price); |
|
| 638 | + // remove any dtt relations cause we DON'T want dtt relations attached |
|
| 639 | + // (note this is just removing the cached relations in the object) |
|
| 640 | + $new_default->_remove_relations('Datetime'); |
|
| 641 | + // @todo we need to add the current attached prices as new prices to the new default ticket. |
|
| 642 | + $new_default = $this->_add_prices_to_ticket( |
|
| 643 | + $price_rows, |
|
| 644 | + $new_default, |
|
| 645 | + $update_prices |
|
| 646 | + ); |
|
| 647 | + // don't forget the base price! |
|
| 648 | + $new_default = $this->_add_prices_to_ticket( |
|
| 649 | + array(), |
|
| 650 | + $new_default, |
|
| 651 | + $update_prices, |
|
| 652 | + $base_price, |
|
| 653 | + $base_price_id |
|
| 654 | + ); |
|
| 655 | + $new_default->save(); |
|
| 656 | + do_action( |
|
| 657 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
| 658 | + $new_default, |
|
| 659 | + $row, |
|
| 660 | + $ticket, |
|
| 661 | + $data |
|
| 662 | + ); |
|
| 663 | + } |
|
| 664 | + // DO ALL dtt relationships for both current tickets and any archived tickets |
|
| 665 | + // for the given dtt that are related to the current ticket. |
|
| 666 | + // TODO... not sure exactly how we're going to do this considering we don't know |
|
| 667 | + // what current ticket the archived tickets are related to |
|
| 668 | + // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
| 669 | + // let's assign any tickets that have been setup to the saved_tickets tracker |
|
| 670 | + // save existing TKT |
|
| 671 | + $ticket->save(); |
|
| 672 | + if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
| 673 | + // save new TKT |
|
| 674 | + $new_tkt->save(); |
|
| 675 | + // add new ticket to array |
|
| 676 | + $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
| 677 | + do_action( |
|
| 678 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
| 679 | + $new_tkt, |
|
| 680 | + $row, |
|
| 681 | + $tkt, |
|
| 682 | + $data |
|
| 683 | + ); |
|
| 684 | + } else { |
|
| 685 | + // add tkt to saved tkts |
|
| 686 | + $saved_tickets[ $ticket->ID() ] = $ticket; |
|
| 687 | + do_action( |
|
| 688 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
| 689 | + $ticket, |
|
| 690 | + $row, |
|
| 691 | + $tkt, |
|
| 692 | + $data |
|
| 693 | + ); |
|
| 694 | + } |
|
| 695 | + } |
|
| 696 | + // now we need to handle tickets actually "deleted permanently". |
|
| 697 | + // There are cases where we'd want this to happen |
|
| 698 | + // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
| 699 | + // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
| 700 | + // No sense in keeping all the related data in the db! |
|
| 701 | + $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
| 702 | + $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
| 703 | + foreach ($tickets_removed as $id) { |
|
| 704 | + $id = absint($id); |
|
| 705 | + // get the ticket for this id |
|
| 706 | + $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
| 707 | + // if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
| 708 | + if ($tkt_to_remove->get('TKT_is_default')) { |
|
| 709 | + continue; |
|
| 710 | + } |
|
| 711 | + // if this tkt has any registrations attached so then we just ARCHIVE |
|
| 712 | + // because we don't actually permanently delete these tickets. |
|
| 713 | + if ($tkt_to_remove->count_related('Registration') > 0) { |
|
| 714 | + $tkt_to_remove->delete(); |
|
| 715 | + continue; |
|
| 716 | + } |
|
| 717 | + // need to get all the related datetimes on this ticket and remove from every single one of them |
|
| 718 | + // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
| 719 | + $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
| 720 | + foreach ($datetimes as $datetime) { |
|
| 721 | + $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
| 722 | + } |
|
| 723 | + // need to do the same for prices (except these prices can also be deleted because again, |
|
| 724 | + // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
| 725 | + $tkt_to_remove->delete_related_permanently('Price'); |
|
| 726 | + do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
| 727 | + // finally let's delete this ticket |
|
| 728 | + // (which should not be blocked at this point b/c we've removed all our relationships) |
|
| 729 | + $tkt_to_remove->delete_permanently(); |
|
| 730 | + } |
|
| 731 | + return $saved_tickets; |
|
| 732 | + } |
|
| 733 | 733 | |
| 734 | 734 | |
| 735 | - /** |
|
| 736 | - * @access protected |
|
| 737 | - * @param EE_Ticket $ticket |
|
| 738 | - * @param \EE_Datetime[] $saved_datetimes |
|
| 739 | - * @param \EE_Datetime[] $added_datetimes |
|
| 740 | - * @param \EE_Datetime[] $removed_datetimes |
|
| 741 | - * @return EE_Ticket |
|
| 742 | - * @throws EE_Error |
|
| 743 | - */ |
|
| 744 | - protected function _update_ticket_datetimes( |
|
| 745 | - EE_Ticket $ticket, |
|
| 746 | - $saved_datetimes = array(), |
|
| 747 | - $added_datetimes = array(), |
|
| 748 | - $removed_datetimes = array() |
|
| 749 | - ) { |
|
| 750 | - // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
| 751 | - // and removing the ticket from datetimes it got removed from. |
|
| 752 | - // first let's add datetimes |
|
| 753 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 754 | - foreach ($added_datetimes as $row_id) { |
|
| 755 | - $row_id = (int) $row_id; |
|
| 756 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 757 | - $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 758 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 759 | - // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
| 760 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 761 | - $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
| 762 | - $saved_datetimes[ $row_id ]->save(); |
|
| 763 | - } |
|
| 764 | - } |
|
| 765 | - } |
|
| 766 | - } |
|
| 767 | - // then remove datetimes |
|
| 768 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 769 | - foreach ($removed_datetimes as $row_id) { |
|
| 770 | - $row_id = (int) $row_id; |
|
| 771 | - // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
| 772 | - // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
| 773 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 774 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 775 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 776 | - // If so, then we need to remove it's sold from the DTT_sold. |
|
| 777 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 778 | - $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
| 779 | - $saved_datetimes[ $row_id ]->save(); |
|
| 780 | - } |
|
| 781 | - } |
|
| 782 | - } |
|
| 783 | - } |
|
| 784 | - // cap ticket qty by datetime reg limits |
|
| 785 | - $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
| 786 | - return $ticket; |
|
| 787 | - } |
|
| 735 | + /** |
|
| 736 | + * @access protected |
|
| 737 | + * @param EE_Ticket $ticket |
|
| 738 | + * @param \EE_Datetime[] $saved_datetimes |
|
| 739 | + * @param \EE_Datetime[] $added_datetimes |
|
| 740 | + * @param \EE_Datetime[] $removed_datetimes |
|
| 741 | + * @return EE_Ticket |
|
| 742 | + * @throws EE_Error |
|
| 743 | + */ |
|
| 744 | + protected function _update_ticket_datetimes( |
|
| 745 | + EE_Ticket $ticket, |
|
| 746 | + $saved_datetimes = array(), |
|
| 747 | + $added_datetimes = array(), |
|
| 748 | + $removed_datetimes = array() |
|
| 749 | + ) { |
|
| 750 | + // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
| 751 | + // and removing the ticket from datetimes it got removed from. |
|
| 752 | + // first let's add datetimes |
|
| 753 | + if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 754 | + foreach ($added_datetimes as $row_id) { |
|
| 755 | + $row_id = (int) $row_id; |
|
| 756 | + if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 757 | + $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 758 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 759 | + // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
| 760 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 761 | + $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
| 762 | + $saved_datetimes[ $row_id ]->save(); |
|
| 763 | + } |
|
| 764 | + } |
|
| 765 | + } |
|
| 766 | + } |
|
| 767 | + // then remove datetimes |
|
| 768 | + if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 769 | + foreach ($removed_datetimes as $row_id) { |
|
| 770 | + $row_id = (int) $row_id; |
|
| 771 | + // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
| 772 | + // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
| 773 | + if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 774 | + $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 775 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 776 | + // If so, then we need to remove it's sold from the DTT_sold. |
|
| 777 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 778 | + $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
| 779 | + $saved_datetimes[ $row_id ]->save(); |
|
| 780 | + } |
|
| 781 | + } |
|
| 782 | + } |
|
| 783 | + } |
|
| 784 | + // cap ticket qty by datetime reg limits |
|
| 785 | + $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
| 786 | + return $ticket; |
|
| 787 | + } |
|
| 788 | 788 | |
| 789 | 789 | |
| 790 | - /** |
|
| 791 | - * @access protected |
|
| 792 | - * @param EE_Ticket $ticket |
|
| 793 | - * @param array $price_rows |
|
| 794 | - * @param int $ticket_price |
|
| 795 | - * @param int $base_price |
|
| 796 | - * @param int $base_price_id |
|
| 797 | - * @return EE_Ticket |
|
| 798 | - * @throws ReflectionException |
|
| 799 | - * @throws InvalidArgumentException |
|
| 800 | - * @throws InvalidInterfaceException |
|
| 801 | - * @throws InvalidDataTypeException |
|
| 802 | - * @throws EE_Error |
|
| 803 | - */ |
|
| 804 | - protected function _duplicate_ticket( |
|
| 805 | - EE_Ticket $ticket, |
|
| 806 | - $price_rows = array(), |
|
| 807 | - $ticket_price = 0, |
|
| 808 | - $base_price = 0, |
|
| 809 | - $base_price_id = 0 |
|
| 810 | - ) { |
|
| 811 | - // create new ticket that's a copy of the existing |
|
| 812 | - // except a new id of course (and not archived) |
|
| 813 | - // AND has the new TKT_price associated with it. |
|
| 814 | - $new_ticket = clone $ticket; |
|
| 815 | - $new_ticket->set('TKT_ID', 0); |
|
| 816 | - $new_ticket->set_deleted(0); |
|
| 817 | - $new_ticket->set_price($ticket_price); |
|
| 818 | - $new_ticket->set_sold(0); |
|
| 819 | - // let's get a new ID for this ticket |
|
| 820 | - $new_ticket->save(); |
|
| 821 | - // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
| 822 | - $datetimes_on_existing = $ticket->datetimes(); |
|
| 823 | - $new_ticket = $this->_update_ticket_datetimes( |
|
| 824 | - $new_ticket, |
|
| 825 | - $datetimes_on_existing, |
|
| 826 | - array_keys($datetimes_on_existing) |
|
| 827 | - ); |
|
| 828 | - // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
| 829 | - // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
| 830 | - // available. |
|
| 831 | - if ($ticket->sold() > 0) { |
|
| 832 | - $new_qty = $ticket->qty() - $ticket->sold(); |
|
| 833 | - $new_ticket->set_qty($new_qty); |
|
| 834 | - } |
|
| 835 | - // now we update the prices just for this ticket |
|
| 836 | - $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
| 837 | - // and we update the base price |
|
| 838 | - $new_ticket = $this->_add_prices_to_ticket( |
|
| 839 | - array(), |
|
| 840 | - $new_ticket, |
|
| 841 | - true, |
|
| 842 | - $base_price, |
|
| 843 | - $base_price_id |
|
| 844 | - ); |
|
| 845 | - return $new_ticket; |
|
| 846 | - } |
|
| 790 | + /** |
|
| 791 | + * @access protected |
|
| 792 | + * @param EE_Ticket $ticket |
|
| 793 | + * @param array $price_rows |
|
| 794 | + * @param int $ticket_price |
|
| 795 | + * @param int $base_price |
|
| 796 | + * @param int $base_price_id |
|
| 797 | + * @return EE_Ticket |
|
| 798 | + * @throws ReflectionException |
|
| 799 | + * @throws InvalidArgumentException |
|
| 800 | + * @throws InvalidInterfaceException |
|
| 801 | + * @throws InvalidDataTypeException |
|
| 802 | + * @throws EE_Error |
|
| 803 | + */ |
|
| 804 | + protected function _duplicate_ticket( |
|
| 805 | + EE_Ticket $ticket, |
|
| 806 | + $price_rows = array(), |
|
| 807 | + $ticket_price = 0, |
|
| 808 | + $base_price = 0, |
|
| 809 | + $base_price_id = 0 |
|
| 810 | + ) { |
|
| 811 | + // create new ticket that's a copy of the existing |
|
| 812 | + // except a new id of course (and not archived) |
|
| 813 | + // AND has the new TKT_price associated with it. |
|
| 814 | + $new_ticket = clone $ticket; |
|
| 815 | + $new_ticket->set('TKT_ID', 0); |
|
| 816 | + $new_ticket->set_deleted(0); |
|
| 817 | + $new_ticket->set_price($ticket_price); |
|
| 818 | + $new_ticket->set_sold(0); |
|
| 819 | + // let's get a new ID for this ticket |
|
| 820 | + $new_ticket->save(); |
|
| 821 | + // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
| 822 | + $datetimes_on_existing = $ticket->datetimes(); |
|
| 823 | + $new_ticket = $this->_update_ticket_datetimes( |
|
| 824 | + $new_ticket, |
|
| 825 | + $datetimes_on_existing, |
|
| 826 | + array_keys($datetimes_on_existing) |
|
| 827 | + ); |
|
| 828 | + // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
| 829 | + // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
| 830 | + // available. |
|
| 831 | + if ($ticket->sold() > 0) { |
|
| 832 | + $new_qty = $ticket->qty() - $ticket->sold(); |
|
| 833 | + $new_ticket->set_qty($new_qty); |
|
| 834 | + } |
|
| 835 | + // now we update the prices just for this ticket |
|
| 836 | + $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
| 837 | + // and we update the base price |
|
| 838 | + $new_ticket = $this->_add_prices_to_ticket( |
|
| 839 | + array(), |
|
| 840 | + $new_ticket, |
|
| 841 | + true, |
|
| 842 | + $base_price, |
|
| 843 | + $base_price_id |
|
| 844 | + ); |
|
| 845 | + return $new_ticket; |
|
| 846 | + } |
|
| 847 | 847 | |
| 848 | 848 | |
| 849 | - /** |
|
| 850 | - * This attaches a list of given prices to a ticket. |
|
| 851 | - * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
| 852 | - * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
| 853 | - * price info and prices are automatically "archived" via the ticket. |
|
| 854 | - * |
|
| 855 | - * @access private |
|
| 856 | - * @param array $prices Array of prices from the form. |
|
| 857 | - * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
| 858 | - * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
| 859 | - * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
| 860 | - * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
| 861 | - * @return EE_Ticket |
|
| 862 | - * @throws ReflectionException |
|
| 863 | - * @throws InvalidArgumentException |
|
| 864 | - * @throws InvalidInterfaceException |
|
| 865 | - * @throws InvalidDataTypeException |
|
| 866 | - * @throws EE_Error |
|
| 867 | - */ |
|
| 868 | - protected function _add_prices_to_ticket( |
|
| 869 | - $prices = array(), |
|
| 870 | - EE_Ticket $ticket, |
|
| 871 | - $new_prices = false, |
|
| 872 | - $base_price = false, |
|
| 873 | - $base_price_id = false |
|
| 874 | - ) { |
|
| 875 | - // let's just get any current prices that may exist on the given ticket |
|
| 876 | - // so we can remove any prices that got trashed in this session. |
|
| 877 | - $current_prices_on_ticket = $base_price !== false |
|
| 878 | - ? $ticket->base_price(true) |
|
| 879 | - : $ticket->price_modifiers(); |
|
| 880 | - $updated_prices = array(); |
|
| 881 | - // if $base_price ! FALSE then updating a base price. |
|
| 882 | - if ($base_price !== false) { |
|
| 883 | - $prices[1] = array( |
|
| 884 | - 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
| 885 | - 'PRT_ID' => 1, |
|
| 886 | - 'PRC_amount' => $base_price, |
|
| 887 | - 'PRC_name' => $ticket->get('TKT_name'), |
|
| 888 | - 'PRC_desc' => $ticket->get('TKT_description'), |
|
| 889 | - ); |
|
| 890 | - } |
|
| 891 | - // possibly need to save tkt |
|
| 892 | - if (! $ticket->ID()) { |
|
| 893 | - $ticket->save(); |
|
| 894 | - } |
|
| 895 | - foreach ($prices as $row => $prc) { |
|
| 896 | - $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
| 897 | - if (empty($prt_id)) { |
|
| 898 | - continue; |
|
| 899 | - } //prices MUST have a price type id. |
|
| 900 | - $PRC_values = array( |
|
| 901 | - 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
| 902 | - 'PRT_ID' => $prt_id, |
|
| 903 | - 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
| 904 | - 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
| 905 | - 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
| 906 | - 'PRC_is_default' => false, |
|
| 907 | - // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
| 908 | - 'PRC_order' => $row, |
|
| 909 | - ); |
|
| 910 | - if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
| 911 | - $PRC_values['PRC_ID'] = 0; |
|
| 912 | - $price = EE_Registry::instance()->load_class( |
|
| 913 | - 'Price', |
|
| 914 | - array($PRC_values), |
|
| 915 | - false, |
|
| 916 | - false |
|
| 917 | - ); |
|
| 918 | - } else { |
|
| 919 | - $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
| 920 | - // update this price with new values |
|
| 921 | - foreach ($PRC_values as $field => $value) { |
|
| 922 | - $price->set($field, $value); |
|
| 923 | - } |
|
| 924 | - } |
|
| 925 | - $price->save(); |
|
| 926 | - $updated_prices[ $price->ID() ] = $price; |
|
| 927 | - $ticket->_add_relation_to($price, 'Price'); |
|
| 928 | - } |
|
| 929 | - // now let's remove any prices that got removed from the ticket |
|
| 930 | - if (! empty($current_prices_on_ticket)) { |
|
| 931 | - $current = array_keys($current_prices_on_ticket); |
|
| 932 | - $updated = array_keys($updated_prices); |
|
| 933 | - $prices_to_remove = array_diff($current, $updated); |
|
| 934 | - if (! empty($prices_to_remove)) { |
|
| 935 | - foreach ($prices_to_remove as $prc_id) { |
|
| 936 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
| 937 | - $ticket->_remove_relation_to($p, 'Price'); |
|
| 938 | - // delete permanently the price |
|
| 939 | - $p->delete_permanently(); |
|
| 940 | - } |
|
| 941 | - } |
|
| 942 | - } |
|
| 943 | - return $ticket; |
|
| 944 | - } |
|
| 849 | + /** |
|
| 850 | + * This attaches a list of given prices to a ticket. |
|
| 851 | + * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
| 852 | + * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
| 853 | + * price info and prices are automatically "archived" via the ticket. |
|
| 854 | + * |
|
| 855 | + * @access private |
|
| 856 | + * @param array $prices Array of prices from the form. |
|
| 857 | + * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
| 858 | + * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
| 859 | + * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
| 860 | + * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
| 861 | + * @return EE_Ticket |
|
| 862 | + * @throws ReflectionException |
|
| 863 | + * @throws InvalidArgumentException |
|
| 864 | + * @throws InvalidInterfaceException |
|
| 865 | + * @throws InvalidDataTypeException |
|
| 866 | + * @throws EE_Error |
|
| 867 | + */ |
|
| 868 | + protected function _add_prices_to_ticket( |
|
| 869 | + $prices = array(), |
|
| 870 | + EE_Ticket $ticket, |
|
| 871 | + $new_prices = false, |
|
| 872 | + $base_price = false, |
|
| 873 | + $base_price_id = false |
|
| 874 | + ) { |
|
| 875 | + // let's just get any current prices that may exist on the given ticket |
|
| 876 | + // so we can remove any prices that got trashed in this session. |
|
| 877 | + $current_prices_on_ticket = $base_price !== false |
|
| 878 | + ? $ticket->base_price(true) |
|
| 879 | + : $ticket->price_modifiers(); |
|
| 880 | + $updated_prices = array(); |
|
| 881 | + // if $base_price ! FALSE then updating a base price. |
|
| 882 | + if ($base_price !== false) { |
|
| 883 | + $prices[1] = array( |
|
| 884 | + 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
| 885 | + 'PRT_ID' => 1, |
|
| 886 | + 'PRC_amount' => $base_price, |
|
| 887 | + 'PRC_name' => $ticket->get('TKT_name'), |
|
| 888 | + 'PRC_desc' => $ticket->get('TKT_description'), |
|
| 889 | + ); |
|
| 890 | + } |
|
| 891 | + // possibly need to save tkt |
|
| 892 | + if (! $ticket->ID()) { |
|
| 893 | + $ticket->save(); |
|
| 894 | + } |
|
| 895 | + foreach ($prices as $row => $prc) { |
|
| 896 | + $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
| 897 | + if (empty($prt_id)) { |
|
| 898 | + continue; |
|
| 899 | + } //prices MUST have a price type id. |
|
| 900 | + $PRC_values = array( |
|
| 901 | + 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
| 902 | + 'PRT_ID' => $prt_id, |
|
| 903 | + 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
| 904 | + 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
| 905 | + 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
| 906 | + 'PRC_is_default' => false, |
|
| 907 | + // make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
| 908 | + 'PRC_order' => $row, |
|
| 909 | + ); |
|
| 910 | + if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
| 911 | + $PRC_values['PRC_ID'] = 0; |
|
| 912 | + $price = EE_Registry::instance()->load_class( |
|
| 913 | + 'Price', |
|
| 914 | + array($PRC_values), |
|
| 915 | + false, |
|
| 916 | + false |
|
| 917 | + ); |
|
| 918 | + } else { |
|
| 919 | + $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
| 920 | + // update this price with new values |
|
| 921 | + foreach ($PRC_values as $field => $value) { |
|
| 922 | + $price->set($field, $value); |
|
| 923 | + } |
|
| 924 | + } |
|
| 925 | + $price->save(); |
|
| 926 | + $updated_prices[ $price->ID() ] = $price; |
|
| 927 | + $ticket->_add_relation_to($price, 'Price'); |
|
| 928 | + } |
|
| 929 | + // now let's remove any prices that got removed from the ticket |
|
| 930 | + if (! empty($current_prices_on_ticket)) { |
|
| 931 | + $current = array_keys($current_prices_on_ticket); |
|
| 932 | + $updated = array_keys($updated_prices); |
|
| 933 | + $prices_to_remove = array_diff($current, $updated); |
|
| 934 | + if (! empty($prices_to_remove)) { |
|
| 935 | + foreach ($prices_to_remove as $prc_id) { |
|
| 936 | + $p = $current_prices_on_ticket[ $prc_id ]; |
|
| 937 | + $ticket->_remove_relation_to($p, 'Price'); |
|
| 938 | + // delete permanently the price |
|
| 939 | + $p->delete_permanently(); |
|
| 940 | + } |
|
| 941 | + } |
|
| 942 | + } |
|
| 943 | + return $ticket; |
|
| 944 | + } |
|
| 945 | 945 | |
| 946 | 946 | |
| 947 | - /** |
|
| 948 | - * @param Events_Admin_Page $event_admin_obj |
|
| 949 | - * @return Events_Admin_Page |
|
| 950 | - */ |
|
| 951 | - public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
| 952 | - { |
|
| 953 | - return $event_admin_obj; |
|
| 954 | - // doing nothing for the moment. |
|
| 955 | - // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
| 956 | - // (use the set_template_args() method) |
|
| 957 | - /** |
|
| 958 | - * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
| 959 | - * 1. TKT_is_default_selector (visible) |
|
| 960 | - * 2. TKT_is_default (hidden) |
|
| 961 | - * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
| 962 | - * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
| 963 | - * this ticket to be saved as a default. |
|
| 964 | - * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
| 965 | - * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
| 966 | - * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
| 967 | - * the TKT HAS been saved as a default.. |
|
| 968 | - * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
| 969 | - * On Autosave: |
|
| 970 | - * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
| 971 | - * then set the TKT_is_default to false. |
|
| 972 | - * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
| 973 | - * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
| 974 | - * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
| 975 | - */ |
|
| 976 | - } |
|
| 947 | + /** |
|
| 948 | + * @param Events_Admin_Page $event_admin_obj |
|
| 949 | + * @return Events_Admin_Page |
|
| 950 | + */ |
|
| 951 | + public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
| 952 | + { |
|
| 953 | + return $event_admin_obj; |
|
| 954 | + // doing nothing for the moment. |
|
| 955 | + // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
| 956 | + // (use the set_template_args() method) |
|
| 957 | + /** |
|
| 958 | + * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
| 959 | + * 1. TKT_is_default_selector (visible) |
|
| 960 | + * 2. TKT_is_default (hidden) |
|
| 961 | + * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
| 962 | + * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
| 963 | + * this ticket to be saved as a default. |
|
| 964 | + * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
| 965 | + * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
| 966 | + * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
| 967 | + * the TKT HAS been saved as a default.. |
|
| 968 | + * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
| 969 | + * On Autosave: |
|
| 970 | + * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
| 971 | + * then set the TKT_is_default to false. |
|
| 972 | + * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
| 973 | + * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
| 974 | + * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
| 975 | + */ |
|
| 976 | + } |
|
| 977 | 977 | |
| 978 | 978 | |
| 979 | - /** |
|
| 980 | - * @throws ReflectionException |
|
| 981 | - * @throws InvalidArgumentException |
|
| 982 | - * @throws InvalidInterfaceException |
|
| 983 | - * @throws InvalidDataTypeException |
|
| 984 | - * @throws DomainException |
|
| 985 | - * @throws EE_Error |
|
| 986 | - */ |
|
| 987 | - public function pricing_metabox() |
|
| 988 | - { |
|
| 989 | - $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
| 990 | - $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
| 991 | - // set is_creating_event property. |
|
| 992 | - $EVT_ID = $event->ID(); |
|
| 993 | - $this->_is_creating_event = empty($this->_req_data['post']); |
|
| 994 | - // default main template args |
|
| 995 | - $main_template_args = array( |
|
| 996 | - 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
| 997 | - 'event_editor_event_datetimes_help_tab', |
|
| 998 | - $this->_adminpage_obj->page_slug, |
|
| 999 | - $this->_adminpage_obj->get_req_action(), |
|
| 1000 | - false, |
|
| 1001 | - false |
|
| 1002 | - ), |
|
| 1003 | - // todo need to add a filter to the template for the help text |
|
| 1004 | - // in the Events_Admin_Page core file so we can add further help |
|
| 1005 | - 'existing_datetime_ids' => '', |
|
| 1006 | - 'total_dtt_rows' => 1, |
|
| 1007 | - 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
| 1008 | - 'add_new_dtt_info', |
|
| 1009 | - $this->_adminpage_obj->page_slug, |
|
| 1010 | - $this->_adminpage_obj->get_req_action(), |
|
| 1011 | - false, |
|
| 1012 | - false |
|
| 1013 | - ), |
|
| 1014 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1015 | - 'datetime_rows' => '', |
|
| 1016 | - 'show_tickets_container' => '', |
|
| 1017 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
| 1018 | - 'ticket_rows' => '', |
|
| 1019 | - 'existing_ticket_ids' => '', |
|
| 1020 | - 'total_ticket_rows' => 1, |
|
| 1021 | - 'ticket_js_structure' => '', |
|
| 1022 | - 'ee_collapsible_status' => ' ee-collapsible-open' |
|
| 1023 | - // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
| 1024 | - ); |
|
| 1025 | - $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
| 1026 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1027 | - /** |
|
| 1028 | - * 1. Start with retrieving Datetimes |
|
| 1029 | - * 2. For each datetime get related tickets |
|
| 1030 | - * 3. For each ticket get related prices |
|
| 1031 | - */ |
|
| 1032 | - /** @var EEM_Datetime $datetime_model */ |
|
| 1033 | - $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
| 1034 | - $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
| 1035 | - $main_template_args['total_dtt_rows'] = count($datetimes); |
|
| 1036 | - /** |
|
| 1037 | - * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
| 1038 | - * for why we are counting $datetime_row and then setting that on the Datetime object |
|
| 1039 | - */ |
|
| 1040 | - $datetime_row = 1; |
|
| 1041 | - foreach ($datetimes as $datetime) { |
|
| 1042 | - $DTT_ID = $datetime->get('DTT_ID'); |
|
| 1043 | - $datetime->set('DTT_order', $datetime_row); |
|
| 1044 | - $existing_datetime_ids[] = $DTT_ID; |
|
| 1045 | - // tickets attached |
|
| 1046 | - $related_tickets = $datetime->ID() > 0 |
|
| 1047 | - ? $datetime->get_many_related( |
|
| 1048 | - 'Ticket', |
|
| 1049 | - array( |
|
| 1050 | - array( |
|
| 1051 | - 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
| 1052 | - ), |
|
| 1053 | - 'default_where_conditions' => 'none', |
|
| 1054 | - 'order_by' => array('TKT_order' => 'ASC'), |
|
| 1055 | - ) |
|
| 1056 | - ) |
|
| 1057 | - : array(); |
|
| 1058 | - // if there are no related tickets this is likely a new event OR autodraft |
|
| 1059 | - // event so we need to generate the default tickets because datetimes |
|
| 1060 | - // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
| 1061 | - // datetime on the event. |
|
| 1062 | - if (empty($related_tickets) && count($datetimes) < 2) { |
|
| 1063 | - /** @var EEM_Ticket $ticket_model */ |
|
| 1064 | - $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 1065 | - $related_tickets = $ticket_model->get_all_default_tickets(); |
|
| 1066 | - // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
| 1067 | - // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
| 1068 | - $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
| 1069 | - $main_default_ticket = reset($related_tickets); |
|
| 1070 | - if ($main_default_ticket instanceof EE_Ticket) { |
|
| 1071 | - foreach ($default_prices as $default_price) { |
|
| 1072 | - if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
| 1073 | - continue; |
|
| 1074 | - } |
|
| 1075 | - $main_default_ticket->cache('Price', $default_price); |
|
| 1076 | - } |
|
| 1077 | - } |
|
| 1078 | - } |
|
| 1079 | - // we can't actually setup rows in this loop yet cause we don't know all |
|
| 1080 | - // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
| 1081 | - // So we're going to temporarily cache some of that information. |
|
| 1082 | - // loop through and setup the ticket rows and make sure the order is set. |
|
| 1083 | - foreach ($related_tickets as $ticket) { |
|
| 1084 | - $TKT_ID = $ticket->get('TKT_ID'); |
|
| 1085 | - $ticket_row = $ticket->get('TKT_row'); |
|
| 1086 | - // we only want unique tickets in our final display!! |
|
| 1087 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1088 | - $existing_ticket_ids[] = $TKT_ID; |
|
| 1089 | - $all_tickets[] = $ticket; |
|
| 1090 | - } |
|
| 1091 | - // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
| 1092 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
| 1093 | - // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
| 1094 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
| 1095 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
| 1096 | - ) { |
|
| 1097 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
| 1098 | - } |
|
| 1099 | - } |
|
| 1100 | - $datetime_row++; |
|
| 1101 | - } |
|
| 1102 | - $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
| 1103 | - $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
| 1104 | - $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
| 1105 | - // sort $all_tickets by order |
|
| 1106 | - usort( |
|
| 1107 | - $all_tickets, |
|
| 1108 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1109 | - $a_order = (int) $a->get('TKT_order'); |
|
| 1110 | - $b_order = (int) $b->get('TKT_order'); |
|
| 1111 | - if ($a_order === $b_order) { |
|
| 1112 | - return 0; |
|
| 1113 | - } |
|
| 1114 | - return ($a_order < $b_order) ? -1 : 1; |
|
| 1115 | - } |
|
| 1116 | - ); |
|
| 1117 | - // k NOW we have all the data we need for setting up the dtt rows |
|
| 1118 | - // and ticket rows so we start our dtt loop again. |
|
| 1119 | - $datetime_row = 1; |
|
| 1120 | - foreach ($datetimes as $datetime) { |
|
| 1121 | - $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
| 1122 | - $datetime_row, |
|
| 1123 | - $datetime, |
|
| 1124 | - $datetime_tickets, |
|
| 1125 | - $all_tickets, |
|
| 1126 | - false, |
|
| 1127 | - $datetimes |
|
| 1128 | - ); |
|
| 1129 | - $datetime_row++; |
|
| 1130 | - } |
|
| 1131 | - // then loop through all tickets for the ticket rows. |
|
| 1132 | - $ticket_row = 1; |
|
| 1133 | - foreach ($all_tickets as $ticket) { |
|
| 1134 | - $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
| 1135 | - $ticket_row, |
|
| 1136 | - $ticket, |
|
| 1137 | - $ticket_datetimes, |
|
| 1138 | - $datetimes, |
|
| 1139 | - false, |
|
| 1140 | - $all_tickets |
|
| 1141 | - ); |
|
| 1142 | - $ticket_row++; |
|
| 1143 | - } |
|
| 1144 | - $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
| 1145 | - EEH_Template::display_template( |
|
| 1146 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1147 | - $main_template_args |
|
| 1148 | - ); |
|
| 1149 | - } |
|
| 979 | + /** |
|
| 980 | + * @throws ReflectionException |
|
| 981 | + * @throws InvalidArgumentException |
|
| 982 | + * @throws InvalidInterfaceException |
|
| 983 | + * @throws InvalidDataTypeException |
|
| 984 | + * @throws DomainException |
|
| 985 | + * @throws EE_Error |
|
| 986 | + */ |
|
| 987 | + public function pricing_metabox() |
|
| 988 | + { |
|
| 989 | + $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
| 990 | + $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
| 991 | + // set is_creating_event property. |
|
| 992 | + $EVT_ID = $event->ID(); |
|
| 993 | + $this->_is_creating_event = empty($this->_req_data['post']); |
|
| 994 | + // default main template args |
|
| 995 | + $main_template_args = array( |
|
| 996 | + 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
| 997 | + 'event_editor_event_datetimes_help_tab', |
|
| 998 | + $this->_adminpage_obj->page_slug, |
|
| 999 | + $this->_adminpage_obj->get_req_action(), |
|
| 1000 | + false, |
|
| 1001 | + false |
|
| 1002 | + ), |
|
| 1003 | + // todo need to add a filter to the template for the help text |
|
| 1004 | + // in the Events_Admin_Page core file so we can add further help |
|
| 1005 | + 'existing_datetime_ids' => '', |
|
| 1006 | + 'total_dtt_rows' => 1, |
|
| 1007 | + 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
| 1008 | + 'add_new_dtt_info', |
|
| 1009 | + $this->_adminpage_obj->page_slug, |
|
| 1010 | + $this->_adminpage_obj->get_req_action(), |
|
| 1011 | + false, |
|
| 1012 | + false |
|
| 1013 | + ), |
|
| 1014 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1015 | + 'datetime_rows' => '', |
|
| 1016 | + 'show_tickets_container' => '', |
|
| 1017 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
| 1018 | + 'ticket_rows' => '', |
|
| 1019 | + 'existing_ticket_ids' => '', |
|
| 1020 | + 'total_ticket_rows' => 1, |
|
| 1021 | + 'ticket_js_structure' => '', |
|
| 1022 | + 'ee_collapsible_status' => ' ee-collapsible-open' |
|
| 1023 | + // $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
| 1024 | + ); |
|
| 1025 | + $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
| 1026 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 1027 | + /** |
|
| 1028 | + * 1. Start with retrieving Datetimes |
|
| 1029 | + * 2. For each datetime get related tickets |
|
| 1030 | + * 3. For each ticket get related prices |
|
| 1031 | + */ |
|
| 1032 | + /** @var EEM_Datetime $datetime_model */ |
|
| 1033 | + $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
| 1034 | + $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
| 1035 | + $main_template_args['total_dtt_rows'] = count($datetimes); |
|
| 1036 | + /** |
|
| 1037 | + * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
| 1038 | + * for why we are counting $datetime_row and then setting that on the Datetime object |
|
| 1039 | + */ |
|
| 1040 | + $datetime_row = 1; |
|
| 1041 | + foreach ($datetimes as $datetime) { |
|
| 1042 | + $DTT_ID = $datetime->get('DTT_ID'); |
|
| 1043 | + $datetime->set('DTT_order', $datetime_row); |
|
| 1044 | + $existing_datetime_ids[] = $DTT_ID; |
|
| 1045 | + // tickets attached |
|
| 1046 | + $related_tickets = $datetime->ID() > 0 |
|
| 1047 | + ? $datetime->get_many_related( |
|
| 1048 | + 'Ticket', |
|
| 1049 | + array( |
|
| 1050 | + array( |
|
| 1051 | + 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
| 1052 | + ), |
|
| 1053 | + 'default_where_conditions' => 'none', |
|
| 1054 | + 'order_by' => array('TKT_order' => 'ASC'), |
|
| 1055 | + ) |
|
| 1056 | + ) |
|
| 1057 | + : array(); |
|
| 1058 | + // if there are no related tickets this is likely a new event OR autodraft |
|
| 1059 | + // event so we need to generate the default tickets because datetimes |
|
| 1060 | + // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
| 1061 | + // datetime on the event. |
|
| 1062 | + if (empty($related_tickets) && count($datetimes) < 2) { |
|
| 1063 | + /** @var EEM_Ticket $ticket_model */ |
|
| 1064 | + $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 1065 | + $related_tickets = $ticket_model->get_all_default_tickets(); |
|
| 1066 | + // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
| 1067 | + // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
| 1068 | + $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
| 1069 | + $main_default_ticket = reset($related_tickets); |
|
| 1070 | + if ($main_default_ticket instanceof EE_Ticket) { |
|
| 1071 | + foreach ($default_prices as $default_price) { |
|
| 1072 | + if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
| 1073 | + continue; |
|
| 1074 | + } |
|
| 1075 | + $main_default_ticket->cache('Price', $default_price); |
|
| 1076 | + } |
|
| 1077 | + } |
|
| 1078 | + } |
|
| 1079 | + // we can't actually setup rows in this loop yet cause we don't know all |
|
| 1080 | + // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
| 1081 | + // So we're going to temporarily cache some of that information. |
|
| 1082 | + // loop through and setup the ticket rows and make sure the order is set. |
|
| 1083 | + foreach ($related_tickets as $ticket) { |
|
| 1084 | + $TKT_ID = $ticket->get('TKT_ID'); |
|
| 1085 | + $ticket_row = $ticket->get('TKT_row'); |
|
| 1086 | + // we only want unique tickets in our final display!! |
|
| 1087 | + if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1088 | + $existing_ticket_ids[] = $TKT_ID; |
|
| 1089 | + $all_tickets[] = $ticket; |
|
| 1090 | + } |
|
| 1091 | + // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
| 1092 | + $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
| 1093 | + // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
| 1094 | + if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
| 1095 | + || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
| 1096 | + ) { |
|
| 1097 | + $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
| 1098 | + } |
|
| 1099 | + } |
|
| 1100 | + $datetime_row++; |
|
| 1101 | + } |
|
| 1102 | + $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
| 1103 | + $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
| 1104 | + $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
| 1105 | + // sort $all_tickets by order |
|
| 1106 | + usort( |
|
| 1107 | + $all_tickets, |
|
| 1108 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1109 | + $a_order = (int) $a->get('TKT_order'); |
|
| 1110 | + $b_order = (int) $b->get('TKT_order'); |
|
| 1111 | + if ($a_order === $b_order) { |
|
| 1112 | + return 0; |
|
| 1113 | + } |
|
| 1114 | + return ($a_order < $b_order) ? -1 : 1; |
|
| 1115 | + } |
|
| 1116 | + ); |
|
| 1117 | + // k NOW we have all the data we need for setting up the dtt rows |
|
| 1118 | + // and ticket rows so we start our dtt loop again. |
|
| 1119 | + $datetime_row = 1; |
|
| 1120 | + foreach ($datetimes as $datetime) { |
|
| 1121 | + $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
| 1122 | + $datetime_row, |
|
| 1123 | + $datetime, |
|
| 1124 | + $datetime_tickets, |
|
| 1125 | + $all_tickets, |
|
| 1126 | + false, |
|
| 1127 | + $datetimes |
|
| 1128 | + ); |
|
| 1129 | + $datetime_row++; |
|
| 1130 | + } |
|
| 1131 | + // then loop through all tickets for the ticket rows. |
|
| 1132 | + $ticket_row = 1; |
|
| 1133 | + foreach ($all_tickets as $ticket) { |
|
| 1134 | + $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
| 1135 | + $ticket_row, |
|
| 1136 | + $ticket, |
|
| 1137 | + $ticket_datetimes, |
|
| 1138 | + $datetimes, |
|
| 1139 | + false, |
|
| 1140 | + $all_tickets |
|
| 1141 | + ); |
|
| 1142 | + $ticket_row++; |
|
| 1143 | + } |
|
| 1144 | + $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
| 1145 | + EEH_Template::display_template( |
|
| 1146 | + PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1147 | + $main_template_args |
|
| 1148 | + ); |
|
| 1149 | + } |
|
| 1150 | 1150 | |
| 1151 | 1151 | |
| 1152 | - /** |
|
| 1153 | - * @param int $datetime_row |
|
| 1154 | - * @param EE_Datetime $datetime |
|
| 1155 | - * @param array $datetime_tickets |
|
| 1156 | - * @param array $all_tickets |
|
| 1157 | - * @param bool $default |
|
| 1158 | - * @param array $all_datetimes |
|
| 1159 | - * @return mixed |
|
| 1160 | - * @throws DomainException |
|
| 1161 | - * @throws EE_Error |
|
| 1162 | - */ |
|
| 1163 | - protected function _get_datetime_row( |
|
| 1164 | - $datetime_row, |
|
| 1165 | - EE_Datetime $datetime, |
|
| 1166 | - $datetime_tickets = array(), |
|
| 1167 | - $all_tickets = array(), |
|
| 1168 | - $default = false, |
|
| 1169 | - $all_datetimes = array() |
|
| 1170 | - ) { |
|
| 1171 | - $dtt_display_template_args = array( |
|
| 1172 | - 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
| 1173 | - $datetime_row, |
|
| 1174 | - $datetime, |
|
| 1175 | - $default, |
|
| 1176 | - $all_datetimes |
|
| 1177 | - ), |
|
| 1178 | - 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
| 1179 | - $datetime_row, |
|
| 1180 | - $datetime, |
|
| 1181 | - $datetime_tickets, |
|
| 1182 | - $all_tickets, |
|
| 1183 | - $default |
|
| 1184 | - ), |
|
| 1185 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1186 | - ); |
|
| 1187 | - return EEH_Template::display_template( |
|
| 1188 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1189 | - $dtt_display_template_args, |
|
| 1190 | - true |
|
| 1191 | - ); |
|
| 1192 | - } |
|
| 1152 | + /** |
|
| 1153 | + * @param int $datetime_row |
|
| 1154 | + * @param EE_Datetime $datetime |
|
| 1155 | + * @param array $datetime_tickets |
|
| 1156 | + * @param array $all_tickets |
|
| 1157 | + * @param bool $default |
|
| 1158 | + * @param array $all_datetimes |
|
| 1159 | + * @return mixed |
|
| 1160 | + * @throws DomainException |
|
| 1161 | + * @throws EE_Error |
|
| 1162 | + */ |
|
| 1163 | + protected function _get_datetime_row( |
|
| 1164 | + $datetime_row, |
|
| 1165 | + EE_Datetime $datetime, |
|
| 1166 | + $datetime_tickets = array(), |
|
| 1167 | + $all_tickets = array(), |
|
| 1168 | + $default = false, |
|
| 1169 | + $all_datetimes = array() |
|
| 1170 | + ) { |
|
| 1171 | + $dtt_display_template_args = array( |
|
| 1172 | + 'dtt_edit_row' => $this->_get_dtt_edit_row( |
|
| 1173 | + $datetime_row, |
|
| 1174 | + $datetime, |
|
| 1175 | + $default, |
|
| 1176 | + $all_datetimes |
|
| 1177 | + ), |
|
| 1178 | + 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
| 1179 | + $datetime_row, |
|
| 1180 | + $datetime, |
|
| 1181 | + $datetime_tickets, |
|
| 1182 | + $all_tickets, |
|
| 1183 | + $default |
|
| 1184 | + ), |
|
| 1185 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1186 | + ); |
|
| 1187 | + return EEH_Template::display_template( |
|
| 1188 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1189 | + $dtt_display_template_args, |
|
| 1190 | + true |
|
| 1191 | + ); |
|
| 1192 | + } |
|
| 1193 | 1193 | |
| 1194 | 1194 | |
| 1195 | - /** |
|
| 1196 | - * This method is used to generate a dtt fields edit row. |
|
| 1197 | - * The same row is used to generate a row with valid DTT objects |
|
| 1198 | - * and the default row that is used as the skeleton by the js. |
|
| 1199 | - * |
|
| 1200 | - * @param int $datetime_row The row number for the row being generated. |
|
| 1201 | - * @param EE_Datetime $datetime |
|
| 1202 | - * @param bool $default Whether a default row is being generated or not. |
|
| 1203 | - * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
| 1204 | - * @return string |
|
| 1205 | - * @throws DomainException |
|
| 1206 | - * @throws EE_Error |
|
| 1207 | - */ |
|
| 1208 | - protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
| 1209 | - { |
|
| 1210 | - // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
| 1211 | - $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
| 1212 | - $template_args = array( |
|
| 1213 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1214 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1215 | - 'edit_dtt_expanded' => '', |
|
| 1216 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1217 | - 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
| 1218 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
| 1219 | - 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
| 1220 | - 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
| 1221 | - 'DTT_reg_limit' => $default |
|
| 1222 | - ? '' |
|
| 1223 | - : $datetime->get_pretty( |
|
| 1224 | - 'DTT_reg_limit', |
|
| 1225 | - 'input' |
|
| 1226 | - ), |
|
| 1227 | - 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1228 | - 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
| 1229 | - 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
| 1230 | - 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1231 | - ? '' |
|
| 1232 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1233 | - 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1234 | - ? 'ee-lock-icon' |
|
| 1235 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1236 | - 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
| 1237 | - ? '' |
|
| 1238 | - : EE_Admin_Page::add_query_args_and_nonce( |
|
| 1239 | - array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
| 1240 | - REG_ADMIN_URL |
|
| 1241 | - ), |
|
| 1242 | - ); |
|
| 1243 | - $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1244 | - ? ' style="display:none"' |
|
| 1245 | - : ''; |
|
| 1246 | - // allow filtering of template args at this point. |
|
| 1247 | - $template_args = apply_filters( |
|
| 1248 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
| 1249 | - $template_args, |
|
| 1250 | - $datetime_row, |
|
| 1251 | - $datetime, |
|
| 1252 | - $default, |
|
| 1253 | - $all_datetimes, |
|
| 1254 | - $this->_is_creating_event |
|
| 1255 | - ); |
|
| 1256 | - return EEH_Template::display_template( |
|
| 1257 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1258 | - $template_args, |
|
| 1259 | - true |
|
| 1260 | - ); |
|
| 1261 | - } |
|
| 1195 | + /** |
|
| 1196 | + * This method is used to generate a dtt fields edit row. |
|
| 1197 | + * The same row is used to generate a row with valid DTT objects |
|
| 1198 | + * and the default row that is used as the skeleton by the js. |
|
| 1199 | + * |
|
| 1200 | + * @param int $datetime_row The row number for the row being generated. |
|
| 1201 | + * @param EE_Datetime $datetime |
|
| 1202 | + * @param bool $default Whether a default row is being generated or not. |
|
| 1203 | + * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
| 1204 | + * @return string |
|
| 1205 | + * @throws DomainException |
|
| 1206 | + * @throws EE_Error |
|
| 1207 | + */ |
|
| 1208 | + protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
| 1209 | + { |
|
| 1210 | + // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
| 1211 | + $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
| 1212 | + $template_args = array( |
|
| 1213 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1214 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1215 | + 'edit_dtt_expanded' => '', |
|
| 1216 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1217 | + 'DTT_name' => $default ? '' : $datetime->get_f('DTT_name'), |
|
| 1218 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
| 1219 | + 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
| 1220 | + 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
| 1221 | + 'DTT_reg_limit' => $default |
|
| 1222 | + ? '' |
|
| 1223 | + : $datetime->get_pretty( |
|
| 1224 | + 'DTT_reg_limit', |
|
| 1225 | + 'input' |
|
| 1226 | + ), |
|
| 1227 | + 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1228 | + 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
| 1229 | + 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
| 1230 | + 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1231 | + ? '' |
|
| 1232 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1233 | + 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1234 | + ? 'ee-lock-icon' |
|
| 1235 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1236 | + 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
| 1237 | + ? '' |
|
| 1238 | + : EE_Admin_Page::add_query_args_and_nonce( |
|
| 1239 | + array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
| 1240 | + REG_ADMIN_URL |
|
| 1241 | + ), |
|
| 1242 | + ); |
|
| 1243 | + $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1244 | + ? ' style="display:none"' |
|
| 1245 | + : ''; |
|
| 1246 | + // allow filtering of template args at this point. |
|
| 1247 | + $template_args = apply_filters( |
|
| 1248 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
| 1249 | + $template_args, |
|
| 1250 | + $datetime_row, |
|
| 1251 | + $datetime, |
|
| 1252 | + $default, |
|
| 1253 | + $all_datetimes, |
|
| 1254 | + $this->_is_creating_event |
|
| 1255 | + ); |
|
| 1256 | + return EEH_Template::display_template( |
|
| 1257 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1258 | + $template_args, |
|
| 1259 | + true |
|
| 1260 | + ); |
|
| 1261 | + } |
|
| 1262 | 1262 | |
| 1263 | 1263 | |
| 1264 | - /** |
|
| 1265 | - * @param int $datetime_row |
|
| 1266 | - * @param EE_Datetime $datetime |
|
| 1267 | - * @param array $datetime_tickets |
|
| 1268 | - * @param array $all_tickets |
|
| 1269 | - * @param bool $default |
|
| 1270 | - * @return mixed |
|
| 1271 | - * @throws DomainException |
|
| 1272 | - * @throws EE_Error |
|
| 1273 | - */ |
|
| 1274 | - protected function _get_dtt_attached_tickets_row( |
|
| 1275 | - $datetime_row, |
|
| 1276 | - $datetime, |
|
| 1277 | - $datetime_tickets = array(), |
|
| 1278 | - $all_tickets = array(), |
|
| 1279 | - $default |
|
| 1280 | - ) { |
|
| 1281 | - $template_args = array( |
|
| 1282 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1283 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1284 | - 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
| 1285 | - 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1286 | - 'show_tickets_row' => ' style="display:none;"', |
|
| 1287 | - 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
| 1288 | - 'add_new_ticket_via_datetime', |
|
| 1289 | - $this->_adminpage_obj->page_slug, |
|
| 1290 | - $this->_adminpage_obj->get_req_action(), |
|
| 1291 | - false, |
|
| 1292 | - false |
|
| 1293 | - ), |
|
| 1294 | - // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1295 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1296 | - ); |
|
| 1297 | - // need to setup the list items (but only if this isn't a default skeleton setup) |
|
| 1298 | - if (! $default) { |
|
| 1299 | - $ticket_row = 1; |
|
| 1300 | - foreach ($all_tickets as $ticket) { |
|
| 1301 | - $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 1302 | - $datetime_row, |
|
| 1303 | - $ticket_row, |
|
| 1304 | - $datetime, |
|
| 1305 | - $ticket, |
|
| 1306 | - $datetime_tickets, |
|
| 1307 | - $default |
|
| 1308 | - ); |
|
| 1309 | - $ticket_row++; |
|
| 1310 | - } |
|
| 1311 | - } |
|
| 1312 | - // filter template args at this point |
|
| 1313 | - $template_args = apply_filters( |
|
| 1314 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
| 1315 | - $template_args, |
|
| 1316 | - $datetime_row, |
|
| 1317 | - $datetime, |
|
| 1318 | - $datetime_tickets, |
|
| 1319 | - $all_tickets, |
|
| 1320 | - $default, |
|
| 1321 | - $this->_is_creating_event |
|
| 1322 | - ); |
|
| 1323 | - return EEH_Template::display_template( |
|
| 1324 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1325 | - $template_args, |
|
| 1326 | - true |
|
| 1327 | - ); |
|
| 1328 | - } |
|
| 1264 | + /** |
|
| 1265 | + * @param int $datetime_row |
|
| 1266 | + * @param EE_Datetime $datetime |
|
| 1267 | + * @param array $datetime_tickets |
|
| 1268 | + * @param array $all_tickets |
|
| 1269 | + * @param bool $default |
|
| 1270 | + * @return mixed |
|
| 1271 | + * @throws DomainException |
|
| 1272 | + * @throws EE_Error |
|
| 1273 | + */ |
|
| 1274 | + protected function _get_dtt_attached_tickets_row( |
|
| 1275 | + $datetime_row, |
|
| 1276 | + $datetime, |
|
| 1277 | + $datetime_tickets = array(), |
|
| 1278 | + $all_tickets = array(), |
|
| 1279 | + $default |
|
| 1280 | + ) { |
|
| 1281 | + $template_args = array( |
|
| 1282 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1283 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1284 | + 'DTT_description' => $default ? '' : $datetime->get_f('DTT_description'), |
|
| 1285 | + 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1286 | + 'show_tickets_row' => ' style="display:none;"', |
|
| 1287 | + 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
| 1288 | + 'add_new_ticket_via_datetime', |
|
| 1289 | + $this->_adminpage_obj->page_slug, |
|
| 1290 | + $this->_adminpage_obj->get_req_action(), |
|
| 1291 | + false, |
|
| 1292 | + false |
|
| 1293 | + ), |
|
| 1294 | + // todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1295 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1296 | + ); |
|
| 1297 | + // need to setup the list items (but only if this isn't a default skeleton setup) |
|
| 1298 | + if (! $default) { |
|
| 1299 | + $ticket_row = 1; |
|
| 1300 | + foreach ($all_tickets as $ticket) { |
|
| 1301 | + $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 1302 | + $datetime_row, |
|
| 1303 | + $ticket_row, |
|
| 1304 | + $datetime, |
|
| 1305 | + $ticket, |
|
| 1306 | + $datetime_tickets, |
|
| 1307 | + $default |
|
| 1308 | + ); |
|
| 1309 | + $ticket_row++; |
|
| 1310 | + } |
|
| 1311 | + } |
|
| 1312 | + // filter template args at this point |
|
| 1313 | + $template_args = apply_filters( |
|
| 1314 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
| 1315 | + $template_args, |
|
| 1316 | + $datetime_row, |
|
| 1317 | + $datetime, |
|
| 1318 | + $datetime_tickets, |
|
| 1319 | + $all_tickets, |
|
| 1320 | + $default, |
|
| 1321 | + $this->_is_creating_event |
|
| 1322 | + ); |
|
| 1323 | + return EEH_Template::display_template( |
|
| 1324 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1325 | + $template_args, |
|
| 1326 | + true |
|
| 1327 | + ); |
|
| 1328 | + } |
|
| 1329 | 1329 | |
| 1330 | 1330 | |
| 1331 | - /** |
|
| 1332 | - * @param int $datetime_row |
|
| 1333 | - * @param int $ticket_row |
|
| 1334 | - * @param EE_Datetime $datetime |
|
| 1335 | - * @param EE_Ticket $ticket |
|
| 1336 | - * @param array $datetime_tickets |
|
| 1337 | - * @param bool $default |
|
| 1338 | - * @return mixed |
|
| 1339 | - * @throws DomainException |
|
| 1340 | - * @throws EE_Error |
|
| 1341 | - */ |
|
| 1342 | - protected function _get_datetime_tickets_list_item( |
|
| 1343 | - $datetime_row, |
|
| 1344 | - $ticket_row, |
|
| 1345 | - $datetime, |
|
| 1346 | - $ticket, |
|
| 1347 | - $datetime_tickets = array(), |
|
| 1348 | - $default |
|
| 1349 | - ) { |
|
| 1350 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
| 1351 | - ? $datetime_tickets[ $datetime->ID() ] |
|
| 1352 | - : array(); |
|
| 1353 | - $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
| 1354 | - $no_ticket = $default && empty($ticket); |
|
| 1355 | - $template_args = array( |
|
| 1356 | - 'dtt_row' => $default |
|
| 1357 | - ? 'DTTNUM' |
|
| 1358 | - : $datetime_row, |
|
| 1359 | - 'tkt_row' => $no_ticket |
|
| 1360 | - ? 'TICKETNUM' |
|
| 1361 | - : $ticket_row, |
|
| 1362 | - 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
| 1363 | - ? ' checked="checked"' |
|
| 1364 | - : '', |
|
| 1365 | - 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
| 1366 | - ? ' ticket-selected' |
|
| 1367 | - : '', |
|
| 1368 | - 'TKT_name' => $no_ticket |
|
| 1369 | - ? 'TKTNAME' |
|
| 1370 | - : $ticket->get('TKT_name'), |
|
| 1371 | - 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
| 1372 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1373 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1374 | - ); |
|
| 1375 | - // filter template args |
|
| 1376 | - $template_args = apply_filters( |
|
| 1377 | - 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
| 1378 | - $template_args, |
|
| 1379 | - $datetime_row, |
|
| 1380 | - $ticket_row, |
|
| 1381 | - $datetime, |
|
| 1382 | - $ticket, |
|
| 1383 | - $datetime_tickets, |
|
| 1384 | - $default, |
|
| 1385 | - $this->_is_creating_event |
|
| 1386 | - ); |
|
| 1387 | - return EEH_Template::display_template( |
|
| 1388 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1389 | - $template_args, |
|
| 1390 | - true |
|
| 1391 | - ); |
|
| 1392 | - } |
|
| 1331 | + /** |
|
| 1332 | + * @param int $datetime_row |
|
| 1333 | + * @param int $ticket_row |
|
| 1334 | + * @param EE_Datetime $datetime |
|
| 1335 | + * @param EE_Ticket $ticket |
|
| 1336 | + * @param array $datetime_tickets |
|
| 1337 | + * @param bool $default |
|
| 1338 | + * @return mixed |
|
| 1339 | + * @throws DomainException |
|
| 1340 | + * @throws EE_Error |
|
| 1341 | + */ |
|
| 1342 | + protected function _get_datetime_tickets_list_item( |
|
| 1343 | + $datetime_row, |
|
| 1344 | + $ticket_row, |
|
| 1345 | + $datetime, |
|
| 1346 | + $ticket, |
|
| 1347 | + $datetime_tickets = array(), |
|
| 1348 | + $default |
|
| 1349 | + ) { |
|
| 1350 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
| 1351 | + ? $datetime_tickets[ $datetime->ID() ] |
|
| 1352 | + : array(); |
|
| 1353 | + $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
| 1354 | + $no_ticket = $default && empty($ticket); |
|
| 1355 | + $template_args = array( |
|
| 1356 | + 'dtt_row' => $default |
|
| 1357 | + ? 'DTTNUM' |
|
| 1358 | + : $datetime_row, |
|
| 1359 | + 'tkt_row' => $no_ticket |
|
| 1360 | + ? 'TICKETNUM' |
|
| 1361 | + : $ticket_row, |
|
| 1362 | + 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
| 1363 | + ? ' checked="checked"' |
|
| 1364 | + : '', |
|
| 1365 | + 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
| 1366 | + ? ' ticket-selected' |
|
| 1367 | + : '', |
|
| 1368 | + 'TKT_name' => $no_ticket |
|
| 1369 | + ? 'TKTNAME' |
|
| 1370 | + : $ticket->get('TKT_name'), |
|
| 1371 | + 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
| 1372 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1373 | + : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1374 | + ); |
|
| 1375 | + // filter template args |
|
| 1376 | + $template_args = apply_filters( |
|
| 1377 | + 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
| 1378 | + $template_args, |
|
| 1379 | + $datetime_row, |
|
| 1380 | + $ticket_row, |
|
| 1381 | + $datetime, |
|
| 1382 | + $ticket, |
|
| 1383 | + $datetime_tickets, |
|
| 1384 | + $default, |
|
| 1385 | + $this->_is_creating_event |
|
| 1386 | + ); |
|
| 1387 | + return EEH_Template::display_template( |
|
| 1388 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1389 | + $template_args, |
|
| 1390 | + true |
|
| 1391 | + ); |
|
| 1392 | + } |
|
| 1393 | 1393 | |
| 1394 | 1394 | |
| 1395 | - /** |
|
| 1396 | - * This generates the ticket row for tickets. |
|
| 1397 | - * This same method is used to generate both the actual rows and the js skeleton row |
|
| 1398 | - * (when default === true) |
|
| 1399 | - * |
|
| 1400 | - * @param int $ticket_row Represents the row number being generated. |
|
| 1401 | - * @param $ticket |
|
| 1402 | - * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
| 1403 | - * or empty for default |
|
| 1404 | - * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
| 1405 | - * @param bool $default Whether default row being generated or not. |
|
| 1406 | - * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
| 1407 | - * (or empty in the case of defaults) |
|
| 1408 | - * @return mixed |
|
| 1409 | - * @throws InvalidArgumentException |
|
| 1410 | - * @throws InvalidInterfaceException |
|
| 1411 | - * @throws InvalidDataTypeException |
|
| 1412 | - * @throws DomainException |
|
| 1413 | - * @throws EE_Error |
|
| 1414 | - * @throws ReflectionException |
|
| 1415 | - */ |
|
| 1416 | - protected function _get_ticket_row( |
|
| 1417 | - $ticket_row, |
|
| 1418 | - $ticket, |
|
| 1419 | - $ticket_datetimes, |
|
| 1420 | - $all_datetimes, |
|
| 1421 | - $default = false, |
|
| 1422 | - $all_tickets = array() |
|
| 1423 | - ) { |
|
| 1424 | - // if $ticket is not an instance of EE_Ticket then force default to true. |
|
| 1425 | - $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
| 1426 | - $prices = ! empty($ticket) && ! $default |
|
| 1427 | - ? $ticket->get_many_related( |
|
| 1428 | - 'Price', |
|
| 1429 | - array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
| 1430 | - ) |
|
| 1431 | - : array(); |
|
| 1432 | - // if there is only one price (which would be the base price) |
|
| 1433 | - // or NO prices and this ticket is a default ticket, |
|
| 1434 | - // let's just make sure there are no cached default prices on the object. |
|
| 1435 | - // This is done by not including any query_params. |
|
| 1436 | - if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
| 1437 | - $prices = $ticket->prices(); |
|
| 1438 | - } |
|
| 1439 | - // check if we're dealing with a default ticket in which case |
|
| 1440 | - // we don't want any starting_ticket_datetime_row values set |
|
| 1441 | - // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
| 1442 | - // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
| 1443 | - $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
| 1444 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 1445 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
| 1446 | - : array(); |
|
| 1447 | - $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1448 | - $base_price = $default ? null : $ticket->base_price(); |
|
| 1449 | - $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
| 1450 | - // breaking out complicated condition for ticket_status |
|
| 1451 | - if ($default) { |
|
| 1452 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1453 | - } else { |
|
| 1454 | - $ticket_status_class = $ticket->is_default() |
|
| 1455 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1456 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1457 | - } |
|
| 1458 | - // breaking out complicated condition for TKT_taxable |
|
| 1459 | - if ($default) { |
|
| 1460 | - $TKT_taxable = ''; |
|
| 1461 | - } else { |
|
| 1462 | - $TKT_taxable = $ticket->taxable() |
|
| 1463 | - ? ' checked="checked"' |
|
| 1464 | - : ''; |
|
| 1465 | - } |
|
| 1466 | - if ($default) { |
|
| 1467 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1468 | - } elseif ($ticket->is_default()) { |
|
| 1469 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1470 | - } else { |
|
| 1471 | - $TKT_status = $ticket->ticket_status(true); |
|
| 1472 | - } |
|
| 1473 | - if ($default) { |
|
| 1474 | - $TKT_min = ''; |
|
| 1475 | - } else { |
|
| 1476 | - $TKT_min = $ticket->min(); |
|
| 1477 | - if ($TKT_min === -1 || $TKT_min === 0) { |
|
| 1478 | - $TKT_min = ''; |
|
| 1479 | - } |
|
| 1480 | - } |
|
| 1481 | - $template_args = array( |
|
| 1482 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1483 | - 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1484 | - // on initial page load this will always be the correct order. |
|
| 1485 | - 'tkt_status_class' => $ticket_status_class, |
|
| 1486 | - 'display_edit_tkt_row' => ' style="display:none;"', |
|
| 1487 | - 'edit_tkt_expanded' => '', |
|
| 1488 | - 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
| 1489 | - 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
| 1490 | - 'TKT_start_date' => $default |
|
| 1491 | - ? '' |
|
| 1492 | - : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
| 1493 | - 'TKT_end_date' => $default |
|
| 1494 | - ? '' |
|
| 1495 | - : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
| 1496 | - 'TKT_status' => $TKT_status, |
|
| 1497 | - 'TKT_price' => $default |
|
| 1498 | - ? '' |
|
| 1499 | - : EEH_Template::format_currency( |
|
| 1500 | - $ticket->get_ticket_total_with_taxes(), |
|
| 1501 | - false, |
|
| 1502 | - false |
|
| 1503 | - ), |
|
| 1504 | - 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
| 1505 | - 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
| 1506 | - 'TKT_qty' => $default |
|
| 1507 | - ? '' |
|
| 1508 | - : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
| 1509 | - 'TKT_qty_for_input' => $default |
|
| 1510 | - ? '' |
|
| 1511 | - : $ticket->get_pretty('TKT_qty', 'input'), |
|
| 1512 | - 'TKT_uses' => $default |
|
| 1513 | - ? '' |
|
| 1514 | - : $ticket->get_pretty('TKT_uses', 'input'), |
|
| 1515 | - 'TKT_min' => $TKT_min, |
|
| 1516 | - 'TKT_max' => $default |
|
| 1517 | - ? '' |
|
| 1518 | - : $ticket->get_pretty('TKT_max', 'input'), |
|
| 1519 | - 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
| 1520 | - 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
| 1521 | - 'TKT_registrations' => $default |
|
| 1522 | - ? 0 |
|
| 1523 | - : $ticket->count_registrations( |
|
| 1524 | - array( |
|
| 1525 | - array( |
|
| 1526 | - 'STS_ID' => array( |
|
| 1527 | - '!=', |
|
| 1528 | - EEM_Registration::status_id_incomplete, |
|
| 1529 | - ), |
|
| 1530 | - ), |
|
| 1531 | - ) |
|
| 1532 | - ), |
|
| 1533 | - 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
| 1534 | - 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
| 1535 | - 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
| 1536 | - 'TKT_required' => $default ? 0 : $ticket->required(), |
|
| 1537 | - 'TKT_is_default_selector' => '', |
|
| 1538 | - 'ticket_price_rows' => '', |
|
| 1539 | - 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
| 1540 | - ? '' |
|
| 1541 | - : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1542 | - 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
| 1543 | - 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
| 1544 | - ? '' |
|
| 1545 | - : ' style="display:none;"', |
|
| 1546 | - 'show_price_mod_button' => count($prices) > 1 |
|
| 1547 | - || ($default && $count_price_mods > 0) |
|
| 1548 | - || (! $default && $ticket->deleted()) |
|
| 1549 | - ? ' style="display:none;"' |
|
| 1550 | - : '', |
|
| 1551 | - 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
| 1552 | - 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1553 | - 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
| 1554 | - 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
| 1555 | - 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
| 1556 | - 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
| 1557 | - 'TKT_taxable' => $TKT_taxable, |
|
| 1558 | - 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
| 1559 | - ? '' |
|
| 1560 | - : ' style="display:none"', |
|
| 1561 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1562 | - 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
| 1563 | - $ticket_subtotal, |
|
| 1564 | - false, |
|
| 1565 | - false |
|
| 1566 | - ), |
|
| 1567 | - 'TKT_subtotal_amount' => $ticket_subtotal, |
|
| 1568 | - 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
| 1569 | - 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
| 1570 | - 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1571 | - ? ' ticket-archived' |
|
| 1572 | - : '', |
|
| 1573 | - 'trash_icon' => $ticket instanceof EE_Ticket |
|
| 1574 | - && $ticket->deleted() |
|
| 1575 | - && ! $ticket->is_permanently_deleteable() |
|
| 1576 | - ? 'ee-lock-icon ' |
|
| 1577 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1578 | - 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1579 | - ? '' |
|
| 1580 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1581 | - ); |
|
| 1582 | - $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1583 | - ? ' style="display:none"' |
|
| 1584 | - : ''; |
|
| 1585 | - // handle rows that should NOT be empty |
|
| 1586 | - if (empty($template_args['TKT_start_date'])) { |
|
| 1587 | - // if empty then the start date will be now. |
|
| 1588 | - $template_args['TKT_start_date'] = date( |
|
| 1589 | - $this->_date_time_format, |
|
| 1590 | - current_time('timestamp') |
|
| 1591 | - ); |
|
| 1592 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1593 | - } |
|
| 1594 | - if (empty($template_args['TKT_end_date'])) { |
|
| 1595 | - // get the earliest datetime (if present); |
|
| 1596 | - $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
| 1597 | - ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
| 1598 | - 'Datetime', |
|
| 1599 | - array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
| 1600 | - ) |
|
| 1601 | - : null; |
|
| 1602 | - if (! empty($earliest_dtt)) { |
|
| 1603 | - $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
| 1604 | - 'DTT_EVT_start', |
|
| 1605 | - $this->_date_time_format |
|
| 1606 | - ); |
|
| 1607 | - } else { |
|
| 1608 | - // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
| 1609 | - $template_args['TKT_end_date'] = date( |
|
| 1610 | - $this->_date_time_format, |
|
| 1611 | - mktime( |
|
| 1612 | - 24, |
|
| 1613 | - 0, |
|
| 1614 | - 0, |
|
| 1615 | - date('m'), |
|
| 1616 | - date('d') + 29, |
|
| 1617 | - date('Y') |
|
| 1618 | - ) |
|
| 1619 | - ); |
|
| 1620 | - } |
|
| 1621 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1622 | - } |
|
| 1623 | - // generate ticket_datetime items |
|
| 1624 | - if (! $default) { |
|
| 1625 | - $datetime_row = 1; |
|
| 1626 | - foreach ($all_datetimes as $datetime) { |
|
| 1627 | - $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 1628 | - $datetime_row, |
|
| 1629 | - $ticket_row, |
|
| 1630 | - $datetime, |
|
| 1631 | - $ticket, |
|
| 1632 | - $ticket_datetimes, |
|
| 1633 | - $default |
|
| 1634 | - ); |
|
| 1635 | - $datetime_row++; |
|
| 1636 | - } |
|
| 1637 | - } |
|
| 1638 | - $price_row = 1; |
|
| 1639 | - foreach ($prices as $price) { |
|
| 1640 | - if (! $price instanceof EE_Price) { |
|
| 1641 | - continue; |
|
| 1642 | - } |
|
| 1643 | - if ($price->is_base_price()) { |
|
| 1644 | - $price_row++; |
|
| 1645 | - continue; |
|
| 1646 | - } |
|
| 1647 | - $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1648 | - $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
| 1649 | - $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
| 1650 | - $ticket_row, |
|
| 1651 | - $price_row, |
|
| 1652 | - $price, |
|
| 1653 | - $default, |
|
| 1654 | - $ticket, |
|
| 1655 | - $show_trash, |
|
| 1656 | - $show_create |
|
| 1657 | - ); |
|
| 1658 | - $price_row++; |
|
| 1659 | - } |
|
| 1660 | - // filter $template_args |
|
| 1661 | - $template_args = apply_filters( |
|
| 1662 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
| 1663 | - $template_args, |
|
| 1664 | - $ticket_row, |
|
| 1665 | - $ticket, |
|
| 1666 | - $ticket_datetimes, |
|
| 1667 | - $all_datetimes, |
|
| 1668 | - $default, |
|
| 1669 | - $all_tickets, |
|
| 1670 | - $this->_is_creating_event |
|
| 1671 | - ); |
|
| 1672 | - return EEH_Template::display_template( |
|
| 1673 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1674 | - $template_args, |
|
| 1675 | - true |
|
| 1676 | - ); |
|
| 1677 | - } |
|
| 1395 | + /** |
|
| 1396 | + * This generates the ticket row for tickets. |
|
| 1397 | + * This same method is used to generate both the actual rows and the js skeleton row |
|
| 1398 | + * (when default === true) |
|
| 1399 | + * |
|
| 1400 | + * @param int $ticket_row Represents the row number being generated. |
|
| 1401 | + * @param $ticket |
|
| 1402 | + * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
| 1403 | + * or empty for default |
|
| 1404 | + * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
| 1405 | + * @param bool $default Whether default row being generated or not. |
|
| 1406 | + * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
| 1407 | + * (or empty in the case of defaults) |
|
| 1408 | + * @return mixed |
|
| 1409 | + * @throws InvalidArgumentException |
|
| 1410 | + * @throws InvalidInterfaceException |
|
| 1411 | + * @throws InvalidDataTypeException |
|
| 1412 | + * @throws DomainException |
|
| 1413 | + * @throws EE_Error |
|
| 1414 | + * @throws ReflectionException |
|
| 1415 | + */ |
|
| 1416 | + protected function _get_ticket_row( |
|
| 1417 | + $ticket_row, |
|
| 1418 | + $ticket, |
|
| 1419 | + $ticket_datetimes, |
|
| 1420 | + $all_datetimes, |
|
| 1421 | + $default = false, |
|
| 1422 | + $all_tickets = array() |
|
| 1423 | + ) { |
|
| 1424 | + // if $ticket is not an instance of EE_Ticket then force default to true. |
|
| 1425 | + $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
| 1426 | + $prices = ! empty($ticket) && ! $default |
|
| 1427 | + ? $ticket->get_many_related( |
|
| 1428 | + 'Price', |
|
| 1429 | + array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC')) |
|
| 1430 | + ) |
|
| 1431 | + : array(); |
|
| 1432 | + // if there is only one price (which would be the base price) |
|
| 1433 | + // or NO prices and this ticket is a default ticket, |
|
| 1434 | + // let's just make sure there are no cached default prices on the object. |
|
| 1435 | + // This is done by not including any query_params. |
|
| 1436 | + if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
| 1437 | + $prices = $ticket->prices(); |
|
| 1438 | + } |
|
| 1439 | + // check if we're dealing with a default ticket in which case |
|
| 1440 | + // we don't want any starting_ticket_datetime_row values set |
|
| 1441 | + // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
| 1442 | + // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
| 1443 | + $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
| 1444 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 1445 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
| 1446 | + : array(); |
|
| 1447 | + $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1448 | + $base_price = $default ? null : $ticket->base_price(); |
|
| 1449 | + $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
| 1450 | + // breaking out complicated condition for ticket_status |
|
| 1451 | + if ($default) { |
|
| 1452 | + $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1453 | + } else { |
|
| 1454 | + $ticket_status_class = $ticket->is_default() |
|
| 1455 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1456 | + : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1457 | + } |
|
| 1458 | + // breaking out complicated condition for TKT_taxable |
|
| 1459 | + if ($default) { |
|
| 1460 | + $TKT_taxable = ''; |
|
| 1461 | + } else { |
|
| 1462 | + $TKT_taxable = $ticket->taxable() |
|
| 1463 | + ? ' checked="checked"' |
|
| 1464 | + : ''; |
|
| 1465 | + } |
|
| 1466 | + if ($default) { |
|
| 1467 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1468 | + } elseif ($ticket->is_default()) { |
|
| 1469 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1470 | + } else { |
|
| 1471 | + $TKT_status = $ticket->ticket_status(true); |
|
| 1472 | + } |
|
| 1473 | + if ($default) { |
|
| 1474 | + $TKT_min = ''; |
|
| 1475 | + } else { |
|
| 1476 | + $TKT_min = $ticket->min(); |
|
| 1477 | + if ($TKT_min === -1 || $TKT_min === 0) { |
|
| 1478 | + $TKT_min = ''; |
|
| 1479 | + } |
|
| 1480 | + } |
|
| 1481 | + $template_args = array( |
|
| 1482 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1483 | + 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1484 | + // on initial page load this will always be the correct order. |
|
| 1485 | + 'tkt_status_class' => $ticket_status_class, |
|
| 1486 | + 'display_edit_tkt_row' => ' style="display:none;"', |
|
| 1487 | + 'edit_tkt_expanded' => '', |
|
| 1488 | + 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
| 1489 | + 'TKT_name' => $default ? '' : $ticket->get_f('TKT_name'), |
|
| 1490 | + 'TKT_start_date' => $default |
|
| 1491 | + ? '' |
|
| 1492 | + : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
| 1493 | + 'TKT_end_date' => $default |
|
| 1494 | + ? '' |
|
| 1495 | + : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
| 1496 | + 'TKT_status' => $TKT_status, |
|
| 1497 | + 'TKT_price' => $default |
|
| 1498 | + ? '' |
|
| 1499 | + : EEH_Template::format_currency( |
|
| 1500 | + $ticket->get_ticket_total_with_taxes(), |
|
| 1501 | + false, |
|
| 1502 | + false |
|
| 1503 | + ), |
|
| 1504 | + 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
| 1505 | + 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
| 1506 | + 'TKT_qty' => $default |
|
| 1507 | + ? '' |
|
| 1508 | + : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
| 1509 | + 'TKT_qty_for_input' => $default |
|
| 1510 | + ? '' |
|
| 1511 | + : $ticket->get_pretty('TKT_qty', 'input'), |
|
| 1512 | + 'TKT_uses' => $default |
|
| 1513 | + ? '' |
|
| 1514 | + : $ticket->get_pretty('TKT_uses', 'input'), |
|
| 1515 | + 'TKT_min' => $TKT_min, |
|
| 1516 | + 'TKT_max' => $default |
|
| 1517 | + ? '' |
|
| 1518 | + : $ticket->get_pretty('TKT_max', 'input'), |
|
| 1519 | + 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
| 1520 | + 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
| 1521 | + 'TKT_registrations' => $default |
|
| 1522 | + ? 0 |
|
| 1523 | + : $ticket->count_registrations( |
|
| 1524 | + array( |
|
| 1525 | + array( |
|
| 1526 | + 'STS_ID' => array( |
|
| 1527 | + '!=', |
|
| 1528 | + EEM_Registration::status_id_incomplete, |
|
| 1529 | + ), |
|
| 1530 | + ), |
|
| 1531 | + ) |
|
| 1532 | + ), |
|
| 1533 | + 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
| 1534 | + 'TKT_description' => $default ? '' : $ticket->get_f('TKT_description'), |
|
| 1535 | + 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
| 1536 | + 'TKT_required' => $default ? 0 : $ticket->required(), |
|
| 1537 | + 'TKT_is_default_selector' => '', |
|
| 1538 | + 'ticket_price_rows' => '', |
|
| 1539 | + 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
| 1540 | + ? '' |
|
| 1541 | + : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1542 | + 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
| 1543 | + 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
| 1544 | + ? '' |
|
| 1545 | + : ' style="display:none;"', |
|
| 1546 | + 'show_price_mod_button' => count($prices) > 1 |
|
| 1547 | + || ($default && $count_price_mods > 0) |
|
| 1548 | + || (! $default && $ticket->deleted()) |
|
| 1549 | + ? ' style="display:none;"' |
|
| 1550 | + : '', |
|
| 1551 | + 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
| 1552 | + 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1553 | + 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
| 1554 | + 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
| 1555 | + 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
| 1556 | + 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
| 1557 | + 'TKT_taxable' => $TKT_taxable, |
|
| 1558 | + 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
| 1559 | + ? '' |
|
| 1560 | + : ' style="display:none"', |
|
| 1561 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1562 | + 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
| 1563 | + $ticket_subtotal, |
|
| 1564 | + false, |
|
| 1565 | + false |
|
| 1566 | + ), |
|
| 1567 | + 'TKT_subtotal_amount' => $ticket_subtotal, |
|
| 1568 | + 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
| 1569 | + 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
| 1570 | + 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1571 | + ? ' ticket-archived' |
|
| 1572 | + : '', |
|
| 1573 | + 'trash_icon' => $ticket instanceof EE_Ticket |
|
| 1574 | + && $ticket->deleted() |
|
| 1575 | + && ! $ticket->is_permanently_deleteable() |
|
| 1576 | + ? 'ee-lock-icon ' |
|
| 1577 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1578 | + 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1579 | + ? '' |
|
| 1580 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1581 | + ); |
|
| 1582 | + $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1583 | + ? ' style="display:none"' |
|
| 1584 | + : ''; |
|
| 1585 | + // handle rows that should NOT be empty |
|
| 1586 | + if (empty($template_args['TKT_start_date'])) { |
|
| 1587 | + // if empty then the start date will be now. |
|
| 1588 | + $template_args['TKT_start_date'] = date( |
|
| 1589 | + $this->_date_time_format, |
|
| 1590 | + current_time('timestamp') |
|
| 1591 | + ); |
|
| 1592 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1593 | + } |
|
| 1594 | + if (empty($template_args['TKT_end_date'])) { |
|
| 1595 | + // get the earliest datetime (if present); |
|
| 1596 | + $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
| 1597 | + ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
| 1598 | + 'Datetime', |
|
| 1599 | + array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
| 1600 | + ) |
|
| 1601 | + : null; |
|
| 1602 | + if (! empty($earliest_dtt)) { |
|
| 1603 | + $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
| 1604 | + 'DTT_EVT_start', |
|
| 1605 | + $this->_date_time_format |
|
| 1606 | + ); |
|
| 1607 | + } else { |
|
| 1608 | + // default so let's just use what's been set for the default date-time which is 30 days from now. |
|
| 1609 | + $template_args['TKT_end_date'] = date( |
|
| 1610 | + $this->_date_time_format, |
|
| 1611 | + mktime( |
|
| 1612 | + 24, |
|
| 1613 | + 0, |
|
| 1614 | + 0, |
|
| 1615 | + date('m'), |
|
| 1616 | + date('d') + 29, |
|
| 1617 | + date('Y') |
|
| 1618 | + ) |
|
| 1619 | + ); |
|
| 1620 | + } |
|
| 1621 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1622 | + } |
|
| 1623 | + // generate ticket_datetime items |
|
| 1624 | + if (! $default) { |
|
| 1625 | + $datetime_row = 1; |
|
| 1626 | + foreach ($all_datetimes as $datetime) { |
|
| 1627 | + $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 1628 | + $datetime_row, |
|
| 1629 | + $ticket_row, |
|
| 1630 | + $datetime, |
|
| 1631 | + $ticket, |
|
| 1632 | + $ticket_datetimes, |
|
| 1633 | + $default |
|
| 1634 | + ); |
|
| 1635 | + $datetime_row++; |
|
| 1636 | + } |
|
| 1637 | + } |
|
| 1638 | + $price_row = 1; |
|
| 1639 | + foreach ($prices as $price) { |
|
| 1640 | + if (! $price instanceof EE_Price) { |
|
| 1641 | + continue; |
|
| 1642 | + } |
|
| 1643 | + if ($price->is_base_price()) { |
|
| 1644 | + $price_row++; |
|
| 1645 | + continue; |
|
| 1646 | + } |
|
| 1647 | + $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1648 | + $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
| 1649 | + $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
| 1650 | + $ticket_row, |
|
| 1651 | + $price_row, |
|
| 1652 | + $price, |
|
| 1653 | + $default, |
|
| 1654 | + $ticket, |
|
| 1655 | + $show_trash, |
|
| 1656 | + $show_create |
|
| 1657 | + ); |
|
| 1658 | + $price_row++; |
|
| 1659 | + } |
|
| 1660 | + // filter $template_args |
|
| 1661 | + $template_args = apply_filters( |
|
| 1662 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
| 1663 | + $template_args, |
|
| 1664 | + $ticket_row, |
|
| 1665 | + $ticket, |
|
| 1666 | + $ticket_datetimes, |
|
| 1667 | + $all_datetimes, |
|
| 1668 | + $default, |
|
| 1669 | + $all_tickets, |
|
| 1670 | + $this->_is_creating_event |
|
| 1671 | + ); |
|
| 1672 | + return EEH_Template::display_template( |
|
| 1673 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1674 | + $template_args, |
|
| 1675 | + true |
|
| 1676 | + ); |
|
| 1677 | + } |
|
| 1678 | 1678 | |
| 1679 | 1679 | |
| 1680 | - /** |
|
| 1681 | - * @param int $ticket_row |
|
| 1682 | - * @param EE_Ticket|null $ticket |
|
| 1683 | - * @return string |
|
| 1684 | - * @throws DomainException |
|
| 1685 | - * @throws EE_Error |
|
| 1686 | - */ |
|
| 1687 | - protected function _get_tax_rows($ticket_row, $ticket) |
|
| 1688 | - { |
|
| 1689 | - $tax_rows = ''; |
|
| 1690 | - /** @var EE_Price[] $taxes */ |
|
| 1691 | - $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
| 1692 | - foreach ($taxes as $tax) { |
|
| 1693 | - $tax_added = $this->_get_tax_added($tax, $ticket); |
|
| 1694 | - $template_args = array( |
|
| 1695 | - 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
| 1696 | - ? '' |
|
| 1697 | - : ' style="display:none;"', |
|
| 1698 | - 'tax_id' => $tax->ID(), |
|
| 1699 | - 'tkt_row' => $ticket_row, |
|
| 1700 | - 'tax_label' => $tax->get('PRC_name'), |
|
| 1701 | - 'tax_added' => $tax_added, |
|
| 1702 | - 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
| 1703 | - 'tax_amount' => $tax->get('PRC_amount'), |
|
| 1704 | - ); |
|
| 1705 | - $template_args = apply_filters( |
|
| 1706 | - 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
| 1707 | - $template_args, |
|
| 1708 | - $ticket_row, |
|
| 1709 | - $ticket, |
|
| 1710 | - $this->_is_creating_event |
|
| 1711 | - ); |
|
| 1712 | - $tax_rows .= EEH_Template::display_template( |
|
| 1713 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1714 | - $template_args, |
|
| 1715 | - true |
|
| 1716 | - ); |
|
| 1717 | - } |
|
| 1718 | - return $tax_rows; |
|
| 1719 | - } |
|
| 1680 | + /** |
|
| 1681 | + * @param int $ticket_row |
|
| 1682 | + * @param EE_Ticket|null $ticket |
|
| 1683 | + * @return string |
|
| 1684 | + * @throws DomainException |
|
| 1685 | + * @throws EE_Error |
|
| 1686 | + */ |
|
| 1687 | + protected function _get_tax_rows($ticket_row, $ticket) |
|
| 1688 | + { |
|
| 1689 | + $tax_rows = ''; |
|
| 1690 | + /** @var EE_Price[] $taxes */ |
|
| 1691 | + $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
| 1692 | + foreach ($taxes as $tax) { |
|
| 1693 | + $tax_added = $this->_get_tax_added($tax, $ticket); |
|
| 1694 | + $template_args = array( |
|
| 1695 | + 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
| 1696 | + ? '' |
|
| 1697 | + : ' style="display:none;"', |
|
| 1698 | + 'tax_id' => $tax->ID(), |
|
| 1699 | + 'tkt_row' => $ticket_row, |
|
| 1700 | + 'tax_label' => $tax->get('PRC_name'), |
|
| 1701 | + 'tax_added' => $tax_added, |
|
| 1702 | + 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
| 1703 | + 'tax_amount' => $tax->get('PRC_amount'), |
|
| 1704 | + ); |
|
| 1705 | + $template_args = apply_filters( |
|
| 1706 | + 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
| 1707 | + $template_args, |
|
| 1708 | + $ticket_row, |
|
| 1709 | + $ticket, |
|
| 1710 | + $this->_is_creating_event |
|
| 1711 | + ); |
|
| 1712 | + $tax_rows .= EEH_Template::display_template( |
|
| 1713 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1714 | + $template_args, |
|
| 1715 | + true |
|
| 1716 | + ); |
|
| 1717 | + } |
|
| 1718 | + return $tax_rows; |
|
| 1719 | + } |
|
| 1720 | 1720 | |
| 1721 | 1721 | |
| 1722 | - /** |
|
| 1723 | - * @param EE_Price $tax |
|
| 1724 | - * @param EE_Ticket|null $ticket |
|
| 1725 | - * @return float|int |
|
| 1726 | - * @throws EE_Error |
|
| 1727 | - */ |
|
| 1728 | - protected function _get_tax_added(EE_Price $tax, $ticket) |
|
| 1729 | - { |
|
| 1730 | - $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1731 | - return $subtotal * $tax->get('PRC_amount') / 100; |
|
| 1732 | - } |
|
| 1722 | + /** |
|
| 1723 | + * @param EE_Price $tax |
|
| 1724 | + * @param EE_Ticket|null $ticket |
|
| 1725 | + * @return float|int |
|
| 1726 | + * @throws EE_Error |
|
| 1727 | + */ |
|
| 1728 | + protected function _get_tax_added(EE_Price $tax, $ticket) |
|
| 1729 | + { |
|
| 1730 | + $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1731 | + return $subtotal * $tax->get('PRC_amount') / 100; |
|
| 1732 | + } |
|
| 1733 | 1733 | |
| 1734 | 1734 | |
| 1735 | - /** |
|
| 1736 | - * @param int $ticket_row |
|
| 1737 | - * @param int $price_row |
|
| 1738 | - * @param EE_Price|null $price |
|
| 1739 | - * @param bool $default |
|
| 1740 | - * @param EE_Ticket|null $ticket |
|
| 1741 | - * @param bool $show_trash |
|
| 1742 | - * @param bool $show_create |
|
| 1743 | - * @return mixed |
|
| 1744 | - * @throws InvalidArgumentException |
|
| 1745 | - * @throws InvalidInterfaceException |
|
| 1746 | - * @throws InvalidDataTypeException |
|
| 1747 | - * @throws DomainException |
|
| 1748 | - * @throws EE_Error |
|
| 1749 | - * @throws ReflectionException |
|
| 1750 | - */ |
|
| 1751 | - protected function _get_ticket_price_row( |
|
| 1752 | - $ticket_row, |
|
| 1753 | - $price_row, |
|
| 1754 | - $price, |
|
| 1755 | - $default, |
|
| 1756 | - $ticket, |
|
| 1757 | - $show_trash = true, |
|
| 1758 | - $show_create = true |
|
| 1759 | - ) { |
|
| 1760 | - $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
| 1761 | - $template_args = array( |
|
| 1762 | - 'tkt_row' => $default && empty($ticket) |
|
| 1763 | - ? 'TICKETNUM' |
|
| 1764 | - : $ticket_row, |
|
| 1765 | - 'PRC_order' => $default && empty($price) |
|
| 1766 | - ? 'PRICENUM' |
|
| 1767 | - : $price_row, |
|
| 1768 | - 'edit_prices_name' => $default && empty($price) |
|
| 1769 | - ? 'PRICENAMEATTR' |
|
| 1770 | - : 'edit_prices', |
|
| 1771 | - 'price_type_selector' => $default && empty($price) |
|
| 1772 | - ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1773 | - : $this->_get_price_type_selector( |
|
| 1774 | - $ticket_row, |
|
| 1775 | - $price_row, |
|
| 1776 | - $price, |
|
| 1777 | - $default, |
|
| 1778 | - $send_disabled |
|
| 1779 | - ), |
|
| 1780 | - 'PRC_ID' => $default && empty($price) |
|
| 1781 | - ? 0 |
|
| 1782 | - : $price->ID(), |
|
| 1783 | - 'PRC_is_default' => $default && empty($price) |
|
| 1784 | - ? 0 |
|
| 1785 | - : $price->get('PRC_is_default'), |
|
| 1786 | - 'PRC_name' => $default && empty($price) |
|
| 1787 | - ? '' |
|
| 1788 | - : $price->get('PRC_name'), |
|
| 1789 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1790 | - 'show_plus_or_minus' => $default && empty($price) |
|
| 1791 | - ? '' |
|
| 1792 | - : ' style="display:none;"', |
|
| 1793 | - 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
| 1794 | - ? ' style="display:none;"' |
|
| 1795 | - : '', |
|
| 1796 | - 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
| 1797 | - ? ' style="display:none;"' |
|
| 1798 | - : '', |
|
| 1799 | - 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
| 1800 | - ? ' style="display:none"' |
|
| 1801 | - : '', |
|
| 1802 | - 'PRC_amount' => $default && empty($price) |
|
| 1803 | - ? 0 |
|
| 1804 | - : $price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1805 | - 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
| 1806 | - ? ' style="display:none;"' |
|
| 1807 | - : '', |
|
| 1808 | - 'show_trash_icon' => $show_trash |
|
| 1809 | - ? '' |
|
| 1810 | - : ' style="display:none;"', |
|
| 1811 | - 'show_create_button' => $show_create |
|
| 1812 | - ? '' |
|
| 1813 | - : ' style="display:none;"', |
|
| 1814 | - 'PRC_desc' => $default && empty($price) |
|
| 1815 | - ? '' |
|
| 1816 | - : $price->get('PRC_desc'), |
|
| 1817 | - 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
| 1818 | - ); |
|
| 1819 | - $template_args = apply_filters( |
|
| 1820 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
| 1821 | - $template_args, |
|
| 1822 | - $ticket_row, |
|
| 1823 | - $price_row, |
|
| 1824 | - $price, |
|
| 1825 | - $default, |
|
| 1826 | - $ticket, |
|
| 1827 | - $show_trash, |
|
| 1828 | - $show_create, |
|
| 1829 | - $this->_is_creating_event |
|
| 1830 | - ); |
|
| 1831 | - return EEH_Template::display_template( |
|
| 1832 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1833 | - $template_args, |
|
| 1834 | - true |
|
| 1835 | - ); |
|
| 1836 | - } |
|
| 1735 | + /** |
|
| 1736 | + * @param int $ticket_row |
|
| 1737 | + * @param int $price_row |
|
| 1738 | + * @param EE_Price|null $price |
|
| 1739 | + * @param bool $default |
|
| 1740 | + * @param EE_Ticket|null $ticket |
|
| 1741 | + * @param bool $show_trash |
|
| 1742 | + * @param bool $show_create |
|
| 1743 | + * @return mixed |
|
| 1744 | + * @throws InvalidArgumentException |
|
| 1745 | + * @throws InvalidInterfaceException |
|
| 1746 | + * @throws InvalidDataTypeException |
|
| 1747 | + * @throws DomainException |
|
| 1748 | + * @throws EE_Error |
|
| 1749 | + * @throws ReflectionException |
|
| 1750 | + */ |
|
| 1751 | + protected function _get_ticket_price_row( |
|
| 1752 | + $ticket_row, |
|
| 1753 | + $price_row, |
|
| 1754 | + $price, |
|
| 1755 | + $default, |
|
| 1756 | + $ticket, |
|
| 1757 | + $show_trash = true, |
|
| 1758 | + $show_create = true |
|
| 1759 | + ) { |
|
| 1760 | + $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
| 1761 | + $template_args = array( |
|
| 1762 | + 'tkt_row' => $default && empty($ticket) |
|
| 1763 | + ? 'TICKETNUM' |
|
| 1764 | + : $ticket_row, |
|
| 1765 | + 'PRC_order' => $default && empty($price) |
|
| 1766 | + ? 'PRICENUM' |
|
| 1767 | + : $price_row, |
|
| 1768 | + 'edit_prices_name' => $default && empty($price) |
|
| 1769 | + ? 'PRICENAMEATTR' |
|
| 1770 | + : 'edit_prices', |
|
| 1771 | + 'price_type_selector' => $default && empty($price) |
|
| 1772 | + ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1773 | + : $this->_get_price_type_selector( |
|
| 1774 | + $ticket_row, |
|
| 1775 | + $price_row, |
|
| 1776 | + $price, |
|
| 1777 | + $default, |
|
| 1778 | + $send_disabled |
|
| 1779 | + ), |
|
| 1780 | + 'PRC_ID' => $default && empty($price) |
|
| 1781 | + ? 0 |
|
| 1782 | + : $price->ID(), |
|
| 1783 | + 'PRC_is_default' => $default && empty($price) |
|
| 1784 | + ? 0 |
|
| 1785 | + : $price->get('PRC_is_default'), |
|
| 1786 | + 'PRC_name' => $default && empty($price) |
|
| 1787 | + ? '' |
|
| 1788 | + : $price->get('PRC_name'), |
|
| 1789 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1790 | + 'show_plus_or_minus' => $default && empty($price) |
|
| 1791 | + ? '' |
|
| 1792 | + : ' style="display:none;"', |
|
| 1793 | + 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
| 1794 | + ? ' style="display:none;"' |
|
| 1795 | + : '', |
|
| 1796 | + 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
| 1797 | + ? ' style="display:none;"' |
|
| 1798 | + : '', |
|
| 1799 | + 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
| 1800 | + ? ' style="display:none"' |
|
| 1801 | + : '', |
|
| 1802 | + 'PRC_amount' => $default && empty($price) |
|
| 1803 | + ? 0 |
|
| 1804 | + : $price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1805 | + 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
| 1806 | + ? ' style="display:none;"' |
|
| 1807 | + : '', |
|
| 1808 | + 'show_trash_icon' => $show_trash |
|
| 1809 | + ? '' |
|
| 1810 | + : ' style="display:none;"', |
|
| 1811 | + 'show_create_button' => $show_create |
|
| 1812 | + ? '' |
|
| 1813 | + : ' style="display:none;"', |
|
| 1814 | + 'PRC_desc' => $default && empty($price) |
|
| 1815 | + ? '' |
|
| 1816 | + : $price->get('PRC_desc'), |
|
| 1817 | + 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
| 1818 | + ); |
|
| 1819 | + $template_args = apply_filters( |
|
| 1820 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
| 1821 | + $template_args, |
|
| 1822 | + $ticket_row, |
|
| 1823 | + $price_row, |
|
| 1824 | + $price, |
|
| 1825 | + $default, |
|
| 1826 | + $ticket, |
|
| 1827 | + $show_trash, |
|
| 1828 | + $show_create, |
|
| 1829 | + $this->_is_creating_event |
|
| 1830 | + ); |
|
| 1831 | + return EEH_Template::display_template( |
|
| 1832 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1833 | + $template_args, |
|
| 1834 | + true |
|
| 1835 | + ); |
|
| 1836 | + } |
|
| 1837 | 1837 | |
| 1838 | 1838 | |
| 1839 | - /** |
|
| 1840 | - * @param int $ticket_row |
|
| 1841 | - * @param int $price_row |
|
| 1842 | - * @param EE_Price $price |
|
| 1843 | - * @param bool $default |
|
| 1844 | - * @param bool $disabled |
|
| 1845 | - * @return mixed |
|
| 1846 | - * @throws ReflectionException |
|
| 1847 | - * @throws InvalidArgumentException |
|
| 1848 | - * @throws InvalidInterfaceException |
|
| 1849 | - * @throws InvalidDataTypeException |
|
| 1850 | - * @throws DomainException |
|
| 1851 | - * @throws EE_Error |
|
| 1852 | - */ |
|
| 1853 | - protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
| 1854 | - { |
|
| 1855 | - if ($price->is_base_price()) { |
|
| 1856 | - return $this->_get_base_price_template( |
|
| 1857 | - $ticket_row, |
|
| 1858 | - $price_row, |
|
| 1859 | - $price, |
|
| 1860 | - $default |
|
| 1861 | - ); |
|
| 1862 | - } |
|
| 1863 | - return $this->_get_price_modifier_template( |
|
| 1864 | - $ticket_row, |
|
| 1865 | - $price_row, |
|
| 1866 | - $price, |
|
| 1867 | - $default, |
|
| 1868 | - $disabled |
|
| 1869 | - ); |
|
| 1870 | - } |
|
| 1839 | + /** |
|
| 1840 | + * @param int $ticket_row |
|
| 1841 | + * @param int $price_row |
|
| 1842 | + * @param EE_Price $price |
|
| 1843 | + * @param bool $default |
|
| 1844 | + * @param bool $disabled |
|
| 1845 | + * @return mixed |
|
| 1846 | + * @throws ReflectionException |
|
| 1847 | + * @throws InvalidArgumentException |
|
| 1848 | + * @throws InvalidInterfaceException |
|
| 1849 | + * @throws InvalidDataTypeException |
|
| 1850 | + * @throws DomainException |
|
| 1851 | + * @throws EE_Error |
|
| 1852 | + */ |
|
| 1853 | + protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
| 1854 | + { |
|
| 1855 | + if ($price->is_base_price()) { |
|
| 1856 | + return $this->_get_base_price_template( |
|
| 1857 | + $ticket_row, |
|
| 1858 | + $price_row, |
|
| 1859 | + $price, |
|
| 1860 | + $default |
|
| 1861 | + ); |
|
| 1862 | + } |
|
| 1863 | + return $this->_get_price_modifier_template( |
|
| 1864 | + $ticket_row, |
|
| 1865 | + $price_row, |
|
| 1866 | + $price, |
|
| 1867 | + $default, |
|
| 1868 | + $disabled |
|
| 1869 | + ); |
|
| 1870 | + } |
|
| 1871 | 1871 | |
| 1872 | 1872 | |
| 1873 | - /** |
|
| 1874 | - * @param int $ticket_row |
|
| 1875 | - * @param int $price_row |
|
| 1876 | - * @param EE_Price $price |
|
| 1877 | - * @param bool $default |
|
| 1878 | - * @return mixed |
|
| 1879 | - * @throws DomainException |
|
| 1880 | - * @throws EE_Error |
|
| 1881 | - */ |
|
| 1882 | - protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1883 | - { |
|
| 1884 | - $template_args = array( |
|
| 1885 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1886 | - 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
| 1887 | - 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
| 1888 | - 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
| 1889 | - 'price_selected_operator' => '+', |
|
| 1890 | - 'price_selected_is_percent' => 0, |
|
| 1891 | - ); |
|
| 1892 | - $template_args = apply_filters( |
|
| 1893 | - 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
| 1894 | - $template_args, |
|
| 1895 | - $ticket_row, |
|
| 1896 | - $price_row, |
|
| 1897 | - $price, |
|
| 1898 | - $default, |
|
| 1899 | - $this->_is_creating_event |
|
| 1900 | - ); |
|
| 1901 | - return EEH_Template::display_template( |
|
| 1902 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1903 | - $template_args, |
|
| 1904 | - true |
|
| 1905 | - ); |
|
| 1906 | - } |
|
| 1873 | + /** |
|
| 1874 | + * @param int $ticket_row |
|
| 1875 | + * @param int $price_row |
|
| 1876 | + * @param EE_Price $price |
|
| 1877 | + * @param bool $default |
|
| 1878 | + * @return mixed |
|
| 1879 | + * @throws DomainException |
|
| 1880 | + * @throws EE_Error |
|
| 1881 | + */ |
|
| 1882 | + protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1883 | + { |
|
| 1884 | + $template_args = array( |
|
| 1885 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1886 | + 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
| 1887 | + 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
| 1888 | + 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
| 1889 | + 'price_selected_operator' => '+', |
|
| 1890 | + 'price_selected_is_percent' => 0, |
|
| 1891 | + ); |
|
| 1892 | + $template_args = apply_filters( |
|
| 1893 | + 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
| 1894 | + $template_args, |
|
| 1895 | + $ticket_row, |
|
| 1896 | + $price_row, |
|
| 1897 | + $price, |
|
| 1898 | + $default, |
|
| 1899 | + $this->_is_creating_event |
|
| 1900 | + ); |
|
| 1901 | + return EEH_Template::display_template( |
|
| 1902 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1903 | + $template_args, |
|
| 1904 | + true |
|
| 1905 | + ); |
|
| 1906 | + } |
|
| 1907 | 1907 | |
| 1908 | 1908 | |
| 1909 | - /** |
|
| 1910 | - * @param int $ticket_row |
|
| 1911 | - * @param int $price_row |
|
| 1912 | - * @param EE_Price $price |
|
| 1913 | - * @param bool $default |
|
| 1914 | - * @param bool $disabled |
|
| 1915 | - * @return mixed |
|
| 1916 | - * @throws ReflectionException |
|
| 1917 | - * @throws InvalidArgumentException |
|
| 1918 | - * @throws InvalidInterfaceException |
|
| 1919 | - * @throws InvalidDataTypeException |
|
| 1920 | - * @throws DomainException |
|
| 1921 | - * @throws EE_Error |
|
| 1922 | - */ |
|
| 1923 | - protected function _get_price_modifier_template( |
|
| 1924 | - $ticket_row, |
|
| 1925 | - $price_row, |
|
| 1926 | - $price, |
|
| 1927 | - $default, |
|
| 1928 | - $disabled = false |
|
| 1929 | - ) { |
|
| 1930 | - $select_name = $default && ! $price instanceof EE_Price |
|
| 1931 | - ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
| 1932 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1933 | - /** @var EEM_Price_Type $price_type_model */ |
|
| 1934 | - $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
| 1935 | - $price_types = $price_type_model->get_all(array( |
|
| 1936 | - array( |
|
| 1937 | - 'OR' => array( |
|
| 1938 | - 'PBT_ID' => '2', |
|
| 1939 | - 'PBT_ID*' => '3', |
|
| 1940 | - ), |
|
| 1941 | - ), |
|
| 1942 | - )); |
|
| 1943 | - $all_price_types = $default && ! $price instanceof EE_Price |
|
| 1944 | - ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
| 1945 | - : array(); |
|
| 1946 | - $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
| 1947 | - $price_option_spans = ''; |
|
| 1948 | - // setup price types for selector |
|
| 1949 | - foreach ($price_types as $price_type) { |
|
| 1950 | - if (! $price_type instanceof EE_Price_Type) { |
|
| 1951 | - continue; |
|
| 1952 | - } |
|
| 1953 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
| 1954 | - // while we're in the loop let's setup the option spans used by js |
|
| 1955 | - $span_args = array( |
|
| 1956 | - 'PRT_ID' => $price_type->ID(), |
|
| 1957 | - 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
| 1958 | - 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
| 1959 | - ); |
|
| 1960 | - $price_option_spans .= EEH_Template::display_template( |
|
| 1961 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1962 | - $span_args, |
|
| 1963 | - true |
|
| 1964 | - ); |
|
| 1965 | - } |
|
| 1966 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
| 1967 | - : $select_name; |
|
| 1968 | - $select_input = new EE_Select_Input( |
|
| 1969 | - $all_price_types, |
|
| 1970 | - array( |
|
| 1971 | - 'default' => $selected_price_type_id, |
|
| 1972 | - 'html_name' => $select_name, |
|
| 1973 | - 'html_class' => 'edit-price-PRT_ID', |
|
| 1974 | - 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
| 1975 | - ) |
|
| 1976 | - ); |
|
| 1977 | - $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
| 1978 | - $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
| 1979 | - $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
| 1980 | - $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
| 1981 | - $template_args = array( |
|
| 1982 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1983 | - 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
| 1984 | - 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
| 1985 | - 'main_name' => $select_name, |
|
| 1986 | - 'selected_price_type_id' => $selected_price_type_id, |
|
| 1987 | - 'price_option_spans' => $price_option_spans, |
|
| 1988 | - 'price_selected_operator' => $price_selected_operator, |
|
| 1989 | - 'price_selected_is_percent' => $price_selected_is_percent, |
|
| 1990 | - 'disabled' => $disabled, |
|
| 1991 | - ); |
|
| 1992 | - $template_args = apply_filters( |
|
| 1993 | - 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
| 1994 | - $template_args, |
|
| 1995 | - $ticket_row, |
|
| 1996 | - $price_row, |
|
| 1997 | - $price, |
|
| 1998 | - $default, |
|
| 1999 | - $disabled, |
|
| 2000 | - $this->_is_creating_event |
|
| 2001 | - ); |
|
| 2002 | - return EEH_Template::display_template( |
|
| 2003 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 2004 | - $template_args, |
|
| 2005 | - true |
|
| 2006 | - ); |
|
| 2007 | - } |
|
| 1909 | + /** |
|
| 1910 | + * @param int $ticket_row |
|
| 1911 | + * @param int $price_row |
|
| 1912 | + * @param EE_Price $price |
|
| 1913 | + * @param bool $default |
|
| 1914 | + * @param bool $disabled |
|
| 1915 | + * @return mixed |
|
| 1916 | + * @throws ReflectionException |
|
| 1917 | + * @throws InvalidArgumentException |
|
| 1918 | + * @throws InvalidInterfaceException |
|
| 1919 | + * @throws InvalidDataTypeException |
|
| 1920 | + * @throws DomainException |
|
| 1921 | + * @throws EE_Error |
|
| 1922 | + */ |
|
| 1923 | + protected function _get_price_modifier_template( |
|
| 1924 | + $ticket_row, |
|
| 1925 | + $price_row, |
|
| 1926 | + $price, |
|
| 1927 | + $default, |
|
| 1928 | + $disabled = false |
|
| 1929 | + ) { |
|
| 1930 | + $select_name = $default && ! $price instanceof EE_Price |
|
| 1931 | + ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
| 1932 | + : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1933 | + /** @var EEM_Price_Type $price_type_model */ |
|
| 1934 | + $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
| 1935 | + $price_types = $price_type_model->get_all(array( |
|
| 1936 | + array( |
|
| 1937 | + 'OR' => array( |
|
| 1938 | + 'PBT_ID' => '2', |
|
| 1939 | + 'PBT_ID*' => '3', |
|
| 1940 | + ), |
|
| 1941 | + ), |
|
| 1942 | + )); |
|
| 1943 | + $all_price_types = $default && ! $price instanceof EE_Price |
|
| 1944 | + ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
| 1945 | + : array(); |
|
| 1946 | + $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
| 1947 | + $price_option_spans = ''; |
|
| 1948 | + // setup price types for selector |
|
| 1949 | + foreach ($price_types as $price_type) { |
|
| 1950 | + if (! $price_type instanceof EE_Price_Type) { |
|
| 1951 | + continue; |
|
| 1952 | + } |
|
| 1953 | + $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
| 1954 | + // while we're in the loop let's setup the option spans used by js |
|
| 1955 | + $span_args = array( |
|
| 1956 | + 'PRT_ID' => $price_type->ID(), |
|
| 1957 | + 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
| 1958 | + 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
| 1959 | + ); |
|
| 1960 | + $price_option_spans .= EEH_Template::display_template( |
|
| 1961 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1962 | + $span_args, |
|
| 1963 | + true |
|
| 1964 | + ); |
|
| 1965 | + } |
|
| 1966 | + $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
| 1967 | + : $select_name; |
|
| 1968 | + $select_input = new EE_Select_Input( |
|
| 1969 | + $all_price_types, |
|
| 1970 | + array( |
|
| 1971 | + 'default' => $selected_price_type_id, |
|
| 1972 | + 'html_name' => $select_name, |
|
| 1973 | + 'html_class' => 'edit-price-PRT_ID', |
|
| 1974 | + 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
| 1975 | + ) |
|
| 1976 | + ); |
|
| 1977 | + $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
| 1978 | + $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
| 1979 | + $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
| 1980 | + $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
| 1981 | + $template_args = array( |
|
| 1982 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1983 | + 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
| 1984 | + 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
| 1985 | + 'main_name' => $select_name, |
|
| 1986 | + 'selected_price_type_id' => $selected_price_type_id, |
|
| 1987 | + 'price_option_spans' => $price_option_spans, |
|
| 1988 | + 'price_selected_operator' => $price_selected_operator, |
|
| 1989 | + 'price_selected_is_percent' => $price_selected_is_percent, |
|
| 1990 | + 'disabled' => $disabled, |
|
| 1991 | + ); |
|
| 1992 | + $template_args = apply_filters( |
|
| 1993 | + 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
| 1994 | + $template_args, |
|
| 1995 | + $ticket_row, |
|
| 1996 | + $price_row, |
|
| 1997 | + $price, |
|
| 1998 | + $default, |
|
| 1999 | + $disabled, |
|
| 2000 | + $this->_is_creating_event |
|
| 2001 | + ); |
|
| 2002 | + return EEH_Template::display_template( |
|
| 2003 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 2004 | + $template_args, |
|
| 2005 | + true |
|
| 2006 | + ); |
|
| 2007 | + } |
|
| 2008 | 2008 | |
| 2009 | 2009 | |
| 2010 | - /** |
|
| 2011 | - * @param int $datetime_row |
|
| 2012 | - * @param int $ticket_row |
|
| 2013 | - * @param EE_Datetime|null $datetime |
|
| 2014 | - * @param EE_Ticket|null $ticket |
|
| 2015 | - * @param array $ticket_datetimes |
|
| 2016 | - * @param bool $default |
|
| 2017 | - * @return mixed |
|
| 2018 | - * @throws DomainException |
|
| 2019 | - * @throws EE_Error |
|
| 2020 | - */ |
|
| 2021 | - protected function _get_ticket_datetime_list_item( |
|
| 2022 | - $datetime_row, |
|
| 2023 | - $ticket_row, |
|
| 2024 | - $datetime, |
|
| 2025 | - $ticket, |
|
| 2026 | - $ticket_datetimes = array(), |
|
| 2027 | - $default |
|
| 2028 | - ) { |
|
| 2029 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 2030 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
| 2031 | - : array(); |
|
| 2032 | - $template_args = array( |
|
| 2033 | - 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
| 2034 | - ? 'DTTNUM' |
|
| 2035 | - : $datetime_row, |
|
| 2036 | - 'tkt_row' => $default |
|
| 2037 | - ? 'TICKETNUM' |
|
| 2038 | - : $ticket_row, |
|
| 2039 | - 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 2040 | - ? ' ticket-selected' |
|
| 2041 | - : '', |
|
| 2042 | - 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 2043 | - ? ' checked="checked"' |
|
| 2044 | - : '', |
|
| 2045 | - 'DTT_name' => $default && empty($datetime) |
|
| 2046 | - ? 'DTTNAME' |
|
| 2047 | - : $datetime->get_dtt_display_name(true), |
|
| 2048 | - 'tkt_status_class' => '', |
|
| 2049 | - ); |
|
| 2050 | - $template_args = apply_filters( |
|
| 2051 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
| 2052 | - $template_args, |
|
| 2053 | - $datetime_row, |
|
| 2054 | - $ticket_row, |
|
| 2055 | - $datetime, |
|
| 2056 | - $ticket, |
|
| 2057 | - $ticket_datetimes, |
|
| 2058 | - $default, |
|
| 2059 | - $this->_is_creating_event |
|
| 2060 | - ); |
|
| 2061 | - return EEH_Template::display_template( |
|
| 2062 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 2063 | - $template_args, |
|
| 2064 | - true |
|
| 2065 | - ); |
|
| 2066 | - } |
|
| 2010 | + /** |
|
| 2011 | + * @param int $datetime_row |
|
| 2012 | + * @param int $ticket_row |
|
| 2013 | + * @param EE_Datetime|null $datetime |
|
| 2014 | + * @param EE_Ticket|null $ticket |
|
| 2015 | + * @param array $ticket_datetimes |
|
| 2016 | + * @param bool $default |
|
| 2017 | + * @return mixed |
|
| 2018 | + * @throws DomainException |
|
| 2019 | + * @throws EE_Error |
|
| 2020 | + */ |
|
| 2021 | + protected function _get_ticket_datetime_list_item( |
|
| 2022 | + $datetime_row, |
|
| 2023 | + $ticket_row, |
|
| 2024 | + $datetime, |
|
| 2025 | + $ticket, |
|
| 2026 | + $ticket_datetimes = array(), |
|
| 2027 | + $default |
|
| 2028 | + ) { |
|
| 2029 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 2030 | + ? $ticket_datetimes[ $ticket->ID() ] |
|
| 2031 | + : array(); |
|
| 2032 | + $template_args = array( |
|
| 2033 | + 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
| 2034 | + ? 'DTTNUM' |
|
| 2035 | + : $datetime_row, |
|
| 2036 | + 'tkt_row' => $default |
|
| 2037 | + ? 'TICKETNUM' |
|
| 2038 | + : $ticket_row, |
|
| 2039 | + 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 2040 | + ? ' ticket-selected' |
|
| 2041 | + : '', |
|
| 2042 | + 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 2043 | + ? ' checked="checked"' |
|
| 2044 | + : '', |
|
| 2045 | + 'DTT_name' => $default && empty($datetime) |
|
| 2046 | + ? 'DTTNAME' |
|
| 2047 | + : $datetime->get_dtt_display_name(true), |
|
| 2048 | + 'tkt_status_class' => '', |
|
| 2049 | + ); |
|
| 2050 | + $template_args = apply_filters( |
|
| 2051 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
| 2052 | + $template_args, |
|
| 2053 | + $datetime_row, |
|
| 2054 | + $ticket_row, |
|
| 2055 | + $datetime, |
|
| 2056 | + $ticket, |
|
| 2057 | + $ticket_datetimes, |
|
| 2058 | + $default, |
|
| 2059 | + $this->_is_creating_event |
|
| 2060 | + ); |
|
| 2061 | + return EEH_Template::display_template( |
|
| 2062 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 2063 | + $template_args, |
|
| 2064 | + true |
|
| 2065 | + ); |
|
| 2066 | + } |
|
| 2067 | 2067 | |
| 2068 | 2068 | |
| 2069 | - /** |
|
| 2070 | - * @param array $all_datetimes |
|
| 2071 | - * @param array $all_tickets |
|
| 2072 | - * @return mixed |
|
| 2073 | - * @throws ReflectionException |
|
| 2074 | - * @throws InvalidArgumentException |
|
| 2075 | - * @throws InvalidInterfaceException |
|
| 2076 | - * @throws InvalidDataTypeException |
|
| 2077 | - * @throws DomainException |
|
| 2078 | - * @throws EE_Error |
|
| 2079 | - */ |
|
| 2080 | - protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
| 2081 | - { |
|
| 2082 | - $template_args = array( |
|
| 2083 | - 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
| 2084 | - 'DTTNUM', |
|
| 2085 | - null, |
|
| 2086 | - true, |
|
| 2087 | - $all_datetimes |
|
| 2088 | - ), |
|
| 2089 | - 'default_ticket_row' => $this->_get_ticket_row( |
|
| 2090 | - 'TICKETNUM', |
|
| 2091 | - null, |
|
| 2092 | - array(), |
|
| 2093 | - array(), |
|
| 2094 | - true |
|
| 2095 | - ), |
|
| 2096 | - 'default_price_row' => $this->_get_ticket_price_row( |
|
| 2097 | - 'TICKETNUM', |
|
| 2098 | - 'PRICENUM', |
|
| 2099 | - null, |
|
| 2100 | - true, |
|
| 2101 | - null |
|
| 2102 | - ), |
|
| 2103 | - 'default_price_rows' => '', |
|
| 2104 | - 'default_base_price_amount' => 0, |
|
| 2105 | - 'default_base_price_name' => '', |
|
| 2106 | - 'default_base_price_description' => '', |
|
| 2107 | - 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
| 2108 | - 'TICKETNUM', |
|
| 2109 | - 'PRICENUM', |
|
| 2110 | - null, |
|
| 2111 | - true |
|
| 2112 | - ), |
|
| 2113 | - 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
| 2114 | - 'DTTNUM', |
|
| 2115 | - null, |
|
| 2116 | - array(), |
|
| 2117 | - array(), |
|
| 2118 | - true |
|
| 2119 | - ), |
|
| 2120 | - 'existing_available_datetime_tickets_list' => '', |
|
| 2121 | - 'existing_available_ticket_datetimes_list' => '', |
|
| 2122 | - 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
| 2123 | - 'DTTNUM', |
|
| 2124 | - 'TICKETNUM', |
|
| 2125 | - null, |
|
| 2126 | - null, |
|
| 2127 | - array(), |
|
| 2128 | - true |
|
| 2129 | - ), |
|
| 2130 | - 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
| 2131 | - 'DTTNUM', |
|
| 2132 | - 'TICKETNUM', |
|
| 2133 | - null, |
|
| 2134 | - null, |
|
| 2135 | - array(), |
|
| 2136 | - true |
|
| 2137 | - ), |
|
| 2138 | - ); |
|
| 2139 | - $ticket_row = 1; |
|
| 2140 | - foreach ($all_tickets as $ticket) { |
|
| 2141 | - $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 2142 | - 'DTTNUM', |
|
| 2143 | - $ticket_row, |
|
| 2144 | - null, |
|
| 2145 | - $ticket, |
|
| 2146 | - array(), |
|
| 2147 | - true |
|
| 2148 | - ); |
|
| 2149 | - $ticket_row++; |
|
| 2150 | - } |
|
| 2151 | - $datetime_row = 1; |
|
| 2152 | - foreach ($all_datetimes as $datetime) { |
|
| 2153 | - $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 2154 | - $datetime_row, |
|
| 2155 | - 'TICKETNUM', |
|
| 2156 | - $datetime, |
|
| 2157 | - null, |
|
| 2158 | - array(), |
|
| 2159 | - true |
|
| 2160 | - ); |
|
| 2161 | - $datetime_row++; |
|
| 2162 | - } |
|
| 2163 | - /** @var EEM_Price $price_model */ |
|
| 2164 | - $price_model = EE_Registry::instance()->load_model('Price'); |
|
| 2165 | - $default_prices = $price_model->get_all_default_prices(); |
|
| 2166 | - $price_row = 1; |
|
| 2167 | - foreach ($default_prices as $price) { |
|
| 2168 | - if (! $price instanceof EE_Price) { |
|
| 2169 | - continue; |
|
| 2170 | - } |
|
| 2171 | - if ($price->is_base_price()) { |
|
| 2172 | - $template_args['default_base_price_amount'] = $price->get_pretty( |
|
| 2173 | - 'PRC_amount', |
|
| 2174 | - 'localized_float' |
|
| 2175 | - ); |
|
| 2176 | - $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
| 2177 | - $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
| 2178 | - $price_row++; |
|
| 2179 | - continue; |
|
| 2180 | - } |
|
| 2181 | - $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
| 2182 | - || count($default_prices) === 1); |
|
| 2183 | - $show_create = ! (count($default_prices) > 1 |
|
| 2184 | - && count($default_prices) |
|
| 2185 | - !== $price_row); |
|
| 2186 | - $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
| 2187 | - 'TICKETNUM', |
|
| 2188 | - $price_row, |
|
| 2189 | - $price, |
|
| 2190 | - true, |
|
| 2191 | - null, |
|
| 2192 | - $show_trash, |
|
| 2193 | - $show_create |
|
| 2194 | - ); |
|
| 2195 | - $price_row++; |
|
| 2196 | - } |
|
| 2197 | - $template_args = apply_filters( |
|
| 2198 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
| 2199 | - $template_args, |
|
| 2200 | - $all_datetimes, |
|
| 2201 | - $all_tickets, |
|
| 2202 | - $this->_is_creating_event |
|
| 2203 | - ); |
|
| 2204 | - return EEH_Template::display_template( |
|
| 2205 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2206 | - $template_args, |
|
| 2207 | - true |
|
| 2208 | - ); |
|
| 2209 | - } |
|
| 2069 | + /** |
|
| 2070 | + * @param array $all_datetimes |
|
| 2071 | + * @param array $all_tickets |
|
| 2072 | + * @return mixed |
|
| 2073 | + * @throws ReflectionException |
|
| 2074 | + * @throws InvalidArgumentException |
|
| 2075 | + * @throws InvalidInterfaceException |
|
| 2076 | + * @throws InvalidDataTypeException |
|
| 2077 | + * @throws DomainException |
|
| 2078 | + * @throws EE_Error |
|
| 2079 | + */ |
|
| 2080 | + protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
| 2081 | + { |
|
| 2082 | + $template_args = array( |
|
| 2083 | + 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
| 2084 | + 'DTTNUM', |
|
| 2085 | + null, |
|
| 2086 | + true, |
|
| 2087 | + $all_datetimes |
|
| 2088 | + ), |
|
| 2089 | + 'default_ticket_row' => $this->_get_ticket_row( |
|
| 2090 | + 'TICKETNUM', |
|
| 2091 | + null, |
|
| 2092 | + array(), |
|
| 2093 | + array(), |
|
| 2094 | + true |
|
| 2095 | + ), |
|
| 2096 | + 'default_price_row' => $this->_get_ticket_price_row( |
|
| 2097 | + 'TICKETNUM', |
|
| 2098 | + 'PRICENUM', |
|
| 2099 | + null, |
|
| 2100 | + true, |
|
| 2101 | + null |
|
| 2102 | + ), |
|
| 2103 | + 'default_price_rows' => '', |
|
| 2104 | + 'default_base_price_amount' => 0, |
|
| 2105 | + 'default_base_price_name' => '', |
|
| 2106 | + 'default_base_price_description' => '', |
|
| 2107 | + 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
| 2108 | + 'TICKETNUM', |
|
| 2109 | + 'PRICENUM', |
|
| 2110 | + null, |
|
| 2111 | + true |
|
| 2112 | + ), |
|
| 2113 | + 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
| 2114 | + 'DTTNUM', |
|
| 2115 | + null, |
|
| 2116 | + array(), |
|
| 2117 | + array(), |
|
| 2118 | + true |
|
| 2119 | + ), |
|
| 2120 | + 'existing_available_datetime_tickets_list' => '', |
|
| 2121 | + 'existing_available_ticket_datetimes_list' => '', |
|
| 2122 | + 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
| 2123 | + 'DTTNUM', |
|
| 2124 | + 'TICKETNUM', |
|
| 2125 | + null, |
|
| 2126 | + null, |
|
| 2127 | + array(), |
|
| 2128 | + true |
|
| 2129 | + ), |
|
| 2130 | + 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
| 2131 | + 'DTTNUM', |
|
| 2132 | + 'TICKETNUM', |
|
| 2133 | + null, |
|
| 2134 | + null, |
|
| 2135 | + array(), |
|
| 2136 | + true |
|
| 2137 | + ), |
|
| 2138 | + ); |
|
| 2139 | + $ticket_row = 1; |
|
| 2140 | + foreach ($all_tickets as $ticket) { |
|
| 2141 | + $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 2142 | + 'DTTNUM', |
|
| 2143 | + $ticket_row, |
|
| 2144 | + null, |
|
| 2145 | + $ticket, |
|
| 2146 | + array(), |
|
| 2147 | + true |
|
| 2148 | + ); |
|
| 2149 | + $ticket_row++; |
|
| 2150 | + } |
|
| 2151 | + $datetime_row = 1; |
|
| 2152 | + foreach ($all_datetimes as $datetime) { |
|
| 2153 | + $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 2154 | + $datetime_row, |
|
| 2155 | + 'TICKETNUM', |
|
| 2156 | + $datetime, |
|
| 2157 | + null, |
|
| 2158 | + array(), |
|
| 2159 | + true |
|
| 2160 | + ); |
|
| 2161 | + $datetime_row++; |
|
| 2162 | + } |
|
| 2163 | + /** @var EEM_Price $price_model */ |
|
| 2164 | + $price_model = EE_Registry::instance()->load_model('Price'); |
|
| 2165 | + $default_prices = $price_model->get_all_default_prices(); |
|
| 2166 | + $price_row = 1; |
|
| 2167 | + foreach ($default_prices as $price) { |
|
| 2168 | + if (! $price instanceof EE_Price) { |
|
| 2169 | + continue; |
|
| 2170 | + } |
|
| 2171 | + if ($price->is_base_price()) { |
|
| 2172 | + $template_args['default_base_price_amount'] = $price->get_pretty( |
|
| 2173 | + 'PRC_amount', |
|
| 2174 | + 'localized_float' |
|
| 2175 | + ); |
|
| 2176 | + $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
| 2177 | + $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
| 2178 | + $price_row++; |
|
| 2179 | + continue; |
|
| 2180 | + } |
|
| 2181 | + $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) |
|
| 2182 | + || count($default_prices) === 1); |
|
| 2183 | + $show_create = ! (count($default_prices) > 1 |
|
| 2184 | + && count($default_prices) |
|
| 2185 | + !== $price_row); |
|
| 2186 | + $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
| 2187 | + 'TICKETNUM', |
|
| 2188 | + $price_row, |
|
| 2189 | + $price, |
|
| 2190 | + true, |
|
| 2191 | + null, |
|
| 2192 | + $show_trash, |
|
| 2193 | + $show_create |
|
| 2194 | + ); |
|
| 2195 | + $price_row++; |
|
| 2196 | + } |
|
| 2197 | + $template_args = apply_filters( |
|
| 2198 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
| 2199 | + $template_args, |
|
| 2200 | + $all_datetimes, |
|
| 2201 | + $all_tickets, |
|
| 2202 | + $this->_is_creating_event |
|
| 2203 | + ); |
|
| 2204 | + return EEH_Template::display_template( |
|
| 2205 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2206 | + $template_args, |
|
| 2207 | + true |
|
| 2208 | + ); |
|
| 2209 | + } |
|
| 2210 | 2210 | } |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | { |
| 49 | 49 | $this->_name = 'pricing'; |
| 50 | 50 | // capability check |
| 51 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 51 | + if ( ! EE_Registry::instance()->CAP->current_user_can( |
|
| 52 | 52 | 'ee_read_default_prices', |
| 53 | 53 | 'advanced_ticket_datetime_metabox' |
| 54 | 54 | )) { |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | ); |
| 149 | 149 | $msg .= '</p><ul>'; |
| 150 | 150 | foreach ($format_validation as $error) { |
| 151 | - $msg .= '<li>' . $error . '</li>'; |
|
| 151 | + $msg .= '<li>'.$error.'</li>'; |
|
| 152 | 152 | } |
| 153 | 153 | $msg .= '</ul><p>'; |
| 154 | 154 | $msg .= sprintf( |
@@ -177,11 +177,11 @@ discard block |
||
| 177 | 177 | $this->_scripts_styles = array( |
| 178 | 178 | 'registers' => array( |
| 179 | 179 | 'ee-tickets-datetimes-css' => array( |
| 180 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 180 | + 'url' => PRICING_ASSETS_URL.'event-tickets-datetimes.css', |
|
| 181 | 181 | 'type' => 'css', |
| 182 | 182 | ), |
| 183 | 183 | 'ee-dtt-ticket-metabox' => array( |
| 184 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 184 | + 'url' => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js', |
|
| 185 | 185 | 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
| 186 | 186 | ), |
| 187 | 187 | ), |
@@ -205,9 +205,9 @@ discard block |
||
| 205 | 205 | 'event_espresso' |
| 206 | 206 | ), |
| 207 | 207 | 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
| 208 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 208 | + . esc_html__('Cancel', 'event_espresso').'</button>', |
|
| 209 | 209 | 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
| 210 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 210 | + . esc_html__('Close', 'event_espresso').'</button>', |
|
| 211 | 211 | 'single_warning_from_tkt' => esc_html__( |
| 212 | 212 | 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
| 213 | 213 | 'event_espresso' |
@@ -217,7 +217,7 @@ discard block |
||
| 217 | 217 | 'event_espresso' |
| 218 | 218 | ), |
| 219 | 219 | 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
| 220 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 220 | + . esc_html__('Dismiss', 'event_espresso').'</button>', |
|
| 221 | 221 | ), |
| 222 | 222 | 'DTT_ERROR_MSG' => array( |
| 223 | 223 | 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
@@ -255,7 +255,7 @@ discard block |
||
| 255 | 255 | { |
| 256 | 256 | foreach ($update_callbacks as $key => $callback) { |
| 257 | 257 | if ($callback[1] === '_default_tickets_update') { |
| 258 | - unset($update_callbacks[ $key ]); |
|
| 258 | + unset($update_callbacks[$key]); |
|
| 259 | 259 | } |
| 260 | 260 | } |
| 261 | 261 | $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
@@ -313,7 +313,7 @@ discard block |
||
| 313 | 313 | foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
| 314 | 314 | // trim all values to ensure any excess whitespace is removed. |
| 315 | 315 | $datetime_data = array_map( |
| 316 | - function ($datetime_data) { |
|
| 316 | + function($datetime_data) { |
|
| 317 | 317 | return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
| 318 | 318 | }, |
| 319 | 319 | $datetime_data |
@@ -343,7 +343,7 @@ discard block |
||
| 343 | 343 | ); |
| 344 | 344 | // if we have an id then let's get existing object first and then set the new values. |
| 345 | 345 | // Otherwise we instantiate a new object for save. |
| 346 | - if (! empty($datetime_data['DTT_ID'])) { |
|
| 346 | + if ( ! empty($datetime_data['DTT_ID'])) { |
|
| 347 | 347 | $datetime = EE_Registry::instance() |
| 348 | 348 | ->load_model('Datetime', array($timezone)) |
| 349 | 349 | ->get_one_by_ID($datetime_data['DTT_ID']); |
@@ -357,7 +357,7 @@ discard block |
||
| 357 | 357 | // after the add_relation_to() the autosave replaces it. |
| 358 | 358 | // We need to do this so we dont' TRASH the parent DTT. |
| 359 | 359 | // (save the ID for both key and value to avoid duplications) |
| 360 | - $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID(); |
|
| 360 | + $saved_dtt_ids[$datetime->ID()] = $datetime->ID(); |
|
| 361 | 361 | } else { |
| 362 | 362 | $datetime = EE_Registry::instance()->load_class( |
| 363 | 363 | 'Datetime', |
@@ -386,8 +386,8 @@ discard block |
||
| 386 | 386 | // because it is possible there was a new one created for the autosave. |
| 387 | 387 | // (save the ID for both key and value to avoid duplications) |
| 388 | 388 | $DTT_ID = $datetime->ID(); |
| 389 | - $saved_dtt_ids[ $DTT_ID ] = $DTT_ID; |
|
| 390 | - $saved_dtt_objs[ $row ] = $datetime; |
|
| 389 | + $saved_dtt_ids[$DTT_ID] = $DTT_ID; |
|
| 390 | + $saved_dtt_objs[$row] = $datetime; |
|
| 391 | 391 | // @todo if ANY of these updates fail then we want the appropriate global error message. |
| 392 | 392 | } |
| 393 | 393 | $event->save(); |
@@ -452,13 +452,13 @@ discard block |
||
| 452 | 452 | $update_prices = $create_new_TKT = false; |
| 453 | 453 | // figure out what datetimes were added to the ticket |
| 454 | 454 | // and what datetimes were removed from the ticket in the session. |
| 455 | - $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]); |
|
| 456 | - $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][ $row ]); |
|
| 455 | + $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]); |
|
| 456 | + $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]); |
|
| 457 | 457 | $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
| 458 | 458 | $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
| 459 | 459 | // trim inputs to ensure any excess whitespace is removed. |
| 460 | 460 | $tkt = array_map( |
| 461 | - function ($ticket_data) { |
|
| 461 | + function($ticket_data) { |
|
| 462 | 462 | return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
| 463 | 463 | }, |
| 464 | 464 | $tkt |
@@ -480,8 +480,8 @@ discard block |
||
| 480 | 480 | $base_price_id = isset($tkt['TKT_base_price_ID']) |
| 481 | 481 | ? $tkt['TKT_base_price_ID'] |
| 482 | 482 | : 0; |
| 483 | - $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ]) |
|
| 484 | - ? $data['edit_prices'][ $row ] |
|
| 483 | + $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) |
|
| 484 | + ? $data['edit_prices'][$row] |
|
| 485 | 485 | : array(); |
| 486 | 486 | $now = null; |
| 487 | 487 | if (empty($tkt['TKT_start_date'])) { |
@@ -493,7 +493,7 @@ discard block |
||
| 493 | 493 | /** |
| 494 | 494 | * set the TKT_end_date to the first datetime attached to the ticket. |
| 495 | 495 | */ |
| 496 | - $first_dtt = $saved_datetimes[ reset($tkt_dtt_rows) ]; |
|
| 496 | + $first_dtt = $saved_datetimes[reset($tkt_dtt_rows)]; |
|
| 497 | 497 | $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
| 498 | 498 | } |
| 499 | 499 | $TKT_values = array( |
@@ -628,7 +628,7 @@ discard block |
||
| 628 | 628 | // need to make sue that the TKT_price is accurate after saving the prices. |
| 629 | 629 | $ticket->ensure_TKT_Price_correct(); |
| 630 | 630 | // handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
| 631 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 631 | + if ( ! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 632 | 632 | $update_prices = true; |
| 633 | 633 | $new_default = clone $ticket; |
| 634 | 634 | $new_default->set('TKT_ID', 0); |
@@ -673,7 +673,7 @@ discard block |
||
| 673 | 673 | // save new TKT |
| 674 | 674 | $new_tkt->save(); |
| 675 | 675 | // add new ticket to array |
| 676 | - $saved_tickets[ $new_tkt->ID() ] = $new_tkt; |
|
| 676 | + $saved_tickets[$new_tkt->ID()] = $new_tkt; |
|
| 677 | 677 | do_action( |
| 678 | 678 | 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
| 679 | 679 | $new_tkt, |
@@ -683,7 +683,7 @@ discard block |
||
| 683 | 683 | ); |
| 684 | 684 | } else { |
| 685 | 685 | // add tkt to saved tkts |
| 686 | - $saved_tickets[ $ticket->ID() ] = $ticket; |
|
| 686 | + $saved_tickets[$ticket->ID()] = $ticket; |
|
| 687 | 687 | do_action( |
| 688 | 688 | 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
| 689 | 689 | $ticket, |
@@ -750,33 +750,33 @@ discard block |
||
| 750 | 750 | // to start we have to add the ticket to all the datetimes its supposed to be with, |
| 751 | 751 | // and removing the ticket from datetimes it got removed from. |
| 752 | 752 | // first let's add datetimes |
| 753 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 753 | + if ( ! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 754 | 754 | foreach ($added_datetimes as $row_id) { |
| 755 | 755 | $row_id = (int) $row_id; |
| 756 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 757 | - $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 756 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 757 | + $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 758 | 758 | // Is this an existing ticket (has an ID) and does it have any sold? |
| 759 | 759 | // If so, then we need to add that to the DTT sold because this DTT is getting added. |
| 760 | 760 | if ($ticket->ID() && $ticket->sold() > 0) { |
| 761 | - $saved_datetimes[ $row_id ]->increase_sold($ticket->sold()); |
|
| 762 | - $saved_datetimes[ $row_id ]->save(); |
|
| 761 | + $saved_datetimes[$row_id]->increase_sold($ticket->sold()); |
|
| 762 | + $saved_datetimes[$row_id]->save(); |
|
| 763 | 763 | } |
| 764 | 764 | } |
| 765 | 765 | } |
| 766 | 766 | } |
| 767 | 767 | // then remove datetimes |
| 768 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 768 | + if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 769 | 769 | foreach ($removed_datetimes as $row_id) { |
| 770 | 770 | $row_id = (int) $row_id; |
| 771 | 771 | // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
| 772 | 772 | // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
| 773 | - if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) { |
|
| 774 | - $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime'); |
|
| 773 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 774 | + $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 775 | 775 | // Is this an existing ticket (has an ID) and does it have any sold? |
| 776 | 776 | // If so, then we need to remove it's sold from the DTT_sold. |
| 777 | 777 | if ($ticket->ID() && $ticket->sold() > 0) { |
| 778 | - $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold()); |
|
| 779 | - $saved_datetimes[ $row_id ]->save(); |
|
| 778 | + $saved_datetimes[$row_id]->decrease_sold($ticket->sold()); |
|
| 779 | + $saved_datetimes[$row_id]->save(); |
|
| 780 | 780 | } |
| 781 | 781 | } |
| 782 | 782 | } |
@@ -889,7 +889,7 @@ discard block |
||
| 889 | 889 | ); |
| 890 | 890 | } |
| 891 | 891 | // possibly need to save tkt |
| 892 | - if (! $ticket->ID()) { |
|
| 892 | + if ( ! $ticket->ID()) { |
|
| 893 | 893 | $ticket->save(); |
| 894 | 894 | } |
| 895 | 895 | foreach ($prices as $row => $prc) { |
@@ -923,17 +923,17 @@ discard block |
||
| 923 | 923 | } |
| 924 | 924 | } |
| 925 | 925 | $price->save(); |
| 926 | - $updated_prices[ $price->ID() ] = $price; |
|
| 926 | + $updated_prices[$price->ID()] = $price; |
|
| 927 | 927 | $ticket->_add_relation_to($price, 'Price'); |
| 928 | 928 | } |
| 929 | 929 | // now let's remove any prices that got removed from the ticket |
| 930 | - if (! empty($current_prices_on_ticket)) { |
|
| 930 | + if ( ! empty($current_prices_on_ticket)) { |
|
| 931 | 931 | $current = array_keys($current_prices_on_ticket); |
| 932 | 932 | $updated = array_keys($updated_prices); |
| 933 | 933 | $prices_to_remove = array_diff($current, $updated); |
| 934 | - if (! empty($prices_to_remove)) { |
|
| 934 | + if ( ! empty($prices_to_remove)) { |
|
| 935 | 935 | foreach ($prices_to_remove as $prc_id) { |
| 936 | - $p = $current_prices_on_ticket[ $prc_id ]; |
|
| 936 | + $p = $current_prices_on_ticket[$prc_id]; |
|
| 937 | 937 | $ticket->_remove_relation_to($p, 'Price'); |
| 938 | 938 | // delete permanently the price |
| 939 | 939 | $p->delete_permanently(); |
@@ -1084,17 +1084,17 @@ discard block |
||
| 1084 | 1084 | $TKT_ID = $ticket->get('TKT_ID'); |
| 1085 | 1085 | $ticket_row = $ticket->get('TKT_row'); |
| 1086 | 1086 | // we only want unique tickets in our final display!! |
| 1087 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1087 | + if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1088 | 1088 | $existing_ticket_ids[] = $TKT_ID; |
| 1089 | 1089 | $all_tickets[] = $ticket; |
| 1090 | 1090 | } |
| 1091 | 1091 | // temporary cache of this ticket info for this datetime for later processing of datetime rows. |
| 1092 | - $datetime_tickets[ $DTT_ID ][] = $ticket_row; |
|
| 1092 | + $datetime_tickets[$DTT_ID][] = $ticket_row; |
|
| 1093 | 1093 | // temporary cache of this datetime info for this ticket for later processing of ticket rows. |
| 1094 | - if (! isset($ticket_datetimes[ $TKT_ID ]) |
|
| 1095 | - || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true) |
|
| 1094 | + if ( ! isset($ticket_datetimes[$TKT_ID]) |
|
| 1095 | + || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true) |
|
| 1096 | 1096 | ) { |
| 1097 | - $ticket_datetimes[ $TKT_ID ][] = $datetime_row; |
|
| 1097 | + $ticket_datetimes[$TKT_ID][] = $datetime_row; |
|
| 1098 | 1098 | } |
| 1099 | 1099 | } |
| 1100 | 1100 | $datetime_row++; |
@@ -1105,7 +1105,7 @@ discard block |
||
| 1105 | 1105 | // sort $all_tickets by order |
| 1106 | 1106 | usort( |
| 1107 | 1107 | $all_tickets, |
| 1108 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1108 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
| 1109 | 1109 | $a_order = (int) $a->get('TKT_order'); |
| 1110 | 1110 | $b_order = (int) $b->get('TKT_order'); |
| 1111 | 1111 | if ($a_order === $b_order) { |
@@ -1143,7 +1143,7 @@ discard block |
||
| 1143 | 1143 | } |
| 1144 | 1144 | $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
| 1145 | 1145 | EEH_Template::display_template( |
| 1146 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1146 | + PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php', |
|
| 1147 | 1147 | $main_template_args |
| 1148 | 1148 | ); |
| 1149 | 1149 | } |
@@ -1185,7 +1185,7 @@ discard block |
||
| 1185 | 1185 | 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
| 1186 | 1186 | ); |
| 1187 | 1187 | return EEH_Template::display_template( |
| 1188 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1188 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php', |
|
| 1189 | 1189 | $dtt_display_template_args, |
| 1190 | 1190 | true |
| 1191 | 1191 | ); |
@@ -1254,7 +1254,7 @@ discard block |
||
| 1254 | 1254 | $this->_is_creating_event |
| 1255 | 1255 | ); |
| 1256 | 1256 | return EEH_Template::display_template( |
| 1257 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1257 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php', |
|
| 1258 | 1258 | $template_args, |
| 1259 | 1259 | true |
| 1260 | 1260 | ); |
@@ -1295,7 +1295,7 @@ discard block |
||
| 1295 | 1295 | 'DTT_ID' => $default ? '' : $datetime->ID(), |
| 1296 | 1296 | ); |
| 1297 | 1297 | // need to setup the list items (but only if this isn't a default skeleton setup) |
| 1298 | - if (! $default) { |
|
| 1298 | + if ( ! $default) { |
|
| 1299 | 1299 | $ticket_row = 1; |
| 1300 | 1300 | foreach ($all_tickets as $ticket) { |
| 1301 | 1301 | $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
@@ -1321,7 +1321,7 @@ discard block |
||
| 1321 | 1321 | $this->_is_creating_event |
| 1322 | 1322 | ); |
| 1323 | 1323 | return EEH_Template::display_template( |
| 1324 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1324 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1325 | 1325 | $template_args, |
| 1326 | 1326 | true |
| 1327 | 1327 | ); |
@@ -1347,8 +1347,8 @@ discard block |
||
| 1347 | 1347 | $datetime_tickets = array(), |
| 1348 | 1348 | $default |
| 1349 | 1349 | ) { |
| 1350 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ]) |
|
| 1351 | - ? $datetime_tickets[ $datetime->ID() ] |
|
| 1350 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()]) |
|
| 1351 | + ? $datetime_tickets[$datetime->ID()] |
|
| 1352 | 1352 | : array(); |
| 1353 | 1353 | $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
| 1354 | 1354 | $no_ticket = $default && empty($ticket); |
@@ -1369,8 +1369,8 @@ discard block |
||
| 1369 | 1369 | ? 'TKTNAME' |
| 1370 | 1370 | : $ticket->get('TKT_name'), |
| 1371 | 1371 | 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
| 1372 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1373 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1372 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
| 1373 | + : ' tkt-status-'.$ticket->ticket_status(), |
|
| 1374 | 1374 | ); |
| 1375 | 1375 | // filter template args |
| 1376 | 1376 | $template_args = apply_filters( |
@@ -1385,7 +1385,7 @@ discard block |
||
| 1385 | 1385 | $this->_is_creating_event |
| 1386 | 1386 | ); |
| 1387 | 1387 | return EEH_Template::display_template( |
| 1388 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1388 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1389 | 1389 | $template_args, |
| 1390 | 1390 | true |
| 1391 | 1391 | ); |
@@ -1441,19 +1441,19 @@ discard block |
||
| 1441 | 1441 | // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
| 1442 | 1442 | // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
| 1443 | 1443 | $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
| 1444 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 1445 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
| 1444 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 1445 | + ? $ticket_datetimes[$ticket->ID()] |
|
| 1446 | 1446 | : array(); |
| 1447 | 1447 | $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
| 1448 | 1448 | $base_price = $default ? null : $ticket->base_price(); |
| 1449 | 1449 | $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
| 1450 | 1450 | // breaking out complicated condition for ticket_status |
| 1451 | 1451 | if ($default) { |
| 1452 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1452 | + $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1453 | 1453 | } else { |
| 1454 | 1454 | $ticket_status_class = $ticket->is_default() |
| 1455 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1456 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1455 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
| 1456 | + : ' tkt-status-'.$ticket->ticket_status(); |
|
| 1457 | 1457 | } |
| 1458 | 1458 | // breaking out complicated condition for TKT_taxable |
| 1459 | 1459 | if ($default) { |
@@ -1545,7 +1545,7 @@ discard block |
||
| 1545 | 1545 | : ' style="display:none;"', |
| 1546 | 1546 | 'show_price_mod_button' => count($prices) > 1 |
| 1547 | 1547 | || ($default && $count_price_mods > 0) |
| 1548 | - || (! $default && $ticket->deleted()) |
|
| 1548 | + || ( ! $default && $ticket->deleted()) |
|
| 1549 | 1549 | ? ' style="display:none;"' |
| 1550 | 1550 | : '', |
| 1551 | 1551 | 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
@@ -1589,7 +1589,7 @@ discard block |
||
| 1589 | 1589 | $this->_date_time_format, |
| 1590 | 1590 | current_time('timestamp') |
| 1591 | 1591 | ); |
| 1592 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1592 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1593 | 1593 | } |
| 1594 | 1594 | if (empty($template_args['TKT_end_date'])) { |
| 1595 | 1595 | // get the earliest datetime (if present); |
@@ -1599,7 +1599,7 @@ discard block |
||
| 1599 | 1599 | array('order_by' => array('DTT_EVT_start' => 'ASC')) |
| 1600 | 1600 | ) |
| 1601 | 1601 | : null; |
| 1602 | - if (! empty($earliest_dtt)) { |
|
| 1602 | + if ( ! empty($earliest_dtt)) { |
|
| 1603 | 1603 | $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
| 1604 | 1604 | 'DTT_EVT_start', |
| 1605 | 1605 | $this->_date_time_format |
@@ -1618,10 +1618,10 @@ discard block |
||
| 1618 | 1618 | ) |
| 1619 | 1619 | ); |
| 1620 | 1620 | } |
| 1621 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1621 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1622 | 1622 | } |
| 1623 | 1623 | // generate ticket_datetime items |
| 1624 | - if (! $default) { |
|
| 1624 | + if ( ! $default) { |
|
| 1625 | 1625 | $datetime_row = 1; |
| 1626 | 1626 | foreach ($all_datetimes as $datetime) { |
| 1627 | 1627 | $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
@@ -1637,7 +1637,7 @@ discard block |
||
| 1637 | 1637 | } |
| 1638 | 1638 | $price_row = 1; |
| 1639 | 1639 | foreach ($prices as $price) { |
| 1640 | - if (! $price instanceof EE_Price) { |
|
| 1640 | + if ( ! $price instanceof EE_Price) { |
|
| 1641 | 1641 | continue; |
| 1642 | 1642 | } |
| 1643 | 1643 | if ($price->is_base_price()) { |
@@ -1670,7 +1670,7 @@ discard block |
||
| 1670 | 1670 | $this->_is_creating_event |
| 1671 | 1671 | ); |
| 1672 | 1672 | return EEH_Template::display_template( |
| 1673 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1673 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php', |
|
| 1674 | 1674 | $template_args, |
| 1675 | 1675 | true |
| 1676 | 1676 | ); |
@@ -1710,7 +1710,7 @@ discard block |
||
| 1710 | 1710 | $this->_is_creating_event |
| 1711 | 1711 | ); |
| 1712 | 1712 | $tax_rows .= EEH_Template::display_template( |
| 1713 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1713 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1714 | 1714 | $template_args, |
| 1715 | 1715 | true |
| 1716 | 1716 | ); |
@@ -1829,7 +1829,7 @@ discard block |
||
| 1829 | 1829 | $this->_is_creating_event |
| 1830 | 1830 | ); |
| 1831 | 1831 | return EEH_Template::display_template( |
| 1832 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1832 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1833 | 1833 | $template_args, |
| 1834 | 1834 | true |
| 1835 | 1835 | ); |
@@ -1899,7 +1899,7 @@ discard block |
||
| 1899 | 1899 | $this->_is_creating_event |
| 1900 | 1900 | ); |
| 1901 | 1901 | return EEH_Template::display_template( |
| 1902 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1902 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php', |
|
| 1903 | 1903 | $template_args, |
| 1904 | 1904 | true |
| 1905 | 1905 | ); |
@@ -1929,7 +1929,7 @@ discard block |
||
| 1929 | 1929 | ) { |
| 1930 | 1930 | $select_name = $default && ! $price instanceof EE_Price |
| 1931 | 1931 | ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
| 1932 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1932 | + : 'edit_prices['.$ticket_row.']['.$price_row.'][PRT_ID]'; |
|
| 1933 | 1933 | /** @var EEM_Price_Type $price_type_model */ |
| 1934 | 1934 | $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
| 1935 | 1935 | $price_types = $price_type_model->get_all(array( |
@@ -1947,10 +1947,10 @@ discard block |
||
| 1947 | 1947 | $price_option_spans = ''; |
| 1948 | 1948 | // setup price types for selector |
| 1949 | 1949 | foreach ($price_types as $price_type) { |
| 1950 | - if (! $price_type instanceof EE_Price_Type) { |
|
| 1950 | + if ( ! $price_type instanceof EE_Price_Type) { |
|
| 1951 | 1951 | continue; |
| 1952 | 1952 | } |
| 1953 | - $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name'); |
|
| 1953 | + $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
|
| 1954 | 1954 | // while we're in the loop let's setup the option spans used by js |
| 1955 | 1955 | $span_args = array( |
| 1956 | 1956 | 'PRT_ID' => $price_type->ID(), |
@@ -1958,12 +1958,12 @@ discard block |
||
| 1958 | 1958 | 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
| 1959 | 1959 | ); |
| 1960 | 1960 | $price_option_spans .= EEH_Template::display_template( |
| 1961 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1961 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php', |
|
| 1962 | 1962 | $span_args, |
| 1963 | 1963 | true |
| 1964 | 1964 | ); |
| 1965 | 1965 | } |
| 1966 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' |
|
| 1966 | + $select_name = $disabled ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]' |
|
| 1967 | 1967 | : $select_name; |
| 1968 | 1968 | $select_input = new EE_Select_Input( |
| 1969 | 1969 | $all_price_types, |
@@ -2000,7 +2000,7 @@ discard block |
||
| 2000 | 2000 | $this->_is_creating_event |
| 2001 | 2001 | ); |
| 2002 | 2002 | return EEH_Template::display_template( |
| 2003 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 2003 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 2004 | 2004 | $template_args, |
| 2005 | 2005 | true |
| 2006 | 2006 | ); |
@@ -2026,8 +2026,8 @@ discard block |
||
| 2026 | 2026 | $ticket_datetimes = array(), |
| 2027 | 2027 | $default |
| 2028 | 2028 | ) { |
| 2029 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ]) |
|
| 2030 | - ? $ticket_datetimes[ $ticket->ID() ] |
|
| 2029 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 2030 | + ? $ticket_datetimes[$ticket->ID()] |
|
| 2031 | 2031 | : array(); |
| 2032 | 2032 | $template_args = array( |
| 2033 | 2033 | 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
@@ -2059,7 +2059,7 @@ discard block |
||
| 2059 | 2059 | $this->_is_creating_event |
| 2060 | 2060 | ); |
| 2061 | 2061 | return EEH_Template::display_template( |
| 2062 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 2062 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 2063 | 2063 | $template_args, |
| 2064 | 2064 | true |
| 2065 | 2065 | ); |
@@ -2165,7 +2165,7 @@ discard block |
||
| 2165 | 2165 | $default_prices = $price_model->get_all_default_prices(); |
| 2166 | 2166 | $price_row = 1; |
| 2167 | 2167 | foreach ($default_prices as $price) { |
| 2168 | - if (! $price instanceof EE_Price) { |
|
| 2168 | + if ( ! $price instanceof EE_Price) { |
|
| 2169 | 2169 | continue; |
| 2170 | 2170 | } |
| 2171 | 2171 | if ($price->is_base_price()) { |
@@ -2202,7 +2202,7 @@ discard block |
||
| 2202 | 2202 | $this->_is_creating_event |
| 2203 | 2203 | ); |
| 2204 | 2204 | return EEH_Template::display_template( |
| 2205 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2205 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2206 | 2206 | $template_args, |
| 2207 | 2207 | true |
| 2208 | 2208 | ); |
@@ -578,7 +578,7 @@ discard block |
||
| 578 | 578 | * @param string $dt_frmt string representation of date format defaults to WP settings |
| 579 | 579 | * @param string $conjunction conjunction junction what's your function ? |
| 580 | 580 | * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
| 581 | - * @return mixed string on success, FALSE on fail |
|
| 581 | + * @return string string on success, FALSE on fail |
|
| 582 | 582 | * @throws ReflectionException |
| 583 | 583 | * @throws InvalidArgumentException |
| 584 | 584 | * @throws InvalidInterfaceException |
@@ -686,7 +686,7 @@ discard block |
||
| 686 | 686 | * @param string $tm_format string representation of time format defaults to 'g:i a' |
| 687 | 687 | * @param string $conjunction conjunction junction what's your function ? |
| 688 | 688 | * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
| 689 | - * @return mixed string on success, FALSE on fail |
|
| 689 | + * @return string string on success, FALSE on fail |
|
| 690 | 690 | * @throws ReflectionException |
| 691 | 691 | * @throws InvalidArgumentException |
| 692 | 692 | * @throws InvalidInterfaceException |
@@ -495,7 +495,7 @@ discard block |
||
| 495 | 495 | $date_or_time, |
| 496 | 496 | $echo |
| 497 | 497 | ); |
| 498 | - if (! $echo) { |
|
| 498 | + if ( ! $echo) { |
|
| 499 | 499 | return $dtt; |
| 500 | 500 | } |
| 501 | 501 | return ''; |
@@ -597,7 +597,7 @@ discard block |
||
| 597 | 597 | ' ', |
| 598 | 598 | $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
| 599 | 599 | ); |
| 600 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 600 | + return $start !== $end ? $start.$conjunction.$end : $start; |
|
| 601 | 601 | } |
| 602 | 602 | |
| 603 | 603 | |
@@ -705,7 +705,7 @@ discard block |
||
| 705 | 705 | ' ', |
| 706 | 706 | $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
| 707 | 707 | ); |
| 708 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 708 | + return $start !== $end ? $start.$conjunction.$end : $start; |
|
| 709 | 709 | } |
| 710 | 710 | |
| 711 | 711 | |
@@ -750,7 +750,7 @@ discard block |
||
| 750 | 750 | ) { |
| 751 | 751 | $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
| 752 | 752 | $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
| 753 | - $full_format = $dt_format . $separator . $tm_format; |
|
| 753 | + $full_format = $dt_format.$separator.$tm_format; |
|
| 754 | 754 | // the range output depends on various conditions |
| 755 | 755 | switch (true) { |
| 756 | 756 | // start date timestamp and end date timestamp are the same. |
@@ -991,7 +991,7 @@ discard block |
||
| 991 | 991 | // tickets remaining available for purchase |
| 992 | 992 | // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
| 993 | 993 | $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
| 994 | - if (! $consider_tickets) { |
|
| 994 | + if ( ! $consider_tickets) { |
|
| 995 | 995 | return $dtt_remaining; |
| 996 | 996 | } |
| 997 | 997 | $tickets_remaining = $this->tickets_remaining(); |
@@ -1015,7 +1015,7 @@ discard block |
||
| 1015 | 1015 | { |
| 1016 | 1016 | $sum = 0; |
| 1017 | 1017 | $tickets = $this->tickets($query_params); |
| 1018 | - if (! empty($tickets)) { |
|
| 1018 | + if ( ! empty($tickets)) { |
|
| 1019 | 1019 | foreach ($tickets as $ticket) { |
| 1020 | 1020 | if ($ticket instanceof EE_Ticket) { |
| 1021 | 1021 | // get the actual amount of tickets that can be sold |
@@ -1166,20 +1166,20 @@ discard block |
||
| 1166 | 1166 | { |
| 1167 | 1167 | if ($use_dtt_name) { |
| 1168 | 1168 | $dtt_name = $this->name(); |
| 1169 | - if (! empty($dtt_name)) { |
|
| 1169 | + if ( ! empty($dtt_name)) { |
|
| 1170 | 1170 | return $dtt_name; |
| 1171 | 1171 | } |
| 1172 | 1172 | } |
| 1173 | 1173 | // first condition is to see if the months are different |
| 1174 | 1174 | if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
| 1175 | 1175 | ) { |
| 1176 | - $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
| 1176 | + $display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a'); |
|
| 1177 | 1177 | // next condition is if its the same month but different day |
| 1178 | 1178 | } else { |
| 1179 | 1179 | if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
| 1180 | 1180 | && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
| 1181 | 1181 | ) { |
| 1182 | - $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
| 1182 | + $display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y'); |
|
| 1183 | 1183 | } else { |
| 1184 | 1184 | $display_date = $this->start_date('F j\, Y') |
| 1185 | 1185 | . ' @ ' |
@@ -13,1276 +13,1276 @@ |
||
| 13 | 13 | class EE_Datetime extends EE_Soft_Delete_Base_Class |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * constant used by get_active_status, indicates datetime has no more available spaces |
|
| 18 | - */ |
|
| 19 | - const sold_out = 'DTS'; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for) |
|
| 23 | - */ |
|
| 24 | - const active = 'DTA'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not |
|
| 28 | - * expired |
|
| 29 | - */ |
|
| 30 | - const upcoming = 'DTU'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Datetime is postponed |
|
| 34 | - */ |
|
| 35 | - const postponed = 'DTP'; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Datetime is cancelled |
|
| 39 | - */ |
|
| 40 | - const cancelled = 'DTC'; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * constant used by get_active_status, indicates datetime has expired (event is over) |
|
| 44 | - */ |
|
| 45 | - const expired = 'DTE'; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * constant used in various places indicating that an event is INACTIVE (not yet ready to be published) |
|
| 49 | - */ |
|
| 50 | - const inactive = 'DTI'; |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @param array $props_n_values incoming values |
|
| 55 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be used.) |
|
| 56 | - * @param array $date_formats incoming date_formats in an array where the first value is the date_format |
|
| 57 | - * and the second value is the time format |
|
| 58 | - * @return EE_Datetime |
|
| 59 | - * @throws ReflectionException |
|
| 60 | - * @throws InvalidArgumentException |
|
| 61 | - * @throws InvalidInterfaceException |
|
| 62 | - * @throws InvalidDataTypeException |
|
| 63 | - * @throws EE_Error |
|
| 64 | - */ |
|
| 65 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 66 | - { |
|
| 67 | - $has_object = parent::_check_for_object( |
|
| 68 | - $props_n_values, |
|
| 69 | - __CLASS__, |
|
| 70 | - $timezone, |
|
| 71 | - $date_formats |
|
| 72 | - ); |
|
| 73 | - return $has_object |
|
| 74 | - ? $has_object |
|
| 75 | - : new self($props_n_values, false, $timezone, $date_formats); |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * @param array $props_n_values incoming values from the database |
|
| 81 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 82 | - * the website will be used. |
|
| 83 | - * @return EE_Datetime |
|
| 84 | - * @throws ReflectionException |
|
| 85 | - * @throws InvalidArgumentException |
|
| 86 | - * @throws InvalidInterfaceException |
|
| 87 | - * @throws InvalidDataTypeException |
|
| 88 | - * @throws EE_Error |
|
| 89 | - */ |
|
| 90 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 91 | - { |
|
| 92 | - return new self($props_n_values, true, $timezone); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * @param $name |
|
| 98 | - * @throws ReflectionException |
|
| 99 | - * @throws InvalidArgumentException |
|
| 100 | - * @throws InvalidInterfaceException |
|
| 101 | - * @throws InvalidDataTypeException |
|
| 102 | - * @throws EE_Error |
|
| 103 | - */ |
|
| 104 | - public function set_name($name) |
|
| 105 | - { |
|
| 106 | - $this->set('DTT_name', $name); |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * @param $description |
|
| 112 | - * @throws ReflectionException |
|
| 113 | - * @throws InvalidArgumentException |
|
| 114 | - * @throws InvalidInterfaceException |
|
| 115 | - * @throws InvalidDataTypeException |
|
| 116 | - * @throws EE_Error |
|
| 117 | - */ |
|
| 118 | - public function set_description($description) |
|
| 119 | - { |
|
| 120 | - $this->set('DTT_description', $description); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Set event start date |
|
| 126 | - * set the start date for an event |
|
| 127 | - * |
|
| 128 | - * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
| 129 | - * @throws ReflectionException |
|
| 130 | - * @throws InvalidArgumentException |
|
| 131 | - * @throws InvalidInterfaceException |
|
| 132 | - * @throws InvalidDataTypeException |
|
| 133 | - * @throws EE_Error |
|
| 134 | - */ |
|
| 135 | - public function set_start_date($date) |
|
| 136 | - { |
|
| 137 | - $this->_set_date_for($date, 'DTT_EVT_start'); |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * Set event start time |
|
| 143 | - * set the start time for an event |
|
| 144 | - * |
|
| 145 | - * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
| 146 | - * @throws ReflectionException |
|
| 147 | - * @throws InvalidArgumentException |
|
| 148 | - * @throws InvalidInterfaceException |
|
| 149 | - * @throws InvalidDataTypeException |
|
| 150 | - * @throws EE_Error |
|
| 151 | - */ |
|
| 152 | - public function set_start_time($time) |
|
| 153 | - { |
|
| 154 | - $this->_set_time_for($time, 'DTT_EVT_start'); |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * Set event end date |
|
| 160 | - * set the end date for an event |
|
| 161 | - * |
|
| 162 | - * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
| 163 | - * @throws ReflectionException |
|
| 164 | - * @throws InvalidArgumentException |
|
| 165 | - * @throws InvalidInterfaceException |
|
| 166 | - * @throws InvalidDataTypeException |
|
| 167 | - * @throws EE_Error |
|
| 168 | - */ |
|
| 169 | - public function set_end_date($date) |
|
| 170 | - { |
|
| 171 | - $this->_set_date_for($date, 'DTT_EVT_end'); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Set event end time |
|
| 177 | - * set the end time for an event |
|
| 178 | - * |
|
| 179 | - * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
| 180 | - * @throws ReflectionException |
|
| 181 | - * @throws InvalidArgumentException |
|
| 182 | - * @throws InvalidInterfaceException |
|
| 183 | - * @throws InvalidDataTypeException |
|
| 184 | - * @throws EE_Error |
|
| 185 | - */ |
|
| 186 | - public function set_end_time($time) |
|
| 187 | - { |
|
| 188 | - $this->_set_time_for($time, 'DTT_EVT_end'); |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Set registration limit |
|
| 194 | - * set the maximum number of attendees that can be registered for this datetime slot |
|
| 195 | - * |
|
| 196 | - * @param int $reg_limit |
|
| 197 | - * @throws ReflectionException |
|
| 198 | - * @throws InvalidArgumentException |
|
| 199 | - * @throws InvalidInterfaceException |
|
| 200 | - * @throws InvalidDataTypeException |
|
| 201 | - * @throws EE_Error |
|
| 202 | - */ |
|
| 203 | - public function set_reg_limit($reg_limit) |
|
| 204 | - { |
|
| 205 | - $this->set('DTT_reg_limit', $reg_limit); |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * get the number of tickets sold for this datetime slot |
|
| 211 | - * |
|
| 212 | - * @return mixed int on success, FALSE on fail |
|
| 213 | - * @throws ReflectionException |
|
| 214 | - * @throws InvalidArgumentException |
|
| 215 | - * @throws InvalidInterfaceException |
|
| 216 | - * @throws InvalidDataTypeException |
|
| 217 | - * @throws EE_Error |
|
| 218 | - */ |
|
| 219 | - public function sold() |
|
| 220 | - { |
|
| 221 | - return $this->get_raw('DTT_sold'); |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param int $sold |
|
| 227 | - * @throws ReflectionException |
|
| 228 | - * @throws InvalidArgumentException |
|
| 229 | - * @throws InvalidInterfaceException |
|
| 230 | - * @throws InvalidDataTypeException |
|
| 231 | - * @throws EE_Error |
|
| 232 | - */ |
|
| 233 | - public function set_sold($sold) |
|
| 234 | - { |
|
| 235 | - // sold can not go below zero |
|
| 236 | - $sold = max(0, $sold); |
|
| 237 | - $this->set('DTT_sold', $sold); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * increments sold by amount passed by $qty |
|
| 243 | - * |
|
| 244 | - * @param int $qty |
|
| 245 | - * @throws ReflectionException |
|
| 246 | - * @throws InvalidArgumentException |
|
| 247 | - * @throws InvalidInterfaceException |
|
| 248 | - * @throws InvalidDataTypeException |
|
| 249 | - * @throws EE_Error |
|
| 250 | - */ |
|
| 251 | - public function increase_sold($qty = 1) |
|
| 252 | - { |
|
| 253 | - $sold = $this->sold() + $qty; |
|
| 254 | - // remove ticket reservation |
|
| 255 | - $this->decrease_reserved($qty); |
|
| 256 | - $this->set_sold($sold); |
|
| 257 | - do_action( |
|
| 258 | - 'AHEE__EE_Datetime__increase_sold', |
|
| 259 | - $this, |
|
| 260 | - $qty, |
|
| 261 | - $sold |
|
| 262 | - ); |
|
| 263 | - } |
|
| 264 | - |
|
| 265 | - |
|
| 266 | - /** |
|
| 267 | - * decrements (subtracts) sold amount passed by $qty |
|
| 268 | - * |
|
| 269 | - * @param int $qty |
|
| 270 | - * @throws ReflectionException |
|
| 271 | - * @throws InvalidArgumentException |
|
| 272 | - * @throws InvalidInterfaceException |
|
| 273 | - * @throws InvalidDataTypeException |
|
| 274 | - * @throws EE_Error |
|
| 275 | - */ |
|
| 276 | - public function decrease_sold($qty = 1) |
|
| 277 | - { |
|
| 278 | - $sold = $this->sold() - $qty; |
|
| 279 | - $this->set_sold($sold); |
|
| 280 | - do_action( |
|
| 281 | - 'AHEE__EE_Datetime__decrease_sold', |
|
| 282 | - $this, |
|
| 283 | - $qty, |
|
| 284 | - $sold |
|
| 285 | - ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Gets qty of reserved tickets for this datetime |
|
| 291 | - * |
|
| 292 | - * @return int |
|
| 293 | - * @throws ReflectionException |
|
| 294 | - * @throws InvalidArgumentException |
|
| 295 | - * @throws InvalidInterfaceException |
|
| 296 | - * @throws InvalidDataTypeException |
|
| 297 | - * @throws EE_Error |
|
| 298 | - */ |
|
| 299 | - public function reserved() |
|
| 300 | - { |
|
| 301 | - return $this->get_raw('DTT_reserved'); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Sets qty of reserved tickets for this datetime |
|
| 307 | - * |
|
| 308 | - * @param int $reserved |
|
| 309 | - * @throws ReflectionException |
|
| 310 | - * @throws InvalidArgumentException |
|
| 311 | - * @throws InvalidInterfaceException |
|
| 312 | - * @throws InvalidDataTypeException |
|
| 313 | - * @throws EE_Error |
|
| 314 | - */ |
|
| 315 | - public function set_reserved($reserved) |
|
| 316 | - { |
|
| 317 | - // reserved can not go below zero |
|
| 318 | - $reserved = max(0, (int) $reserved); |
|
| 319 | - $this->set('DTT_reserved', $reserved); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - |
|
| 323 | - /** |
|
| 324 | - * increments reserved by amount passed by $qty |
|
| 325 | - * |
|
| 326 | - * @param int $qty |
|
| 327 | - * @return void |
|
| 328 | - * @throws ReflectionException |
|
| 329 | - * @throws InvalidArgumentException |
|
| 330 | - * @throws InvalidInterfaceException |
|
| 331 | - * @throws InvalidDataTypeException |
|
| 332 | - * @throws EE_Error |
|
| 333 | - */ |
|
| 334 | - public function increase_reserved($qty = 1) |
|
| 335 | - { |
|
| 336 | - $reserved = $this->reserved() + absint($qty); |
|
| 337 | - do_action( |
|
| 338 | - 'AHEE__EE_Datetime__increase_reserved', |
|
| 339 | - $this, |
|
| 340 | - $qty, |
|
| 341 | - $reserved |
|
| 342 | - ); |
|
| 343 | - $this->set_reserved($reserved); |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * decrements (subtracts) reserved by amount passed by $qty |
|
| 349 | - * |
|
| 350 | - * @param int $qty |
|
| 351 | - * @return void |
|
| 352 | - * @throws ReflectionException |
|
| 353 | - * @throws InvalidArgumentException |
|
| 354 | - * @throws InvalidInterfaceException |
|
| 355 | - * @throws InvalidDataTypeException |
|
| 356 | - * @throws EE_Error |
|
| 357 | - */ |
|
| 358 | - public function decrease_reserved($qty = 1) |
|
| 359 | - { |
|
| 360 | - $reserved = $this->reserved() - absint($qty); |
|
| 361 | - do_action( |
|
| 362 | - 'AHEE__EE_Datetime__decrease_reserved', |
|
| 363 | - $this, |
|
| 364 | - $qty, |
|
| 365 | - $reserved |
|
| 366 | - ); |
|
| 367 | - $this->set_reserved($reserved); |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - |
|
| 371 | - /** |
|
| 372 | - * total sold and reserved tickets |
|
| 373 | - * |
|
| 374 | - * @return int |
|
| 375 | - * @throws ReflectionException |
|
| 376 | - * @throws InvalidArgumentException |
|
| 377 | - * @throws InvalidInterfaceException |
|
| 378 | - * @throws InvalidDataTypeException |
|
| 379 | - * @throws EE_Error |
|
| 380 | - */ |
|
| 381 | - public function sold_and_reserved() |
|
| 382 | - { |
|
| 383 | - return $this->sold() + $this->reserved(); |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * returns the datetime name |
|
| 389 | - * |
|
| 390 | - * @return string |
|
| 391 | - * @throws ReflectionException |
|
| 392 | - * @throws InvalidArgumentException |
|
| 393 | - * @throws InvalidInterfaceException |
|
| 394 | - * @throws InvalidDataTypeException |
|
| 395 | - * @throws EE_Error |
|
| 396 | - */ |
|
| 397 | - public function name() |
|
| 398 | - { |
|
| 399 | - return $this->get('DTT_name'); |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - |
|
| 403 | - /** |
|
| 404 | - * returns the datetime description |
|
| 405 | - * |
|
| 406 | - * @return string |
|
| 407 | - * @throws ReflectionException |
|
| 408 | - * @throws InvalidArgumentException |
|
| 409 | - * @throws InvalidInterfaceException |
|
| 410 | - * @throws InvalidDataTypeException |
|
| 411 | - * @throws EE_Error |
|
| 412 | - */ |
|
| 413 | - public function description() |
|
| 414 | - { |
|
| 415 | - return $this->get('DTT_description'); |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - |
|
| 419 | - /** |
|
| 420 | - * This helper simply returns whether the event_datetime for the current datetime is a primary datetime |
|
| 421 | - * |
|
| 422 | - * @return boolean TRUE if is primary, FALSE if not. |
|
| 423 | - * @throws ReflectionException |
|
| 424 | - * @throws InvalidArgumentException |
|
| 425 | - * @throws InvalidInterfaceException |
|
| 426 | - * @throws InvalidDataTypeException |
|
| 427 | - * @throws EE_Error |
|
| 428 | - */ |
|
| 429 | - public function is_primary() |
|
| 430 | - { |
|
| 431 | - return $this->get('DTT_is_primary'); |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - |
|
| 435 | - /** |
|
| 436 | - * This helper simply returns the order for the datetime |
|
| 437 | - * |
|
| 438 | - * @return int The order of the datetime for this event. |
|
| 439 | - * @throws ReflectionException |
|
| 440 | - * @throws InvalidArgumentException |
|
| 441 | - * @throws InvalidInterfaceException |
|
| 442 | - * @throws InvalidDataTypeException |
|
| 443 | - * @throws EE_Error |
|
| 444 | - */ |
|
| 445 | - public function order() |
|
| 446 | - { |
|
| 447 | - return $this->get('DTT_order'); |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * This helper simply returns the parent id for the datetime |
|
| 453 | - * |
|
| 454 | - * @return int |
|
| 455 | - * @throws ReflectionException |
|
| 456 | - * @throws InvalidArgumentException |
|
| 457 | - * @throws InvalidInterfaceException |
|
| 458 | - * @throws InvalidDataTypeException |
|
| 459 | - * @throws EE_Error |
|
| 460 | - */ |
|
| 461 | - public function parent() |
|
| 462 | - { |
|
| 463 | - return $this->get('DTT_parent'); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * show date and/or time |
|
| 469 | - * |
|
| 470 | - * @param string $date_or_time whether to display a date or time or both |
|
| 471 | - * @param string $start_or_end whether to display start or end datetimes |
|
| 472 | - * @param string $dt_frmt |
|
| 473 | - * @param string $tm_frmt |
|
| 474 | - * @param bool $echo whether we echo or return (note echoing uses "pretty" formats, |
|
| 475 | - * otherwise we use the standard formats) |
|
| 476 | - * @return string|bool string on success, FALSE on fail |
|
| 477 | - * @throws ReflectionException |
|
| 478 | - * @throws InvalidArgumentException |
|
| 479 | - * @throws InvalidInterfaceException |
|
| 480 | - * @throws InvalidDataTypeException |
|
| 481 | - * @throws EE_Error |
|
| 482 | - */ |
|
| 483 | - private function _show_datetime( |
|
| 484 | - $date_or_time = null, |
|
| 485 | - $start_or_end = 'start', |
|
| 486 | - $dt_frmt = '', |
|
| 487 | - $tm_frmt = '', |
|
| 488 | - $echo = false |
|
| 489 | - ) { |
|
| 490 | - $field_name = "DTT_EVT_{$start_or_end}"; |
|
| 491 | - $dtt = $this->_get_datetime( |
|
| 492 | - $field_name, |
|
| 493 | - $dt_frmt, |
|
| 494 | - $tm_frmt, |
|
| 495 | - $date_or_time, |
|
| 496 | - $echo |
|
| 497 | - ); |
|
| 498 | - if (! $echo) { |
|
| 499 | - return $dtt; |
|
| 500 | - } |
|
| 501 | - return ''; |
|
| 502 | - } |
|
| 503 | - |
|
| 504 | - |
|
| 505 | - /** |
|
| 506 | - * get event start date. Provide either the date format, or NULL to re-use the |
|
| 507 | - * last-used format, or '' to use the default date format |
|
| 508 | - * |
|
| 509 | - * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
| 510 | - * @return mixed string on success, FALSE on fail |
|
| 511 | - * @throws ReflectionException |
|
| 512 | - * @throws InvalidArgumentException |
|
| 513 | - * @throws InvalidInterfaceException |
|
| 514 | - * @throws InvalidDataTypeException |
|
| 515 | - * @throws EE_Error |
|
| 516 | - */ |
|
| 517 | - public function start_date($dt_frmt = '') |
|
| 518 | - { |
|
| 519 | - return $this->_show_datetime('D', 'start', $dt_frmt); |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - |
|
| 523 | - /** |
|
| 524 | - * Echoes start_date() |
|
| 525 | - * |
|
| 526 | - * @param string $dt_frmt |
|
| 527 | - * @throws ReflectionException |
|
| 528 | - * @throws InvalidArgumentException |
|
| 529 | - * @throws InvalidInterfaceException |
|
| 530 | - * @throws InvalidDataTypeException |
|
| 531 | - * @throws EE_Error |
|
| 532 | - */ |
|
| 533 | - public function e_start_date($dt_frmt = '') |
|
| 534 | - { |
|
| 535 | - $this->_show_datetime('D', 'start', $dt_frmt, null, true); |
|
| 536 | - } |
|
| 537 | - |
|
| 538 | - |
|
| 539 | - /** |
|
| 540 | - * get end date. Provide either the date format, or NULL to re-use the |
|
| 541 | - * last-used format, or '' to use the default date format |
|
| 542 | - * |
|
| 543 | - * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
| 544 | - * @return mixed string on success, FALSE on fail |
|
| 545 | - * @throws ReflectionException |
|
| 546 | - * @throws InvalidArgumentException |
|
| 547 | - * @throws InvalidInterfaceException |
|
| 548 | - * @throws InvalidDataTypeException |
|
| 549 | - * @throws EE_Error |
|
| 550 | - */ |
|
| 551 | - public function end_date($dt_frmt = '') |
|
| 552 | - { |
|
| 553 | - return $this->_show_datetime('D', 'end', $dt_frmt); |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - |
|
| 557 | - /** |
|
| 558 | - * Echoes the end date. See end_date() |
|
| 559 | - * |
|
| 560 | - * @param string $dt_frmt |
|
| 561 | - * @throws ReflectionException |
|
| 562 | - * @throws InvalidArgumentException |
|
| 563 | - * @throws InvalidInterfaceException |
|
| 564 | - * @throws InvalidDataTypeException |
|
| 565 | - * @throws EE_Error |
|
| 566 | - */ |
|
| 567 | - public function e_end_date($dt_frmt = '') |
|
| 568 | - { |
|
| 569 | - $this->_show_datetime('D', 'end', $dt_frmt, null, true); |
|
| 570 | - } |
|
| 571 | - |
|
| 572 | - |
|
| 573 | - /** |
|
| 574 | - * get date_range - meaning the start AND end date |
|
| 575 | - * |
|
| 576 | - * @access public |
|
| 577 | - * @param string $dt_frmt string representation of date format defaults to WP settings |
|
| 578 | - * @param string $conjunction conjunction junction what's your function ? |
|
| 579 | - * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 580 | - * @return mixed string on success, FALSE on fail |
|
| 581 | - * @throws ReflectionException |
|
| 582 | - * @throws InvalidArgumentException |
|
| 583 | - * @throws InvalidInterfaceException |
|
| 584 | - * @throws InvalidDataTypeException |
|
| 585 | - * @throws EE_Error |
|
| 586 | - */ |
|
| 587 | - public function date_range($dt_frmt = '', $conjunction = ' - ') |
|
| 588 | - { |
|
| 589 | - $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt; |
|
| 590 | - $start = str_replace( |
|
| 591 | - ' ', |
|
| 592 | - ' ', |
|
| 593 | - $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt) |
|
| 594 | - ); |
|
| 595 | - $end = str_replace( |
|
| 596 | - ' ', |
|
| 597 | - ' ', |
|
| 598 | - $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
|
| 599 | - ); |
|
| 600 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 601 | - } |
|
| 602 | - |
|
| 603 | - |
|
| 604 | - /** |
|
| 605 | - * @param string $dt_frmt |
|
| 606 | - * @param string $conjunction |
|
| 607 | - * @throws ReflectionException |
|
| 608 | - * @throws InvalidArgumentException |
|
| 609 | - * @throws InvalidInterfaceException |
|
| 610 | - * @throws InvalidDataTypeException |
|
| 611 | - * @throws EE_Error |
|
| 612 | - */ |
|
| 613 | - public function e_date_range($dt_frmt = '', $conjunction = ' - ') |
|
| 614 | - { |
|
| 615 | - echo $this->date_range($dt_frmt, $conjunction); |
|
| 616 | - } |
|
| 617 | - |
|
| 618 | - |
|
| 619 | - /** |
|
| 620 | - * get start time |
|
| 621 | - * |
|
| 622 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 623 | - * @return mixed string on success, FALSE on fail |
|
| 624 | - * @throws ReflectionException |
|
| 625 | - * @throws InvalidArgumentException |
|
| 626 | - * @throws InvalidInterfaceException |
|
| 627 | - * @throws InvalidDataTypeException |
|
| 628 | - * @throws EE_Error |
|
| 629 | - */ |
|
| 630 | - public function start_time($tm_format = '') |
|
| 631 | - { |
|
| 632 | - return $this->_show_datetime('T', 'start', null, $tm_format); |
|
| 633 | - } |
|
| 634 | - |
|
| 635 | - |
|
| 636 | - /** |
|
| 637 | - * @param string $tm_format |
|
| 638 | - * @throws ReflectionException |
|
| 639 | - * @throws InvalidArgumentException |
|
| 640 | - * @throws InvalidInterfaceException |
|
| 641 | - * @throws InvalidDataTypeException |
|
| 642 | - * @throws EE_Error |
|
| 643 | - */ |
|
| 644 | - public function e_start_time($tm_format = '') |
|
| 645 | - { |
|
| 646 | - $this->_show_datetime('T', 'start', null, $tm_format, true); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - |
|
| 650 | - /** |
|
| 651 | - * get end time |
|
| 652 | - * |
|
| 653 | - * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
| 654 | - * @return mixed string on success, FALSE on fail |
|
| 655 | - * @throws ReflectionException |
|
| 656 | - * @throws InvalidArgumentException |
|
| 657 | - * @throws InvalidInterfaceException |
|
| 658 | - * @throws InvalidDataTypeException |
|
| 659 | - * @throws EE_Error |
|
| 660 | - */ |
|
| 661 | - public function end_time($tm_format = '') |
|
| 662 | - { |
|
| 663 | - return $this->_show_datetime('T', 'end', null, $tm_format); |
|
| 664 | - } |
|
| 665 | - |
|
| 666 | - |
|
| 667 | - /** |
|
| 668 | - * @param string $tm_format |
|
| 669 | - * @throws ReflectionException |
|
| 670 | - * @throws InvalidArgumentException |
|
| 671 | - * @throws InvalidInterfaceException |
|
| 672 | - * @throws InvalidDataTypeException |
|
| 673 | - * @throws EE_Error |
|
| 674 | - */ |
|
| 675 | - public function e_end_time($tm_format = '') |
|
| 676 | - { |
|
| 677 | - $this->_show_datetime('T', 'end', null, $tm_format, true); |
|
| 678 | - } |
|
| 679 | - |
|
| 680 | - |
|
| 681 | - /** |
|
| 682 | - * get time_range |
|
| 683 | - * |
|
| 684 | - * @access public |
|
| 685 | - * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
| 686 | - * @param string $conjunction conjunction junction what's your function ? |
|
| 687 | - * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 688 | - * @return mixed string on success, FALSE on fail |
|
| 689 | - * @throws ReflectionException |
|
| 690 | - * @throws InvalidArgumentException |
|
| 691 | - * @throws InvalidInterfaceException |
|
| 692 | - * @throws InvalidDataTypeException |
|
| 693 | - * @throws EE_Error |
|
| 694 | - */ |
|
| 695 | - public function time_range($tm_format = '', $conjunction = ' - ') |
|
| 696 | - { |
|
| 697 | - $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
| 698 | - $start = str_replace( |
|
| 699 | - ' ', |
|
| 700 | - ' ', |
|
| 701 | - $this->get_i18n_datetime('DTT_EVT_start', $tm_format) |
|
| 702 | - ); |
|
| 703 | - $end = str_replace( |
|
| 704 | - ' ', |
|
| 705 | - ' ', |
|
| 706 | - $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
|
| 707 | - ); |
|
| 708 | - return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 709 | - } |
|
| 710 | - |
|
| 711 | - |
|
| 712 | - /** |
|
| 713 | - * @param string $tm_format |
|
| 714 | - * @param string $conjunction |
|
| 715 | - * @throws ReflectionException |
|
| 716 | - * @throws InvalidArgumentException |
|
| 717 | - * @throws InvalidInterfaceException |
|
| 718 | - * @throws InvalidDataTypeException |
|
| 719 | - * @throws EE_Error |
|
| 720 | - */ |
|
| 721 | - public function e_time_range($tm_format = '', $conjunction = ' - ') |
|
| 722 | - { |
|
| 723 | - echo $this->time_range($tm_format, $conjunction); |
|
| 724 | - } |
|
| 725 | - |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * This returns a range representation of the date and times. |
|
| 729 | - * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end. |
|
| 730 | - * Also, the return value is localized. |
|
| 731 | - * |
|
| 732 | - * @param string $dt_format |
|
| 733 | - * @param string $tm_format |
|
| 734 | - * @param string $conjunction used between two different dates or times. |
|
| 735 | - * ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm |
|
| 736 | - * @param string $separator used between the date and time formats. |
|
| 737 | - * ex: Dec 1, 2016{$separator}2pm |
|
| 738 | - * @return string |
|
| 739 | - * @throws ReflectionException |
|
| 740 | - * @throws InvalidArgumentException |
|
| 741 | - * @throws InvalidInterfaceException |
|
| 742 | - * @throws InvalidDataTypeException |
|
| 743 | - * @throws EE_Error |
|
| 744 | - */ |
|
| 745 | - public function date_and_time_range( |
|
| 746 | - $dt_format = '', |
|
| 747 | - $tm_format = '', |
|
| 748 | - $conjunction = ' - ', |
|
| 749 | - $separator = ' ' |
|
| 750 | - ) { |
|
| 751 | - $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
|
| 752 | - $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
| 753 | - $full_format = $dt_format . $separator . $tm_format; |
|
| 754 | - // the range output depends on various conditions |
|
| 755 | - switch (true) { |
|
| 756 | - // start date timestamp and end date timestamp are the same. |
|
| 757 | - case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')): |
|
| 758 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format); |
|
| 759 | - break; |
|
| 760 | - // start and end date are the same but times are different |
|
| 761 | - case ($this->start_date() === $this->end_date()): |
|
| 762 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
| 763 | - . $conjunction |
|
| 764 | - . $this->get_i18n_datetime('DTT_EVT_end', $tm_format); |
|
| 765 | - break; |
|
| 766 | - // all other conditions |
|
| 767 | - default: |
|
| 768 | - $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
| 769 | - . $conjunction |
|
| 770 | - . $this->get_i18n_datetime('DTT_EVT_end', $full_format); |
|
| 771 | - break; |
|
| 772 | - } |
|
| 773 | - return $output; |
|
| 774 | - } |
|
| 775 | - |
|
| 776 | - |
|
| 777 | - /** |
|
| 778 | - * This echos the results of date and time range. |
|
| 779 | - * |
|
| 780 | - * @see date_and_time_range() for more details on purpose. |
|
| 781 | - * @param string $dt_format |
|
| 782 | - * @param string $tm_format |
|
| 783 | - * @param string $conjunction |
|
| 784 | - * @return void |
|
| 785 | - * @throws ReflectionException |
|
| 786 | - * @throws InvalidArgumentException |
|
| 787 | - * @throws InvalidInterfaceException |
|
| 788 | - * @throws InvalidDataTypeException |
|
| 789 | - * @throws EE_Error |
|
| 790 | - */ |
|
| 791 | - public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') |
|
| 792 | - { |
|
| 793 | - echo $this->date_and_time_range($dt_format, $tm_format, $conjunction); |
|
| 794 | - } |
|
| 795 | - |
|
| 796 | - |
|
| 797 | - /** |
|
| 798 | - * get start date and start time |
|
| 799 | - * |
|
| 800 | - * @param string $dt_format - string representation of date format defaults to 'F j, Y' |
|
| 801 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 802 | - * @return mixed string on success, FALSE on fail |
|
| 803 | - * @throws ReflectionException |
|
| 804 | - * @throws InvalidArgumentException |
|
| 805 | - * @throws InvalidInterfaceException |
|
| 806 | - * @throws InvalidDataTypeException |
|
| 807 | - * @throws EE_Error |
|
| 808 | - */ |
|
| 809 | - public function start_date_and_time($dt_format = '', $tm_format = '') |
|
| 810 | - { |
|
| 811 | - return $this->_show_datetime('', 'start', $dt_format, $tm_format); |
|
| 812 | - } |
|
| 813 | - |
|
| 814 | - |
|
| 815 | - /** |
|
| 816 | - * @param string $dt_frmt |
|
| 817 | - * @param string $tm_format |
|
| 818 | - * @throws ReflectionException |
|
| 819 | - * @throws InvalidArgumentException |
|
| 820 | - * @throws InvalidInterfaceException |
|
| 821 | - * @throws InvalidDataTypeException |
|
| 822 | - * @throws EE_Error |
|
| 823 | - */ |
|
| 824 | - public function e_start_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 825 | - { |
|
| 826 | - $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true); |
|
| 827 | - } |
|
| 828 | - |
|
| 829 | - |
|
| 830 | - /** |
|
| 831 | - * Shows the length of the event (start to end time). |
|
| 832 | - * Can be shown in 'seconds','minutes','hours', or 'days'. |
|
| 833 | - * By default, rounds up. (So if you use 'days', and then event |
|
| 834 | - * only occurs for 1 hour, it will return 1 day). |
|
| 835 | - * |
|
| 836 | - * @param string $units 'seconds','minutes','hours','days' |
|
| 837 | - * @param bool $round_up |
|
| 838 | - * @return float|int|mixed |
|
| 839 | - * @throws ReflectionException |
|
| 840 | - * @throws InvalidArgumentException |
|
| 841 | - * @throws InvalidInterfaceException |
|
| 842 | - * @throws InvalidDataTypeException |
|
| 843 | - * @throws EE_Error |
|
| 844 | - */ |
|
| 845 | - public function length($units = 'seconds', $round_up = false) |
|
| 846 | - { |
|
| 847 | - $start = $this->get_raw('DTT_EVT_start'); |
|
| 848 | - $end = $this->get_raw('DTT_EVT_end'); |
|
| 849 | - $length_in_units = $end - $start; |
|
| 850 | - switch ($units) { |
|
| 851 | - // NOTE: We purposefully don't use "break;" in order to chain the divisions |
|
| 852 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 853 | - // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment |
|
| 854 | - case 'days': |
|
| 855 | - $length_in_units /= 24; |
|
| 856 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 857 | - case 'hours': |
|
| 858 | - // fall through is intentional |
|
| 859 | - $length_in_units /= 60; |
|
| 860 | - /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 861 | - case 'minutes': |
|
| 862 | - // fall through is intentional |
|
| 863 | - $length_in_units /= 60; |
|
| 864 | - case 'seconds': |
|
| 865 | - default: |
|
| 866 | - $length_in_units = ceil($length_in_units); |
|
| 867 | - } |
|
| 868 | - // phpcs:enable |
|
| 869 | - if ($round_up) { |
|
| 870 | - $length_in_units = max($length_in_units, 1); |
|
| 871 | - } |
|
| 872 | - return $length_in_units; |
|
| 873 | - } |
|
| 874 | - |
|
| 875 | - |
|
| 876 | - /** |
|
| 877 | - * get end date and time |
|
| 878 | - * |
|
| 879 | - * @param string $dt_frmt - string representation of date format defaults to 'F j, Y' |
|
| 880 | - * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 881 | - * @return mixed string on success, FALSE on fail |
|
| 882 | - * @throws ReflectionException |
|
| 883 | - * @throws InvalidArgumentException |
|
| 884 | - * @throws InvalidInterfaceException |
|
| 885 | - * @throws InvalidDataTypeException |
|
| 886 | - * @throws EE_Error |
|
| 887 | - */ |
|
| 888 | - public function end_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 889 | - { |
|
| 890 | - return $this->_show_datetime('', 'end', $dt_frmt, $tm_format); |
|
| 891 | - } |
|
| 892 | - |
|
| 893 | - |
|
| 894 | - /** |
|
| 895 | - * @param string $dt_frmt |
|
| 896 | - * @param string $tm_format |
|
| 897 | - * @throws ReflectionException |
|
| 898 | - * @throws InvalidArgumentException |
|
| 899 | - * @throws InvalidInterfaceException |
|
| 900 | - * @throws InvalidDataTypeException |
|
| 901 | - * @throws EE_Error |
|
| 902 | - */ |
|
| 903 | - public function e_end_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 904 | - { |
|
| 905 | - $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true); |
|
| 906 | - } |
|
| 907 | - |
|
| 908 | - |
|
| 909 | - /** |
|
| 910 | - * get start timestamp |
|
| 911 | - * |
|
| 912 | - * @return int |
|
| 913 | - * @throws ReflectionException |
|
| 914 | - * @throws InvalidArgumentException |
|
| 915 | - * @throws InvalidInterfaceException |
|
| 916 | - * @throws InvalidDataTypeException |
|
| 917 | - * @throws EE_Error |
|
| 918 | - */ |
|
| 919 | - public function start() |
|
| 920 | - { |
|
| 921 | - return $this->get_raw('DTT_EVT_start'); |
|
| 922 | - } |
|
| 923 | - |
|
| 924 | - |
|
| 925 | - /** |
|
| 926 | - * get end timestamp |
|
| 927 | - * |
|
| 928 | - * @return int |
|
| 929 | - * @throws ReflectionException |
|
| 930 | - * @throws InvalidArgumentException |
|
| 931 | - * @throws InvalidInterfaceException |
|
| 932 | - * @throws InvalidDataTypeException |
|
| 933 | - * @throws EE_Error |
|
| 934 | - */ |
|
| 935 | - public function end() |
|
| 936 | - { |
|
| 937 | - return $this->get_raw('DTT_EVT_end'); |
|
| 938 | - } |
|
| 939 | - |
|
| 940 | - |
|
| 941 | - /** |
|
| 942 | - * get the registration limit for this datetime slot |
|
| 943 | - * |
|
| 944 | - * @return mixed int on success, FALSE on fail |
|
| 945 | - * @throws ReflectionException |
|
| 946 | - * @throws InvalidArgumentException |
|
| 947 | - * @throws InvalidInterfaceException |
|
| 948 | - * @throws InvalidDataTypeException |
|
| 949 | - * @throws EE_Error |
|
| 950 | - */ |
|
| 951 | - public function reg_limit() |
|
| 952 | - { |
|
| 953 | - return $this->get_raw('DTT_reg_limit'); |
|
| 954 | - } |
|
| 955 | - |
|
| 956 | - |
|
| 957 | - /** |
|
| 958 | - * have the tickets sold for this datetime, met or exceed the registration limit ? |
|
| 959 | - * |
|
| 960 | - * @return boolean |
|
| 961 | - * @throws ReflectionException |
|
| 962 | - * @throws InvalidArgumentException |
|
| 963 | - * @throws InvalidInterfaceException |
|
| 964 | - * @throws InvalidDataTypeException |
|
| 965 | - * @throws EE_Error |
|
| 966 | - */ |
|
| 967 | - public function sold_out() |
|
| 968 | - { |
|
| 969 | - return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit(); |
|
| 970 | - } |
|
| 971 | - |
|
| 972 | - |
|
| 973 | - /** |
|
| 974 | - * return the total number of spaces remaining at this venue. |
|
| 975 | - * This only takes the venue's capacity into account, NOT the tickets available for sale |
|
| 976 | - * |
|
| 977 | - * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left |
|
| 978 | - * Because if all tickets attached to this datetime have no spaces left, |
|
| 979 | - * then this datetime IS effectively sold out. |
|
| 980 | - * However, there are cases where we just want to know the spaces |
|
| 981 | - * remaining for this particular datetime, hence the flag. |
|
| 982 | - * @return int |
|
| 983 | - * @throws ReflectionException |
|
| 984 | - * @throws InvalidArgumentException |
|
| 985 | - * @throws InvalidInterfaceException |
|
| 986 | - * @throws InvalidDataTypeException |
|
| 987 | - * @throws EE_Error |
|
| 988 | - */ |
|
| 989 | - public function spaces_remaining($consider_tickets = false) |
|
| 990 | - { |
|
| 991 | - // tickets remaining available for purchase |
|
| 992 | - // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
|
| 993 | - $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
|
| 994 | - if (! $consider_tickets) { |
|
| 995 | - return $dtt_remaining; |
|
| 996 | - } |
|
| 997 | - $tickets_remaining = $this->tickets_remaining(); |
|
| 998 | - return min($dtt_remaining, $tickets_remaining); |
|
| 999 | - } |
|
| 1000 | - |
|
| 1001 | - |
|
| 1002 | - /** |
|
| 1003 | - * Counts the total tickets available |
|
| 1004 | - * (from all the different types of tickets which are available for this datetime). |
|
| 1005 | - * |
|
| 1006 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1007 | - * @return int |
|
| 1008 | - * @throws ReflectionException |
|
| 1009 | - * @throws InvalidArgumentException |
|
| 1010 | - * @throws InvalidInterfaceException |
|
| 1011 | - * @throws InvalidDataTypeException |
|
| 1012 | - * @throws EE_Error |
|
| 1013 | - */ |
|
| 1014 | - public function tickets_remaining($query_params = array()) |
|
| 1015 | - { |
|
| 1016 | - $sum = 0; |
|
| 1017 | - $tickets = $this->tickets($query_params); |
|
| 1018 | - if (! empty($tickets)) { |
|
| 1019 | - foreach ($tickets as $ticket) { |
|
| 1020 | - if ($ticket instanceof EE_Ticket) { |
|
| 1021 | - // get the actual amount of tickets that can be sold |
|
| 1022 | - $qty = $ticket->qty('saleable'); |
|
| 1023 | - if ($qty === EE_INF) { |
|
| 1024 | - return EE_INF; |
|
| 1025 | - } |
|
| 1026 | - // no negative ticket quantities plz |
|
| 1027 | - if ($qty > 0) { |
|
| 1028 | - $sum += $qty; |
|
| 1029 | - } |
|
| 1030 | - } |
|
| 1031 | - } |
|
| 1032 | - } |
|
| 1033 | - return $sum; |
|
| 1034 | - } |
|
| 1035 | - |
|
| 1036 | - |
|
| 1037 | - /** |
|
| 1038 | - * Gets the count of all the tickets available at this datetime (not ticket types) |
|
| 1039 | - * before any were sold |
|
| 1040 | - * |
|
| 1041 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1042 | - * @return int |
|
| 1043 | - * @throws ReflectionException |
|
| 1044 | - * @throws InvalidArgumentException |
|
| 1045 | - * @throws InvalidInterfaceException |
|
| 1046 | - * @throws InvalidDataTypeException |
|
| 1047 | - * @throws EE_Error |
|
| 1048 | - */ |
|
| 1049 | - public function sum_tickets_initially_available($query_params = array()) |
|
| 1050 | - { |
|
| 1051 | - return $this->sum_related('Ticket', $query_params, 'TKT_qty'); |
|
| 1052 | - } |
|
| 1053 | - |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * Returns the lesser-of-the two: spaces remaining at this datetime, or |
|
| 1057 | - * the total tickets remaining (a sum of the tickets remaining for each ticket type |
|
| 1058 | - * that is available for this datetime). |
|
| 1059 | - * |
|
| 1060 | - * @return int |
|
| 1061 | - * @throws ReflectionException |
|
| 1062 | - * @throws InvalidArgumentException |
|
| 1063 | - * @throws InvalidInterfaceException |
|
| 1064 | - * @throws InvalidDataTypeException |
|
| 1065 | - * @throws EE_Error |
|
| 1066 | - */ |
|
| 1067 | - public function total_tickets_available_at_this_datetime() |
|
| 1068 | - { |
|
| 1069 | - return $this->spaces_remaining(true); |
|
| 1070 | - } |
|
| 1071 | - |
|
| 1072 | - |
|
| 1073 | - /** |
|
| 1074 | - * This simply compares the internal dtt for the given string with NOW |
|
| 1075 | - * and determines if the date is upcoming or not. |
|
| 1076 | - * |
|
| 1077 | - * @access public |
|
| 1078 | - * @return boolean |
|
| 1079 | - * @throws ReflectionException |
|
| 1080 | - * @throws InvalidArgumentException |
|
| 1081 | - * @throws InvalidInterfaceException |
|
| 1082 | - * @throws InvalidDataTypeException |
|
| 1083 | - * @throws EE_Error |
|
| 1084 | - */ |
|
| 1085 | - public function is_upcoming() |
|
| 1086 | - { |
|
| 1087 | - return ($this->get_raw('DTT_EVT_start') > time()); |
|
| 1088 | - } |
|
| 1089 | - |
|
| 1090 | - |
|
| 1091 | - /** |
|
| 1092 | - * This simply compares the internal datetime for the given string with NOW |
|
| 1093 | - * and returns if the date is active (i.e. start and end time) |
|
| 1094 | - * |
|
| 1095 | - * @return boolean |
|
| 1096 | - * @throws ReflectionException |
|
| 1097 | - * @throws InvalidArgumentException |
|
| 1098 | - * @throws InvalidInterfaceException |
|
| 1099 | - * @throws InvalidDataTypeException |
|
| 1100 | - * @throws EE_Error |
|
| 1101 | - */ |
|
| 1102 | - public function is_active() |
|
| 1103 | - { |
|
| 1104 | - return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time()); |
|
| 1105 | - } |
|
| 1106 | - |
|
| 1107 | - |
|
| 1108 | - /** |
|
| 1109 | - * This simply compares the internal dtt for the given string with NOW |
|
| 1110 | - * and determines if the date is expired or not. |
|
| 1111 | - * |
|
| 1112 | - * @return boolean |
|
| 1113 | - * @throws ReflectionException |
|
| 1114 | - * @throws InvalidArgumentException |
|
| 1115 | - * @throws InvalidInterfaceException |
|
| 1116 | - * @throws InvalidDataTypeException |
|
| 1117 | - * @throws EE_Error |
|
| 1118 | - */ |
|
| 1119 | - public function is_expired() |
|
| 1120 | - { |
|
| 1121 | - return ($this->get_raw('DTT_EVT_end') < time()); |
|
| 1122 | - } |
|
| 1123 | - |
|
| 1124 | - |
|
| 1125 | - /** |
|
| 1126 | - * This returns the active status for whether an event is active, upcoming, or expired |
|
| 1127 | - * |
|
| 1128 | - * @return int return value will be one of the EE_Datetime status constants. |
|
| 1129 | - * @throws ReflectionException |
|
| 1130 | - * @throws InvalidArgumentException |
|
| 1131 | - * @throws InvalidInterfaceException |
|
| 1132 | - * @throws InvalidDataTypeException |
|
| 1133 | - * @throws EE_Error |
|
| 1134 | - */ |
|
| 1135 | - public function get_active_status() |
|
| 1136 | - { |
|
| 1137 | - $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime(); |
|
| 1138 | - if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) { |
|
| 1139 | - return EE_Datetime::sold_out; |
|
| 1140 | - } |
|
| 1141 | - if ($this->is_expired()) { |
|
| 1142 | - return EE_Datetime::expired; |
|
| 1143 | - } |
|
| 1144 | - if ($this->is_upcoming()) { |
|
| 1145 | - return EE_Datetime::upcoming; |
|
| 1146 | - } |
|
| 1147 | - if ($this->is_active()) { |
|
| 1148 | - return EE_Datetime::active; |
|
| 1149 | - } |
|
| 1150 | - return null; |
|
| 1151 | - } |
|
| 1152 | - |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * This returns a nice display name for the datetime that is contingent on the span between the dates and times. |
|
| 1156 | - * |
|
| 1157 | - * @param boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty. |
|
| 1158 | - * @return string |
|
| 1159 | - * @throws ReflectionException |
|
| 1160 | - * @throws InvalidArgumentException |
|
| 1161 | - * @throws InvalidInterfaceException |
|
| 1162 | - * @throws InvalidDataTypeException |
|
| 1163 | - * @throws EE_Error |
|
| 1164 | - */ |
|
| 1165 | - public function get_dtt_display_name($use_dtt_name = false) |
|
| 1166 | - { |
|
| 1167 | - if ($use_dtt_name) { |
|
| 1168 | - $dtt_name = $this->name(); |
|
| 1169 | - if (! empty($dtt_name)) { |
|
| 1170 | - return $dtt_name; |
|
| 1171 | - } |
|
| 1172 | - } |
|
| 1173 | - // first condition is to see if the months are different |
|
| 1174 | - if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
|
| 1175 | - ) { |
|
| 1176 | - $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
| 1177 | - // next condition is if its the same month but different day |
|
| 1178 | - } else { |
|
| 1179 | - if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
|
| 1180 | - && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
|
| 1181 | - ) { |
|
| 1182 | - $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
| 1183 | - } else { |
|
| 1184 | - $display_date = $this->start_date('F j\, Y') |
|
| 1185 | - . ' @ ' |
|
| 1186 | - . $this->start_date('g:i a') |
|
| 1187 | - . ' - ' |
|
| 1188 | - . $this->end_date('g:i a'); |
|
| 1189 | - } |
|
| 1190 | - } |
|
| 1191 | - return $display_date; |
|
| 1192 | - } |
|
| 1193 | - |
|
| 1194 | - |
|
| 1195 | - /** |
|
| 1196 | - * Gets all the tickets for this datetime |
|
| 1197 | - * |
|
| 1198 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1199 | - * @return EE_Base_Class[]|EE_Ticket[] |
|
| 1200 | - * @throws ReflectionException |
|
| 1201 | - * @throws InvalidArgumentException |
|
| 1202 | - * @throws InvalidInterfaceException |
|
| 1203 | - * @throws InvalidDataTypeException |
|
| 1204 | - * @throws EE_Error |
|
| 1205 | - */ |
|
| 1206 | - public function tickets($query_params = array()) |
|
| 1207 | - { |
|
| 1208 | - return $this->get_many_related('Ticket', $query_params); |
|
| 1209 | - } |
|
| 1210 | - |
|
| 1211 | - |
|
| 1212 | - /** |
|
| 1213 | - * Gets all the ticket types currently available for purchase |
|
| 1214 | - * |
|
| 1215 | - * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1216 | - * @return EE_Ticket[] |
|
| 1217 | - * @throws ReflectionException |
|
| 1218 | - * @throws InvalidArgumentException |
|
| 1219 | - * @throws InvalidInterfaceException |
|
| 1220 | - * @throws InvalidDataTypeException |
|
| 1221 | - * @throws EE_Error |
|
| 1222 | - */ |
|
| 1223 | - public function ticket_types_available_for_purchase($query_params = array()) |
|
| 1224 | - { |
|
| 1225 | - // first check if datetime is valid |
|
| 1226 | - if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) { |
|
| 1227 | - return array(); |
|
| 1228 | - } |
|
| 1229 | - if (empty($query_params)) { |
|
| 1230 | - $query_params = array( |
|
| 1231 | - array( |
|
| 1232 | - 'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')), |
|
| 1233 | - 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
| 1234 | - 'TKT_deleted' => false, |
|
| 1235 | - ), |
|
| 1236 | - ); |
|
| 1237 | - } |
|
| 1238 | - return $this->tickets($query_params); |
|
| 1239 | - } |
|
| 1240 | - |
|
| 1241 | - |
|
| 1242 | - /** |
|
| 1243 | - * @return EE_Base_Class|EE_Event |
|
| 1244 | - * @throws ReflectionException |
|
| 1245 | - * @throws InvalidArgumentException |
|
| 1246 | - * @throws InvalidInterfaceException |
|
| 1247 | - * @throws InvalidDataTypeException |
|
| 1248 | - * @throws EE_Error |
|
| 1249 | - */ |
|
| 1250 | - public function event() |
|
| 1251 | - { |
|
| 1252 | - return $this->get_first_related('Event'); |
|
| 1253 | - } |
|
| 1254 | - |
|
| 1255 | - |
|
| 1256 | - /** |
|
| 1257 | - * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime |
|
| 1258 | - * (via the tickets). into account |
|
| 1259 | - * |
|
| 1260 | - * @return int |
|
| 1261 | - * @throws ReflectionException |
|
| 1262 | - * @throws InvalidArgumentException |
|
| 1263 | - * @throws InvalidInterfaceException |
|
| 1264 | - * @throws InvalidDataTypeException |
|
| 1265 | - * @throws EE_Error |
|
| 1266 | - */ |
|
| 1267 | - public function update_sold() |
|
| 1268 | - { |
|
| 1269 | - $count_regs_for_this_datetime = EEM_Registration::instance()->count( |
|
| 1270 | - array( |
|
| 1271 | - array( |
|
| 1272 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 1273 | - 'REG_deleted' => 0, |
|
| 1274 | - 'Ticket.Datetime.DTT_ID' => $this->ID(), |
|
| 1275 | - ), |
|
| 1276 | - ) |
|
| 1277 | - ); |
|
| 1278 | - $sold = $this->sold(); |
|
| 1279 | - if ($count_regs_for_this_datetime > $sold) { |
|
| 1280 | - $this->increase_sold($count_regs_for_this_datetime - $sold); |
|
| 1281 | - $this->save(); |
|
| 1282 | - } elseif ($count_regs_for_this_datetime < $sold) { |
|
| 1283 | - $this->decrease_sold($count_regs_for_this_datetime - $sold); |
|
| 1284 | - $this->save(); |
|
| 1285 | - } |
|
| 1286 | - return $count_regs_for_this_datetime; |
|
| 1287 | - } |
|
| 16 | + /** |
|
| 17 | + * constant used by get_active_status, indicates datetime has no more available spaces |
|
| 18 | + */ |
|
| 19 | + const sold_out = 'DTS'; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for) |
|
| 23 | + */ |
|
| 24 | + const active = 'DTA'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not |
|
| 28 | + * expired |
|
| 29 | + */ |
|
| 30 | + const upcoming = 'DTU'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Datetime is postponed |
|
| 34 | + */ |
|
| 35 | + const postponed = 'DTP'; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Datetime is cancelled |
|
| 39 | + */ |
|
| 40 | + const cancelled = 'DTC'; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * constant used by get_active_status, indicates datetime has expired (event is over) |
|
| 44 | + */ |
|
| 45 | + const expired = 'DTE'; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * constant used in various places indicating that an event is INACTIVE (not yet ready to be published) |
|
| 49 | + */ |
|
| 50 | + const inactive = 'DTI'; |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @param array $props_n_values incoming values |
|
| 55 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be used.) |
|
| 56 | + * @param array $date_formats incoming date_formats in an array where the first value is the date_format |
|
| 57 | + * and the second value is the time format |
|
| 58 | + * @return EE_Datetime |
|
| 59 | + * @throws ReflectionException |
|
| 60 | + * @throws InvalidArgumentException |
|
| 61 | + * @throws InvalidInterfaceException |
|
| 62 | + * @throws InvalidDataTypeException |
|
| 63 | + * @throws EE_Error |
|
| 64 | + */ |
|
| 65 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 66 | + { |
|
| 67 | + $has_object = parent::_check_for_object( |
|
| 68 | + $props_n_values, |
|
| 69 | + __CLASS__, |
|
| 70 | + $timezone, |
|
| 71 | + $date_formats |
|
| 72 | + ); |
|
| 73 | + return $has_object |
|
| 74 | + ? $has_object |
|
| 75 | + : new self($props_n_values, false, $timezone, $date_formats); |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * @param array $props_n_values incoming values from the database |
|
| 81 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 82 | + * the website will be used. |
|
| 83 | + * @return EE_Datetime |
|
| 84 | + * @throws ReflectionException |
|
| 85 | + * @throws InvalidArgumentException |
|
| 86 | + * @throws InvalidInterfaceException |
|
| 87 | + * @throws InvalidDataTypeException |
|
| 88 | + * @throws EE_Error |
|
| 89 | + */ |
|
| 90 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 91 | + { |
|
| 92 | + return new self($props_n_values, true, $timezone); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * @param $name |
|
| 98 | + * @throws ReflectionException |
|
| 99 | + * @throws InvalidArgumentException |
|
| 100 | + * @throws InvalidInterfaceException |
|
| 101 | + * @throws InvalidDataTypeException |
|
| 102 | + * @throws EE_Error |
|
| 103 | + */ |
|
| 104 | + public function set_name($name) |
|
| 105 | + { |
|
| 106 | + $this->set('DTT_name', $name); |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * @param $description |
|
| 112 | + * @throws ReflectionException |
|
| 113 | + * @throws InvalidArgumentException |
|
| 114 | + * @throws InvalidInterfaceException |
|
| 115 | + * @throws InvalidDataTypeException |
|
| 116 | + * @throws EE_Error |
|
| 117 | + */ |
|
| 118 | + public function set_description($description) |
|
| 119 | + { |
|
| 120 | + $this->set('DTT_description', $description); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Set event start date |
|
| 126 | + * set the start date for an event |
|
| 127 | + * |
|
| 128 | + * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
| 129 | + * @throws ReflectionException |
|
| 130 | + * @throws InvalidArgumentException |
|
| 131 | + * @throws InvalidInterfaceException |
|
| 132 | + * @throws InvalidDataTypeException |
|
| 133 | + * @throws EE_Error |
|
| 134 | + */ |
|
| 135 | + public function set_start_date($date) |
|
| 136 | + { |
|
| 137 | + $this->_set_date_for($date, 'DTT_EVT_start'); |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * Set event start time |
|
| 143 | + * set the start time for an event |
|
| 144 | + * |
|
| 145 | + * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
| 146 | + * @throws ReflectionException |
|
| 147 | + * @throws InvalidArgumentException |
|
| 148 | + * @throws InvalidInterfaceException |
|
| 149 | + * @throws InvalidDataTypeException |
|
| 150 | + * @throws EE_Error |
|
| 151 | + */ |
|
| 152 | + public function set_start_time($time) |
|
| 153 | + { |
|
| 154 | + $this->_set_time_for($time, 'DTT_EVT_start'); |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * Set event end date |
|
| 160 | + * set the end date for an event |
|
| 161 | + * |
|
| 162 | + * @param string $date a string representation of the event's date ex: Dec. 25, 2025 or 12-25-2025 |
|
| 163 | + * @throws ReflectionException |
|
| 164 | + * @throws InvalidArgumentException |
|
| 165 | + * @throws InvalidInterfaceException |
|
| 166 | + * @throws InvalidDataTypeException |
|
| 167 | + * @throws EE_Error |
|
| 168 | + */ |
|
| 169 | + public function set_end_date($date) |
|
| 170 | + { |
|
| 171 | + $this->_set_date_for($date, 'DTT_EVT_end'); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Set event end time |
|
| 177 | + * set the end time for an event |
|
| 178 | + * |
|
| 179 | + * @param string $time a string representation of the event time ex: 9am or 7:30 PM |
|
| 180 | + * @throws ReflectionException |
|
| 181 | + * @throws InvalidArgumentException |
|
| 182 | + * @throws InvalidInterfaceException |
|
| 183 | + * @throws InvalidDataTypeException |
|
| 184 | + * @throws EE_Error |
|
| 185 | + */ |
|
| 186 | + public function set_end_time($time) |
|
| 187 | + { |
|
| 188 | + $this->_set_time_for($time, 'DTT_EVT_end'); |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Set registration limit |
|
| 194 | + * set the maximum number of attendees that can be registered for this datetime slot |
|
| 195 | + * |
|
| 196 | + * @param int $reg_limit |
|
| 197 | + * @throws ReflectionException |
|
| 198 | + * @throws InvalidArgumentException |
|
| 199 | + * @throws InvalidInterfaceException |
|
| 200 | + * @throws InvalidDataTypeException |
|
| 201 | + * @throws EE_Error |
|
| 202 | + */ |
|
| 203 | + public function set_reg_limit($reg_limit) |
|
| 204 | + { |
|
| 205 | + $this->set('DTT_reg_limit', $reg_limit); |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * get the number of tickets sold for this datetime slot |
|
| 211 | + * |
|
| 212 | + * @return mixed int on success, FALSE on fail |
|
| 213 | + * @throws ReflectionException |
|
| 214 | + * @throws InvalidArgumentException |
|
| 215 | + * @throws InvalidInterfaceException |
|
| 216 | + * @throws InvalidDataTypeException |
|
| 217 | + * @throws EE_Error |
|
| 218 | + */ |
|
| 219 | + public function sold() |
|
| 220 | + { |
|
| 221 | + return $this->get_raw('DTT_sold'); |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param int $sold |
|
| 227 | + * @throws ReflectionException |
|
| 228 | + * @throws InvalidArgumentException |
|
| 229 | + * @throws InvalidInterfaceException |
|
| 230 | + * @throws InvalidDataTypeException |
|
| 231 | + * @throws EE_Error |
|
| 232 | + */ |
|
| 233 | + public function set_sold($sold) |
|
| 234 | + { |
|
| 235 | + // sold can not go below zero |
|
| 236 | + $sold = max(0, $sold); |
|
| 237 | + $this->set('DTT_sold', $sold); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * increments sold by amount passed by $qty |
|
| 243 | + * |
|
| 244 | + * @param int $qty |
|
| 245 | + * @throws ReflectionException |
|
| 246 | + * @throws InvalidArgumentException |
|
| 247 | + * @throws InvalidInterfaceException |
|
| 248 | + * @throws InvalidDataTypeException |
|
| 249 | + * @throws EE_Error |
|
| 250 | + */ |
|
| 251 | + public function increase_sold($qty = 1) |
|
| 252 | + { |
|
| 253 | + $sold = $this->sold() + $qty; |
|
| 254 | + // remove ticket reservation |
|
| 255 | + $this->decrease_reserved($qty); |
|
| 256 | + $this->set_sold($sold); |
|
| 257 | + do_action( |
|
| 258 | + 'AHEE__EE_Datetime__increase_sold', |
|
| 259 | + $this, |
|
| 260 | + $qty, |
|
| 261 | + $sold |
|
| 262 | + ); |
|
| 263 | + } |
|
| 264 | + |
|
| 265 | + |
|
| 266 | + /** |
|
| 267 | + * decrements (subtracts) sold amount passed by $qty |
|
| 268 | + * |
|
| 269 | + * @param int $qty |
|
| 270 | + * @throws ReflectionException |
|
| 271 | + * @throws InvalidArgumentException |
|
| 272 | + * @throws InvalidInterfaceException |
|
| 273 | + * @throws InvalidDataTypeException |
|
| 274 | + * @throws EE_Error |
|
| 275 | + */ |
|
| 276 | + public function decrease_sold($qty = 1) |
|
| 277 | + { |
|
| 278 | + $sold = $this->sold() - $qty; |
|
| 279 | + $this->set_sold($sold); |
|
| 280 | + do_action( |
|
| 281 | + 'AHEE__EE_Datetime__decrease_sold', |
|
| 282 | + $this, |
|
| 283 | + $qty, |
|
| 284 | + $sold |
|
| 285 | + ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Gets qty of reserved tickets for this datetime |
|
| 291 | + * |
|
| 292 | + * @return int |
|
| 293 | + * @throws ReflectionException |
|
| 294 | + * @throws InvalidArgumentException |
|
| 295 | + * @throws InvalidInterfaceException |
|
| 296 | + * @throws InvalidDataTypeException |
|
| 297 | + * @throws EE_Error |
|
| 298 | + */ |
|
| 299 | + public function reserved() |
|
| 300 | + { |
|
| 301 | + return $this->get_raw('DTT_reserved'); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Sets qty of reserved tickets for this datetime |
|
| 307 | + * |
|
| 308 | + * @param int $reserved |
|
| 309 | + * @throws ReflectionException |
|
| 310 | + * @throws InvalidArgumentException |
|
| 311 | + * @throws InvalidInterfaceException |
|
| 312 | + * @throws InvalidDataTypeException |
|
| 313 | + * @throws EE_Error |
|
| 314 | + */ |
|
| 315 | + public function set_reserved($reserved) |
|
| 316 | + { |
|
| 317 | + // reserved can not go below zero |
|
| 318 | + $reserved = max(0, (int) $reserved); |
|
| 319 | + $this->set('DTT_reserved', $reserved); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + |
|
| 323 | + /** |
|
| 324 | + * increments reserved by amount passed by $qty |
|
| 325 | + * |
|
| 326 | + * @param int $qty |
|
| 327 | + * @return void |
|
| 328 | + * @throws ReflectionException |
|
| 329 | + * @throws InvalidArgumentException |
|
| 330 | + * @throws InvalidInterfaceException |
|
| 331 | + * @throws InvalidDataTypeException |
|
| 332 | + * @throws EE_Error |
|
| 333 | + */ |
|
| 334 | + public function increase_reserved($qty = 1) |
|
| 335 | + { |
|
| 336 | + $reserved = $this->reserved() + absint($qty); |
|
| 337 | + do_action( |
|
| 338 | + 'AHEE__EE_Datetime__increase_reserved', |
|
| 339 | + $this, |
|
| 340 | + $qty, |
|
| 341 | + $reserved |
|
| 342 | + ); |
|
| 343 | + $this->set_reserved($reserved); |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * decrements (subtracts) reserved by amount passed by $qty |
|
| 349 | + * |
|
| 350 | + * @param int $qty |
|
| 351 | + * @return void |
|
| 352 | + * @throws ReflectionException |
|
| 353 | + * @throws InvalidArgumentException |
|
| 354 | + * @throws InvalidInterfaceException |
|
| 355 | + * @throws InvalidDataTypeException |
|
| 356 | + * @throws EE_Error |
|
| 357 | + */ |
|
| 358 | + public function decrease_reserved($qty = 1) |
|
| 359 | + { |
|
| 360 | + $reserved = $this->reserved() - absint($qty); |
|
| 361 | + do_action( |
|
| 362 | + 'AHEE__EE_Datetime__decrease_reserved', |
|
| 363 | + $this, |
|
| 364 | + $qty, |
|
| 365 | + $reserved |
|
| 366 | + ); |
|
| 367 | + $this->set_reserved($reserved); |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + |
|
| 371 | + /** |
|
| 372 | + * total sold and reserved tickets |
|
| 373 | + * |
|
| 374 | + * @return int |
|
| 375 | + * @throws ReflectionException |
|
| 376 | + * @throws InvalidArgumentException |
|
| 377 | + * @throws InvalidInterfaceException |
|
| 378 | + * @throws InvalidDataTypeException |
|
| 379 | + * @throws EE_Error |
|
| 380 | + */ |
|
| 381 | + public function sold_and_reserved() |
|
| 382 | + { |
|
| 383 | + return $this->sold() + $this->reserved(); |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * returns the datetime name |
|
| 389 | + * |
|
| 390 | + * @return string |
|
| 391 | + * @throws ReflectionException |
|
| 392 | + * @throws InvalidArgumentException |
|
| 393 | + * @throws InvalidInterfaceException |
|
| 394 | + * @throws InvalidDataTypeException |
|
| 395 | + * @throws EE_Error |
|
| 396 | + */ |
|
| 397 | + public function name() |
|
| 398 | + { |
|
| 399 | + return $this->get('DTT_name'); |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + |
|
| 403 | + /** |
|
| 404 | + * returns the datetime description |
|
| 405 | + * |
|
| 406 | + * @return string |
|
| 407 | + * @throws ReflectionException |
|
| 408 | + * @throws InvalidArgumentException |
|
| 409 | + * @throws InvalidInterfaceException |
|
| 410 | + * @throws InvalidDataTypeException |
|
| 411 | + * @throws EE_Error |
|
| 412 | + */ |
|
| 413 | + public function description() |
|
| 414 | + { |
|
| 415 | + return $this->get('DTT_description'); |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + |
|
| 419 | + /** |
|
| 420 | + * This helper simply returns whether the event_datetime for the current datetime is a primary datetime |
|
| 421 | + * |
|
| 422 | + * @return boolean TRUE if is primary, FALSE if not. |
|
| 423 | + * @throws ReflectionException |
|
| 424 | + * @throws InvalidArgumentException |
|
| 425 | + * @throws InvalidInterfaceException |
|
| 426 | + * @throws InvalidDataTypeException |
|
| 427 | + * @throws EE_Error |
|
| 428 | + */ |
|
| 429 | + public function is_primary() |
|
| 430 | + { |
|
| 431 | + return $this->get('DTT_is_primary'); |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + |
|
| 435 | + /** |
|
| 436 | + * This helper simply returns the order for the datetime |
|
| 437 | + * |
|
| 438 | + * @return int The order of the datetime for this event. |
|
| 439 | + * @throws ReflectionException |
|
| 440 | + * @throws InvalidArgumentException |
|
| 441 | + * @throws InvalidInterfaceException |
|
| 442 | + * @throws InvalidDataTypeException |
|
| 443 | + * @throws EE_Error |
|
| 444 | + */ |
|
| 445 | + public function order() |
|
| 446 | + { |
|
| 447 | + return $this->get('DTT_order'); |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * This helper simply returns the parent id for the datetime |
|
| 453 | + * |
|
| 454 | + * @return int |
|
| 455 | + * @throws ReflectionException |
|
| 456 | + * @throws InvalidArgumentException |
|
| 457 | + * @throws InvalidInterfaceException |
|
| 458 | + * @throws InvalidDataTypeException |
|
| 459 | + * @throws EE_Error |
|
| 460 | + */ |
|
| 461 | + public function parent() |
|
| 462 | + { |
|
| 463 | + return $this->get('DTT_parent'); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * show date and/or time |
|
| 469 | + * |
|
| 470 | + * @param string $date_or_time whether to display a date or time or both |
|
| 471 | + * @param string $start_or_end whether to display start or end datetimes |
|
| 472 | + * @param string $dt_frmt |
|
| 473 | + * @param string $tm_frmt |
|
| 474 | + * @param bool $echo whether we echo or return (note echoing uses "pretty" formats, |
|
| 475 | + * otherwise we use the standard formats) |
|
| 476 | + * @return string|bool string on success, FALSE on fail |
|
| 477 | + * @throws ReflectionException |
|
| 478 | + * @throws InvalidArgumentException |
|
| 479 | + * @throws InvalidInterfaceException |
|
| 480 | + * @throws InvalidDataTypeException |
|
| 481 | + * @throws EE_Error |
|
| 482 | + */ |
|
| 483 | + private function _show_datetime( |
|
| 484 | + $date_or_time = null, |
|
| 485 | + $start_or_end = 'start', |
|
| 486 | + $dt_frmt = '', |
|
| 487 | + $tm_frmt = '', |
|
| 488 | + $echo = false |
|
| 489 | + ) { |
|
| 490 | + $field_name = "DTT_EVT_{$start_or_end}"; |
|
| 491 | + $dtt = $this->_get_datetime( |
|
| 492 | + $field_name, |
|
| 493 | + $dt_frmt, |
|
| 494 | + $tm_frmt, |
|
| 495 | + $date_or_time, |
|
| 496 | + $echo |
|
| 497 | + ); |
|
| 498 | + if (! $echo) { |
|
| 499 | + return $dtt; |
|
| 500 | + } |
|
| 501 | + return ''; |
|
| 502 | + } |
|
| 503 | + |
|
| 504 | + |
|
| 505 | + /** |
|
| 506 | + * get event start date. Provide either the date format, or NULL to re-use the |
|
| 507 | + * last-used format, or '' to use the default date format |
|
| 508 | + * |
|
| 509 | + * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
| 510 | + * @return mixed string on success, FALSE on fail |
|
| 511 | + * @throws ReflectionException |
|
| 512 | + * @throws InvalidArgumentException |
|
| 513 | + * @throws InvalidInterfaceException |
|
| 514 | + * @throws InvalidDataTypeException |
|
| 515 | + * @throws EE_Error |
|
| 516 | + */ |
|
| 517 | + public function start_date($dt_frmt = '') |
|
| 518 | + { |
|
| 519 | + return $this->_show_datetime('D', 'start', $dt_frmt); |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + |
|
| 523 | + /** |
|
| 524 | + * Echoes start_date() |
|
| 525 | + * |
|
| 526 | + * @param string $dt_frmt |
|
| 527 | + * @throws ReflectionException |
|
| 528 | + * @throws InvalidArgumentException |
|
| 529 | + * @throws InvalidInterfaceException |
|
| 530 | + * @throws InvalidDataTypeException |
|
| 531 | + * @throws EE_Error |
|
| 532 | + */ |
|
| 533 | + public function e_start_date($dt_frmt = '') |
|
| 534 | + { |
|
| 535 | + $this->_show_datetime('D', 'start', $dt_frmt, null, true); |
|
| 536 | + } |
|
| 537 | + |
|
| 538 | + |
|
| 539 | + /** |
|
| 540 | + * get end date. Provide either the date format, or NULL to re-use the |
|
| 541 | + * last-used format, or '' to use the default date format |
|
| 542 | + * |
|
| 543 | + * @param string $dt_frmt string representation of date format defaults to 'F j, Y' |
|
| 544 | + * @return mixed string on success, FALSE on fail |
|
| 545 | + * @throws ReflectionException |
|
| 546 | + * @throws InvalidArgumentException |
|
| 547 | + * @throws InvalidInterfaceException |
|
| 548 | + * @throws InvalidDataTypeException |
|
| 549 | + * @throws EE_Error |
|
| 550 | + */ |
|
| 551 | + public function end_date($dt_frmt = '') |
|
| 552 | + { |
|
| 553 | + return $this->_show_datetime('D', 'end', $dt_frmt); |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + |
|
| 557 | + /** |
|
| 558 | + * Echoes the end date. See end_date() |
|
| 559 | + * |
|
| 560 | + * @param string $dt_frmt |
|
| 561 | + * @throws ReflectionException |
|
| 562 | + * @throws InvalidArgumentException |
|
| 563 | + * @throws InvalidInterfaceException |
|
| 564 | + * @throws InvalidDataTypeException |
|
| 565 | + * @throws EE_Error |
|
| 566 | + */ |
|
| 567 | + public function e_end_date($dt_frmt = '') |
|
| 568 | + { |
|
| 569 | + $this->_show_datetime('D', 'end', $dt_frmt, null, true); |
|
| 570 | + } |
|
| 571 | + |
|
| 572 | + |
|
| 573 | + /** |
|
| 574 | + * get date_range - meaning the start AND end date |
|
| 575 | + * |
|
| 576 | + * @access public |
|
| 577 | + * @param string $dt_frmt string representation of date format defaults to WP settings |
|
| 578 | + * @param string $conjunction conjunction junction what's your function ? |
|
| 579 | + * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 580 | + * @return mixed string on success, FALSE on fail |
|
| 581 | + * @throws ReflectionException |
|
| 582 | + * @throws InvalidArgumentException |
|
| 583 | + * @throws InvalidInterfaceException |
|
| 584 | + * @throws InvalidDataTypeException |
|
| 585 | + * @throws EE_Error |
|
| 586 | + */ |
|
| 587 | + public function date_range($dt_frmt = '', $conjunction = ' - ') |
|
| 588 | + { |
|
| 589 | + $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt; |
|
| 590 | + $start = str_replace( |
|
| 591 | + ' ', |
|
| 592 | + ' ', |
|
| 593 | + $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt) |
|
| 594 | + ); |
|
| 595 | + $end = str_replace( |
|
| 596 | + ' ', |
|
| 597 | + ' ', |
|
| 598 | + $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt) |
|
| 599 | + ); |
|
| 600 | + return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 601 | + } |
|
| 602 | + |
|
| 603 | + |
|
| 604 | + /** |
|
| 605 | + * @param string $dt_frmt |
|
| 606 | + * @param string $conjunction |
|
| 607 | + * @throws ReflectionException |
|
| 608 | + * @throws InvalidArgumentException |
|
| 609 | + * @throws InvalidInterfaceException |
|
| 610 | + * @throws InvalidDataTypeException |
|
| 611 | + * @throws EE_Error |
|
| 612 | + */ |
|
| 613 | + public function e_date_range($dt_frmt = '', $conjunction = ' - ') |
|
| 614 | + { |
|
| 615 | + echo $this->date_range($dt_frmt, $conjunction); |
|
| 616 | + } |
|
| 617 | + |
|
| 618 | + |
|
| 619 | + /** |
|
| 620 | + * get start time |
|
| 621 | + * |
|
| 622 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 623 | + * @return mixed string on success, FALSE on fail |
|
| 624 | + * @throws ReflectionException |
|
| 625 | + * @throws InvalidArgumentException |
|
| 626 | + * @throws InvalidInterfaceException |
|
| 627 | + * @throws InvalidDataTypeException |
|
| 628 | + * @throws EE_Error |
|
| 629 | + */ |
|
| 630 | + public function start_time($tm_format = '') |
|
| 631 | + { |
|
| 632 | + return $this->_show_datetime('T', 'start', null, $tm_format); |
|
| 633 | + } |
|
| 634 | + |
|
| 635 | + |
|
| 636 | + /** |
|
| 637 | + * @param string $tm_format |
|
| 638 | + * @throws ReflectionException |
|
| 639 | + * @throws InvalidArgumentException |
|
| 640 | + * @throws InvalidInterfaceException |
|
| 641 | + * @throws InvalidDataTypeException |
|
| 642 | + * @throws EE_Error |
|
| 643 | + */ |
|
| 644 | + public function e_start_time($tm_format = '') |
|
| 645 | + { |
|
| 646 | + $this->_show_datetime('T', 'start', null, $tm_format, true); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + |
|
| 650 | + /** |
|
| 651 | + * get end time |
|
| 652 | + * |
|
| 653 | + * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
| 654 | + * @return mixed string on success, FALSE on fail |
|
| 655 | + * @throws ReflectionException |
|
| 656 | + * @throws InvalidArgumentException |
|
| 657 | + * @throws InvalidInterfaceException |
|
| 658 | + * @throws InvalidDataTypeException |
|
| 659 | + * @throws EE_Error |
|
| 660 | + */ |
|
| 661 | + public function end_time($tm_format = '') |
|
| 662 | + { |
|
| 663 | + return $this->_show_datetime('T', 'end', null, $tm_format); |
|
| 664 | + } |
|
| 665 | + |
|
| 666 | + |
|
| 667 | + /** |
|
| 668 | + * @param string $tm_format |
|
| 669 | + * @throws ReflectionException |
|
| 670 | + * @throws InvalidArgumentException |
|
| 671 | + * @throws InvalidInterfaceException |
|
| 672 | + * @throws InvalidDataTypeException |
|
| 673 | + * @throws EE_Error |
|
| 674 | + */ |
|
| 675 | + public function e_end_time($tm_format = '') |
|
| 676 | + { |
|
| 677 | + $this->_show_datetime('T', 'end', null, $tm_format, true); |
|
| 678 | + } |
|
| 679 | + |
|
| 680 | + |
|
| 681 | + /** |
|
| 682 | + * get time_range |
|
| 683 | + * |
|
| 684 | + * @access public |
|
| 685 | + * @param string $tm_format string representation of time format defaults to 'g:i a' |
|
| 686 | + * @param string $conjunction conjunction junction what's your function ? |
|
| 687 | + * this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 688 | + * @return mixed string on success, FALSE on fail |
|
| 689 | + * @throws ReflectionException |
|
| 690 | + * @throws InvalidArgumentException |
|
| 691 | + * @throws InvalidInterfaceException |
|
| 692 | + * @throws InvalidDataTypeException |
|
| 693 | + * @throws EE_Error |
|
| 694 | + */ |
|
| 695 | + public function time_range($tm_format = '', $conjunction = ' - ') |
|
| 696 | + { |
|
| 697 | + $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
| 698 | + $start = str_replace( |
|
| 699 | + ' ', |
|
| 700 | + ' ', |
|
| 701 | + $this->get_i18n_datetime('DTT_EVT_start', $tm_format) |
|
| 702 | + ); |
|
| 703 | + $end = str_replace( |
|
| 704 | + ' ', |
|
| 705 | + ' ', |
|
| 706 | + $this->get_i18n_datetime('DTT_EVT_end', $tm_format) |
|
| 707 | + ); |
|
| 708 | + return $start !== $end ? $start . $conjunction . $end : $start; |
|
| 709 | + } |
|
| 710 | + |
|
| 711 | + |
|
| 712 | + /** |
|
| 713 | + * @param string $tm_format |
|
| 714 | + * @param string $conjunction |
|
| 715 | + * @throws ReflectionException |
|
| 716 | + * @throws InvalidArgumentException |
|
| 717 | + * @throws InvalidInterfaceException |
|
| 718 | + * @throws InvalidDataTypeException |
|
| 719 | + * @throws EE_Error |
|
| 720 | + */ |
|
| 721 | + public function e_time_range($tm_format = '', $conjunction = ' - ') |
|
| 722 | + { |
|
| 723 | + echo $this->time_range($tm_format, $conjunction); |
|
| 724 | + } |
|
| 725 | + |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * This returns a range representation of the date and times. |
|
| 729 | + * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end. |
|
| 730 | + * Also, the return value is localized. |
|
| 731 | + * |
|
| 732 | + * @param string $dt_format |
|
| 733 | + * @param string $tm_format |
|
| 734 | + * @param string $conjunction used between two different dates or times. |
|
| 735 | + * ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm |
|
| 736 | + * @param string $separator used between the date and time formats. |
|
| 737 | + * ex: Dec 1, 2016{$separator}2pm |
|
| 738 | + * @return string |
|
| 739 | + * @throws ReflectionException |
|
| 740 | + * @throws InvalidArgumentException |
|
| 741 | + * @throws InvalidInterfaceException |
|
| 742 | + * @throws InvalidDataTypeException |
|
| 743 | + * @throws EE_Error |
|
| 744 | + */ |
|
| 745 | + public function date_and_time_range( |
|
| 746 | + $dt_format = '', |
|
| 747 | + $tm_format = '', |
|
| 748 | + $conjunction = ' - ', |
|
| 749 | + $separator = ' ' |
|
| 750 | + ) { |
|
| 751 | + $dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt; |
|
| 752 | + $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt; |
|
| 753 | + $full_format = $dt_format . $separator . $tm_format; |
|
| 754 | + // the range output depends on various conditions |
|
| 755 | + switch (true) { |
|
| 756 | + // start date timestamp and end date timestamp are the same. |
|
| 757 | + case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')): |
|
| 758 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format); |
|
| 759 | + break; |
|
| 760 | + // start and end date are the same but times are different |
|
| 761 | + case ($this->start_date() === $this->end_date()): |
|
| 762 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
| 763 | + . $conjunction |
|
| 764 | + . $this->get_i18n_datetime('DTT_EVT_end', $tm_format); |
|
| 765 | + break; |
|
| 766 | + // all other conditions |
|
| 767 | + default: |
|
| 768 | + $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format) |
|
| 769 | + . $conjunction |
|
| 770 | + . $this->get_i18n_datetime('DTT_EVT_end', $full_format); |
|
| 771 | + break; |
|
| 772 | + } |
|
| 773 | + return $output; |
|
| 774 | + } |
|
| 775 | + |
|
| 776 | + |
|
| 777 | + /** |
|
| 778 | + * This echos the results of date and time range. |
|
| 779 | + * |
|
| 780 | + * @see date_and_time_range() for more details on purpose. |
|
| 781 | + * @param string $dt_format |
|
| 782 | + * @param string $tm_format |
|
| 783 | + * @param string $conjunction |
|
| 784 | + * @return void |
|
| 785 | + * @throws ReflectionException |
|
| 786 | + * @throws InvalidArgumentException |
|
| 787 | + * @throws InvalidInterfaceException |
|
| 788 | + * @throws InvalidDataTypeException |
|
| 789 | + * @throws EE_Error |
|
| 790 | + */ |
|
| 791 | + public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') |
|
| 792 | + { |
|
| 793 | + echo $this->date_and_time_range($dt_format, $tm_format, $conjunction); |
|
| 794 | + } |
|
| 795 | + |
|
| 796 | + |
|
| 797 | + /** |
|
| 798 | + * get start date and start time |
|
| 799 | + * |
|
| 800 | + * @param string $dt_format - string representation of date format defaults to 'F j, Y' |
|
| 801 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 802 | + * @return mixed string on success, FALSE on fail |
|
| 803 | + * @throws ReflectionException |
|
| 804 | + * @throws InvalidArgumentException |
|
| 805 | + * @throws InvalidInterfaceException |
|
| 806 | + * @throws InvalidDataTypeException |
|
| 807 | + * @throws EE_Error |
|
| 808 | + */ |
|
| 809 | + public function start_date_and_time($dt_format = '', $tm_format = '') |
|
| 810 | + { |
|
| 811 | + return $this->_show_datetime('', 'start', $dt_format, $tm_format); |
|
| 812 | + } |
|
| 813 | + |
|
| 814 | + |
|
| 815 | + /** |
|
| 816 | + * @param string $dt_frmt |
|
| 817 | + * @param string $tm_format |
|
| 818 | + * @throws ReflectionException |
|
| 819 | + * @throws InvalidArgumentException |
|
| 820 | + * @throws InvalidInterfaceException |
|
| 821 | + * @throws InvalidDataTypeException |
|
| 822 | + * @throws EE_Error |
|
| 823 | + */ |
|
| 824 | + public function e_start_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 825 | + { |
|
| 826 | + $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true); |
|
| 827 | + } |
|
| 828 | + |
|
| 829 | + |
|
| 830 | + /** |
|
| 831 | + * Shows the length of the event (start to end time). |
|
| 832 | + * Can be shown in 'seconds','minutes','hours', or 'days'. |
|
| 833 | + * By default, rounds up. (So if you use 'days', and then event |
|
| 834 | + * only occurs for 1 hour, it will return 1 day). |
|
| 835 | + * |
|
| 836 | + * @param string $units 'seconds','minutes','hours','days' |
|
| 837 | + * @param bool $round_up |
|
| 838 | + * @return float|int|mixed |
|
| 839 | + * @throws ReflectionException |
|
| 840 | + * @throws InvalidArgumentException |
|
| 841 | + * @throws InvalidInterfaceException |
|
| 842 | + * @throws InvalidDataTypeException |
|
| 843 | + * @throws EE_Error |
|
| 844 | + */ |
|
| 845 | + public function length($units = 'seconds', $round_up = false) |
|
| 846 | + { |
|
| 847 | + $start = $this->get_raw('DTT_EVT_start'); |
|
| 848 | + $end = $this->get_raw('DTT_EVT_end'); |
|
| 849 | + $length_in_units = $end - $start; |
|
| 850 | + switch ($units) { |
|
| 851 | + // NOTE: We purposefully don't use "break;" in order to chain the divisions |
|
| 852 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 853 | + // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment |
|
| 854 | + case 'days': |
|
| 855 | + $length_in_units /= 24; |
|
| 856 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 857 | + case 'hours': |
|
| 858 | + // fall through is intentional |
|
| 859 | + $length_in_units /= 60; |
|
| 860 | + /** @noinspection PhpMissingBreakStatementInspection */ |
|
| 861 | + case 'minutes': |
|
| 862 | + // fall through is intentional |
|
| 863 | + $length_in_units /= 60; |
|
| 864 | + case 'seconds': |
|
| 865 | + default: |
|
| 866 | + $length_in_units = ceil($length_in_units); |
|
| 867 | + } |
|
| 868 | + // phpcs:enable |
|
| 869 | + if ($round_up) { |
|
| 870 | + $length_in_units = max($length_in_units, 1); |
|
| 871 | + } |
|
| 872 | + return $length_in_units; |
|
| 873 | + } |
|
| 874 | + |
|
| 875 | + |
|
| 876 | + /** |
|
| 877 | + * get end date and time |
|
| 878 | + * |
|
| 879 | + * @param string $dt_frmt - string representation of date format defaults to 'F j, Y' |
|
| 880 | + * @param string $tm_format - string representation of time format defaults to 'g:i a' |
|
| 881 | + * @return mixed string on success, FALSE on fail |
|
| 882 | + * @throws ReflectionException |
|
| 883 | + * @throws InvalidArgumentException |
|
| 884 | + * @throws InvalidInterfaceException |
|
| 885 | + * @throws InvalidDataTypeException |
|
| 886 | + * @throws EE_Error |
|
| 887 | + */ |
|
| 888 | + public function end_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 889 | + { |
|
| 890 | + return $this->_show_datetime('', 'end', $dt_frmt, $tm_format); |
|
| 891 | + } |
|
| 892 | + |
|
| 893 | + |
|
| 894 | + /** |
|
| 895 | + * @param string $dt_frmt |
|
| 896 | + * @param string $tm_format |
|
| 897 | + * @throws ReflectionException |
|
| 898 | + * @throws InvalidArgumentException |
|
| 899 | + * @throws InvalidInterfaceException |
|
| 900 | + * @throws InvalidDataTypeException |
|
| 901 | + * @throws EE_Error |
|
| 902 | + */ |
|
| 903 | + public function e_end_date_and_time($dt_frmt = '', $tm_format = '') |
|
| 904 | + { |
|
| 905 | + $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true); |
|
| 906 | + } |
|
| 907 | + |
|
| 908 | + |
|
| 909 | + /** |
|
| 910 | + * get start timestamp |
|
| 911 | + * |
|
| 912 | + * @return int |
|
| 913 | + * @throws ReflectionException |
|
| 914 | + * @throws InvalidArgumentException |
|
| 915 | + * @throws InvalidInterfaceException |
|
| 916 | + * @throws InvalidDataTypeException |
|
| 917 | + * @throws EE_Error |
|
| 918 | + */ |
|
| 919 | + public function start() |
|
| 920 | + { |
|
| 921 | + return $this->get_raw('DTT_EVT_start'); |
|
| 922 | + } |
|
| 923 | + |
|
| 924 | + |
|
| 925 | + /** |
|
| 926 | + * get end timestamp |
|
| 927 | + * |
|
| 928 | + * @return int |
|
| 929 | + * @throws ReflectionException |
|
| 930 | + * @throws InvalidArgumentException |
|
| 931 | + * @throws InvalidInterfaceException |
|
| 932 | + * @throws InvalidDataTypeException |
|
| 933 | + * @throws EE_Error |
|
| 934 | + */ |
|
| 935 | + public function end() |
|
| 936 | + { |
|
| 937 | + return $this->get_raw('DTT_EVT_end'); |
|
| 938 | + } |
|
| 939 | + |
|
| 940 | + |
|
| 941 | + /** |
|
| 942 | + * get the registration limit for this datetime slot |
|
| 943 | + * |
|
| 944 | + * @return mixed int on success, FALSE on fail |
|
| 945 | + * @throws ReflectionException |
|
| 946 | + * @throws InvalidArgumentException |
|
| 947 | + * @throws InvalidInterfaceException |
|
| 948 | + * @throws InvalidDataTypeException |
|
| 949 | + * @throws EE_Error |
|
| 950 | + */ |
|
| 951 | + public function reg_limit() |
|
| 952 | + { |
|
| 953 | + return $this->get_raw('DTT_reg_limit'); |
|
| 954 | + } |
|
| 955 | + |
|
| 956 | + |
|
| 957 | + /** |
|
| 958 | + * have the tickets sold for this datetime, met or exceed the registration limit ? |
|
| 959 | + * |
|
| 960 | + * @return boolean |
|
| 961 | + * @throws ReflectionException |
|
| 962 | + * @throws InvalidArgumentException |
|
| 963 | + * @throws InvalidInterfaceException |
|
| 964 | + * @throws InvalidDataTypeException |
|
| 965 | + * @throws EE_Error |
|
| 966 | + */ |
|
| 967 | + public function sold_out() |
|
| 968 | + { |
|
| 969 | + return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit(); |
|
| 970 | + } |
|
| 971 | + |
|
| 972 | + |
|
| 973 | + /** |
|
| 974 | + * return the total number of spaces remaining at this venue. |
|
| 975 | + * This only takes the venue's capacity into account, NOT the tickets available for sale |
|
| 976 | + * |
|
| 977 | + * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left |
|
| 978 | + * Because if all tickets attached to this datetime have no spaces left, |
|
| 979 | + * then this datetime IS effectively sold out. |
|
| 980 | + * However, there are cases where we just want to know the spaces |
|
| 981 | + * remaining for this particular datetime, hence the flag. |
|
| 982 | + * @return int |
|
| 983 | + * @throws ReflectionException |
|
| 984 | + * @throws InvalidArgumentException |
|
| 985 | + * @throws InvalidInterfaceException |
|
| 986 | + * @throws InvalidDataTypeException |
|
| 987 | + * @throws EE_Error |
|
| 988 | + */ |
|
| 989 | + public function spaces_remaining($consider_tickets = false) |
|
| 990 | + { |
|
| 991 | + // tickets remaining available for purchase |
|
| 992 | + // no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF |
|
| 993 | + $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved(); |
|
| 994 | + if (! $consider_tickets) { |
|
| 995 | + return $dtt_remaining; |
|
| 996 | + } |
|
| 997 | + $tickets_remaining = $this->tickets_remaining(); |
|
| 998 | + return min($dtt_remaining, $tickets_remaining); |
|
| 999 | + } |
|
| 1000 | + |
|
| 1001 | + |
|
| 1002 | + /** |
|
| 1003 | + * Counts the total tickets available |
|
| 1004 | + * (from all the different types of tickets which are available for this datetime). |
|
| 1005 | + * |
|
| 1006 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1007 | + * @return int |
|
| 1008 | + * @throws ReflectionException |
|
| 1009 | + * @throws InvalidArgumentException |
|
| 1010 | + * @throws InvalidInterfaceException |
|
| 1011 | + * @throws InvalidDataTypeException |
|
| 1012 | + * @throws EE_Error |
|
| 1013 | + */ |
|
| 1014 | + public function tickets_remaining($query_params = array()) |
|
| 1015 | + { |
|
| 1016 | + $sum = 0; |
|
| 1017 | + $tickets = $this->tickets($query_params); |
|
| 1018 | + if (! empty($tickets)) { |
|
| 1019 | + foreach ($tickets as $ticket) { |
|
| 1020 | + if ($ticket instanceof EE_Ticket) { |
|
| 1021 | + // get the actual amount of tickets that can be sold |
|
| 1022 | + $qty = $ticket->qty('saleable'); |
|
| 1023 | + if ($qty === EE_INF) { |
|
| 1024 | + return EE_INF; |
|
| 1025 | + } |
|
| 1026 | + // no negative ticket quantities plz |
|
| 1027 | + if ($qty > 0) { |
|
| 1028 | + $sum += $qty; |
|
| 1029 | + } |
|
| 1030 | + } |
|
| 1031 | + } |
|
| 1032 | + } |
|
| 1033 | + return $sum; |
|
| 1034 | + } |
|
| 1035 | + |
|
| 1036 | + |
|
| 1037 | + /** |
|
| 1038 | + * Gets the count of all the tickets available at this datetime (not ticket types) |
|
| 1039 | + * before any were sold |
|
| 1040 | + * |
|
| 1041 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1042 | + * @return int |
|
| 1043 | + * @throws ReflectionException |
|
| 1044 | + * @throws InvalidArgumentException |
|
| 1045 | + * @throws InvalidInterfaceException |
|
| 1046 | + * @throws InvalidDataTypeException |
|
| 1047 | + * @throws EE_Error |
|
| 1048 | + */ |
|
| 1049 | + public function sum_tickets_initially_available($query_params = array()) |
|
| 1050 | + { |
|
| 1051 | + return $this->sum_related('Ticket', $query_params, 'TKT_qty'); |
|
| 1052 | + } |
|
| 1053 | + |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * Returns the lesser-of-the two: spaces remaining at this datetime, or |
|
| 1057 | + * the total tickets remaining (a sum of the tickets remaining for each ticket type |
|
| 1058 | + * that is available for this datetime). |
|
| 1059 | + * |
|
| 1060 | + * @return int |
|
| 1061 | + * @throws ReflectionException |
|
| 1062 | + * @throws InvalidArgumentException |
|
| 1063 | + * @throws InvalidInterfaceException |
|
| 1064 | + * @throws InvalidDataTypeException |
|
| 1065 | + * @throws EE_Error |
|
| 1066 | + */ |
|
| 1067 | + public function total_tickets_available_at_this_datetime() |
|
| 1068 | + { |
|
| 1069 | + return $this->spaces_remaining(true); |
|
| 1070 | + } |
|
| 1071 | + |
|
| 1072 | + |
|
| 1073 | + /** |
|
| 1074 | + * This simply compares the internal dtt for the given string with NOW |
|
| 1075 | + * and determines if the date is upcoming or not. |
|
| 1076 | + * |
|
| 1077 | + * @access public |
|
| 1078 | + * @return boolean |
|
| 1079 | + * @throws ReflectionException |
|
| 1080 | + * @throws InvalidArgumentException |
|
| 1081 | + * @throws InvalidInterfaceException |
|
| 1082 | + * @throws InvalidDataTypeException |
|
| 1083 | + * @throws EE_Error |
|
| 1084 | + */ |
|
| 1085 | + public function is_upcoming() |
|
| 1086 | + { |
|
| 1087 | + return ($this->get_raw('DTT_EVT_start') > time()); |
|
| 1088 | + } |
|
| 1089 | + |
|
| 1090 | + |
|
| 1091 | + /** |
|
| 1092 | + * This simply compares the internal datetime for the given string with NOW |
|
| 1093 | + * and returns if the date is active (i.e. start and end time) |
|
| 1094 | + * |
|
| 1095 | + * @return boolean |
|
| 1096 | + * @throws ReflectionException |
|
| 1097 | + * @throws InvalidArgumentException |
|
| 1098 | + * @throws InvalidInterfaceException |
|
| 1099 | + * @throws InvalidDataTypeException |
|
| 1100 | + * @throws EE_Error |
|
| 1101 | + */ |
|
| 1102 | + public function is_active() |
|
| 1103 | + { |
|
| 1104 | + return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time()); |
|
| 1105 | + } |
|
| 1106 | + |
|
| 1107 | + |
|
| 1108 | + /** |
|
| 1109 | + * This simply compares the internal dtt for the given string with NOW |
|
| 1110 | + * and determines if the date is expired or not. |
|
| 1111 | + * |
|
| 1112 | + * @return boolean |
|
| 1113 | + * @throws ReflectionException |
|
| 1114 | + * @throws InvalidArgumentException |
|
| 1115 | + * @throws InvalidInterfaceException |
|
| 1116 | + * @throws InvalidDataTypeException |
|
| 1117 | + * @throws EE_Error |
|
| 1118 | + */ |
|
| 1119 | + public function is_expired() |
|
| 1120 | + { |
|
| 1121 | + return ($this->get_raw('DTT_EVT_end') < time()); |
|
| 1122 | + } |
|
| 1123 | + |
|
| 1124 | + |
|
| 1125 | + /** |
|
| 1126 | + * This returns the active status for whether an event is active, upcoming, or expired |
|
| 1127 | + * |
|
| 1128 | + * @return int return value will be one of the EE_Datetime status constants. |
|
| 1129 | + * @throws ReflectionException |
|
| 1130 | + * @throws InvalidArgumentException |
|
| 1131 | + * @throws InvalidInterfaceException |
|
| 1132 | + * @throws InvalidDataTypeException |
|
| 1133 | + * @throws EE_Error |
|
| 1134 | + */ |
|
| 1135 | + public function get_active_status() |
|
| 1136 | + { |
|
| 1137 | + $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime(); |
|
| 1138 | + if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) { |
|
| 1139 | + return EE_Datetime::sold_out; |
|
| 1140 | + } |
|
| 1141 | + if ($this->is_expired()) { |
|
| 1142 | + return EE_Datetime::expired; |
|
| 1143 | + } |
|
| 1144 | + if ($this->is_upcoming()) { |
|
| 1145 | + return EE_Datetime::upcoming; |
|
| 1146 | + } |
|
| 1147 | + if ($this->is_active()) { |
|
| 1148 | + return EE_Datetime::active; |
|
| 1149 | + } |
|
| 1150 | + return null; |
|
| 1151 | + } |
|
| 1152 | + |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * This returns a nice display name for the datetime that is contingent on the span between the dates and times. |
|
| 1156 | + * |
|
| 1157 | + * @param boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty. |
|
| 1158 | + * @return string |
|
| 1159 | + * @throws ReflectionException |
|
| 1160 | + * @throws InvalidArgumentException |
|
| 1161 | + * @throws InvalidInterfaceException |
|
| 1162 | + * @throws InvalidDataTypeException |
|
| 1163 | + * @throws EE_Error |
|
| 1164 | + */ |
|
| 1165 | + public function get_dtt_display_name($use_dtt_name = false) |
|
| 1166 | + { |
|
| 1167 | + if ($use_dtt_name) { |
|
| 1168 | + $dtt_name = $this->name(); |
|
| 1169 | + if (! empty($dtt_name)) { |
|
| 1170 | + return $dtt_name; |
|
| 1171 | + } |
|
| 1172 | + } |
|
| 1173 | + // first condition is to see if the months are different |
|
| 1174 | + if (date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end')) |
|
| 1175 | + ) { |
|
| 1176 | + $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a'); |
|
| 1177 | + // next condition is if its the same month but different day |
|
| 1178 | + } else { |
|
| 1179 | + if (date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end')) |
|
| 1180 | + && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end')) |
|
| 1181 | + ) { |
|
| 1182 | + $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y'); |
|
| 1183 | + } else { |
|
| 1184 | + $display_date = $this->start_date('F j\, Y') |
|
| 1185 | + . ' @ ' |
|
| 1186 | + . $this->start_date('g:i a') |
|
| 1187 | + . ' - ' |
|
| 1188 | + . $this->end_date('g:i a'); |
|
| 1189 | + } |
|
| 1190 | + } |
|
| 1191 | + return $display_date; |
|
| 1192 | + } |
|
| 1193 | + |
|
| 1194 | + |
|
| 1195 | + /** |
|
| 1196 | + * Gets all the tickets for this datetime |
|
| 1197 | + * |
|
| 1198 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1199 | + * @return EE_Base_Class[]|EE_Ticket[] |
|
| 1200 | + * @throws ReflectionException |
|
| 1201 | + * @throws InvalidArgumentException |
|
| 1202 | + * @throws InvalidInterfaceException |
|
| 1203 | + * @throws InvalidDataTypeException |
|
| 1204 | + * @throws EE_Error |
|
| 1205 | + */ |
|
| 1206 | + public function tickets($query_params = array()) |
|
| 1207 | + { |
|
| 1208 | + return $this->get_many_related('Ticket', $query_params); |
|
| 1209 | + } |
|
| 1210 | + |
|
| 1211 | + |
|
| 1212 | + /** |
|
| 1213 | + * Gets all the ticket types currently available for purchase |
|
| 1214 | + * |
|
| 1215 | + * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
| 1216 | + * @return EE_Ticket[] |
|
| 1217 | + * @throws ReflectionException |
|
| 1218 | + * @throws InvalidArgumentException |
|
| 1219 | + * @throws InvalidInterfaceException |
|
| 1220 | + * @throws InvalidDataTypeException |
|
| 1221 | + * @throws EE_Error |
|
| 1222 | + */ |
|
| 1223 | + public function ticket_types_available_for_purchase($query_params = array()) |
|
| 1224 | + { |
|
| 1225 | + // first check if datetime is valid |
|
| 1226 | + if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) { |
|
| 1227 | + return array(); |
|
| 1228 | + } |
|
| 1229 | + if (empty($query_params)) { |
|
| 1230 | + $query_params = array( |
|
| 1231 | + array( |
|
| 1232 | + 'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')), |
|
| 1233 | + 'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')), |
|
| 1234 | + 'TKT_deleted' => false, |
|
| 1235 | + ), |
|
| 1236 | + ); |
|
| 1237 | + } |
|
| 1238 | + return $this->tickets($query_params); |
|
| 1239 | + } |
|
| 1240 | + |
|
| 1241 | + |
|
| 1242 | + /** |
|
| 1243 | + * @return EE_Base_Class|EE_Event |
|
| 1244 | + * @throws ReflectionException |
|
| 1245 | + * @throws InvalidArgumentException |
|
| 1246 | + * @throws InvalidInterfaceException |
|
| 1247 | + * @throws InvalidDataTypeException |
|
| 1248 | + * @throws EE_Error |
|
| 1249 | + */ |
|
| 1250 | + public function event() |
|
| 1251 | + { |
|
| 1252 | + return $this->get_first_related('Event'); |
|
| 1253 | + } |
|
| 1254 | + |
|
| 1255 | + |
|
| 1256 | + /** |
|
| 1257 | + * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime |
|
| 1258 | + * (via the tickets). into account |
|
| 1259 | + * |
|
| 1260 | + * @return int |
|
| 1261 | + * @throws ReflectionException |
|
| 1262 | + * @throws InvalidArgumentException |
|
| 1263 | + * @throws InvalidInterfaceException |
|
| 1264 | + * @throws InvalidDataTypeException |
|
| 1265 | + * @throws EE_Error |
|
| 1266 | + */ |
|
| 1267 | + public function update_sold() |
|
| 1268 | + { |
|
| 1269 | + $count_regs_for_this_datetime = EEM_Registration::instance()->count( |
|
| 1270 | + array( |
|
| 1271 | + array( |
|
| 1272 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 1273 | + 'REG_deleted' => 0, |
|
| 1274 | + 'Ticket.Datetime.DTT_ID' => $this->ID(), |
|
| 1275 | + ), |
|
| 1276 | + ) |
|
| 1277 | + ); |
|
| 1278 | + $sold = $this->sold(); |
|
| 1279 | + if ($count_regs_for_this_datetime > $sold) { |
|
| 1280 | + $this->increase_sold($count_regs_for_this_datetime - $sold); |
|
| 1281 | + $this->save(); |
|
| 1282 | + } elseif ($count_regs_for_this_datetime < $sold) { |
|
| 1283 | + $this->decrease_sold($count_regs_for_this_datetime - $sold); |
|
| 1284 | + $this->save(); |
|
| 1285 | + } |
|
| 1286 | + return $count_regs_for_this_datetime; |
|
| 1287 | + } |
|
| 1288 | 1288 | } |
@@ -656,7 +656,7 @@ |
||
| 656 | 656 | /** |
| 657 | 657 | * Gets the event that's related to the ticket, if this line item represents a ticket. |
| 658 | 658 | * |
| 659 | - * @return EE_Event|null |
|
| 659 | + * @return EE_Base_Class|null |
|
| 660 | 660 | * @throws EE_Error |
| 661 | 661 | */ |
| 662 | 662 | public function ticket_event() |
@@ -14,1430 +14,1430 @@ |
||
| 14 | 14 | class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * for children line items (currently not a normal relation) |
|
| 19 | - * |
|
| 20 | - * @type EE_Line_Item[] |
|
| 21 | - */ |
|
| 22 | - protected $_children = array(); |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * for the parent line item |
|
| 26 | - * |
|
| 27 | - * @var EE_Line_Item |
|
| 28 | - */ |
|
| 29 | - protected $_parent; |
|
| 30 | - |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * |
|
| 34 | - * @param array $props_n_values incoming values |
|
| 35 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 36 | - * used.) |
|
| 37 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 38 | - * date_format and the second value is the time format |
|
| 39 | - * @return EE_Line_Item |
|
| 40 | - * @throws EE_Error |
|
| 41 | - */ |
|
| 42 | - public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 43 | - { |
|
| 44 | - $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 45 | - return $has_object |
|
| 46 | - ? $has_object |
|
| 47 | - : new self($props_n_values, false, $timezone); |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @param array $props_n_values incoming values from the database |
|
| 53 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 54 | - * the website will be used. |
|
| 55 | - * @return EE_Line_Item |
|
| 56 | - * @throws EE_Error |
|
| 57 | - */ |
|
| 58 | - public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 59 | - { |
|
| 60 | - return new self($props_n_values, true, $timezone); |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Adds some defaults if they're not specified |
|
| 66 | - * |
|
| 67 | - * @param array $fieldValues |
|
| 68 | - * @param bool $bydb |
|
| 69 | - * @param string $timezone |
|
| 70 | - * @throws EE_Error |
|
| 71 | - */ |
|
| 72 | - protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
| 73 | - { |
|
| 74 | - parent::__construct($fieldValues, $bydb, $timezone); |
|
| 75 | - if (! $this->get('LIN_code')) { |
|
| 76 | - $this->set_code($this->generate_code()); |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * Gets ID |
|
| 83 | - * |
|
| 84 | - * @return int |
|
| 85 | - * @throws EE_Error |
|
| 86 | - */ |
|
| 87 | - public function ID() |
|
| 88 | - { |
|
| 89 | - return $this->get('LIN_ID'); |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Gets TXN_ID |
|
| 95 | - * |
|
| 96 | - * @return int |
|
| 97 | - * @throws EE_Error |
|
| 98 | - */ |
|
| 99 | - public function TXN_ID() |
|
| 100 | - { |
|
| 101 | - return $this->get('TXN_ID'); |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * Sets TXN_ID |
|
| 107 | - * |
|
| 108 | - * @param int $TXN_ID |
|
| 109 | - * @throws EE_Error |
|
| 110 | - */ |
|
| 111 | - public function set_TXN_ID($TXN_ID) |
|
| 112 | - { |
|
| 113 | - $this->set('TXN_ID', $TXN_ID); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Gets name |
|
| 119 | - * |
|
| 120 | - * @return string |
|
| 121 | - * @throws EE_Error |
|
| 122 | - */ |
|
| 123 | - public function name() |
|
| 124 | - { |
|
| 125 | - $name = $this->get('LIN_name'); |
|
| 126 | - if (! $name) { |
|
| 127 | - $name = ucwords(str_replace('-', ' ', $this->type())); |
|
| 128 | - } |
|
| 129 | - return $name; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Sets name |
|
| 135 | - * |
|
| 136 | - * @param string $name |
|
| 137 | - * @throws EE_Error |
|
| 138 | - */ |
|
| 139 | - public function set_name($name) |
|
| 140 | - { |
|
| 141 | - $this->set('LIN_name', $name); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Gets desc |
|
| 147 | - * |
|
| 148 | - * @return string |
|
| 149 | - * @throws EE_Error |
|
| 150 | - */ |
|
| 151 | - public function desc() |
|
| 152 | - { |
|
| 153 | - return $this->get('LIN_desc'); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * Sets desc |
|
| 159 | - * |
|
| 160 | - * @param string $desc |
|
| 161 | - * @throws EE_Error |
|
| 162 | - */ |
|
| 163 | - public function set_desc($desc) |
|
| 164 | - { |
|
| 165 | - $this->set('LIN_desc', $desc); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Gets quantity |
|
| 171 | - * |
|
| 172 | - * @return int |
|
| 173 | - * @throws EE_Error |
|
| 174 | - */ |
|
| 175 | - public function quantity() |
|
| 176 | - { |
|
| 177 | - return $this->get('LIN_quantity'); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Sets quantity |
|
| 183 | - * |
|
| 184 | - * @param int $quantity |
|
| 185 | - * @throws EE_Error |
|
| 186 | - */ |
|
| 187 | - public function set_quantity($quantity) |
|
| 188 | - { |
|
| 189 | - $this->set('LIN_quantity', max($quantity, 0)); |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * Gets item_id |
|
| 195 | - * |
|
| 196 | - * @return string |
|
| 197 | - * @throws EE_Error |
|
| 198 | - */ |
|
| 199 | - public function OBJ_ID() |
|
| 200 | - { |
|
| 201 | - return $this->get('OBJ_ID'); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Sets item_id |
|
| 207 | - * |
|
| 208 | - * @param string $item_id |
|
| 209 | - * @throws EE_Error |
|
| 210 | - */ |
|
| 211 | - public function set_OBJ_ID($item_id) |
|
| 212 | - { |
|
| 213 | - $this->set('OBJ_ID', $item_id); |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Gets item_type |
|
| 219 | - * |
|
| 220 | - * @return string |
|
| 221 | - * @throws EE_Error |
|
| 222 | - */ |
|
| 223 | - public function OBJ_type() |
|
| 224 | - { |
|
| 225 | - return $this->get('OBJ_type'); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * Gets item_type |
|
| 231 | - * |
|
| 232 | - * @return string |
|
| 233 | - * @throws EE_Error |
|
| 234 | - */ |
|
| 235 | - public function OBJ_type_i18n() |
|
| 236 | - { |
|
| 237 | - $obj_type = $this->OBJ_type(); |
|
| 238 | - switch ($obj_type) { |
|
| 239 | - case 'Event': |
|
| 240 | - $obj_type = __('Event', 'event_espresso'); |
|
| 241 | - break; |
|
| 242 | - case 'Price': |
|
| 243 | - $obj_type = __('Price', 'event_espresso'); |
|
| 244 | - break; |
|
| 245 | - case 'Promotion': |
|
| 246 | - $obj_type = __('Promotion', 'event_espresso'); |
|
| 247 | - break; |
|
| 248 | - case 'Ticket': |
|
| 249 | - $obj_type = __('Ticket', 'event_espresso'); |
|
| 250 | - break; |
|
| 251 | - case 'Transaction': |
|
| 252 | - $obj_type = __('Transaction', 'event_espresso'); |
|
| 253 | - break; |
|
| 254 | - } |
|
| 255 | - return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * Sets item_type |
|
| 261 | - * |
|
| 262 | - * @param string $OBJ_type |
|
| 263 | - * @throws EE_Error |
|
| 264 | - */ |
|
| 265 | - public function set_OBJ_type($OBJ_type) |
|
| 266 | - { |
|
| 267 | - $this->set('OBJ_type', $OBJ_type); |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - |
|
| 271 | - /** |
|
| 272 | - * Gets unit_price |
|
| 273 | - * |
|
| 274 | - * @return float |
|
| 275 | - * @throws EE_Error |
|
| 276 | - */ |
|
| 277 | - public function unit_price() |
|
| 278 | - { |
|
| 279 | - return $this->get('LIN_unit_price'); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - /** |
|
| 284 | - * Sets unit_price |
|
| 285 | - * |
|
| 286 | - * @param float $unit_price |
|
| 287 | - * @throws EE_Error |
|
| 288 | - */ |
|
| 289 | - public function set_unit_price($unit_price) |
|
| 290 | - { |
|
| 291 | - $this->set('LIN_unit_price', $unit_price); |
|
| 292 | - } |
|
| 293 | - |
|
| 294 | - |
|
| 295 | - /** |
|
| 296 | - * Checks if this item is a percentage modifier or not |
|
| 297 | - * |
|
| 298 | - * @return boolean |
|
| 299 | - * @throws EE_Error |
|
| 300 | - */ |
|
| 301 | - public function is_percent() |
|
| 302 | - { |
|
| 303 | - if ($this->is_tax_sub_total()) { |
|
| 304 | - // tax subtotals HAVE a percent on them, that percentage only applies |
|
| 305 | - // to taxable items, so its' an exception. Treat it like a flat line item |
|
| 306 | - return false; |
|
| 307 | - } |
|
| 308 | - $unit_price = abs($this->get('LIN_unit_price')); |
|
| 309 | - $percent = abs($this->get('LIN_percent')); |
|
| 310 | - if ($unit_price < .001 && $percent) { |
|
| 311 | - return true; |
|
| 312 | - } |
|
| 313 | - if ($unit_price >= .001 && ! $percent) { |
|
| 314 | - return false; |
|
| 315 | - } |
|
| 316 | - if ($unit_price >= .001 && $percent) { |
|
| 317 | - throw new EE_Error( |
|
| 318 | - sprintf( |
|
| 319 | - esc_html__('A Line Item can not have a unit price of (%s) AND a percent (%s)!', 'event_espresso'), |
|
| 320 | - $unit_price, |
|
| 321 | - $percent |
|
| 322 | - ) |
|
| 323 | - ); |
|
| 324 | - } |
|
| 325 | - // if they're both 0, assume its not a percent item |
|
| 326 | - return false; |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - |
|
| 330 | - /** |
|
| 331 | - * Gets percent (between 100-.001) |
|
| 332 | - * |
|
| 333 | - * @return float |
|
| 334 | - * @throws EE_Error |
|
| 335 | - */ |
|
| 336 | - public function percent() |
|
| 337 | - { |
|
| 338 | - return $this->get('LIN_percent'); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * Sets percent (between 100-0.01) |
|
| 344 | - * |
|
| 345 | - * @param float $percent |
|
| 346 | - * @throws EE_Error |
|
| 347 | - */ |
|
| 348 | - public function set_percent($percent) |
|
| 349 | - { |
|
| 350 | - $this->set('LIN_percent', $percent); |
|
| 351 | - } |
|
| 352 | - |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * Gets total |
|
| 356 | - * |
|
| 357 | - * @return float |
|
| 358 | - * @throws EE_Error |
|
| 359 | - */ |
|
| 360 | - public function total() |
|
| 361 | - { |
|
| 362 | - return $this->get('LIN_total'); |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - |
|
| 366 | - /** |
|
| 367 | - * Sets total |
|
| 368 | - * |
|
| 369 | - * @param float $total |
|
| 370 | - * @throws EE_Error |
|
| 371 | - */ |
|
| 372 | - public function set_total($total) |
|
| 373 | - { |
|
| 374 | - $this->set('LIN_total', $total); |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - |
|
| 378 | - /** |
|
| 379 | - * Gets order |
|
| 380 | - * |
|
| 381 | - * @return int |
|
| 382 | - * @throws EE_Error |
|
| 383 | - */ |
|
| 384 | - public function order() |
|
| 385 | - { |
|
| 386 | - return $this->get('LIN_order'); |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - |
|
| 390 | - /** |
|
| 391 | - * Sets order |
|
| 392 | - * |
|
| 393 | - * @param int $order |
|
| 394 | - * @throws EE_Error |
|
| 395 | - */ |
|
| 396 | - public function set_order($order) |
|
| 397 | - { |
|
| 398 | - $this->set('LIN_order', $order); |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * Gets parent |
|
| 404 | - * |
|
| 405 | - * @return int |
|
| 406 | - * @throws EE_Error |
|
| 407 | - */ |
|
| 408 | - public function parent_ID() |
|
| 409 | - { |
|
| 410 | - return $this->get('LIN_parent'); |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * Sets parent |
|
| 416 | - * |
|
| 417 | - * @param int $parent |
|
| 418 | - * @throws EE_Error |
|
| 419 | - */ |
|
| 420 | - public function set_parent_ID($parent) |
|
| 421 | - { |
|
| 422 | - $this->set('LIN_parent', $parent); |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Gets type |
|
| 428 | - * |
|
| 429 | - * @return string |
|
| 430 | - * @throws EE_Error |
|
| 431 | - */ |
|
| 432 | - public function type() |
|
| 433 | - { |
|
| 434 | - return $this->get('LIN_type'); |
|
| 435 | - } |
|
| 436 | - |
|
| 437 | - |
|
| 438 | - /** |
|
| 439 | - * Sets type |
|
| 440 | - * |
|
| 441 | - * @param string $type |
|
| 442 | - * @throws EE_Error |
|
| 443 | - */ |
|
| 444 | - public function set_type($type) |
|
| 445 | - { |
|
| 446 | - $this->set('LIN_type', $type); |
|
| 447 | - } |
|
| 448 | - |
|
| 449 | - |
|
| 450 | - /** |
|
| 451 | - * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\ |
|
| 452 | - * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB |
|
| 453 | - * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()` |
|
| 454 | - * or indirectly by `EE_Line_item::add_child_line_item()`) |
|
| 455 | - * |
|
| 456 | - * @return EE_Base_Class|EE_Line_Item |
|
| 457 | - * @throws EE_Error |
|
| 458 | - */ |
|
| 459 | - public function parent() |
|
| 460 | - { |
|
| 461 | - return $this->ID() |
|
| 462 | - ? $this->get_model()->get_one_by_ID($this->parent_ID()) |
|
| 463 | - : $this->_parent; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 469 | - * |
|
| 470 | - * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 471 | - * @throws EE_Error |
|
| 472 | - */ |
|
| 473 | - public function children() |
|
| 474 | - { |
|
| 475 | - if ($this->ID()) { |
|
| 476 | - return $this->get_model()->get_all( |
|
| 477 | - array( |
|
| 478 | - array('LIN_parent' => $this->ID()), |
|
| 479 | - 'order_by' => array('LIN_order' => 'ASC'), |
|
| 480 | - ) |
|
| 481 | - ); |
|
| 482 | - } |
|
| 483 | - if (! is_array($this->_children)) { |
|
| 484 | - $this->_children = array(); |
|
| 485 | - } |
|
| 486 | - return $this->_children; |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - |
|
| 490 | - /** |
|
| 491 | - * Gets code |
|
| 492 | - * |
|
| 493 | - * @return string |
|
| 494 | - * @throws EE_Error |
|
| 495 | - */ |
|
| 496 | - public function code() |
|
| 497 | - { |
|
| 498 | - return $this->get('LIN_code'); |
|
| 499 | - } |
|
| 500 | - |
|
| 501 | - |
|
| 502 | - /** |
|
| 503 | - * Sets code |
|
| 504 | - * |
|
| 505 | - * @param string $code |
|
| 506 | - * @throws EE_Error |
|
| 507 | - */ |
|
| 508 | - public function set_code($code) |
|
| 509 | - { |
|
| 510 | - $this->set('LIN_code', $code); |
|
| 511 | - } |
|
| 512 | - |
|
| 513 | - |
|
| 514 | - /** |
|
| 515 | - * Gets is_taxable |
|
| 516 | - * |
|
| 517 | - * @return boolean |
|
| 518 | - * @throws EE_Error |
|
| 519 | - */ |
|
| 520 | - public function is_taxable() |
|
| 521 | - { |
|
| 522 | - return $this->get('LIN_is_taxable'); |
|
| 523 | - } |
|
| 524 | - |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * Sets is_taxable |
|
| 528 | - * |
|
| 529 | - * @param boolean $is_taxable |
|
| 530 | - * @throws EE_Error |
|
| 531 | - */ |
|
| 532 | - public function set_is_taxable($is_taxable) |
|
| 533 | - { |
|
| 534 | - $this->set('LIN_is_taxable', $is_taxable); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - |
|
| 538 | - /** |
|
| 539 | - * Gets the object that this model-joins-to. |
|
| 540 | - * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on |
|
| 541 | - * EEM_Promotion_Object |
|
| 542 | - * |
|
| 543 | - * Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object |
|
| 544 | - * |
|
| 545 | - * @return EE_Base_Class | NULL |
|
| 546 | - * @throws EE_Error |
|
| 547 | - */ |
|
| 548 | - public function get_object() |
|
| 549 | - { |
|
| 550 | - $model_name_of_related_obj = $this->OBJ_type(); |
|
| 551 | - return $this->get_model()->has_relation($model_name_of_related_obj) |
|
| 552 | - ? $this->get_first_related($model_name_of_related_obj) |
|
| 553 | - : null; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - |
|
| 557 | - /** |
|
| 558 | - * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket. |
|
| 559 | - * (IE, if this line item is for a price or something else, will return NULL) |
|
| 560 | - * |
|
| 561 | - * @param array $query_params |
|
| 562 | - * @return EE_Base_Class|EE_Ticket |
|
| 563 | - * @throws EE_Error |
|
| 564 | - */ |
|
| 565 | - public function ticket($query_params = array()) |
|
| 566 | - { |
|
| 567 | - // we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived. This can be overridden via the incoming $query_params argument |
|
| 568 | - $remove_defaults = array('default_where_conditions' => 'none'); |
|
| 569 | - $query_params = array_merge($remove_defaults, $query_params); |
|
| 570 | - return $this->get_first_related('Ticket', $query_params); |
|
| 571 | - } |
|
| 572 | - |
|
| 573 | - |
|
| 574 | - /** |
|
| 575 | - * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket |
|
| 576 | - * |
|
| 577 | - * @return EE_Datetime | NULL |
|
| 578 | - * @throws EE_Error |
|
| 579 | - */ |
|
| 580 | - public function get_ticket_datetime() |
|
| 581 | - { |
|
| 582 | - if ($this->OBJ_type() === 'Ticket') { |
|
| 583 | - $ticket = $this->ticket(); |
|
| 584 | - if ($ticket instanceof EE_Ticket) { |
|
| 585 | - $datetime = $ticket->first_datetime(); |
|
| 586 | - if ($datetime instanceof EE_Datetime) { |
|
| 587 | - return $datetime; |
|
| 588 | - } |
|
| 589 | - } |
|
| 590 | - } |
|
| 591 | - return null; |
|
| 592 | - } |
|
| 593 | - |
|
| 594 | - |
|
| 595 | - /** |
|
| 596 | - * Gets the event's name that's related to the ticket, if this is for |
|
| 597 | - * a ticket |
|
| 598 | - * |
|
| 599 | - * @return string |
|
| 600 | - * @throws EE_Error |
|
| 601 | - */ |
|
| 602 | - public function ticket_event_name() |
|
| 603 | - { |
|
| 604 | - $event_name = esc_html__('Unknown', 'event_espresso'); |
|
| 605 | - $event = $this->ticket_event(); |
|
| 606 | - if ($event instanceof EE_Event) { |
|
| 607 | - $event_name = $event->name(); |
|
| 608 | - } |
|
| 609 | - return $event_name; |
|
| 610 | - } |
|
| 611 | - |
|
| 612 | - |
|
| 613 | - /** |
|
| 614 | - * Gets the event that's related to the ticket, if this line item represents a ticket. |
|
| 615 | - * |
|
| 616 | - * @return EE_Event|null |
|
| 617 | - * @throws EE_Error |
|
| 618 | - */ |
|
| 619 | - public function ticket_event() |
|
| 620 | - { |
|
| 621 | - $event = null; |
|
| 622 | - $ticket = $this->ticket(); |
|
| 623 | - if ($ticket instanceof EE_Ticket) { |
|
| 624 | - $datetime = $ticket->first_datetime(); |
|
| 625 | - if ($datetime instanceof EE_Datetime) { |
|
| 626 | - $event = $datetime->event(); |
|
| 627 | - } |
|
| 628 | - } |
|
| 629 | - return $event; |
|
| 630 | - } |
|
| 631 | - |
|
| 632 | - |
|
| 633 | - /** |
|
| 634 | - * Gets the first datetime for this lien item, assuming it's for a ticket |
|
| 635 | - * |
|
| 636 | - * @param string $date_format |
|
| 637 | - * @param string $time_format |
|
| 638 | - * @return string |
|
| 639 | - * @throws EE_Error |
|
| 640 | - */ |
|
| 641 | - public function ticket_datetime_start($date_format = '', $time_format = '') |
|
| 642 | - { |
|
| 643 | - $first_datetime_string = esc_html__('Unknown', 'event_espresso'); |
|
| 644 | - $datetime = $this->get_ticket_datetime(); |
|
| 645 | - if ($datetime) { |
|
| 646 | - $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format); |
|
| 647 | - } |
|
| 648 | - return $first_datetime_string; |
|
| 649 | - } |
|
| 650 | - |
|
| 651 | - |
|
| 652 | - /** |
|
| 653 | - * Adds the line item as a child to this line item. If there is another child line |
|
| 654 | - * item with the same LIN_code, it is overwritten by this new one |
|
| 655 | - * |
|
| 656 | - * @param EEI_Line_Item $line_item |
|
| 657 | - * @param bool $set_order |
|
| 658 | - * @return bool success |
|
| 659 | - * @throws EE_Error |
|
| 660 | - */ |
|
| 661 | - public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) |
|
| 662 | - { |
|
| 663 | - // should we calculate the LIN_order for this line item ? |
|
| 664 | - if ($set_order || $line_item->order() === null) { |
|
| 665 | - $line_item->set_order(count($this->children())); |
|
| 666 | - } |
|
| 667 | - if ($this->ID()) { |
|
| 668 | - // check for any duplicate line items (with the same code), if so, this replaces it |
|
| 669 | - $line_item_with_same_code = $this->get_child_line_item($line_item->code()); |
|
| 670 | - if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) { |
|
| 671 | - $this->delete_child_line_item($line_item_with_same_code->code()); |
|
| 672 | - } |
|
| 673 | - $line_item->set_parent_ID($this->ID()); |
|
| 674 | - if ($this->TXN_ID()) { |
|
| 675 | - $line_item->set_TXN_ID($this->TXN_ID()); |
|
| 676 | - } |
|
| 677 | - return $line_item->save(); |
|
| 678 | - } |
|
| 679 | - $this->_children[ $line_item->code() ] = $line_item; |
|
| 680 | - if ($line_item->parent() !== $this) { |
|
| 681 | - $line_item->set_parent($this); |
|
| 682 | - } |
|
| 683 | - return true; |
|
| 684 | - } |
|
| 685 | - |
|
| 686 | - |
|
| 687 | - /** |
|
| 688 | - * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation. |
|
| 689 | - * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save() |
|
| 690 | - * However, if this line item is NOT saved to the DB, this just caches the parent on |
|
| 691 | - * the EE_Line_Item::_parent property. |
|
| 692 | - * |
|
| 693 | - * @param EE_Line_Item $line_item |
|
| 694 | - * @throws EE_Error |
|
| 695 | - */ |
|
| 696 | - public function set_parent($line_item) |
|
| 697 | - { |
|
| 698 | - if ($this->ID()) { |
|
| 699 | - if (! $line_item->ID()) { |
|
| 700 | - $line_item->save(); |
|
| 701 | - } |
|
| 702 | - $this->set_parent_ID($line_item->ID()); |
|
| 703 | - $this->save(); |
|
| 704 | - } else { |
|
| 705 | - $this->_parent = $line_item; |
|
| 706 | - $this->set_parent_ID($line_item->ID()); |
|
| 707 | - } |
|
| 708 | - } |
|
| 709 | - |
|
| 710 | - |
|
| 711 | - /** |
|
| 712 | - * Gets the child line item as specified by its code. Because this returns an object (by reference) |
|
| 713 | - * you can modify this child line item and the parent (this object) can know about them |
|
| 714 | - * because it also has a reference to that line item |
|
| 715 | - * |
|
| 716 | - * @param string $code |
|
| 717 | - * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 718 | - * @throws EE_Error |
|
| 719 | - */ |
|
| 720 | - public function get_child_line_item($code) |
|
| 721 | - { |
|
| 722 | - if ($this->ID()) { |
|
| 723 | - return $this->get_model()->get_one( |
|
| 724 | - array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
|
| 725 | - ); |
|
| 726 | - } |
|
| 727 | - return isset($this->_children[ $code ]) |
|
| 728 | - ? $this->_children[ $code ] |
|
| 729 | - : null; |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD |
|
| 735 | - * cached on it) |
|
| 736 | - * |
|
| 737 | - * @return int |
|
| 738 | - * @throws EE_Error |
|
| 739 | - */ |
|
| 740 | - public function delete_children_line_items() |
|
| 741 | - { |
|
| 742 | - if ($this->ID()) { |
|
| 743 | - return $this->get_model()->delete(array(array('LIN_parent' => $this->ID()))); |
|
| 744 | - } |
|
| 745 | - $count = count($this->_children); |
|
| 746 | - $this->_children = array(); |
|
| 747 | - return $count; |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - |
|
| 751 | - /** |
|
| 752 | - * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 753 | - * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 754 | - * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 755 | - * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be |
|
| 756 | - * deleted) |
|
| 757 | - * |
|
| 758 | - * @param string $code |
|
| 759 | - * @param bool $stop_search_once_found |
|
| 760 | - * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to |
|
| 761 | - * the DB yet) |
|
| 762 | - * @throws EE_Error |
|
| 763 | - */ |
|
| 764 | - public function delete_child_line_item($code, $stop_search_once_found = true) |
|
| 765 | - { |
|
| 766 | - if ($this->ID()) { |
|
| 767 | - $items_deleted = 0; |
|
| 768 | - if ($this->code() === $code) { |
|
| 769 | - $items_deleted += EEH_Line_Item::delete_all_child_items($this); |
|
| 770 | - $items_deleted += (int) $this->delete(); |
|
| 771 | - if ($stop_search_once_found) { |
|
| 772 | - return $items_deleted; |
|
| 773 | - } |
|
| 774 | - } |
|
| 775 | - foreach ($this->children() as $child_line_item) { |
|
| 776 | - $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found); |
|
| 777 | - } |
|
| 778 | - return $items_deleted; |
|
| 779 | - } |
|
| 780 | - if (isset($this->_children[ $code ])) { |
|
| 781 | - unset($this->_children[ $code ]); |
|
| 782 | - return 1; |
|
| 783 | - } |
|
| 784 | - return 0; |
|
| 785 | - } |
|
| 786 | - |
|
| 787 | - |
|
| 788 | - /** |
|
| 789 | - * If this line item is in the database, is of the type subtotal, and |
|
| 790 | - * has no children, why do we have it? It should be deleted so this function |
|
| 791 | - * does that |
|
| 792 | - * |
|
| 793 | - * @return boolean |
|
| 794 | - * @throws EE_Error |
|
| 795 | - */ |
|
| 796 | - public function delete_if_childless_subtotal() |
|
| 797 | - { |
|
| 798 | - if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) { |
|
| 799 | - return $this->delete(); |
|
| 800 | - } |
|
| 801 | - return false; |
|
| 802 | - } |
|
| 803 | - |
|
| 804 | - |
|
| 805 | - /** |
|
| 806 | - * Creates a code and returns a string. doesn't assign the code to this model object |
|
| 807 | - * |
|
| 808 | - * @return string |
|
| 809 | - * @throws EE_Error |
|
| 810 | - */ |
|
| 811 | - public function generate_code() |
|
| 812 | - { |
|
| 813 | - // each line item in the cart requires a unique identifier |
|
| 814 | - return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 815 | - } |
|
| 816 | - |
|
| 817 | - |
|
| 818 | - /** |
|
| 819 | - * @return bool |
|
| 820 | - * @throws EE_Error |
|
| 821 | - */ |
|
| 822 | - public function is_tax() |
|
| 823 | - { |
|
| 824 | - return $this->type() === EEM_Line_Item::type_tax; |
|
| 825 | - } |
|
| 826 | - |
|
| 827 | - |
|
| 828 | - /** |
|
| 829 | - * @return bool |
|
| 830 | - * @throws EE_Error |
|
| 831 | - */ |
|
| 832 | - public function is_tax_sub_total() |
|
| 833 | - { |
|
| 834 | - return $this->type() === EEM_Line_Item::type_tax_sub_total; |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - |
|
| 838 | - /** |
|
| 839 | - * @return bool |
|
| 840 | - * @throws EE_Error |
|
| 841 | - */ |
|
| 842 | - public function is_line_item() |
|
| 843 | - { |
|
| 844 | - return $this->type() === EEM_Line_Item::type_line_item; |
|
| 845 | - } |
|
| 846 | - |
|
| 847 | - |
|
| 848 | - /** |
|
| 849 | - * @return bool |
|
| 850 | - * @throws EE_Error |
|
| 851 | - */ |
|
| 852 | - public function is_sub_line_item() |
|
| 853 | - { |
|
| 854 | - return $this->type() === EEM_Line_Item::type_sub_line_item; |
|
| 855 | - } |
|
| 856 | - |
|
| 857 | - |
|
| 858 | - /** |
|
| 859 | - * @return bool |
|
| 860 | - * @throws EE_Error |
|
| 861 | - */ |
|
| 862 | - public function is_sub_total() |
|
| 863 | - { |
|
| 864 | - return $this->type() === EEM_Line_Item::type_sub_total; |
|
| 865 | - } |
|
| 866 | - |
|
| 867 | - |
|
| 868 | - /** |
|
| 869 | - * Whether or not this line item is a cancellation line item |
|
| 870 | - * |
|
| 871 | - * @return boolean |
|
| 872 | - * @throws EE_Error |
|
| 873 | - */ |
|
| 874 | - public function is_cancellation() |
|
| 875 | - { |
|
| 876 | - return EEM_Line_Item::type_cancellation === $this->type(); |
|
| 877 | - } |
|
| 878 | - |
|
| 879 | - |
|
| 880 | - /** |
|
| 881 | - * @return bool |
|
| 882 | - * @throws EE_Error |
|
| 883 | - */ |
|
| 884 | - public function is_total() |
|
| 885 | - { |
|
| 886 | - return $this->type() === EEM_Line_Item::type_total; |
|
| 887 | - } |
|
| 888 | - |
|
| 889 | - |
|
| 890 | - /** |
|
| 891 | - * @return bool |
|
| 892 | - * @throws EE_Error |
|
| 893 | - */ |
|
| 894 | - public function is_cancelled() |
|
| 895 | - { |
|
| 896 | - return $this->type() === EEM_Line_Item::type_cancellation; |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - |
|
| 900 | - /** |
|
| 901 | - * @return string like '2, 004.00', formatted according to the localized currency |
|
| 902 | - * @throws EE_Error |
|
| 903 | - */ |
|
| 904 | - public function unit_price_no_code() |
|
| 905 | - { |
|
| 906 | - return $this->get_pretty('LIN_unit_price', 'no_currency_code'); |
|
| 907 | - } |
|
| 908 | - |
|
| 909 | - |
|
| 910 | - /** |
|
| 911 | - * @return string like '2, 004.00', formatted according to the localized currency |
|
| 912 | - * @throws EE_Error |
|
| 913 | - */ |
|
| 914 | - public function total_no_code() |
|
| 915 | - { |
|
| 916 | - return $this->get_pretty('LIN_total', 'no_currency_code'); |
|
| 917 | - } |
|
| 918 | - |
|
| 919 | - |
|
| 920 | - /** |
|
| 921 | - * Gets the final total on this item, taking taxes into account. |
|
| 922 | - * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 923 | - * If this is used on a grand-total line item, also updates the transaction's |
|
| 924 | - * TXN_total (provided this line item is allowed to persist, otherwise we don't |
|
| 925 | - * want to change a persistable transaction with info from a non-persistent line item) |
|
| 926 | - * |
|
| 927 | - * @return float |
|
| 928 | - * @throws EE_Error |
|
| 929 | - * @throws InvalidArgumentException |
|
| 930 | - * @throws InvalidInterfaceException |
|
| 931 | - * @throws InvalidDataTypeException |
|
| 932 | - */ |
|
| 933 | - public function recalculate_total_including_taxes() |
|
| 934 | - { |
|
| 935 | - $pre_tax_total = $this->recalculate_pre_tax_total(); |
|
| 936 | - $tax_total = $this->recalculate_taxes_and_tax_total(); |
|
| 937 | - $total = $pre_tax_total + $tax_total; |
|
| 938 | - // no negative totals plz |
|
| 939 | - $total = max($total, 0); |
|
| 940 | - $this->set_total($total); |
|
| 941 | - // only update the related transaction's total |
|
| 942 | - // if we intend to save this line item and its a grand total |
|
| 943 | - if ($this->allow_persist() && $this->type() === EEM_Line_Item::type_total |
|
| 944 | - && $this->transaction() |
|
| 945 | - instanceof |
|
| 946 | - EE_Transaction |
|
| 947 | - ) { |
|
| 948 | - $this->transaction()->set_total($total); |
|
| 949 | - if ($this->transaction()->ID()) { |
|
| 950 | - $this->transaction()->save(); |
|
| 951 | - } |
|
| 952 | - } |
|
| 953 | - $this->maybe_save(); |
|
| 954 | - return $total; |
|
| 955 | - } |
|
| 956 | - |
|
| 957 | - |
|
| 958 | - /** |
|
| 959 | - * Recursively goes through all the children and recalculates sub-totals EXCEPT for |
|
| 960 | - * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its |
|
| 961 | - * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and |
|
| 962 | - * when this is called on the grand total |
|
| 963 | - * |
|
| 964 | - * @return float |
|
| 965 | - * @throws InvalidArgumentException |
|
| 966 | - * @throws InvalidInterfaceException |
|
| 967 | - * @throws InvalidDataTypeException |
|
| 968 | - * @throws EE_Error |
|
| 969 | - */ |
|
| 970 | - public function recalculate_pre_tax_total() |
|
| 971 | - { |
|
| 972 | - $total = 0; |
|
| 973 | - $my_children = $this->children(); |
|
| 974 | - $has_children = ! empty($my_children); |
|
| 975 | - if ($has_children && $this->is_line_item()) { |
|
| 976 | - $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
|
| 977 | - } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 978 | - $total = $this->unit_price() * $this->quantity(); |
|
| 979 | - } elseif ($this->is_sub_total() || $this->is_total()) { |
|
| 980 | - $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
|
| 981 | - } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) { |
|
| 982 | - // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total |
|
| 983 | - return 0; |
|
| 984 | - } |
|
| 985 | - // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
|
| 986 | - if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 987 | - ) { |
|
| 988 | - if ($this->OBJ_type() !== 'Event') { |
|
| 989 | - $this->set_quantity(1); |
|
| 990 | - } |
|
| 991 | - if (! $this->is_percent()) { |
|
| 992 | - $this->set_unit_price($total); |
|
| 993 | - } |
|
| 994 | - } |
|
| 995 | - // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
|
| 996 | - // so it ought to be |
|
| 997 | - if (! $this->is_total()) { |
|
| 998 | - $this->set_total($total); |
|
| 999 | - // if not a percent line item, make sure we keep the unit price in sync |
|
| 1000 | - if ($has_children |
|
| 1001 | - && $this->is_line_item() |
|
| 1002 | - && ! $this->is_percent() |
|
| 1003 | - ) { |
|
| 1004 | - if ($this->quantity() === 0) { |
|
| 1005 | - $new_unit_price = 0; |
|
| 1006 | - } else { |
|
| 1007 | - $new_unit_price = $this->total() / $this->quantity(); |
|
| 1008 | - } |
|
| 1009 | - $this->set_unit_price($new_unit_price); |
|
| 1010 | - } |
|
| 1011 | - $this->maybe_save(); |
|
| 1012 | - } |
|
| 1013 | - return $total; |
|
| 1014 | - } |
|
| 1015 | - |
|
| 1016 | - |
|
| 1017 | - /** |
|
| 1018 | - * Calculates the pretax total when this line item is a subtotal or total line item. |
|
| 1019 | - * Basically does a sum-then-round approach (ie, any percent line item that are children |
|
| 1020 | - * will calculate their total based on the un-rounded total we're working with so far, and |
|
| 1021 | - * THEN round the result; instead of rounding as we go like with sub-line-items) |
|
| 1022 | - * |
|
| 1023 | - * @param float $calculated_total_so_far |
|
| 1024 | - * @param EE_Line_Item[] $my_children |
|
| 1025 | - * @return float |
|
| 1026 | - * @throws InvalidArgumentException |
|
| 1027 | - * @throws InvalidInterfaceException |
|
| 1028 | - * @throws InvalidDataTypeException |
|
| 1029 | - * @throws EE_Error |
|
| 1030 | - */ |
|
| 1031 | - protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) |
|
| 1032 | - { |
|
| 1033 | - if ($my_children === null) { |
|
| 1034 | - $my_children = $this->children(); |
|
| 1035 | - } |
|
| 1036 | - $subtotal_quantity = 0; |
|
| 1037 | - // get the total of all its children |
|
| 1038 | - foreach ($my_children as $child_line_item) { |
|
| 1039 | - if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1040 | - // percentage line items are based on total so far |
|
| 1041 | - if ($child_line_item->is_percent()) { |
|
| 1042 | - // round as we go so that the line items add up ok |
|
| 1043 | - $percent_total = round( |
|
| 1044 | - $calculated_total_so_far * $child_line_item->percent() / 100, |
|
| 1045 | - EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1046 | - ); |
|
| 1047 | - $child_line_item->set_total($percent_total); |
|
| 1048 | - // so far all percent line items should have a quantity of 1 |
|
| 1049 | - // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1050 | - $child_line_item->set_quantity(1); |
|
| 1051 | - $child_line_item->maybe_save(); |
|
| 1052 | - $calculated_total_so_far += $percent_total; |
|
| 1053 | - } else { |
|
| 1054 | - // verify flat sub-line-item quantities match their parent |
|
| 1055 | - if ($child_line_item->is_sub_line_item()) { |
|
| 1056 | - $child_line_item->set_quantity($this->quantity()); |
|
| 1057 | - } |
|
| 1058 | - $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1059 | - $subtotal_quantity += $child_line_item->quantity(); |
|
| 1060 | - } |
|
| 1061 | - } |
|
| 1062 | - } |
|
| 1063 | - if ($this->is_sub_total()) { |
|
| 1064 | - // no negative totals plz |
|
| 1065 | - $calculated_total_so_far = max($calculated_total_so_far, 0); |
|
| 1066 | - $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0; |
|
| 1067 | - $this->set_quantity($subtotal_quantity); |
|
| 1068 | - $this->maybe_save(); |
|
| 1069 | - } |
|
| 1070 | - return $calculated_total_so_far; |
|
| 1071 | - } |
|
| 1072 | - |
|
| 1073 | - |
|
| 1074 | - /** |
|
| 1075 | - * Calculates the pretax total for a normal line item, in a round-then-sum approach |
|
| 1076 | - * (where each sub-line-item is applied to the base price for the line item |
|
| 1077 | - * and the result is immediately rounded, rather than summing all the sub-line-items |
|
| 1078 | - * then rounding, like we do when recalculating pretax totals on totals and subtotals). |
|
| 1079 | - * |
|
| 1080 | - * @param float $calculated_total_so_far |
|
| 1081 | - * @param EE_Line_Item[] $my_children |
|
| 1082 | - * @return float |
|
| 1083 | - * @throws InvalidArgumentException |
|
| 1084 | - * @throws InvalidInterfaceException |
|
| 1085 | - * @throws InvalidDataTypeException |
|
| 1086 | - * @throws EE_Error |
|
| 1087 | - */ |
|
| 1088 | - protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) |
|
| 1089 | - { |
|
| 1090 | - if ($my_children === null) { |
|
| 1091 | - $my_children = $this->children(); |
|
| 1092 | - } |
|
| 1093 | - // we need to keep track of the running total for a single item, |
|
| 1094 | - // because we need to round as we go |
|
| 1095 | - $unit_price_for_total = 0; |
|
| 1096 | - $quantity_for_total = 1; |
|
| 1097 | - // get the total of all its children |
|
| 1098 | - foreach ($my_children as $child_line_item) { |
|
| 1099 | - if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1100 | - if ($child_line_item->is_percent()) { |
|
| 1101 | - // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity |
|
| 1102 | - // not total multiplied by percent, because that ignores rounding along-the-way |
|
| 1103 | - $percent_unit_price = round( |
|
| 1104 | - $unit_price_for_total * $child_line_item->percent() / 100, |
|
| 1105 | - EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1106 | - ); |
|
| 1107 | - $percent_total = $percent_unit_price * $quantity_for_total; |
|
| 1108 | - $child_line_item->set_total($percent_total); |
|
| 1109 | - // so far all percent line items should have a quantity of 1 |
|
| 1110 | - // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1111 | - $child_line_item->set_quantity(1); |
|
| 1112 | - $child_line_item->maybe_save(); |
|
| 1113 | - $calculated_total_so_far += $percent_total; |
|
| 1114 | - $unit_price_for_total += $percent_unit_price; |
|
| 1115 | - } else { |
|
| 1116 | - // verify flat sub-line-item quantities match their parent |
|
| 1117 | - if ($child_line_item->is_sub_line_item()) { |
|
| 1118 | - $child_line_item->set_quantity($this->quantity()); |
|
| 1119 | - } |
|
| 1120 | - $quantity_for_total = $child_line_item->quantity(); |
|
| 1121 | - $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1122 | - $unit_price_for_total += $child_line_item->unit_price(); |
|
| 1123 | - } |
|
| 1124 | - } |
|
| 1125 | - } |
|
| 1126 | - return $calculated_total_so_far; |
|
| 1127 | - } |
|
| 1128 | - |
|
| 1129 | - |
|
| 1130 | - /** |
|
| 1131 | - * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets |
|
| 1132 | - * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items |
|
| 1133 | - * and tax sub-total if already in the DB |
|
| 1134 | - * |
|
| 1135 | - * @return float |
|
| 1136 | - * @throws EE_Error |
|
| 1137 | - */ |
|
| 1138 | - public function recalculate_taxes_and_tax_total() |
|
| 1139 | - { |
|
| 1140 | - // get all taxes |
|
| 1141 | - $taxes = $this->tax_descendants(); |
|
| 1142 | - // calculate the pretax total |
|
| 1143 | - $taxable_total = $this->taxable_total(); |
|
| 1144 | - $tax_total = 0; |
|
| 1145 | - foreach ($taxes as $tax) { |
|
| 1146 | - $total_on_this_tax = $taxable_total * $tax->percent() / 100; |
|
| 1147 | - // remember the total on this line item |
|
| 1148 | - $tax->set_total($total_on_this_tax); |
|
| 1149 | - $tax->maybe_save(); |
|
| 1150 | - $tax_total += $tax->total(); |
|
| 1151 | - } |
|
| 1152 | - $this->_recalculate_tax_sub_total(); |
|
| 1153 | - return $tax_total; |
|
| 1154 | - } |
|
| 1155 | - |
|
| 1156 | - |
|
| 1157 | - /** |
|
| 1158 | - * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated |
|
| 1159 | - * |
|
| 1160 | - * @return void |
|
| 1161 | - * @throws EE_Error |
|
| 1162 | - */ |
|
| 1163 | - private function _recalculate_tax_sub_total() |
|
| 1164 | - { |
|
| 1165 | - if ($this->is_tax_sub_total()) { |
|
| 1166 | - $total = 0; |
|
| 1167 | - $total_percent = 0; |
|
| 1168 | - // simply loop through all its children (which should be taxes) and sum their total |
|
| 1169 | - foreach ($this->children() as $child_tax) { |
|
| 1170 | - if ($child_tax instanceof EE_Line_Item) { |
|
| 1171 | - $total += $child_tax->total(); |
|
| 1172 | - $total_percent += $child_tax->percent(); |
|
| 1173 | - } |
|
| 1174 | - } |
|
| 1175 | - $this->set_total($total); |
|
| 1176 | - $this->set_percent($total_percent); |
|
| 1177 | - $this->maybe_save(); |
|
| 1178 | - } elseif ($this->is_total()) { |
|
| 1179 | - foreach ($this->children() as $maybe_tax_subtotal) { |
|
| 1180 | - if ($maybe_tax_subtotal instanceof EE_Line_Item) { |
|
| 1181 | - $maybe_tax_subtotal->_recalculate_tax_sub_total(); |
|
| 1182 | - } |
|
| 1183 | - } |
|
| 1184 | - } |
|
| 1185 | - } |
|
| 1186 | - |
|
| 1187 | - |
|
| 1188 | - /** |
|
| 1189 | - * Gets the total tax on this line item. Assumes taxes have already been calculated using |
|
| 1190 | - * recalculate_taxes_and_total |
|
| 1191 | - * |
|
| 1192 | - * @return float |
|
| 1193 | - * @throws EE_Error |
|
| 1194 | - */ |
|
| 1195 | - public function get_total_tax() |
|
| 1196 | - { |
|
| 1197 | - $this->_recalculate_tax_sub_total(); |
|
| 1198 | - $total = 0; |
|
| 1199 | - foreach ($this->tax_descendants() as $tax_line_item) { |
|
| 1200 | - if ($tax_line_item instanceof EE_Line_Item) { |
|
| 1201 | - $total += $tax_line_item->total(); |
|
| 1202 | - } |
|
| 1203 | - } |
|
| 1204 | - return $total; |
|
| 1205 | - } |
|
| 1206 | - |
|
| 1207 | - |
|
| 1208 | - /** |
|
| 1209 | - * Gets the total for all the items purchased only |
|
| 1210 | - * |
|
| 1211 | - * @return float |
|
| 1212 | - * @throws EE_Error |
|
| 1213 | - */ |
|
| 1214 | - public function get_items_total() |
|
| 1215 | - { |
|
| 1216 | - // by default, let's make sure we're consistent with the existing line item |
|
| 1217 | - if ($this->is_total()) { |
|
| 1218 | - $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this); |
|
| 1219 | - if ($pretax_subtotal_li instanceof EE_Line_Item) { |
|
| 1220 | - return $pretax_subtotal_li->total(); |
|
| 1221 | - } |
|
| 1222 | - } |
|
| 1223 | - $total = 0; |
|
| 1224 | - foreach ($this->get_items() as $item) { |
|
| 1225 | - if ($item instanceof EE_Line_Item) { |
|
| 1226 | - $total += $item->total(); |
|
| 1227 | - } |
|
| 1228 | - } |
|
| 1229 | - return $total; |
|
| 1230 | - } |
|
| 1231 | - |
|
| 1232 | - |
|
| 1233 | - /** |
|
| 1234 | - * Gets all the descendants (ie, children or children of children etc) that |
|
| 1235 | - * are of the type 'tax' |
|
| 1236 | - * |
|
| 1237 | - * @return EE_Line_Item[] |
|
| 1238 | - */ |
|
| 1239 | - public function tax_descendants() |
|
| 1240 | - { |
|
| 1241 | - return EEH_Line_Item::get_tax_descendants($this); |
|
| 1242 | - } |
|
| 1243 | - |
|
| 1244 | - |
|
| 1245 | - /** |
|
| 1246 | - * Gets all the real items purchased which are children of this item |
|
| 1247 | - * |
|
| 1248 | - * @return EE_Line_Item[] |
|
| 1249 | - */ |
|
| 1250 | - public function get_items() |
|
| 1251 | - { |
|
| 1252 | - return EEH_Line_Item::get_line_item_descendants($this); |
|
| 1253 | - } |
|
| 1254 | - |
|
| 1255 | - |
|
| 1256 | - /** |
|
| 1257 | - * Returns the amount taxable among this line item's children (or if it has no children, |
|
| 1258 | - * how much of it is taxable). Does not recalculate totals or subtotals. |
|
| 1259 | - * If the taxable total is negative, (eg, if none of the tickets were taxable, |
|
| 1260 | - * but there is a "Taxable" discount), returns 0. |
|
| 1261 | - * |
|
| 1262 | - * @return float |
|
| 1263 | - * @throws EE_Error |
|
| 1264 | - */ |
|
| 1265 | - public function taxable_total() |
|
| 1266 | - { |
|
| 1267 | - $total = 0; |
|
| 1268 | - if ($this->children()) { |
|
| 1269 | - foreach ($this->children() as $child_line_item) { |
|
| 1270 | - if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) { |
|
| 1271 | - // if it's a percent item, only take into account the percent |
|
| 1272 | - // that's taxable too (the taxable total so far) |
|
| 1273 | - if ($child_line_item->is_percent()) { |
|
| 1274 | - $total += ($total * $child_line_item->percent() / 100); |
|
| 1275 | - } else { |
|
| 1276 | - $total += $child_line_item->total(); |
|
| 1277 | - } |
|
| 1278 | - } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) { |
|
| 1279 | - $total += $child_line_item->taxable_total(); |
|
| 1280 | - } |
|
| 1281 | - } |
|
| 1282 | - } |
|
| 1283 | - return max($total, 0); |
|
| 1284 | - } |
|
| 1285 | - |
|
| 1286 | - |
|
| 1287 | - /** |
|
| 1288 | - * Gets the transaction for this line item |
|
| 1289 | - * |
|
| 1290 | - * @return EE_Base_Class|EE_Transaction |
|
| 1291 | - * @throws EE_Error |
|
| 1292 | - */ |
|
| 1293 | - public function transaction() |
|
| 1294 | - { |
|
| 1295 | - return $this->get_first_related('Transaction'); |
|
| 1296 | - } |
|
| 1297 | - |
|
| 1298 | - |
|
| 1299 | - /** |
|
| 1300 | - * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1301 | - * Because there currently is no proper parent-child relation on the model, |
|
| 1302 | - * save_this_and_cached() will NOT save the descendants. |
|
| 1303 | - * Also sets the transaction on this line item and all its descendants before saving |
|
| 1304 | - * |
|
| 1305 | - * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 1306 | - * @return int count of items saved |
|
| 1307 | - * @throws EE_Error |
|
| 1308 | - */ |
|
| 1309 | - public function save_this_and_descendants_to_txn($txn_id = null) |
|
| 1310 | - { |
|
| 1311 | - $count = 0; |
|
| 1312 | - if (! $txn_id) { |
|
| 1313 | - $txn_id = $this->TXN_ID(); |
|
| 1314 | - } |
|
| 1315 | - $this->set_TXN_ID($txn_id); |
|
| 1316 | - $children = $this->children(); |
|
| 1317 | - $count += $this->save() |
|
| 1318 | - ? 1 |
|
| 1319 | - : 0; |
|
| 1320 | - foreach ($children as $child_line_item) { |
|
| 1321 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1322 | - $child_line_item->set_parent_ID($this->ID()); |
|
| 1323 | - $count += $child_line_item->save_this_and_descendants_to_txn($txn_id); |
|
| 1324 | - } |
|
| 1325 | - } |
|
| 1326 | - return $count; |
|
| 1327 | - } |
|
| 1328 | - |
|
| 1329 | - |
|
| 1330 | - /** |
|
| 1331 | - * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1332 | - * |
|
| 1333 | - * @return int count of items saved |
|
| 1334 | - * @throws EE_Error |
|
| 1335 | - */ |
|
| 1336 | - public function save_this_and_descendants() |
|
| 1337 | - { |
|
| 1338 | - $count = 0; |
|
| 1339 | - $children = $this->children(); |
|
| 1340 | - $count += $this->save() |
|
| 1341 | - ? 1 |
|
| 1342 | - : 0; |
|
| 1343 | - foreach ($children as $child_line_item) { |
|
| 1344 | - if ($child_line_item instanceof EE_Line_Item) { |
|
| 1345 | - $child_line_item->set_parent_ID($this->ID()); |
|
| 1346 | - $count += $child_line_item->save_this_and_descendants(); |
|
| 1347 | - } |
|
| 1348 | - } |
|
| 1349 | - return $count; |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - |
|
| 1353 | - /** |
|
| 1354 | - * returns the cancellation line item if this item was cancelled |
|
| 1355 | - * |
|
| 1356 | - * @return EE_Line_Item[] |
|
| 1357 | - * @throws InvalidArgumentException |
|
| 1358 | - * @throws InvalidInterfaceException |
|
| 1359 | - * @throws InvalidDataTypeException |
|
| 1360 | - * @throws ReflectionException |
|
| 1361 | - * @throws EE_Error |
|
| 1362 | - */ |
|
| 1363 | - public function get_cancellations() |
|
| 1364 | - { |
|
| 1365 | - EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1366 | - return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation); |
|
| 1367 | - } |
|
| 1368 | - |
|
| 1369 | - |
|
| 1370 | - /** |
|
| 1371 | - * If this item has an ID, then this saves it again to update the db |
|
| 1372 | - * |
|
| 1373 | - * @return int count of items saved |
|
| 1374 | - * @throws EE_Error |
|
| 1375 | - */ |
|
| 1376 | - public function maybe_save() |
|
| 1377 | - { |
|
| 1378 | - if ($this->ID()) { |
|
| 1379 | - return $this->save(); |
|
| 1380 | - } |
|
| 1381 | - return false; |
|
| 1382 | - } |
|
| 1383 | - |
|
| 1384 | - |
|
| 1385 | - /** |
|
| 1386 | - * clears the cached children and parent from the line item |
|
| 1387 | - * |
|
| 1388 | - * @return void |
|
| 1389 | - */ |
|
| 1390 | - public function clear_related_line_item_cache() |
|
| 1391 | - { |
|
| 1392 | - $this->_children = array(); |
|
| 1393 | - $this->_parent = null; |
|
| 1394 | - } |
|
| 1395 | - |
|
| 1396 | - |
|
| 1397 | - /** |
|
| 1398 | - * @param bool $raw |
|
| 1399 | - * @return int |
|
| 1400 | - * @throws EE_Error |
|
| 1401 | - */ |
|
| 1402 | - public function timestamp($raw = false) |
|
| 1403 | - { |
|
| 1404 | - return $raw |
|
| 1405 | - ? $this->get_raw('LIN_timestamp') |
|
| 1406 | - : $this->get('LIN_timestamp'); |
|
| 1407 | - } |
|
| 1408 | - |
|
| 1409 | - |
|
| 1410 | - |
|
| 1411 | - |
|
| 1412 | - /************************* DEPRECATED *************************/ |
|
| 1413 | - /** |
|
| 1414 | - * @deprecated 4.6.0 |
|
| 1415 | - * @param string $type one of the constants on EEM_Line_Item |
|
| 1416 | - * @return EE_Line_Item[] |
|
| 1417 | - */ |
|
| 1418 | - protected function _get_descendants_of_type($type) |
|
| 1419 | - { |
|
| 1420 | - EE_Error::doing_it_wrong( |
|
| 1421 | - 'EE_Line_Item::_get_descendants_of_type()', |
|
| 1422 | - __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), |
|
| 1423 | - '4.6.0' |
|
| 1424 | - ); |
|
| 1425 | - return EEH_Line_Item::get_descendants_of_type($this, $type); |
|
| 1426 | - } |
|
| 1427 | - |
|
| 1428 | - |
|
| 1429 | - /** |
|
| 1430 | - * @deprecated 4.6.0 |
|
| 1431 | - * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1432 | - * @return EE_Line_Item |
|
| 1433 | - */ |
|
| 1434 | - public function get_nearest_descendant_of_type($type) |
|
| 1435 | - { |
|
| 1436 | - EE_Error::doing_it_wrong( |
|
| 1437 | - 'EE_Line_Item::get_nearest_descendant_of_type()', |
|
| 1438 | - __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), |
|
| 1439 | - '4.6.0' |
|
| 1440 | - ); |
|
| 1441 | - return EEH_Line_Item::get_nearest_descendant_of_type($this, $type); |
|
| 1442 | - } |
|
| 17 | + /** |
|
| 18 | + * for children line items (currently not a normal relation) |
|
| 19 | + * |
|
| 20 | + * @type EE_Line_Item[] |
|
| 21 | + */ |
|
| 22 | + protected $_children = array(); |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * for the parent line item |
|
| 26 | + * |
|
| 27 | + * @var EE_Line_Item |
|
| 28 | + */ |
|
| 29 | + protected $_parent; |
|
| 30 | + |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * |
|
| 34 | + * @param array $props_n_values incoming values |
|
| 35 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 36 | + * used.) |
|
| 37 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 38 | + * date_format and the second value is the time format |
|
| 39 | + * @return EE_Line_Item |
|
| 40 | + * @throws EE_Error |
|
| 41 | + */ |
|
| 42 | + public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) |
|
| 43 | + { |
|
| 44 | + $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats); |
|
| 45 | + return $has_object |
|
| 46 | + ? $has_object |
|
| 47 | + : new self($props_n_values, false, $timezone); |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @param array $props_n_values incoming values from the database |
|
| 53 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 54 | + * the website will be used. |
|
| 55 | + * @return EE_Line_Item |
|
| 56 | + * @throws EE_Error |
|
| 57 | + */ |
|
| 58 | + public static function new_instance_from_db($props_n_values = array(), $timezone = null) |
|
| 59 | + { |
|
| 60 | + return new self($props_n_values, true, $timezone); |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Adds some defaults if they're not specified |
|
| 66 | + * |
|
| 67 | + * @param array $fieldValues |
|
| 68 | + * @param bool $bydb |
|
| 69 | + * @param string $timezone |
|
| 70 | + * @throws EE_Error |
|
| 71 | + */ |
|
| 72 | + protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
|
| 73 | + { |
|
| 74 | + parent::__construct($fieldValues, $bydb, $timezone); |
|
| 75 | + if (! $this->get('LIN_code')) { |
|
| 76 | + $this->set_code($this->generate_code()); |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * Gets ID |
|
| 83 | + * |
|
| 84 | + * @return int |
|
| 85 | + * @throws EE_Error |
|
| 86 | + */ |
|
| 87 | + public function ID() |
|
| 88 | + { |
|
| 89 | + return $this->get('LIN_ID'); |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Gets TXN_ID |
|
| 95 | + * |
|
| 96 | + * @return int |
|
| 97 | + * @throws EE_Error |
|
| 98 | + */ |
|
| 99 | + public function TXN_ID() |
|
| 100 | + { |
|
| 101 | + return $this->get('TXN_ID'); |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * Sets TXN_ID |
|
| 107 | + * |
|
| 108 | + * @param int $TXN_ID |
|
| 109 | + * @throws EE_Error |
|
| 110 | + */ |
|
| 111 | + public function set_TXN_ID($TXN_ID) |
|
| 112 | + { |
|
| 113 | + $this->set('TXN_ID', $TXN_ID); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Gets name |
|
| 119 | + * |
|
| 120 | + * @return string |
|
| 121 | + * @throws EE_Error |
|
| 122 | + */ |
|
| 123 | + public function name() |
|
| 124 | + { |
|
| 125 | + $name = $this->get('LIN_name'); |
|
| 126 | + if (! $name) { |
|
| 127 | + $name = ucwords(str_replace('-', ' ', $this->type())); |
|
| 128 | + } |
|
| 129 | + return $name; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Sets name |
|
| 135 | + * |
|
| 136 | + * @param string $name |
|
| 137 | + * @throws EE_Error |
|
| 138 | + */ |
|
| 139 | + public function set_name($name) |
|
| 140 | + { |
|
| 141 | + $this->set('LIN_name', $name); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Gets desc |
|
| 147 | + * |
|
| 148 | + * @return string |
|
| 149 | + * @throws EE_Error |
|
| 150 | + */ |
|
| 151 | + public function desc() |
|
| 152 | + { |
|
| 153 | + return $this->get('LIN_desc'); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * Sets desc |
|
| 159 | + * |
|
| 160 | + * @param string $desc |
|
| 161 | + * @throws EE_Error |
|
| 162 | + */ |
|
| 163 | + public function set_desc($desc) |
|
| 164 | + { |
|
| 165 | + $this->set('LIN_desc', $desc); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Gets quantity |
|
| 171 | + * |
|
| 172 | + * @return int |
|
| 173 | + * @throws EE_Error |
|
| 174 | + */ |
|
| 175 | + public function quantity() |
|
| 176 | + { |
|
| 177 | + return $this->get('LIN_quantity'); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Sets quantity |
|
| 183 | + * |
|
| 184 | + * @param int $quantity |
|
| 185 | + * @throws EE_Error |
|
| 186 | + */ |
|
| 187 | + public function set_quantity($quantity) |
|
| 188 | + { |
|
| 189 | + $this->set('LIN_quantity', max($quantity, 0)); |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * Gets item_id |
|
| 195 | + * |
|
| 196 | + * @return string |
|
| 197 | + * @throws EE_Error |
|
| 198 | + */ |
|
| 199 | + public function OBJ_ID() |
|
| 200 | + { |
|
| 201 | + return $this->get('OBJ_ID'); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Sets item_id |
|
| 207 | + * |
|
| 208 | + * @param string $item_id |
|
| 209 | + * @throws EE_Error |
|
| 210 | + */ |
|
| 211 | + public function set_OBJ_ID($item_id) |
|
| 212 | + { |
|
| 213 | + $this->set('OBJ_ID', $item_id); |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Gets item_type |
|
| 219 | + * |
|
| 220 | + * @return string |
|
| 221 | + * @throws EE_Error |
|
| 222 | + */ |
|
| 223 | + public function OBJ_type() |
|
| 224 | + { |
|
| 225 | + return $this->get('OBJ_type'); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * Gets item_type |
|
| 231 | + * |
|
| 232 | + * @return string |
|
| 233 | + * @throws EE_Error |
|
| 234 | + */ |
|
| 235 | + public function OBJ_type_i18n() |
|
| 236 | + { |
|
| 237 | + $obj_type = $this->OBJ_type(); |
|
| 238 | + switch ($obj_type) { |
|
| 239 | + case 'Event': |
|
| 240 | + $obj_type = __('Event', 'event_espresso'); |
|
| 241 | + break; |
|
| 242 | + case 'Price': |
|
| 243 | + $obj_type = __('Price', 'event_espresso'); |
|
| 244 | + break; |
|
| 245 | + case 'Promotion': |
|
| 246 | + $obj_type = __('Promotion', 'event_espresso'); |
|
| 247 | + break; |
|
| 248 | + case 'Ticket': |
|
| 249 | + $obj_type = __('Ticket', 'event_espresso'); |
|
| 250 | + break; |
|
| 251 | + case 'Transaction': |
|
| 252 | + $obj_type = __('Transaction', 'event_espresso'); |
|
| 253 | + break; |
|
| 254 | + } |
|
| 255 | + return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * Sets item_type |
|
| 261 | + * |
|
| 262 | + * @param string $OBJ_type |
|
| 263 | + * @throws EE_Error |
|
| 264 | + */ |
|
| 265 | + public function set_OBJ_type($OBJ_type) |
|
| 266 | + { |
|
| 267 | + $this->set('OBJ_type', $OBJ_type); |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + |
|
| 271 | + /** |
|
| 272 | + * Gets unit_price |
|
| 273 | + * |
|
| 274 | + * @return float |
|
| 275 | + * @throws EE_Error |
|
| 276 | + */ |
|
| 277 | + public function unit_price() |
|
| 278 | + { |
|
| 279 | + return $this->get('LIN_unit_price'); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + /** |
|
| 284 | + * Sets unit_price |
|
| 285 | + * |
|
| 286 | + * @param float $unit_price |
|
| 287 | + * @throws EE_Error |
|
| 288 | + */ |
|
| 289 | + public function set_unit_price($unit_price) |
|
| 290 | + { |
|
| 291 | + $this->set('LIN_unit_price', $unit_price); |
|
| 292 | + } |
|
| 293 | + |
|
| 294 | + |
|
| 295 | + /** |
|
| 296 | + * Checks if this item is a percentage modifier or not |
|
| 297 | + * |
|
| 298 | + * @return boolean |
|
| 299 | + * @throws EE_Error |
|
| 300 | + */ |
|
| 301 | + public function is_percent() |
|
| 302 | + { |
|
| 303 | + if ($this->is_tax_sub_total()) { |
|
| 304 | + // tax subtotals HAVE a percent on them, that percentage only applies |
|
| 305 | + // to taxable items, so its' an exception. Treat it like a flat line item |
|
| 306 | + return false; |
|
| 307 | + } |
|
| 308 | + $unit_price = abs($this->get('LIN_unit_price')); |
|
| 309 | + $percent = abs($this->get('LIN_percent')); |
|
| 310 | + if ($unit_price < .001 && $percent) { |
|
| 311 | + return true; |
|
| 312 | + } |
|
| 313 | + if ($unit_price >= .001 && ! $percent) { |
|
| 314 | + return false; |
|
| 315 | + } |
|
| 316 | + if ($unit_price >= .001 && $percent) { |
|
| 317 | + throw new EE_Error( |
|
| 318 | + sprintf( |
|
| 319 | + esc_html__('A Line Item can not have a unit price of (%s) AND a percent (%s)!', 'event_espresso'), |
|
| 320 | + $unit_price, |
|
| 321 | + $percent |
|
| 322 | + ) |
|
| 323 | + ); |
|
| 324 | + } |
|
| 325 | + // if they're both 0, assume its not a percent item |
|
| 326 | + return false; |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + |
|
| 330 | + /** |
|
| 331 | + * Gets percent (between 100-.001) |
|
| 332 | + * |
|
| 333 | + * @return float |
|
| 334 | + * @throws EE_Error |
|
| 335 | + */ |
|
| 336 | + public function percent() |
|
| 337 | + { |
|
| 338 | + return $this->get('LIN_percent'); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * Sets percent (between 100-0.01) |
|
| 344 | + * |
|
| 345 | + * @param float $percent |
|
| 346 | + * @throws EE_Error |
|
| 347 | + */ |
|
| 348 | + public function set_percent($percent) |
|
| 349 | + { |
|
| 350 | + $this->set('LIN_percent', $percent); |
|
| 351 | + } |
|
| 352 | + |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * Gets total |
|
| 356 | + * |
|
| 357 | + * @return float |
|
| 358 | + * @throws EE_Error |
|
| 359 | + */ |
|
| 360 | + public function total() |
|
| 361 | + { |
|
| 362 | + return $this->get('LIN_total'); |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + |
|
| 366 | + /** |
|
| 367 | + * Sets total |
|
| 368 | + * |
|
| 369 | + * @param float $total |
|
| 370 | + * @throws EE_Error |
|
| 371 | + */ |
|
| 372 | + public function set_total($total) |
|
| 373 | + { |
|
| 374 | + $this->set('LIN_total', $total); |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + |
|
| 378 | + /** |
|
| 379 | + * Gets order |
|
| 380 | + * |
|
| 381 | + * @return int |
|
| 382 | + * @throws EE_Error |
|
| 383 | + */ |
|
| 384 | + public function order() |
|
| 385 | + { |
|
| 386 | + return $this->get('LIN_order'); |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + |
|
| 390 | + /** |
|
| 391 | + * Sets order |
|
| 392 | + * |
|
| 393 | + * @param int $order |
|
| 394 | + * @throws EE_Error |
|
| 395 | + */ |
|
| 396 | + public function set_order($order) |
|
| 397 | + { |
|
| 398 | + $this->set('LIN_order', $order); |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * Gets parent |
|
| 404 | + * |
|
| 405 | + * @return int |
|
| 406 | + * @throws EE_Error |
|
| 407 | + */ |
|
| 408 | + public function parent_ID() |
|
| 409 | + { |
|
| 410 | + return $this->get('LIN_parent'); |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * Sets parent |
|
| 416 | + * |
|
| 417 | + * @param int $parent |
|
| 418 | + * @throws EE_Error |
|
| 419 | + */ |
|
| 420 | + public function set_parent_ID($parent) |
|
| 421 | + { |
|
| 422 | + $this->set('LIN_parent', $parent); |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Gets type |
|
| 428 | + * |
|
| 429 | + * @return string |
|
| 430 | + * @throws EE_Error |
|
| 431 | + */ |
|
| 432 | + public function type() |
|
| 433 | + { |
|
| 434 | + return $this->get('LIN_type'); |
|
| 435 | + } |
|
| 436 | + |
|
| 437 | + |
|
| 438 | + /** |
|
| 439 | + * Sets type |
|
| 440 | + * |
|
| 441 | + * @param string $type |
|
| 442 | + * @throws EE_Error |
|
| 443 | + */ |
|
| 444 | + public function set_type($type) |
|
| 445 | + { |
|
| 446 | + $this->set('LIN_type', $type); |
|
| 447 | + } |
|
| 448 | + |
|
| 449 | + |
|
| 450 | + /** |
|
| 451 | + * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\ |
|
| 452 | + * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB |
|
| 453 | + * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()` |
|
| 454 | + * or indirectly by `EE_Line_item::add_child_line_item()`) |
|
| 455 | + * |
|
| 456 | + * @return EE_Base_Class|EE_Line_Item |
|
| 457 | + * @throws EE_Error |
|
| 458 | + */ |
|
| 459 | + public function parent() |
|
| 460 | + { |
|
| 461 | + return $this->ID() |
|
| 462 | + ? $this->get_model()->get_one_by_ID($this->parent_ID()) |
|
| 463 | + : $this->_parent; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * Gets ALL the children of this line item (ie, all the parts that contribute towards this total). |
|
| 469 | + * |
|
| 470 | + * @return EE_Base_Class[]|EE_Line_Item[] |
|
| 471 | + * @throws EE_Error |
|
| 472 | + */ |
|
| 473 | + public function children() |
|
| 474 | + { |
|
| 475 | + if ($this->ID()) { |
|
| 476 | + return $this->get_model()->get_all( |
|
| 477 | + array( |
|
| 478 | + array('LIN_parent' => $this->ID()), |
|
| 479 | + 'order_by' => array('LIN_order' => 'ASC'), |
|
| 480 | + ) |
|
| 481 | + ); |
|
| 482 | + } |
|
| 483 | + if (! is_array($this->_children)) { |
|
| 484 | + $this->_children = array(); |
|
| 485 | + } |
|
| 486 | + return $this->_children; |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + |
|
| 490 | + /** |
|
| 491 | + * Gets code |
|
| 492 | + * |
|
| 493 | + * @return string |
|
| 494 | + * @throws EE_Error |
|
| 495 | + */ |
|
| 496 | + public function code() |
|
| 497 | + { |
|
| 498 | + return $this->get('LIN_code'); |
|
| 499 | + } |
|
| 500 | + |
|
| 501 | + |
|
| 502 | + /** |
|
| 503 | + * Sets code |
|
| 504 | + * |
|
| 505 | + * @param string $code |
|
| 506 | + * @throws EE_Error |
|
| 507 | + */ |
|
| 508 | + public function set_code($code) |
|
| 509 | + { |
|
| 510 | + $this->set('LIN_code', $code); |
|
| 511 | + } |
|
| 512 | + |
|
| 513 | + |
|
| 514 | + /** |
|
| 515 | + * Gets is_taxable |
|
| 516 | + * |
|
| 517 | + * @return boolean |
|
| 518 | + * @throws EE_Error |
|
| 519 | + */ |
|
| 520 | + public function is_taxable() |
|
| 521 | + { |
|
| 522 | + return $this->get('LIN_is_taxable'); |
|
| 523 | + } |
|
| 524 | + |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * Sets is_taxable |
|
| 528 | + * |
|
| 529 | + * @param boolean $is_taxable |
|
| 530 | + * @throws EE_Error |
|
| 531 | + */ |
|
| 532 | + public function set_is_taxable($is_taxable) |
|
| 533 | + { |
|
| 534 | + $this->set('LIN_is_taxable', $is_taxable); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + |
|
| 538 | + /** |
|
| 539 | + * Gets the object that this model-joins-to. |
|
| 540 | + * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on |
|
| 541 | + * EEM_Promotion_Object |
|
| 542 | + * |
|
| 543 | + * Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object |
|
| 544 | + * |
|
| 545 | + * @return EE_Base_Class | NULL |
|
| 546 | + * @throws EE_Error |
|
| 547 | + */ |
|
| 548 | + public function get_object() |
|
| 549 | + { |
|
| 550 | + $model_name_of_related_obj = $this->OBJ_type(); |
|
| 551 | + return $this->get_model()->has_relation($model_name_of_related_obj) |
|
| 552 | + ? $this->get_first_related($model_name_of_related_obj) |
|
| 553 | + : null; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + |
|
| 557 | + /** |
|
| 558 | + * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket. |
|
| 559 | + * (IE, if this line item is for a price or something else, will return NULL) |
|
| 560 | + * |
|
| 561 | + * @param array $query_params |
|
| 562 | + * @return EE_Base_Class|EE_Ticket |
|
| 563 | + * @throws EE_Error |
|
| 564 | + */ |
|
| 565 | + public function ticket($query_params = array()) |
|
| 566 | + { |
|
| 567 | + // we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived. This can be overridden via the incoming $query_params argument |
|
| 568 | + $remove_defaults = array('default_where_conditions' => 'none'); |
|
| 569 | + $query_params = array_merge($remove_defaults, $query_params); |
|
| 570 | + return $this->get_first_related('Ticket', $query_params); |
|
| 571 | + } |
|
| 572 | + |
|
| 573 | + |
|
| 574 | + /** |
|
| 575 | + * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket |
|
| 576 | + * |
|
| 577 | + * @return EE_Datetime | NULL |
|
| 578 | + * @throws EE_Error |
|
| 579 | + */ |
|
| 580 | + public function get_ticket_datetime() |
|
| 581 | + { |
|
| 582 | + if ($this->OBJ_type() === 'Ticket') { |
|
| 583 | + $ticket = $this->ticket(); |
|
| 584 | + if ($ticket instanceof EE_Ticket) { |
|
| 585 | + $datetime = $ticket->first_datetime(); |
|
| 586 | + if ($datetime instanceof EE_Datetime) { |
|
| 587 | + return $datetime; |
|
| 588 | + } |
|
| 589 | + } |
|
| 590 | + } |
|
| 591 | + return null; |
|
| 592 | + } |
|
| 593 | + |
|
| 594 | + |
|
| 595 | + /** |
|
| 596 | + * Gets the event's name that's related to the ticket, if this is for |
|
| 597 | + * a ticket |
|
| 598 | + * |
|
| 599 | + * @return string |
|
| 600 | + * @throws EE_Error |
|
| 601 | + */ |
|
| 602 | + public function ticket_event_name() |
|
| 603 | + { |
|
| 604 | + $event_name = esc_html__('Unknown', 'event_espresso'); |
|
| 605 | + $event = $this->ticket_event(); |
|
| 606 | + if ($event instanceof EE_Event) { |
|
| 607 | + $event_name = $event->name(); |
|
| 608 | + } |
|
| 609 | + return $event_name; |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + |
|
| 613 | + /** |
|
| 614 | + * Gets the event that's related to the ticket, if this line item represents a ticket. |
|
| 615 | + * |
|
| 616 | + * @return EE_Event|null |
|
| 617 | + * @throws EE_Error |
|
| 618 | + */ |
|
| 619 | + public function ticket_event() |
|
| 620 | + { |
|
| 621 | + $event = null; |
|
| 622 | + $ticket = $this->ticket(); |
|
| 623 | + if ($ticket instanceof EE_Ticket) { |
|
| 624 | + $datetime = $ticket->first_datetime(); |
|
| 625 | + if ($datetime instanceof EE_Datetime) { |
|
| 626 | + $event = $datetime->event(); |
|
| 627 | + } |
|
| 628 | + } |
|
| 629 | + return $event; |
|
| 630 | + } |
|
| 631 | + |
|
| 632 | + |
|
| 633 | + /** |
|
| 634 | + * Gets the first datetime for this lien item, assuming it's for a ticket |
|
| 635 | + * |
|
| 636 | + * @param string $date_format |
|
| 637 | + * @param string $time_format |
|
| 638 | + * @return string |
|
| 639 | + * @throws EE_Error |
|
| 640 | + */ |
|
| 641 | + public function ticket_datetime_start($date_format = '', $time_format = '') |
|
| 642 | + { |
|
| 643 | + $first_datetime_string = esc_html__('Unknown', 'event_espresso'); |
|
| 644 | + $datetime = $this->get_ticket_datetime(); |
|
| 645 | + if ($datetime) { |
|
| 646 | + $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format); |
|
| 647 | + } |
|
| 648 | + return $first_datetime_string; |
|
| 649 | + } |
|
| 650 | + |
|
| 651 | + |
|
| 652 | + /** |
|
| 653 | + * Adds the line item as a child to this line item. If there is another child line |
|
| 654 | + * item with the same LIN_code, it is overwritten by this new one |
|
| 655 | + * |
|
| 656 | + * @param EEI_Line_Item $line_item |
|
| 657 | + * @param bool $set_order |
|
| 658 | + * @return bool success |
|
| 659 | + * @throws EE_Error |
|
| 660 | + */ |
|
| 661 | + public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) |
|
| 662 | + { |
|
| 663 | + // should we calculate the LIN_order for this line item ? |
|
| 664 | + if ($set_order || $line_item->order() === null) { |
|
| 665 | + $line_item->set_order(count($this->children())); |
|
| 666 | + } |
|
| 667 | + if ($this->ID()) { |
|
| 668 | + // check for any duplicate line items (with the same code), if so, this replaces it |
|
| 669 | + $line_item_with_same_code = $this->get_child_line_item($line_item->code()); |
|
| 670 | + if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) { |
|
| 671 | + $this->delete_child_line_item($line_item_with_same_code->code()); |
|
| 672 | + } |
|
| 673 | + $line_item->set_parent_ID($this->ID()); |
|
| 674 | + if ($this->TXN_ID()) { |
|
| 675 | + $line_item->set_TXN_ID($this->TXN_ID()); |
|
| 676 | + } |
|
| 677 | + return $line_item->save(); |
|
| 678 | + } |
|
| 679 | + $this->_children[ $line_item->code() ] = $line_item; |
|
| 680 | + if ($line_item->parent() !== $this) { |
|
| 681 | + $line_item->set_parent($this); |
|
| 682 | + } |
|
| 683 | + return true; |
|
| 684 | + } |
|
| 685 | + |
|
| 686 | + |
|
| 687 | + /** |
|
| 688 | + * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation. |
|
| 689 | + * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save() |
|
| 690 | + * However, if this line item is NOT saved to the DB, this just caches the parent on |
|
| 691 | + * the EE_Line_Item::_parent property. |
|
| 692 | + * |
|
| 693 | + * @param EE_Line_Item $line_item |
|
| 694 | + * @throws EE_Error |
|
| 695 | + */ |
|
| 696 | + public function set_parent($line_item) |
|
| 697 | + { |
|
| 698 | + if ($this->ID()) { |
|
| 699 | + if (! $line_item->ID()) { |
|
| 700 | + $line_item->save(); |
|
| 701 | + } |
|
| 702 | + $this->set_parent_ID($line_item->ID()); |
|
| 703 | + $this->save(); |
|
| 704 | + } else { |
|
| 705 | + $this->_parent = $line_item; |
|
| 706 | + $this->set_parent_ID($line_item->ID()); |
|
| 707 | + } |
|
| 708 | + } |
|
| 709 | + |
|
| 710 | + |
|
| 711 | + /** |
|
| 712 | + * Gets the child line item as specified by its code. Because this returns an object (by reference) |
|
| 713 | + * you can modify this child line item and the parent (this object) can know about them |
|
| 714 | + * because it also has a reference to that line item |
|
| 715 | + * |
|
| 716 | + * @param string $code |
|
| 717 | + * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL |
|
| 718 | + * @throws EE_Error |
|
| 719 | + */ |
|
| 720 | + public function get_child_line_item($code) |
|
| 721 | + { |
|
| 722 | + if ($this->ID()) { |
|
| 723 | + return $this->get_model()->get_one( |
|
| 724 | + array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
|
| 725 | + ); |
|
| 726 | + } |
|
| 727 | + return isset($this->_children[ $code ]) |
|
| 728 | + ? $this->_children[ $code ] |
|
| 729 | + : null; |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD |
|
| 735 | + * cached on it) |
|
| 736 | + * |
|
| 737 | + * @return int |
|
| 738 | + * @throws EE_Error |
|
| 739 | + */ |
|
| 740 | + public function delete_children_line_items() |
|
| 741 | + { |
|
| 742 | + if ($this->ID()) { |
|
| 743 | + return $this->get_model()->delete(array(array('LIN_parent' => $this->ID()))); |
|
| 744 | + } |
|
| 745 | + $count = count($this->_children); |
|
| 746 | + $this->_children = array(); |
|
| 747 | + return $count; |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + |
|
| 751 | + /** |
|
| 752 | + * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line |
|
| 753 | + * HAS NOT been saved to the DB, removes the child line item with index $code. |
|
| 754 | + * Also searches through the child's children for a matching line item. However, once a line item has been found |
|
| 755 | + * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be |
|
| 756 | + * deleted) |
|
| 757 | + * |
|
| 758 | + * @param string $code |
|
| 759 | + * @param bool $stop_search_once_found |
|
| 760 | + * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to |
|
| 761 | + * the DB yet) |
|
| 762 | + * @throws EE_Error |
|
| 763 | + */ |
|
| 764 | + public function delete_child_line_item($code, $stop_search_once_found = true) |
|
| 765 | + { |
|
| 766 | + if ($this->ID()) { |
|
| 767 | + $items_deleted = 0; |
|
| 768 | + if ($this->code() === $code) { |
|
| 769 | + $items_deleted += EEH_Line_Item::delete_all_child_items($this); |
|
| 770 | + $items_deleted += (int) $this->delete(); |
|
| 771 | + if ($stop_search_once_found) { |
|
| 772 | + return $items_deleted; |
|
| 773 | + } |
|
| 774 | + } |
|
| 775 | + foreach ($this->children() as $child_line_item) { |
|
| 776 | + $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found); |
|
| 777 | + } |
|
| 778 | + return $items_deleted; |
|
| 779 | + } |
|
| 780 | + if (isset($this->_children[ $code ])) { |
|
| 781 | + unset($this->_children[ $code ]); |
|
| 782 | + return 1; |
|
| 783 | + } |
|
| 784 | + return 0; |
|
| 785 | + } |
|
| 786 | + |
|
| 787 | + |
|
| 788 | + /** |
|
| 789 | + * If this line item is in the database, is of the type subtotal, and |
|
| 790 | + * has no children, why do we have it? It should be deleted so this function |
|
| 791 | + * does that |
|
| 792 | + * |
|
| 793 | + * @return boolean |
|
| 794 | + * @throws EE_Error |
|
| 795 | + */ |
|
| 796 | + public function delete_if_childless_subtotal() |
|
| 797 | + { |
|
| 798 | + if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) { |
|
| 799 | + return $this->delete(); |
|
| 800 | + } |
|
| 801 | + return false; |
|
| 802 | + } |
|
| 803 | + |
|
| 804 | + |
|
| 805 | + /** |
|
| 806 | + * Creates a code and returns a string. doesn't assign the code to this model object |
|
| 807 | + * |
|
| 808 | + * @return string |
|
| 809 | + * @throws EE_Error |
|
| 810 | + */ |
|
| 811 | + public function generate_code() |
|
| 812 | + { |
|
| 813 | + // each line item in the cart requires a unique identifier |
|
| 814 | + return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 815 | + } |
|
| 816 | + |
|
| 817 | + |
|
| 818 | + /** |
|
| 819 | + * @return bool |
|
| 820 | + * @throws EE_Error |
|
| 821 | + */ |
|
| 822 | + public function is_tax() |
|
| 823 | + { |
|
| 824 | + return $this->type() === EEM_Line_Item::type_tax; |
|
| 825 | + } |
|
| 826 | + |
|
| 827 | + |
|
| 828 | + /** |
|
| 829 | + * @return bool |
|
| 830 | + * @throws EE_Error |
|
| 831 | + */ |
|
| 832 | + public function is_tax_sub_total() |
|
| 833 | + { |
|
| 834 | + return $this->type() === EEM_Line_Item::type_tax_sub_total; |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + |
|
| 838 | + /** |
|
| 839 | + * @return bool |
|
| 840 | + * @throws EE_Error |
|
| 841 | + */ |
|
| 842 | + public function is_line_item() |
|
| 843 | + { |
|
| 844 | + return $this->type() === EEM_Line_Item::type_line_item; |
|
| 845 | + } |
|
| 846 | + |
|
| 847 | + |
|
| 848 | + /** |
|
| 849 | + * @return bool |
|
| 850 | + * @throws EE_Error |
|
| 851 | + */ |
|
| 852 | + public function is_sub_line_item() |
|
| 853 | + { |
|
| 854 | + return $this->type() === EEM_Line_Item::type_sub_line_item; |
|
| 855 | + } |
|
| 856 | + |
|
| 857 | + |
|
| 858 | + /** |
|
| 859 | + * @return bool |
|
| 860 | + * @throws EE_Error |
|
| 861 | + */ |
|
| 862 | + public function is_sub_total() |
|
| 863 | + { |
|
| 864 | + return $this->type() === EEM_Line_Item::type_sub_total; |
|
| 865 | + } |
|
| 866 | + |
|
| 867 | + |
|
| 868 | + /** |
|
| 869 | + * Whether or not this line item is a cancellation line item |
|
| 870 | + * |
|
| 871 | + * @return boolean |
|
| 872 | + * @throws EE_Error |
|
| 873 | + */ |
|
| 874 | + public function is_cancellation() |
|
| 875 | + { |
|
| 876 | + return EEM_Line_Item::type_cancellation === $this->type(); |
|
| 877 | + } |
|
| 878 | + |
|
| 879 | + |
|
| 880 | + /** |
|
| 881 | + * @return bool |
|
| 882 | + * @throws EE_Error |
|
| 883 | + */ |
|
| 884 | + public function is_total() |
|
| 885 | + { |
|
| 886 | + return $this->type() === EEM_Line_Item::type_total; |
|
| 887 | + } |
|
| 888 | + |
|
| 889 | + |
|
| 890 | + /** |
|
| 891 | + * @return bool |
|
| 892 | + * @throws EE_Error |
|
| 893 | + */ |
|
| 894 | + public function is_cancelled() |
|
| 895 | + { |
|
| 896 | + return $this->type() === EEM_Line_Item::type_cancellation; |
|
| 897 | + } |
|
| 898 | + |
|
| 899 | + |
|
| 900 | + /** |
|
| 901 | + * @return string like '2, 004.00', formatted according to the localized currency |
|
| 902 | + * @throws EE_Error |
|
| 903 | + */ |
|
| 904 | + public function unit_price_no_code() |
|
| 905 | + { |
|
| 906 | + return $this->get_pretty('LIN_unit_price', 'no_currency_code'); |
|
| 907 | + } |
|
| 908 | + |
|
| 909 | + |
|
| 910 | + /** |
|
| 911 | + * @return string like '2, 004.00', formatted according to the localized currency |
|
| 912 | + * @throws EE_Error |
|
| 913 | + */ |
|
| 914 | + public function total_no_code() |
|
| 915 | + { |
|
| 916 | + return $this->get_pretty('LIN_total', 'no_currency_code'); |
|
| 917 | + } |
|
| 918 | + |
|
| 919 | + |
|
| 920 | + /** |
|
| 921 | + * Gets the final total on this item, taking taxes into account. |
|
| 922 | + * Has the side-effect of setting the sub-total as it was just calculated. |
|
| 923 | + * If this is used on a grand-total line item, also updates the transaction's |
|
| 924 | + * TXN_total (provided this line item is allowed to persist, otherwise we don't |
|
| 925 | + * want to change a persistable transaction with info from a non-persistent line item) |
|
| 926 | + * |
|
| 927 | + * @return float |
|
| 928 | + * @throws EE_Error |
|
| 929 | + * @throws InvalidArgumentException |
|
| 930 | + * @throws InvalidInterfaceException |
|
| 931 | + * @throws InvalidDataTypeException |
|
| 932 | + */ |
|
| 933 | + public function recalculate_total_including_taxes() |
|
| 934 | + { |
|
| 935 | + $pre_tax_total = $this->recalculate_pre_tax_total(); |
|
| 936 | + $tax_total = $this->recalculate_taxes_and_tax_total(); |
|
| 937 | + $total = $pre_tax_total + $tax_total; |
|
| 938 | + // no negative totals plz |
|
| 939 | + $total = max($total, 0); |
|
| 940 | + $this->set_total($total); |
|
| 941 | + // only update the related transaction's total |
|
| 942 | + // if we intend to save this line item and its a grand total |
|
| 943 | + if ($this->allow_persist() && $this->type() === EEM_Line_Item::type_total |
|
| 944 | + && $this->transaction() |
|
| 945 | + instanceof |
|
| 946 | + EE_Transaction |
|
| 947 | + ) { |
|
| 948 | + $this->transaction()->set_total($total); |
|
| 949 | + if ($this->transaction()->ID()) { |
|
| 950 | + $this->transaction()->save(); |
|
| 951 | + } |
|
| 952 | + } |
|
| 953 | + $this->maybe_save(); |
|
| 954 | + return $total; |
|
| 955 | + } |
|
| 956 | + |
|
| 957 | + |
|
| 958 | + /** |
|
| 959 | + * Recursively goes through all the children and recalculates sub-totals EXCEPT for |
|
| 960 | + * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its |
|
| 961 | + * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and |
|
| 962 | + * when this is called on the grand total |
|
| 963 | + * |
|
| 964 | + * @return float |
|
| 965 | + * @throws InvalidArgumentException |
|
| 966 | + * @throws InvalidInterfaceException |
|
| 967 | + * @throws InvalidDataTypeException |
|
| 968 | + * @throws EE_Error |
|
| 969 | + */ |
|
| 970 | + public function recalculate_pre_tax_total() |
|
| 971 | + { |
|
| 972 | + $total = 0; |
|
| 973 | + $my_children = $this->children(); |
|
| 974 | + $has_children = ! empty($my_children); |
|
| 975 | + if ($has_children && $this->is_line_item()) { |
|
| 976 | + $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
|
| 977 | + } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 978 | + $total = $this->unit_price() * $this->quantity(); |
|
| 979 | + } elseif ($this->is_sub_total() || $this->is_total()) { |
|
| 980 | + $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
|
| 981 | + } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) { |
|
| 982 | + // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total |
|
| 983 | + return 0; |
|
| 984 | + } |
|
| 985 | + // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
|
| 986 | + if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 987 | + ) { |
|
| 988 | + if ($this->OBJ_type() !== 'Event') { |
|
| 989 | + $this->set_quantity(1); |
|
| 990 | + } |
|
| 991 | + if (! $this->is_percent()) { |
|
| 992 | + $this->set_unit_price($total); |
|
| 993 | + } |
|
| 994 | + } |
|
| 995 | + // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
|
| 996 | + // so it ought to be |
|
| 997 | + if (! $this->is_total()) { |
|
| 998 | + $this->set_total($total); |
|
| 999 | + // if not a percent line item, make sure we keep the unit price in sync |
|
| 1000 | + if ($has_children |
|
| 1001 | + && $this->is_line_item() |
|
| 1002 | + && ! $this->is_percent() |
|
| 1003 | + ) { |
|
| 1004 | + if ($this->quantity() === 0) { |
|
| 1005 | + $new_unit_price = 0; |
|
| 1006 | + } else { |
|
| 1007 | + $new_unit_price = $this->total() / $this->quantity(); |
|
| 1008 | + } |
|
| 1009 | + $this->set_unit_price($new_unit_price); |
|
| 1010 | + } |
|
| 1011 | + $this->maybe_save(); |
|
| 1012 | + } |
|
| 1013 | + return $total; |
|
| 1014 | + } |
|
| 1015 | + |
|
| 1016 | + |
|
| 1017 | + /** |
|
| 1018 | + * Calculates the pretax total when this line item is a subtotal or total line item. |
|
| 1019 | + * Basically does a sum-then-round approach (ie, any percent line item that are children |
|
| 1020 | + * will calculate their total based on the un-rounded total we're working with so far, and |
|
| 1021 | + * THEN round the result; instead of rounding as we go like with sub-line-items) |
|
| 1022 | + * |
|
| 1023 | + * @param float $calculated_total_so_far |
|
| 1024 | + * @param EE_Line_Item[] $my_children |
|
| 1025 | + * @return float |
|
| 1026 | + * @throws InvalidArgumentException |
|
| 1027 | + * @throws InvalidInterfaceException |
|
| 1028 | + * @throws InvalidDataTypeException |
|
| 1029 | + * @throws EE_Error |
|
| 1030 | + */ |
|
| 1031 | + protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) |
|
| 1032 | + { |
|
| 1033 | + if ($my_children === null) { |
|
| 1034 | + $my_children = $this->children(); |
|
| 1035 | + } |
|
| 1036 | + $subtotal_quantity = 0; |
|
| 1037 | + // get the total of all its children |
|
| 1038 | + foreach ($my_children as $child_line_item) { |
|
| 1039 | + if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1040 | + // percentage line items are based on total so far |
|
| 1041 | + if ($child_line_item->is_percent()) { |
|
| 1042 | + // round as we go so that the line items add up ok |
|
| 1043 | + $percent_total = round( |
|
| 1044 | + $calculated_total_so_far * $child_line_item->percent() / 100, |
|
| 1045 | + EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1046 | + ); |
|
| 1047 | + $child_line_item->set_total($percent_total); |
|
| 1048 | + // so far all percent line items should have a quantity of 1 |
|
| 1049 | + // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1050 | + $child_line_item->set_quantity(1); |
|
| 1051 | + $child_line_item->maybe_save(); |
|
| 1052 | + $calculated_total_so_far += $percent_total; |
|
| 1053 | + } else { |
|
| 1054 | + // verify flat sub-line-item quantities match their parent |
|
| 1055 | + if ($child_line_item->is_sub_line_item()) { |
|
| 1056 | + $child_line_item->set_quantity($this->quantity()); |
|
| 1057 | + } |
|
| 1058 | + $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1059 | + $subtotal_quantity += $child_line_item->quantity(); |
|
| 1060 | + } |
|
| 1061 | + } |
|
| 1062 | + } |
|
| 1063 | + if ($this->is_sub_total()) { |
|
| 1064 | + // no negative totals plz |
|
| 1065 | + $calculated_total_so_far = max($calculated_total_so_far, 0); |
|
| 1066 | + $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0; |
|
| 1067 | + $this->set_quantity($subtotal_quantity); |
|
| 1068 | + $this->maybe_save(); |
|
| 1069 | + } |
|
| 1070 | + return $calculated_total_so_far; |
|
| 1071 | + } |
|
| 1072 | + |
|
| 1073 | + |
|
| 1074 | + /** |
|
| 1075 | + * Calculates the pretax total for a normal line item, in a round-then-sum approach |
|
| 1076 | + * (where each sub-line-item is applied to the base price for the line item |
|
| 1077 | + * and the result is immediately rounded, rather than summing all the sub-line-items |
|
| 1078 | + * then rounding, like we do when recalculating pretax totals on totals and subtotals). |
|
| 1079 | + * |
|
| 1080 | + * @param float $calculated_total_so_far |
|
| 1081 | + * @param EE_Line_Item[] $my_children |
|
| 1082 | + * @return float |
|
| 1083 | + * @throws InvalidArgumentException |
|
| 1084 | + * @throws InvalidInterfaceException |
|
| 1085 | + * @throws InvalidDataTypeException |
|
| 1086 | + * @throws EE_Error |
|
| 1087 | + */ |
|
| 1088 | + protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) |
|
| 1089 | + { |
|
| 1090 | + if ($my_children === null) { |
|
| 1091 | + $my_children = $this->children(); |
|
| 1092 | + } |
|
| 1093 | + // we need to keep track of the running total for a single item, |
|
| 1094 | + // because we need to round as we go |
|
| 1095 | + $unit_price_for_total = 0; |
|
| 1096 | + $quantity_for_total = 1; |
|
| 1097 | + // get the total of all its children |
|
| 1098 | + foreach ($my_children as $child_line_item) { |
|
| 1099 | + if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) { |
|
| 1100 | + if ($child_line_item->is_percent()) { |
|
| 1101 | + // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity |
|
| 1102 | + // not total multiplied by percent, because that ignores rounding along-the-way |
|
| 1103 | + $percent_unit_price = round( |
|
| 1104 | + $unit_price_for_total * $child_line_item->percent() / 100, |
|
| 1105 | + EE_Registry::instance()->CFG->currency->dec_plc |
|
| 1106 | + ); |
|
| 1107 | + $percent_total = $percent_unit_price * $quantity_for_total; |
|
| 1108 | + $child_line_item->set_total($percent_total); |
|
| 1109 | + // so far all percent line items should have a quantity of 1 |
|
| 1110 | + // (ie, no double percent discounts. Although that might be requested someday) |
|
| 1111 | + $child_line_item->set_quantity(1); |
|
| 1112 | + $child_line_item->maybe_save(); |
|
| 1113 | + $calculated_total_so_far += $percent_total; |
|
| 1114 | + $unit_price_for_total += $percent_unit_price; |
|
| 1115 | + } else { |
|
| 1116 | + // verify flat sub-line-item quantities match their parent |
|
| 1117 | + if ($child_line_item->is_sub_line_item()) { |
|
| 1118 | + $child_line_item->set_quantity($this->quantity()); |
|
| 1119 | + } |
|
| 1120 | + $quantity_for_total = $child_line_item->quantity(); |
|
| 1121 | + $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total(); |
|
| 1122 | + $unit_price_for_total += $child_line_item->unit_price(); |
|
| 1123 | + } |
|
| 1124 | + } |
|
| 1125 | + } |
|
| 1126 | + return $calculated_total_so_far; |
|
| 1127 | + } |
|
| 1128 | + |
|
| 1129 | + |
|
| 1130 | + /** |
|
| 1131 | + * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets |
|
| 1132 | + * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items |
|
| 1133 | + * and tax sub-total if already in the DB |
|
| 1134 | + * |
|
| 1135 | + * @return float |
|
| 1136 | + * @throws EE_Error |
|
| 1137 | + */ |
|
| 1138 | + public function recalculate_taxes_and_tax_total() |
|
| 1139 | + { |
|
| 1140 | + // get all taxes |
|
| 1141 | + $taxes = $this->tax_descendants(); |
|
| 1142 | + // calculate the pretax total |
|
| 1143 | + $taxable_total = $this->taxable_total(); |
|
| 1144 | + $tax_total = 0; |
|
| 1145 | + foreach ($taxes as $tax) { |
|
| 1146 | + $total_on_this_tax = $taxable_total * $tax->percent() / 100; |
|
| 1147 | + // remember the total on this line item |
|
| 1148 | + $tax->set_total($total_on_this_tax); |
|
| 1149 | + $tax->maybe_save(); |
|
| 1150 | + $tax_total += $tax->total(); |
|
| 1151 | + } |
|
| 1152 | + $this->_recalculate_tax_sub_total(); |
|
| 1153 | + return $tax_total; |
|
| 1154 | + } |
|
| 1155 | + |
|
| 1156 | + |
|
| 1157 | + /** |
|
| 1158 | + * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated |
|
| 1159 | + * |
|
| 1160 | + * @return void |
|
| 1161 | + * @throws EE_Error |
|
| 1162 | + */ |
|
| 1163 | + private function _recalculate_tax_sub_total() |
|
| 1164 | + { |
|
| 1165 | + if ($this->is_tax_sub_total()) { |
|
| 1166 | + $total = 0; |
|
| 1167 | + $total_percent = 0; |
|
| 1168 | + // simply loop through all its children (which should be taxes) and sum their total |
|
| 1169 | + foreach ($this->children() as $child_tax) { |
|
| 1170 | + if ($child_tax instanceof EE_Line_Item) { |
|
| 1171 | + $total += $child_tax->total(); |
|
| 1172 | + $total_percent += $child_tax->percent(); |
|
| 1173 | + } |
|
| 1174 | + } |
|
| 1175 | + $this->set_total($total); |
|
| 1176 | + $this->set_percent($total_percent); |
|
| 1177 | + $this->maybe_save(); |
|
| 1178 | + } elseif ($this->is_total()) { |
|
| 1179 | + foreach ($this->children() as $maybe_tax_subtotal) { |
|
| 1180 | + if ($maybe_tax_subtotal instanceof EE_Line_Item) { |
|
| 1181 | + $maybe_tax_subtotal->_recalculate_tax_sub_total(); |
|
| 1182 | + } |
|
| 1183 | + } |
|
| 1184 | + } |
|
| 1185 | + } |
|
| 1186 | + |
|
| 1187 | + |
|
| 1188 | + /** |
|
| 1189 | + * Gets the total tax on this line item. Assumes taxes have already been calculated using |
|
| 1190 | + * recalculate_taxes_and_total |
|
| 1191 | + * |
|
| 1192 | + * @return float |
|
| 1193 | + * @throws EE_Error |
|
| 1194 | + */ |
|
| 1195 | + public function get_total_tax() |
|
| 1196 | + { |
|
| 1197 | + $this->_recalculate_tax_sub_total(); |
|
| 1198 | + $total = 0; |
|
| 1199 | + foreach ($this->tax_descendants() as $tax_line_item) { |
|
| 1200 | + if ($tax_line_item instanceof EE_Line_Item) { |
|
| 1201 | + $total += $tax_line_item->total(); |
|
| 1202 | + } |
|
| 1203 | + } |
|
| 1204 | + return $total; |
|
| 1205 | + } |
|
| 1206 | + |
|
| 1207 | + |
|
| 1208 | + /** |
|
| 1209 | + * Gets the total for all the items purchased only |
|
| 1210 | + * |
|
| 1211 | + * @return float |
|
| 1212 | + * @throws EE_Error |
|
| 1213 | + */ |
|
| 1214 | + public function get_items_total() |
|
| 1215 | + { |
|
| 1216 | + // by default, let's make sure we're consistent with the existing line item |
|
| 1217 | + if ($this->is_total()) { |
|
| 1218 | + $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this); |
|
| 1219 | + if ($pretax_subtotal_li instanceof EE_Line_Item) { |
|
| 1220 | + return $pretax_subtotal_li->total(); |
|
| 1221 | + } |
|
| 1222 | + } |
|
| 1223 | + $total = 0; |
|
| 1224 | + foreach ($this->get_items() as $item) { |
|
| 1225 | + if ($item instanceof EE_Line_Item) { |
|
| 1226 | + $total += $item->total(); |
|
| 1227 | + } |
|
| 1228 | + } |
|
| 1229 | + return $total; |
|
| 1230 | + } |
|
| 1231 | + |
|
| 1232 | + |
|
| 1233 | + /** |
|
| 1234 | + * Gets all the descendants (ie, children or children of children etc) that |
|
| 1235 | + * are of the type 'tax' |
|
| 1236 | + * |
|
| 1237 | + * @return EE_Line_Item[] |
|
| 1238 | + */ |
|
| 1239 | + public function tax_descendants() |
|
| 1240 | + { |
|
| 1241 | + return EEH_Line_Item::get_tax_descendants($this); |
|
| 1242 | + } |
|
| 1243 | + |
|
| 1244 | + |
|
| 1245 | + /** |
|
| 1246 | + * Gets all the real items purchased which are children of this item |
|
| 1247 | + * |
|
| 1248 | + * @return EE_Line_Item[] |
|
| 1249 | + */ |
|
| 1250 | + public function get_items() |
|
| 1251 | + { |
|
| 1252 | + return EEH_Line_Item::get_line_item_descendants($this); |
|
| 1253 | + } |
|
| 1254 | + |
|
| 1255 | + |
|
| 1256 | + /** |
|
| 1257 | + * Returns the amount taxable among this line item's children (or if it has no children, |
|
| 1258 | + * how much of it is taxable). Does not recalculate totals or subtotals. |
|
| 1259 | + * If the taxable total is negative, (eg, if none of the tickets were taxable, |
|
| 1260 | + * but there is a "Taxable" discount), returns 0. |
|
| 1261 | + * |
|
| 1262 | + * @return float |
|
| 1263 | + * @throws EE_Error |
|
| 1264 | + */ |
|
| 1265 | + public function taxable_total() |
|
| 1266 | + { |
|
| 1267 | + $total = 0; |
|
| 1268 | + if ($this->children()) { |
|
| 1269 | + foreach ($this->children() as $child_line_item) { |
|
| 1270 | + if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) { |
|
| 1271 | + // if it's a percent item, only take into account the percent |
|
| 1272 | + // that's taxable too (the taxable total so far) |
|
| 1273 | + if ($child_line_item->is_percent()) { |
|
| 1274 | + $total += ($total * $child_line_item->percent() / 100); |
|
| 1275 | + } else { |
|
| 1276 | + $total += $child_line_item->total(); |
|
| 1277 | + } |
|
| 1278 | + } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) { |
|
| 1279 | + $total += $child_line_item->taxable_total(); |
|
| 1280 | + } |
|
| 1281 | + } |
|
| 1282 | + } |
|
| 1283 | + return max($total, 0); |
|
| 1284 | + } |
|
| 1285 | + |
|
| 1286 | + |
|
| 1287 | + /** |
|
| 1288 | + * Gets the transaction for this line item |
|
| 1289 | + * |
|
| 1290 | + * @return EE_Base_Class|EE_Transaction |
|
| 1291 | + * @throws EE_Error |
|
| 1292 | + */ |
|
| 1293 | + public function transaction() |
|
| 1294 | + { |
|
| 1295 | + return $this->get_first_related('Transaction'); |
|
| 1296 | + } |
|
| 1297 | + |
|
| 1298 | + |
|
| 1299 | + /** |
|
| 1300 | + * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1301 | + * Because there currently is no proper parent-child relation on the model, |
|
| 1302 | + * save_this_and_cached() will NOT save the descendants. |
|
| 1303 | + * Also sets the transaction on this line item and all its descendants before saving |
|
| 1304 | + * |
|
| 1305 | + * @param int $txn_id if none is provided, assumes $this->TXN_ID() |
|
| 1306 | + * @return int count of items saved |
|
| 1307 | + * @throws EE_Error |
|
| 1308 | + */ |
|
| 1309 | + public function save_this_and_descendants_to_txn($txn_id = null) |
|
| 1310 | + { |
|
| 1311 | + $count = 0; |
|
| 1312 | + if (! $txn_id) { |
|
| 1313 | + $txn_id = $this->TXN_ID(); |
|
| 1314 | + } |
|
| 1315 | + $this->set_TXN_ID($txn_id); |
|
| 1316 | + $children = $this->children(); |
|
| 1317 | + $count += $this->save() |
|
| 1318 | + ? 1 |
|
| 1319 | + : 0; |
|
| 1320 | + foreach ($children as $child_line_item) { |
|
| 1321 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1322 | + $child_line_item->set_parent_ID($this->ID()); |
|
| 1323 | + $count += $child_line_item->save_this_and_descendants_to_txn($txn_id); |
|
| 1324 | + } |
|
| 1325 | + } |
|
| 1326 | + return $count; |
|
| 1327 | + } |
|
| 1328 | + |
|
| 1329 | + |
|
| 1330 | + /** |
|
| 1331 | + * Saves this line item to the DB, and recursively saves its descendants. |
|
| 1332 | + * |
|
| 1333 | + * @return int count of items saved |
|
| 1334 | + * @throws EE_Error |
|
| 1335 | + */ |
|
| 1336 | + public function save_this_and_descendants() |
|
| 1337 | + { |
|
| 1338 | + $count = 0; |
|
| 1339 | + $children = $this->children(); |
|
| 1340 | + $count += $this->save() |
|
| 1341 | + ? 1 |
|
| 1342 | + : 0; |
|
| 1343 | + foreach ($children as $child_line_item) { |
|
| 1344 | + if ($child_line_item instanceof EE_Line_Item) { |
|
| 1345 | + $child_line_item->set_parent_ID($this->ID()); |
|
| 1346 | + $count += $child_line_item->save_this_and_descendants(); |
|
| 1347 | + } |
|
| 1348 | + } |
|
| 1349 | + return $count; |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + |
|
| 1353 | + /** |
|
| 1354 | + * returns the cancellation line item if this item was cancelled |
|
| 1355 | + * |
|
| 1356 | + * @return EE_Line_Item[] |
|
| 1357 | + * @throws InvalidArgumentException |
|
| 1358 | + * @throws InvalidInterfaceException |
|
| 1359 | + * @throws InvalidDataTypeException |
|
| 1360 | + * @throws ReflectionException |
|
| 1361 | + * @throws EE_Error |
|
| 1362 | + */ |
|
| 1363 | + public function get_cancellations() |
|
| 1364 | + { |
|
| 1365 | + EE_Registry::instance()->load_helper('Line_Item'); |
|
| 1366 | + return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation); |
|
| 1367 | + } |
|
| 1368 | + |
|
| 1369 | + |
|
| 1370 | + /** |
|
| 1371 | + * If this item has an ID, then this saves it again to update the db |
|
| 1372 | + * |
|
| 1373 | + * @return int count of items saved |
|
| 1374 | + * @throws EE_Error |
|
| 1375 | + */ |
|
| 1376 | + public function maybe_save() |
|
| 1377 | + { |
|
| 1378 | + if ($this->ID()) { |
|
| 1379 | + return $this->save(); |
|
| 1380 | + } |
|
| 1381 | + return false; |
|
| 1382 | + } |
|
| 1383 | + |
|
| 1384 | + |
|
| 1385 | + /** |
|
| 1386 | + * clears the cached children and parent from the line item |
|
| 1387 | + * |
|
| 1388 | + * @return void |
|
| 1389 | + */ |
|
| 1390 | + public function clear_related_line_item_cache() |
|
| 1391 | + { |
|
| 1392 | + $this->_children = array(); |
|
| 1393 | + $this->_parent = null; |
|
| 1394 | + } |
|
| 1395 | + |
|
| 1396 | + |
|
| 1397 | + /** |
|
| 1398 | + * @param bool $raw |
|
| 1399 | + * @return int |
|
| 1400 | + * @throws EE_Error |
|
| 1401 | + */ |
|
| 1402 | + public function timestamp($raw = false) |
|
| 1403 | + { |
|
| 1404 | + return $raw |
|
| 1405 | + ? $this->get_raw('LIN_timestamp') |
|
| 1406 | + : $this->get('LIN_timestamp'); |
|
| 1407 | + } |
|
| 1408 | + |
|
| 1409 | + |
|
| 1410 | + |
|
| 1411 | + |
|
| 1412 | + /************************* DEPRECATED *************************/ |
|
| 1413 | + /** |
|
| 1414 | + * @deprecated 4.6.0 |
|
| 1415 | + * @param string $type one of the constants on EEM_Line_Item |
|
| 1416 | + * @return EE_Line_Item[] |
|
| 1417 | + */ |
|
| 1418 | + protected function _get_descendants_of_type($type) |
|
| 1419 | + { |
|
| 1420 | + EE_Error::doing_it_wrong( |
|
| 1421 | + 'EE_Line_Item::_get_descendants_of_type()', |
|
| 1422 | + __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), |
|
| 1423 | + '4.6.0' |
|
| 1424 | + ); |
|
| 1425 | + return EEH_Line_Item::get_descendants_of_type($this, $type); |
|
| 1426 | + } |
|
| 1427 | + |
|
| 1428 | + |
|
| 1429 | + /** |
|
| 1430 | + * @deprecated 4.6.0 |
|
| 1431 | + * @param string $type like one of the EEM_Line_Item::type_* |
|
| 1432 | + * @return EE_Line_Item |
|
| 1433 | + */ |
|
| 1434 | + public function get_nearest_descendant_of_type($type) |
|
| 1435 | + { |
|
| 1436 | + EE_Error::doing_it_wrong( |
|
| 1437 | + 'EE_Line_Item::get_nearest_descendant_of_type()', |
|
| 1438 | + __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), |
|
| 1439 | + '4.6.0' |
|
| 1440 | + ); |
|
| 1441 | + return EEH_Line_Item::get_nearest_descendant_of_type($this, $type); |
|
| 1442 | + } |
|
| 1443 | 1443 | } |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | protected function __construct($fieldValues = array(), $bydb = false, $timezone = '') |
| 73 | 73 | { |
| 74 | 74 | parent::__construct($fieldValues, $bydb, $timezone); |
| 75 | - if (! $this->get('LIN_code')) { |
|
| 75 | + if ( ! $this->get('LIN_code')) { |
|
| 76 | 76 | $this->set_code($this->generate_code()); |
| 77 | 77 | } |
| 78 | 78 | } |
@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | public function name() |
| 124 | 124 | { |
| 125 | 125 | $name = $this->get('LIN_name'); |
| 126 | - if (! $name) { |
|
| 126 | + if ( ! $name) { |
|
| 127 | 127 | $name = ucwords(str_replace('-', ' ', $this->type())); |
| 128 | 128 | } |
| 129 | 129 | return $name; |
@@ -480,7 +480,7 @@ discard block |
||
| 480 | 480 | ) |
| 481 | 481 | ); |
| 482 | 482 | } |
| 483 | - if (! is_array($this->_children)) { |
|
| 483 | + if ( ! is_array($this->_children)) { |
|
| 484 | 484 | $this->_children = array(); |
| 485 | 485 | } |
| 486 | 486 | return $this->_children; |
@@ -676,7 +676,7 @@ discard block |
||
| 676 | 676 | } |
| 677 | 677 | return $line_item->save(); |
| 678 | 678 | } |
| 679 | - $this->_children[ $line_item->code() ] = $line_item; |
|
| 679 | + $this->_children[$line_item->code()] = $line_item; |
|
| 680 | 680 | if ($line_item->parent() !== $this) { |
| 681 | 681 | $line_item->set_parent($this); |
| 682 | 682 | } |
@@ -696,7 +696,7 @@ discard block |
||
| 696 | 696 | public function set_parent($line_item) |
| 697 | 697 | { |
| 698 | 698 | if ($this->ID()) { |
| 699 | - if (! $line_item->ID()) { |
|
| 699 | + if ( ! $line_item->ID()) { |
|
| 700 | 700 | $line_item->save(); |
| 701 | 701 | } |
| 702 | 702 | $this->set_parent_ID($line_item->ID()); |
@@ -724,8 +724,8 @@ discard block |
||
| 724 | 724 | array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)) |
| 725 | 725 | ); |
| 726 | 726 | } |
| 727 | - return isset($this->_children[ $code ]) |
|
| 728 | - ? $this->_children[ $code ] |
|
| 727 | + return isset($this->_children[$code]) |
|
| 728 | + ? $this->_children[$code] |
|
| 729 | 729 | : null; |
| 730 | 730 | } |
| 731 | 731 | |
@@ -777,8 +777,8 @@ discard block |
||
| 777 | 777 | } |
| 778 | 778 | return $items_deleted; |
| 779 | 779 | } |
| 780 | - if (isset($this->_children[ $code ])) { |
|
| 781 | - unset($this->_children[ $code ]); |
|
| 780 | + if (isset($this->_children[$code])) { |
|
| 781 | + unset($this->_children[$code]); |
|
| 782 | 782 | return 1; |
| 783 | 783 | } |
| 784 | 784 | return 0; |
@@ -811,7 +811,7 @@ discard block |
||
| 811 | 811 | public function generate_code() |
| 812 | 812 | { |
| 813 | 813 | // each line item in the cart requires a unique identifier |
| 814 | - return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime()); |
|
| 814 | + return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime()); |
|
| 815 | 815 | } |
| 816 | 816 | |
| 817 | 817 | |
@@ -974,7 +974,7 @@ discard block |
||
| 974 | 974 | $has_children = ! empty($my_children); |
| 975 | 975 | if ($has_children && $this->is_line_item()) { |
| 976 | 976 | $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children); |
| 977 | - } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 977 | + } elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) { |
|
| 978 | 978 | $total = $this->unit_price() * $this->quantity(); |
| 979 | 979 | } elseif ($this->is_sub_total() || $this->is_total()) { |
| 980 | 980 | $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children); |
@@ -983,18 +983,18 @@ discard block |
||
| 983 | 983 | return 0; |
| 984 | 984 | } |
| 985 | 985 | // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events) |
| 986 | - if (! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 986 | + if ( ! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation() |
|
| 987 | 987 | ) { |
| 988 | 988 | if ($this->OBJ_type() !== 'Event') { |
| 989 | 989 | $this->set_quantity(1); |
| 990 | 990 | } |
| 991 | - if (! $this->is_percent()) { |
|
| 991 | + if ( ! $this->is_percent()) { |
|
| 992 | 992 | $this->set_unit_price($total); |
| 993 | 993 | } |
| 994 | 994 | } |
| 995 | 995 | // we don't want to bother saving grand totals, because that needs to factor in taxes anyways |
| 996 | 996 | // so it ought to be |
| 997 | - if (! $this->is_total()) { |
|
| 997 | + if ( ! $this->is_total()) { |
|
| 998 | 998 | $this->set_total($total); |
| 999 | 999 | // if not a percent line item, make sure we keep the unit price in sync |
| 1000 | 1000 | if ($has_children |
@@ -1309,7 +1309,7 @@ discard block |
||
| 1309 | 1309 | public function save_this_and_descendants_to_txn($txn_id = null) |
| 1310 | 1310 | { |
| 1311 | 1311 | $count = 0; |
| 1312 | - if (! $txn_id) { |
|
| 1312 | + if ( ! $txn_id) { |
|
| 1313 | 1313 | $txn_id = $this->TXN_ID(); |
| 1314 | 1314 | } |
| 1315 | 1315 | $this->set_TXN_ID($txn_id); |