@@ -15,919 +15,919 @@ |
||
| 15 | 15 | class EEM_Event extends EEM_CPT_Base |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
| 20 | - * event |
|
| 21 | - */ |
|
| 22 | - const sold_out = 'sold_out'; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
| 26 | - * date) |
|
| 27 | - */ |
|
| 28 | - const postponed = 'postponed'; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * constant used by status(), indicating that the event will no longer occur |
|
| 32 | - */ |
|
| 33 | - const cancelled = 'cancelled'; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 39 | - protected static $_default_reg_status; |
|
| 40 | - |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * This is the default for the additional limit field. |
|
| 44 | - * @var int |
|
| 45 | - */ |
|
| 46 | - protected static $_default_additional_limit = 10; |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * private instance of the Event object |
|
| 51 | - * |
|
| 52 | - * @var EEM_Event |
|
| 53 | - */ |
|
| 54 | - protected static $_instance; |
|
| 55 | - |
|
| 56 | - |
|
| 57 | - |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
| 61 | - * |
|
| 62 | - * @param string $timezone |
|
| 63 | - * @throws \EE_Error |
|
| 64 | - */ |
|
| 65 | - protected function __construct($timezone = null) |
|
| 66 | - { |
|
| 67 | - EE_Registry::instance()->load_model('Registration'); |
|
| 68 | - $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
| 69 | - $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
| 70 | - // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
| 71 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
| 72 | - // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
| 73 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
| 74 | - // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
| 75 | - // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
| 76 | - $this->_custom_stati = apply_filters( |
|
| 77 | - 'AFEE__EEM_Event__construct___custom_stati', |
|
| 78 | - array( |
|
| 79 | - EEM_Event::cancelled => array( |
|
| 80 | - 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
| 81 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
| 82 | - ), |
|
| 83 | - EEM_Event::postponed => array( |
|
| 84 | - 'label' => esc_html__('Postponed', 'event_espresso'), |
|
| 85 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
| 86 | - ), |
|
| 87 | - EEM_Event::sold_out => array( |
|
| 88 | - 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
| 89 | - 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
| 90 | - ), |
|
| 91 | - ) |
|
| 92 | - ); |
|
| 93 | - self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
| 94 | - : self::$_default_reg_status; |
|
| 95 | - $this->_tables = array( |
|
| 96 | - 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
| 97 | - 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
| 98 | - ); |
|
| 99 | - $this->_fields = array( |
|
| 100 | - 'Event_CPT' => array( |
|
| 101 | - 'EVT_ID' => new EE_Primary_Key_Int_Field( |
|
| 102 | - 'ID', |
|
| 103 | - esc_html__('Post ID for Event', 'event_espresso') |
|
| 104 | - ), |
|
| 105 | - 'EVT_name' => new EE_Plain_Text_Field( |
|
| 106 | - 'post_title', |
|
| 107 | - esc_html__('Event Name', 'event_espresso'), |
|
| 108 | - false, |
|
| 109 | - '' |
|
| 110 | - ), |
|
| 111 | - 'EVT_desc' => new EE_Post_Content_Field( |
|
| 112 | - 'post_content', |
|
| 113 | - esc_html__('Event Description', 'event_espresso'), |
|
| 114 | - false, |
|
| 115 | - '' |
|
| 116 | - ), |
|
| 117 | - 'EVT_slug' => new EE_Slug_Field( |
|
| 118 | - 'post_name', |
|
| 119 | - esc_html__('Event Slug', 'event_espresso'), |
|
| 120 | - false, |
|
| 121 | - '' |
|
| 122 | - ), |
|
| 123 | - 'EVT_created' => new EE_Datetime_Field( |
|
| 124 | - 'post_date', |
|
| 125 | - esc_html__('Date/Time Event Created', 'event_espresso'), |
|
| 126 | - false, |
|
| 127 | - EE_Datetime_Field::now |
|
| 128 | - ), |
|
| 129 | - 'EVT_short_desc' => new EE_Simple_HTML_Field( |
|
| 130 | - 'post_excerpt', |
|
| 131 | - esc_html__('Event Short Description', 'event_espresso'), |
|
| 132 | - false, |
|
| 133 | - '' |
|
| 134 | - ), |
|
| 135 | - 'EVT_modified' => new EE_Datetime_Field( |
|
| 136 | - 'post_modified', |
|
| 137 | - esc_html__('Date/Time Event Modified', 'event_espresso'), |
|
| 138 | - false, |
|
| 139 | - EE_Datetime_Field::now |
|
| 140 | - ), |
|
| 141 | - 'EVT_wp_user' => new EE_WP_User_Field( |
|
| 142 | - 'post_author', |
|
| 143 | - esc_html__('Event Creator ID', 'event_espresso'), |
|
| 144 | - false |
|
| 145 | - ), |
|
| 146 | - 'parent' => new EE_Integer_Field( |
|
| 147 | - 'post_parent', |
|
| 148 | - esc_html__('Event Parent ID', 'event_espresso'), |
|
| 149 | - false, |
|
| 150 | - 0 |
|
| 151 | - ), |
|
| 152 | - 'EVT_order' => new EE_Integer_Field( |
|
| 153 | - 'menu_order', |
|
| 154 | - esc_html__('Event Menu Order', 'event_espresso'), |
|
| 155 | - false, |
|
| 156 | - 1 |
|
| 157 | - ), |
|
| 158 | - 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
| 159 | - // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
| 160 | - 'status' => new EE_WP_Post_Status_Field( |
|
| 161 | - 'post_status', |
|
| 162 | - esc_html__('Event Status', 'event_espresso'), |
|
| 163 | - false, |
|
| 164 | - 'draft', |
|
| 165 | - $this->_custom_stati |
|
| 166 | - ), |
|
| 167 | - 'password' => new EE_Password_Field( |
|
| 168 | - 'post_password', |
|
| 169 | - __('Password', 'event_espresso'), |
|
| 170 | - false, |
|
| 171 | - '', |
|
| 172 | - array( |
|
| 173 | - 'EVT_desc', |
|
| 174 | - 'EVT_short_desc', |
|
| 175 | - 'EVT_display_desc', |
|
| 176 | - 'EVT_display_ticket_selector', |
|
| 177 | - 'EVT_visible_on', |
|
| 178 | - 'EVT_additional_limit', |
|
| 179 | - 'EVT_default_registration_status', |
|
| 180 | - 'EVT_member_only', |
|
| 181 | - 'EVT_phone', |
|
| 182 | - 'EVT_allow_overflow', |
|
| 183 | - 'EVT_timezone_string', |
|
| 184 | - 'EVT_external_URL', |
|
| 185 | - 'EVT_donations' |
|
| 186 | - ) |
|
| 187 | - ) |
|
| 188 | - ), |
|
| 189 | - 'Event_Meta' => array( |
|
| 190 | - 'EVTM_ID' => new EE_DB_Only_Float_Field( |
|
| 191 | - 'EVTM_ID', |
|
| 192 | - esc_html__('Event Meta Row ID', 'event_espresso'), |
|
| 193 | - false |
|
| 194 | - ), |
|
| 195 | - 'EVT_ID_fk' => new EE_DB_Only_Int_Field( |
|
| 196 | - 'EVT_ID', |
|
| 197 | - esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), |
|
| 198 | - false |
|
| 199 | - ), |
|
| 200 | - 'EVT_display_desc' => new EE_Boolean_Field( |
|
| 201 | - 'EVT_display_desc', |
|
| 202 | - esc_html__('Display Description Flag', 'event_espresso'), |
|
| 203 | - false, |
|
| 204 | - true |
|
| 205 | - ), |
|
| 206 | - 'EVT_display_ticket_selector' => new EE_Boolean_Field( |
|
| 207 | - 'EVT_display_ticket_selector', |
|
| 208 | - esc_html__('Display Ticket Selector Flag', 'event_espresso'), |
|
| 209 | - false, |
|
| 210 | - true |
|
| 211 | - ), |
|
| 212 | - 'EVT_visible_on' => new EE_Datetime_Field( |
|
| 213 | - 'EVT_visible_on', |
|
| 214 | - esc_html__('Event Visible Date', 'event_espresso'), |
|
| 215 | - true, |
|
| 216 | - EE_Datetime_Field::now |
|
| 217 | - ), |
|
| 218 | - 'EVT_additional_limit' => new EE_Integer_Field( |
|
| 219 | - 'EVT_additional_limit', |
|
| 220 | - esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
| 221 | - true, |
|
| 222 | - self::$_default_additional_limit |
|
| 223 | - ), |
|
| 224 | - 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
| 225 | - 'EVT_default_registration_status', |
|
| 226 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
| 227 | - false, |
|
| 228 | - EEM_Event::$_default_reg_status, |
|
| 229 | - EEM_Registration::reg_status_array() |
|
| 230 | - ), |
|
| 231 | - 'EVT_member_only' => new EE_Boolean_Field( |
|
| 232 | - 'EVT_member_only', |
|
| 233 | - esc_html__('Member-Only Event Flag', 'event_espresso'), |
|
| 234 | - false, |
|
| 235 | - false |
|
| 236 | - ), |
|
| 237 | - 'EVT_phone' => new EE_Plain_Text_Field( |
|
| 238 | - 'EVT_phone', |
|
| 239 | - esc_html__('Event Phone Number', 'event_espresso'), |
|
| 240 | - false, |
|
| 241 | - '' |
|
| 242 | - ), |
|
| 243 | - 'EVT_allow_overflow' => new EE_Boolean_Field( |
|
| 244 | - 'EVT_allow_overflow', |
|
| 245 | - esc_html__('Allow Overflow on Event', 'event_espresso'), |
|
| 246 | - false, |
|
| 247 | - false |
|
| 248 | - ), |
|
| 249 | - 'EVT_timezone_string' => new EE_Plain_Text_Field( |
|
| 250 | - 'EVT_timezone_string', |
|
| 251 | - esc_html__('Timezone (name) for Event times', 'event_espresso'), |
|
| 252 | - false, |
|
| 253 | - '' |
|
| 254 | - ), |
|
| 255 | - 'EVT_external_URL' => new EE_Plain_Text_Field( |
|
| 256 | - 'EVT_external_URL', |
|
| 257 | - esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), |
|
| 258 | - true |
|
| 259 | - ), |
|
| 260 | - 'EVT_donations' => new EE_Boolean_Field( |
|
| 261 | - 'EVT_donations', |
|
| 262 | - esc_html__('Accept Donations?', 'event_espresso'), |
|
| 263 | - false, |
|
| 264 | - false |
|
| 265 | - ), |
|
| 266 | - ), |
|
| 267 | - ); |
|
| 268 | - $this->_model_relations = array( |
|
| 269 | - 'Registration' => new EE_Has_Many_Relation(), |
|
| 270 | - 'Datetime' => new EE_Has_Many_Relation(), |
|
| 271 | - 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
| 272 | - 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
| 273 | - 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
| 274 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
| 275 | - 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
| 276 | - 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
| 277 | - 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
| 278 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
| 279 | - ); |
|
| 280 | - // this model is generally available for reading |
|
| 281 | - $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
| 282 | - $this->model_chain_to_password = ''; |
|
| 283 | - parent::__construct($timezone); |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * @param string $default_reg_status |
|
| 290 | - */ |
|
| 291 | - public static function set_default_reg_status($default_reg_status) |
|
| 292 | - { |
|
| 293 | - self::$_default_reg_status = $default_reg_status; |
|
| 294 | - // if EEM_Event has already been instantiated, |
|
| 295 | - // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
| 296 | - if (self::$_instance instanceof EEM_Event) { |
|
| 297 | - $default_reg_status = new EE_Enum_Text_Field( |
|
| 298 | - 'EVT_default_registration_status', |
|
| 299 | - esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
| 300 | - false, |
|
| 301 | - $default_reg_status, |
|
| 302 | - EEM_Registration::reg_status_array() |
|
| 303 | - ); |
|
| 304 | - $default_reg_status->_construct_finalize( |
|
| 305 | - 'Event_Meta', |
|
| 306 | - 'EVT_default_registration_status', |
|
| 307 | - 'EEM_Event' |
|
| 308 | - ); |
|
| 309 | - self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
| 310 | - } |
|
| 311 | - } |
|
| 312 | - |
|
| 313 | - |
|
| 314 | - /** |
|
| 315 | - * Used to override the default for the additional limit field. |
|
| 316 | - * @param $additional_limit |
|
| 317 | - */ |
|
| 318 | - public static function set_default_additional_limit($additional_limit) |
|
| 319 | - { |
|
| 320 | - self::$_default_additional_limit = (int) $additional_limit; |
|
| 321 | - if (self::$_instance instanceof EEM_Event) { |
|
| 322 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
| 323 | - 'EVT_additional_limit', |
|
| 324 | - __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
| 325 | - true, |
|
| 326 | - self::$_default_additional_limit |
|
| 327 | - ); |
|
| 328 | - self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
| 329 | - 'Event_Meta', |
|
| 330 | - 'EVT_additional_limit', |
|
| 331 | - 'EEM_Event' |
|
| 332 | - ); |
|
| 333 | - } |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - |
|
| 337 | - /** |
|
| 338 | - * Return what is currently set as the default additional limit for the event. |
|
| 339 | - * @return int |
|
| 340 | - */ |
|
| 341 | - public static function get_default_additional_limit() |
|
| 342 | - { |
|
| 343 | - return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * get_question_groups |
|
| 349 | - * |
|
| 350 | - * @return array |
|
| 351 | - * @throws \EE_Error |
|
| 352 | - */ |
|
| 353 | - public function get_all_question_groups() |
|
| 354 | - { |
|
| 355 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
| 356 | - array( |
|
| 357 | - array('QSG_deleted' => false), |
|
| 358 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
| 359 | - ) |
|
| 360 | - ); |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * get_question_groups |
|
| 367 | - * |
|
| 368 | - * @param int $EVT_ID |
|
| 369 | - * @return array|bool |
|
| 370 | - * @throws \EE_Error |
|
| 371 | - */ |
|
| 372 | - public function get_all_event_question_groups($EVT_ID = 0) |
|
| 373 | - { |
|
| 374 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 375 | - EE_Error::add_error( |
|
| 376 | - esc_html__( |
|
| 377 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
| 378 | - 'event_espresso' |
|
| 379 | - ), |
|
| 380 | - __FILE__, |
|
| 381 | - __FUNCTION__, |
|
| 382 | - __LINE__ |
|
| 383 | - ); |
|
| 384 | - return false; |
|
| 385 | - } |
|
| 386 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
| 387 | - array( |
|
| 388 | - array('EVT_ID' => $EVT_ID), |
|
| 389 | - ) |
|
| 390 | - ); |
|
| 391 | - } |
|
| 392 | - |
|
| 393 | - |
|
| 394 | - /** |
|
| 395 | - * get_question_groups |
|
| 396 | - * |
|
| 397 | - * @param int $EVT_ID |
|
| 398 | - * @param boolean $for_primary_attendee |
|
| 399 | - * @return array|bool |
|
| 400 | - * @throws EE_Error |
|
| 401 | - * @throws InvalidArgumentException |
|
| 402 | - * @throws ReflectionException |
|
| 403 | - * @throws InvalidDataTypeException |
|
| 404 | - * @throws InvalidInterfaceException |
|
| 405 | - */ |
|
| 406 | - public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
| 407 | - { |
|
| 408 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 409 | - EE_Error::add_error( |
|
| 410 | - esc_html__( |
|
| 411 | - // @codingStandardsIgnoreStart |
|
| 412 | - 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
| 413 | - // @codingStandardsIgnoreEnd |
|
| 414 | - 'event_espresso' |
|
| 415 | - ), |
|
| 416 | - __FILE__, |
|
| 417 | - __FUNCTION__, |
|
| 418 | - __LINE__ |
|
| 419 | - ); |
|
| 420 | - return false; |
|
| 421 | - } |
|
| 422 | - $query_params = [ |
|
| 423 | - [ |
|
| 424 | - 'EVT_ID' => $EVT_ID, |
|
| 425 | - EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true |
|
| 426 | - ] |
|
| 427 | - ]; |
|
| 428 | - if ($for_primary_attendee) { |
|
| 429 | - $query_params[0]['EQG_primary'] = true; |
|
| 430 | - } else { |
|
| 431 | - $query_params[0]['EQG_additional'] = true; |
|
| 432 | - } |
|
| 433 | - return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params); |
|
| 434 | - } |
|
| 435 | - |
|
| 436 | - |
|
| 437 | - /** |
|
| 438 | - * get_question_groups |
|
| 439 | - * |
|
| 440 | - * @param int $EVT_ID |
|
| 441 | - * @param EE_Registration $registration |
|
| 442 | - * @return array|bool |
|
| 443 | - * @throws EE_Error |
|
| 444 | - * @throws InvalidArgumentException |
|
| 445 | - * @throws InvalidDataTypeException |
|
| 446 | - * @throws InvalidInterfaceException |
|
| 447 | - * @throws ReflectionException |
|
| 448 | - */ |
|
| 449 | - public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
| 450 | - { |
|
| 451 | - if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 452 | - EE_Error::add_error( |
|
| 453 | - esc_html__( |
|
| 454 | - 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
| 455 | - 'event_espresso' |
|
| 456 | - ), |
|
| 457 | - __FILE__, |
|
| 458 | - __FUNCTION__, |
|
| 459 | - __LINE__ |
|
| 460 | - ); |
|
| 461 | - return false; |
|
| 462 | - } |
|
| 463 | - return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
| 464 | - [ |
|
| 465 | - [ |
|
| 466 | - 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
| 467 | - 'Event_Question_Group.' |
|
| 468 | - . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
| 469 | - $registration->is_primary_registrant() |
|
| 470 | - ) => true |
|
| 471 | - ], |
|
| 472 | - 'order_by' => ['QSG_order' => 'ASC'], |
|
| 473 | - ] |
|
| 474 | - ); |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * get_question_target_db_column |
|
| 481 | - * |
|
| 482 | - * @param string $QSG_IDs csv list of $QSG IDs |
|
| 483 | - * @return array|bool |
|
| 484 | - * @throws \EE_Error |
|
| 485 | - */ |
|
| 486 | - public function get_questions_in_groups($QSG_IDs = '') |
|
| 487 | - { |
|
| 488 | - if (empty($QSG_IDs)) { |
|
| 489 | - EE_Error::add_error( |
|
| 490 | - esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
| 491 | - __FILE__, |
|
| 492 | - __FUNCTION__, |
|
| 493 | - __LINE__ |
|
| 494 | - ); |
|
| 495 | - return false; |
|
| 496 | - } |
|
| 497 | - return EE_Registry::instance()->load_model('Question')->get_all( |
|
| 498 | - array( |
|
| 499 | - array( |
|
| 500 | - 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
| 501 | - 'QST_deleted' => false, |
|
| 502 | - 'QST_admin_only' => is_admin(), |
|
| 503 | - ), |
|
| 504 | - 'order_by' => 'QST_order', |
|
| 505 | - ) |
|
| 506 | - ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - |
|
| 510 | - |
|
| 511 | - /** |
|
| 512 | - * get_options_for_question |
|
| 513 | - * |
|
| 514 | - * @param string $QST_IDs csv list of $QST IDs |
|
| 515 | - * @return array|bool |
|
| 516 | - * @throws \EE_Error |
|
| 517 | - */ |
|
| 518 | - public function get_options_for_question($QST_IDs) |
|
| 519 | - { |
|
| 520 | - if (empty($QST_IDs)) { |
|
| 521 | - EE_Error::add_error( |
|
| 522 | - esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
| 523 | - __FILE__, |
|
| 524 | - __FUNCTION__, |
|
| 525 | - __LINE__ |
|
| 526 | - ); |
|
| 527 | - return false; |
|
| 528 | - } |
|
| 529 | - return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
| 530 | - array( |
|
| 531 | - array( |
|
| 532 | - 'Question.QST_ID' => array('IN', $QST_IDs), |
|
| 533 | - 'QSO_deleted' => false, |
|
| 534 | - ), |
|
| 535 | - 'order_by' => 'QSO_ID', |
|
| 536 | - ) |
|
| 537 | - ); |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - |
|
| 541 | - |
|
| 542 | - |
|
| 543 | - |
|
| 544 | - |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Gets all events that are published |
|
| 548 | - * and have event start time earlier than now and an event end time later than now |
|
| 549 | - * |
|
| 550 | - * @param array $query_params An array of query params to further filter on |
|
| 551 | - * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
| 552 | - * @param bool $count whether to return the count or not (default FALSE) |
|
| 553 | - * @return EE_Event[]|int |
|
| 554 | - * @throws \EE_Error |
|
| 555 | - */ |
|
| 556 | - public function get_active_events($query_params, $count = false) |
|
| 557 | - { |
|
| 558 | - if (array_key_exists(0, $query_params)) { |
|
| 559 | - $where_params = $query_params[0]; |
|
| 560 | - unset($query_params[0]); |
|
| 561 | - } else { |
|
| 562 | - $where_params = array(); |
|
| 563 | - } |
|
| 564 | - // if we have count make sure we don't include group by |
|
| 565 | - if ($count && isset($query_params['group_by'])) { |
|
| 566 | - unset($query_params['group_by']); |
|
| 567 | - } |
|
| 568 | - // let's add specific query_params for active_events |
|
| 569 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
| 570 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
| 571 | - // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
| 572 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 573 | - $where_params['Datetime.DTT_EVT_start******'] = array( |
|
| 574 | - '<', |
|
| 575 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 576 | - ); |
|
| 577 | - } else { |
|
| 578 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
| 579 | - '<', |
|
| 580 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 581 | - ); |
|
| 582 | - } |
|
| 583 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 584 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
| 585 | - '>', |
|
| 586 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 587 | - ); |
|
| 588 | - } else { |
|
| 589 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
| 590 | - '>', |
|
| 591 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 592 | - ); |
|
| 593 | - } |
|
| 594 | - $query_params[0] = $where_params; |
|
| 595 | - // don't use $query_params with count() |
|
| 596 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
| 597 | - return $count |
|
| 598 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 599 | - : $this->get_all($query_params); |
|
| 600 | - } |
|
| 601 | - |
|
| 602 | - |
|
| 603 | - |
|
| 604 | - /** |
|
| 605 | - * get all events that are published and have an event start time later than now |
|
| 606 | - * |
|
| 607 | - * @param array $query_params An array of query params to further filter on |
|
| 608 | - * (Note that status and DTT_EVT_start will be overridden) |
|
| 609 | - * @param bool $count whether to return the count or not (default FALSE) |
|
| 610 | - * @return EE_Event[]|int |
|
| 611 | - * @throws \EE_Error |
|
| 612 | - */ |
|
| 613 | - public function get_upcoming_events($query_params, $count = false) |
|
| 614 | - { |
|
| 615 | - if (array_key_exists(0, $query_params)) { |
|
| 616 | - $where_params = $query_params[0]; |
|
| 617 | - unset($query_params[0]); |
|
| 618 | - } else { |
|
| 619 | - $where_params = array(); |
|
| 620 | - } |
|
| 621 | - // if we have count make sure we don't include group by |
|
| 622 | - if ($count && isset($query_params['group_by'])) { |
|
| 623 | - unset($query_params['group_by']); |
|
| 624 | - } |
|
| 625 | - // let's add specific query_params for active_events |
|
| 626 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
| 627 | - // we need to pull events with a status of publish and sold_out |
|
| 628 | - $event_status = array('publish', EEM_Event::sold_out); |
|
| 629 | - // check if the user can read private events and if so add the 'private status to the were params' |
|
| 630 | - if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) { |
|
| 631 | - $event_status[] = 'private'; |
|
| 632 | - } |
|
| 633 | - $where_params['status'] = array('IN', $event_status); |
|
| 634 | - // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
| 635 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 636 | - $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
| 637 | - '>', |
|
| 638 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 639 | - ); |
|
| 640 | - } else { |
|
| 641 | - $where_params['Datetime.DTT_EVT_start'] = array( |
|
| 642 | - '>', |
|
| 643 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 644 | - ); |
|
| 645 | - } |
|
| 646 | - $query_params[0] = $where_params; |
|
| 647 | - // don't use $query_params with count() |
|
| 648 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
| 649 | - return $count |
|
| 650 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 651 | - : $this->get_all($query_params); |
|
| 652 | - } |
|
| 653 | - |
|
| 654 | - |
|
| 655 | - |
|
| 656 | - /** |
|
| 657 | - * Gets all events that are published |
|
| 658 | - * and have an event end time later than now |
|
| 659 | - * |
|
| 660 | - * @param array $query_params An array of query params to further filter on |
|
| 661 | - * (note that status and DTT_EVT_end will be overridden) |
|
| 662 | - * @param bool $count whether to return the count or not (default FALSE) |
|
| 663 | - * @return EE_Event[]|int |
|
| 664 | - * @throws \EE_Error |
|
| 665 | - */ |
|
| 666 | - public function get_active_and_upcoming_events($query_params, $count = false) |
|
| 667 | - { |
|
| 668 | - if (array_key_exists(0, $query_params)) { |
|
| 669 | - $where_params = $query_params[0]; |
|
| 670 | - unset($query_params[0]); |
|
| 671 | - } else { |
|
| 672 | - $where_params = array(); |
|
| 673 | - } |
|
| 674 | - // if we have count make sure we don't include group by |
|
| 675 | - if ($count && isset($query_params['group_by'])) { |
|
| 676 | - unset($query_params['group_by']); |
|
| 677 | - } |
|
| 678 | - // let's add specific query_params for active_events |
|
| 679 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
| 680 | - $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
| 681 | - // add where params for DTT_EVT_end |
|
| 682 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 683 | - $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
| 684 | - '>', |
|
| 685 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 686 | - ); |
|
| 687 | - } else { |
|
| 688 | - $where_params['Datetime.DTT_EVT_end'] = array( |
|
| 689 | - '>', |
|
| 690 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 691 | - ); |
|
| 692 | - } |
|
| 693 | - $query_params[0] = $where_params; |
|
| 694 | - // don't use $query_params with count() |
|
| 695 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
| 696 | - return $count |
|
| 697 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 698 | - : $this->get_all($query_params); |
|
| 699 | - } |
|
| 700 | - |
|
| 701 | - |
|
| 702 | - |
|
| 703 | - /** |
|
| 704 | - * This only returns events that are expired. |
|
| 705 | - * They may still be published but all their datetimes have expired. |
|
| 706 | - * |
|
| 707 | - * @param array $query_params An array of query params to further filter on |
|
| 708 | - * (note that status and DTT_EVT_end will be overridden) |
|
| 709 | - * @param bool $count whether to return the count or not (default FALSE) |
|
| 710 | - * @return EE_Event[]|int |
|
| 711 | - * @throws \EE_Error |
|
| 712 | - */ |
|
| 713 | - public function get_expired_events($query_params, $count = false) |
|
| 714 | - { |
|
| 715 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
| 716 | - // if we have count make sure we don't include group by |
|
| 717 | - if ($count && isset($query_params['group_by'])) { |
|
| 718 | - unset($query_params['group_by']); |
|
| 719 | - } |
|
| 720 | - // let's add specific query_params for active_events |
|
| 721 | - // keep in mind this will override any sent status in the query AND any date queries. |
|
| 722 | - if (isset($where_params['status'])) { |
|
| 723 | - unset($where_params['status']); |
|
| 724 | - } |
|
| 725 | - $exclude_query = $query_params; |
|
| 726 | - if (isset($exclude_query[0])) { |
|
| 727 | - unset($exclude_query[0]); |
|
| 728 | - } |
|
| 729 | - $exclude_query[0] = array( |
|
| 730 | - 'Datetime.DTT_EVT_end' => array( |
|
| 731 | - '>', |
|
| 732 | - EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 733 | - ), |
|
| 734 | - ); |
|
| 735 | - // first get all events that have datetimes where its not expired. |
|
| 736 | - $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
| 737 | - $event_ids = array_keys($event_ids); |
|
| 738 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
| 739 | - $and_condition = array( |
|
| 740 | - 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
| 741 | - 'EVT_ID' => array('NOT IN', $event_ids), |
|
| 742 | - ); |
|
| 743 | - if (isset($where_params['OR'])) { |
|
| 744 | - $and_condition['OR'] = $where_params['OR']; |
|
| 745 | - unset($where_params['OR']); |
|
| 746 | - } |
|
| 747 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 748 | - $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
| 749 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
| 750 | - } |
|
| 751 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 752 | - $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
| 753 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
| 754 | - } |
|
| 755 | - // merge remaining $where params with the and conditions. |
|
| 756 | - $where_params['AND'] = array_merge($and_condition, $where_params); |
|
| 757 | - $query_params[0] = $where_params; |
|
| 758 | - // don't use $query_params with count() |
|
| 759 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
| 760 | - return $count |
|
| 761 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 762 | - : $this->get_all($query_params); |
|
| 763 | - } |
|
| 764 | - |
|
| 765 | - |
|
| 766 | - |
|
| 767 | - /** |
|
| 768 | - * This basically just returns the events that do not have the publish status. |
|
| 769 | - * |
|
| 770 | - * @param array $query_params An array of query params to further filter on |
|
| 771 | - * (note that status will be overwritten) |
|
| 772 | - * @param boolean $count whether to return the count or not (default FALSE) |
|
| 773 | - * @return EE_Event[]|int |
|
| 774 | - * @throws \EE_Error |
|
| 775 | - */ |
|
| 776 | - public function get_inactive_events($query_params, $count = false) |
|
| 777 | - { |
|
| 778 | - $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
| 779 | - // let's add in specific query_params for inactive events. |
|
| 780 | - if (isset($where_params['status'])) { |
|
| 781 | - unset($where_params['status']); |
|
| 782 | - } |
|
| 783 | - // if we have count make sure we don't include group by |
|
| 784 | - if ($count && isset($query_params['group_by'])) { |
|
| 785 | - unset($query_params['group_by']); |
|
| 786 | - } |
|
| 787 | - // if we have any additional query_params, let's add them to the 'AND' condition |
|
| 788 | - $where_params['AND']['status'] = array('!=', 'publish'); |
|
| 789 | - if (isset($where_params['OR'])) { |
|
| 790 | - $where_params['AND']['OR'] = $where_params['OR']; |
|
| 791 | - unset($where_params['OR']); |
|
| 792 | - } |
|
| 793 | - if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 794 | - $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
| 795 | - unset($where_params['Datetime.DTT_EVT_end']); |
|
| 796 | - } |
|
| 797 | - if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 798 | - $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
| 799 | - unset($where_params['Datetime.DTT_EVT_start']); |
|
| 800 | - } |
|
| 801 | - $query_params[0] = $where_params; |
|
| 802 | - // don't use $query_params with count() |
|
| 803 | - // because we don't want to include additional query clauses like "GROUP BY" |
|
| 804 | - return $count |
|
| 805 | - ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 806 | - : $this->get_all($query_params); |
|
| 807 | - } |
|
| 808 | - |
|
| 809 | - |
|
| 810 | - |
|
| 811 | - /** |
|
| 812 | - * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
| 813 | - * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
| 814 | - * attached to the event. See parent for param descriptions |
|
| 815 | - * |
|
| 816 | - * @param $id_or_obj |
|
| 817 | - * @param $other_model_id_or_obj |
|
| 818 | - * @param string $relationName |
|
| 819 | - * @param array $where_query |
|
| 820 | - * @return EE_Base_Class |
|
| 821 | - * @throws EE_Error |
|
| 822 | - */ |
|
| 823 | - public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
| 824 | - { |
|
| 825 | - if ($relationName === 'Price') { |
|
| 826 | - // let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
| 827 | - $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
| 828 | - // if EVT_ID = 0, then this is a default |
|
| 829 | - if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
| 830 | - // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
| 831 | - $prc_chk->set('PRC_ID', 0); |
|
| 832 | - } |
|
| 833 | - // run parent |
|
| 834 | - return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
| 835 | - } |
|
| 836 | - // otherwise carry on as normal |
|
| 837 | - return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
| 838 | - } |
|
| 839 | - |
|
| 840 | - |
|
| 841 | - |
|
| 842 | - /******************** DEPRECATED METHODS ********************/ |
|
| 843 | - |
|
| 844 | - |
|
| 845 | - |
|
| 846 | - /** |
|
| 847 | - * _get_question_target_db_column |
|
| 848 | - * |
|
| 849 | - * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
| 850 | - * EE_Registration_Custom_Questions_Form located in |
|
| 851 | - * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
| 852 | - * @access public |
|
| 853 | - * @param EE_Registration $registration (so existing answers for registration are included) |
|
| 854 | - * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
| 855 | - * registration). |
|
| 856 | - * @throws EE_Error |
|
| 857 | - * @return array |
|
| 858 | - */ |
|
| 859 | - public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
| 860 | - { |
|
| 861 | - if (empty($EVT_ID)) { |
|
| 862 | - throw new EE_Error(__( |
|
| 863 | - 'An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
| 864 | - 'event_espresso' |
|
| 865 | - )); |
|
| 866 | - } |
|
| 867 | - $questions = array(); |
|
| 868 | - // get all question groups for event |
|
| 869 | - $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
| 870 | - if (! empty($qgs)) { |
|
| 871 | - foreach ($qgs as $qg) { |
|
| 872 | - $qsts = $qg->questions(); |
|
| 873 | - $questions[ $qg->ID() ] = $qg->model_field_array(); |
|
| 874 | - $questions[ $qg->ID() ]['QSG_questions'] = array(); |
|
| 875 | - foreach ($qsts as $qst) { |
|
| 876 | - if ($qst->is_system_question()) { |
|
| 877 | - continue; |
|
| 878 | - } |
|
| 879 | - $answer = EEM_Answer::instance()->get_one(array( |
|
| 880 | - array( |
|
| 881 | - 'QST_ID' => $qst->ID(), |
|
| 882 | - 'REG_ID' => $registration->ID(), |
|
| 883 | - ), |
|
| 884 | - )); |
|
| 885 | - $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
| 886 | - $qst_name = $qstn_id = $qst->ID(); |
|
| 887 | - $ans_id = $answer->ID(); |
|
| 888 | - $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
| 889 | - $input_name = ''; |
|
| 890 | - $input_id = sanitize_key($qst->display_text()); |
|
| 891 | - $input_class = ''; |
|
| 892 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array(); |
|
| 893 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn' |
|
| 894 | - . $input_name |
|
| 895 | - . $qst_name; |
|
| 896 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
| 897 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class; |
|
| 898 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array(); |
|
| 899 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst; |
|
| 900 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer; |
|
| 901 | - // leave responses as-is, don't convert stuff into html entities please! |
|
| 902 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false; |
|
| 903 | - if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
| 904 | - $QSOs = $qst->options(true, $answer->value()); |
|
| 905 | - if (is_array($QSOs)) { |
|
| 906 | - foreach ($QSOs as $QSO_ID => $QSO) { |
|
| 907 | - $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array(); |
|
| 908 | - } |
|
| 909 | - } |
|
| 910 | - } |
|
| 911 | - } |
|
| 912 | - } |
|
| 913 | - } |
|
| 914 | - return $questions; |
|
| 915 | - } |
|
| 916 | - |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value |
|
| 920 | - * or an stdClass where each property is the name of a column, |
|
| 921 | - * @return EE_Base_Class |
|
| 922 | - * @throws \EE_Error |
|
| 923 | - */ |
|
| 924 | - public function instantiate_class_from_array_or_object($cols_n_values) |
|
| 925 | - { |
|
| 926 | - $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values); |
|
| 927 | - if ($classInstance instanceof EE_Event) { |
|
| 928 | - // events have their timezone defined in the DB, so use it immediately |
|
| 929 | - $this->set_timezone($classInstance->get_timezone()); |
|
| 930 | - } |
|
| 931 | - return $classInstance; |
|
| 932 | - } |
|
| 18 | + /** |
|
| 19 | + * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the |
|
| 20 | + * event |
|
| 21 | + */ |
|
| 22 | + const sold_out = 'sold_out'; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later |
|
| 26 | + * date) |
|
| 27 | + */ |
|
| 28 | + const postponed = 'postponed'; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * constant used by status(), indicating that the event will no longer occur |
|
| 32 | + */ |
|
| 33 | + const cancelled = 'cancelled'; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | + protected static $_default_reg_status; |
|
| 40 | + |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * This is the default for the additional limit field. |
|
| 44 | + * @var int |
|
| 45 | + */ |
|
| 46 | + protected static $_default_additional_limit = 10; |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * private instance of the Event object |
|
| 51 | + * |
|
| 52 | + * @var EEM_Event |
|
| 53 | + */ |
|
| 54 | + protected static $_instance; |
|
| 55 | + |
|
| 56 | + |
|
| 57 | + |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Adds a relationship to Term_Taxonomy for each CPT_Base |
|
| 61 | + * |
|
| 62 | + * @param string $timezone |
|
| 63 | + * @throws \EE_Error |
|
| 64 | + */ |
|
| 65 | + protected function __construct($timezone = null) |
|
| 66 | + { |
|
| 67 | + EE_Registry::instance()->load_model('Registration'); |
|
| 68 | + $this->singular_item = esc_html__('Event', 'event_espresso'); |
|
| 69 | + $this->plural_item = esc_html__('Events', 'event_espresso'); |
|
| 70 | + // to remove Cancelled events from the frontend, copy the following filter to your functions.php file |
|
| 71 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' ); |
|
| 72 | + // to remove Postponed events from the frontend, copy the following filter to your functions.php file |
|
| 73 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' ); |
|
| 74 | + // to remove Sold Out events from the frontend, copy the following filter to your functions.php file |
|
| 75 | + // add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' ); |
|
| 76 | + $this->_custom_stati = apply_filters( |
|
| 77 | + 'AFEE__EEM_Event__construct___custom_stati', |
|
| 78 | + array( |
|
| 79 | + EEM_Event::cancelled => array( |
|
| 80 | + 'label' => esc_html__('Cancelled', 'event_espresso'), |
|
| 81 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true), |
|
| 82 | + ), |
|
| 83 | + EEM_Event::postponed => array( |
|
| 84 | + 'label' => esc_html__('Postponed', 'event_espresso'), |
|
| 85 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true), |
|
| 86 | + ), |
|
| 87 | + EEM_Event::sold_out => array( |
|
| 88 | + 'label' => esc_html__('Sold Out', 'event_espresso'), |
|
| 89 | + 'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true), |
|
| 90 | + ), |
|
| 91 | + ) |
|
| 92 | + ); |
|
| 93 | + self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment |
|
| 94 | + : self::$_default_reg_status; |
|
| 95 | + $this->_tables = array( |
|
| 96 | + 'Event_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
| 97 | + 'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'), |
|
| 98 | + ); |
|
| 99 | + $this->_fields = array( |
|
| 100 | + 'Event_CPT' => array( |
|
| 101 | + 'EVT_ID' => new EE_Primary_Key_Int_Field( |
|
| 102 | + 'ID', |
|
| 103 | + esc_html__('Post ID for Event', 'event_espresso') |
|
| 104 | + ), |
|
| 105 | + 'EVT_name' => new EE_Plain_Text_Field( |
|
| 106 | + 'post_title', |
|
| 107 | + esc_html__('Event Name', 'event_espresso'), |
|
| 108 | + false, |
|
| 109 | + '' |
|
| 110 | + ), |
|
| 111 | + 'EVT_desc' => new EE_Post_Content_Field( |
|
| 112 | + 'post_content', |
|
| 113 | + esc_html__('Event Description', 'event_espresso'), |
|
| 114 | + false, |
|
| 115 | + '' |
|
| 116 | + ), |
|
| 117 | + 'EVT_slug' => new EE_Slug_Field( |
|
| 118 | + 'post_name', |
|
| 119 | + esc_html__('Event Slug', 'event_espresso'), |
|
| 120 | + false, |
|
| 121 | + '' |
|
| 122 | + ), |
|
| 123 | + 'EVT_created' => new EE_Datetime_Field( |
|
| 124 | + 'post_date', |
|
| 125 | + esc_html__('Date/Time Event Created', 'event_espresso'), |
|
| 126 | + false, |
|
| 127 | + EE_Datetime_Field::now |
|
| 128 | + ), |
|
| 129 | + 'EVT_short_desc' => new EE_Simple_HTML_Field( |
|
| 130 | + 'post_excerpt', |
|
| 131 | + esc_html__('Event Short Description', 'event_espresso'), |
|
| 132 | + false, |
|
| 133 | + '' |
|
| 134 | + ), |
|
| 135 | + 'EVT_modified' => new EE_Datetime_Field( |
|
| 136 | + 'post_modified', |
|
| 137 | + esc_html__('Date/Time Event Modified', 'event_espresso'), |
|
| 138 | + false, |
|
| 139 | + EE_Datetime_Field::now |
|
| 140 | + ), |
|
| 141 | + 'EVT_wp_user' => new EE_WP_User_Field( |
|
| 142 | + 'post_author', |
|
| 143 | + esc_html__('Event Creator ID', 'event_espresso'), |
|
| 144 | + false |
|
| 145 | + ), |
|
| 146 | + 'parent' => new EE_Integer_Field( |
|
| 147 | + 'post_parent', |
|
| 148 | + esc_html__('Event Parent ID', 'event_espresso'), |
|
| 149 | + false, |
|
| 150 | + 0 |
|
| 151 | + ), |
|
| 152 | + 'EVT_order' => new EE_Integer_Field( |
|
| 153 | + 'menu_order', |
|
| 154 | + esc_html__('Event Menu Order', 'event_espresso'), |
|
| 155 | + false, |
|
| 156 | + 1 |
|
| 157 | + ), |
|
| 158 | + 'post_type' => new EE_WP_Post_Type_Field('espresso_events'), |
|
| 159 | + // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ), |
|
| 160 | + 'status' => new EE_WP_Post_Status_Field( |
|
| 161 | + 'post_status', |
|
| 162 | + esc_html__('Event Status', 'event_espresso'), |
|
| 163 | + false, |
|
| 164 | + 'draft', |
|
| 165 | + $this->_custom_stati |
|
| 166 | + ), |
|
| 167 | + 'password' => new EE_Password_Field( |
|
| 168 | + 'post_password', |
|
| 169 | + __('Password', 'event_espresso'), |
|
| 170 | + false, |
|
| 171 | + '', |
|
| 172 | + array( |
|
| 173 | + 'EVT_desc', |
|
| 174 | + 'EVT_short_desc', |
|
| 175 | + 'EVT_display_desc', |
|
| 176 | + 'EVT_display_ticket_selector', |
|
| 177 | + 'EVT_visible_on', |
|
| 178 | + 'EVT_additional_limit', |
|
| 179 | + 'EVT_default_registration_status', |
|
| 180 | + 'EVT_member_only', |
|
| 181 | + 'EVT_phone', |
|
| 182 | + 'EVT_allow_overflow', |
|
| 183 | + 'EVT_timezone_string', |
|
| 184 | + 'EVT_external_URL', |
|
| 185 | + 'EVT_donations' |
|
| 186 | + ) |
|
| 187 | + ) |
|
| 188 | + ), |
|
| 189 | + 'Event_Meta' => array( |
|
| 190 | + 'EVTM_ID' => new EE_DB_Only_Float_Field( |
|
| 191 | + 'EVTM_ID', |
|
| 192 | + esc_html__('Event Meta Row ID', 'event_espresso'), |
|
| 193 | + false |
|
| 194 | + ), |
|
| 195 | + 'EVT_ID_fk' => new EE_DB_Only_Int_Field( |
|
| 196 | + 'EVT_ID', |
|
| 197 | + esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), |
|
| 198 | + false |
|
| 199 | + ), |
|
| 200 | + 'EVT_display_desc' => new EE_Boolean_Field( |
|
| 201 | + 'EVT_display_desc', |
|
| 202 | + esc_html__('Display Description Flag', 'event_espresso'), |
|
| 203 | + false, |
|
| 204 | + true |
|
| 205 | + ), |
|
| 206 | + 'EVT_display_ticket_selector' => new EE_Boolean_Field( |
|
| 207 | + 'EVT_display_ticket_selector', |
|
| 208 | + esc_html__('Display Ticket Selector Flag', 'event_espresso'), |
|
| 209 | + false, |
|
| 210 | + true |
|
| 211 | + ), |
|
| 212 | + 'EVT_visible_on' => new EE_Datetime_Field( |
|
| 213 | + 'EVT_visible_on', |
|
| 214 | + esc_html__('Event Visible Date', 'event_espresso'), |
|
| 215 | + true, |
|
| 216 | + EE_Datetime_Field::now |
|
| 217 | + ), |
|
| 218 | + 'EVT_additional_limit' => new EE_Integer_Field( |
|
| 219 | + 'EVT_additional_limit', |
|
| 220 | + esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
| 221 | + true, |
|
| 222 | + self::$_default_additional_limit |
|
| 223 | + ), |
|
| 224 | + 'EVT_default_registration_status' => new EE_Enum_Text_Field( |
|
| 225 | + 'EVT_default_registration_status', |
|
| 226 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
| 227 | + false, |
|
| 228 | + EEM_Event::$_default_reg_status, |
|
| 229 | + EEM_Registration::reg_status_array() |
|
| 230 | + ), |
|
| 231 | + 'EVT_member_only' => new EE_Boolean_Field( |
|
| 232 | + 'EVT_member_only', |
|
| 233 | + esc_html__('Member-Only Event Flag', 'event_espresso'), |
|
| 234 | + false, |
|
| 235 | + false |
|
| 236 | + ), |
|
| 237 | + 'EVT_phone' => new EE_Plain_Text_Field( |
|
| 238 | + 'EVT_phone', |
|
| 239 | + esc_html__('Event Phone Number', 'event_espresso'), |
|
| 240 | + false, |
|
| 241 | + '' |
|
| 242 | + ), |
|
| 243 | + 'EVT_allow_overflow' => new EE_Boolean_Field( |
|
| 244 | + 'EVT_allow_overflow', |
|
| 245 | + esc_html__('Allow Overflow on Event', 'event_espresso'), |
|
| 246 | + false, |
|
| 247 | + false |
|
| 248 | + ), |
|
| 249 | + 'EVT_timezone_string' => new EE_Plain_Text_Field( |
|
| 250 | + 'EVT_timezone_string', |
|
| 251 | + esc_html__('Timezone (name) for Event times', 'event_espresso'), |
|
| 252 | + false, |
|
| 253 | + '' |
|
| 254 | + ), |
|
| 255 | + 'EVT_external_URL' => new EE_Plain_Text_Field( |
|
| 256 | + 'EVT_external_URL', |
|
| 257 | + esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), |
|
| 258 | + true |
|
| 259 | + ), |
|
| 260 | + 'EVT_donations' => new EE_Boolean_Field( |
|
| 261 | + 'EVT_donations', |
|
| 262 | + esc_html__('Accept Donations?', 'event_espresso'), |
|
| 263 | + false, |
|
| 264 | + false |
|
| 265 | + ), |
|
| 266 | + ), |
|
| 267 | + ); |
|
| 268 | + $this->_model_relations = array( |
|
| 269 | + 'Registration' => new EE_Has_Many_Relation(), |
|
| 270 | + 'Datetime' => new EE_Has_Many_Relation(), |
|
| 271 | + 'Question_Group' => new EE_HABTM_Relation('Event_Question_Group'), |
|
| 272 | + 'Event_Question_Group' => new EE_Has_Many_Relation(), |
|
| 273 | + 'Venue' => new EE_HABTM_Relation('Event_Venue'), |
|
| 274 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
| 275 | + 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
| 276 | + 'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'), |
|
| 277 | + 'Attendee' => new EE_HABTM_Relation('Registration'), |
|
| 278 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
| 279 | + ); |
|
| 280 | + // this model is generally available for reading |
|
| 281 | + $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public(); |
|
| 282 | + $this->model_chain_to_password = ''; |
|
| 283 | + parent::__construct($timezone); |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * @param string $default_reg_status |
|
| 290 | + */ |
|
| 291 | + public static function set_default_reg_status($default_reg_status) |
|
| 292 | + { |
|
| 293 | + self::$_default_reg_status = $default_reg_status; |
|
| 294 | + // if EEM_Event has already been instantiated, |
|
| 295 | + // then we need to reset the `EVT_default_reg_status` field to use the new default. |
|
| 296 | + if (self::$_instance instanceof EEM_Event) { |
|
| 297 | + $default_reg_status = new EE_Enum_Text_Field( |
|
| 298 | + 'EVT_default_registration_status', |
|
| 299 | + esc_html__('Default Registration Status on this Event', 'event_espresso'), |
|
| 300 | + false, |
|
| 301 | + $default_reg_status, |
|
| 302 | + EEM_Registration::reg_status_array() |
|
| 303 | + ); |
|
| 304 | + $default_reg_status->_construct_finalize( |
|
| 305 | + 'Event_Meta', |
|
| 306 | + 'EVT_default_registration_status', |
|
| 307 | + 'EEM_Event' |
|
| 308 | + ); |
|
| 309 | + self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status; |
|
| 310 | + } |
|
| 311 | + } |
|
| 312 | + |
|
| 313 | + |
|
| 314 | + /** |
|
| 315 | + * Used to override the default for the additional limit field. |
|
| 316 | + * @param $additional_limit |
|
| 317 | + */ |
|
| 318 | + public static function set_default_additional_limit($additional_limit) |
|
| 319 | + { |
|
| 320 | + self::$_default_additional_limit = (int) $additional_limit; |
|
| 321 | + if (self::$_instance instanceof EEM_Event) { |
|
| 322 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field( |
|
| 323 | + 'EVT_additional_limit', |
|
| 324 | + __('Limit of Additional Registrations on Same Transaction', 'event_espresso'), |
|
| 325 | + true, |
|
| 326 | + self::$_default_additional_limit |
|
| 327 | + ); |
|
| 328 | + self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize( |
|
| 329 | + 'Event_Meta', |
|
| 330 | + 'EVT_additional_limit', |
|
| 331 | + 'EEM_Event' |
|
| 332 | + ); |
|
| 333 | + } |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + |
|
| 337 | + /** |
|
| 338 | + * Return what is currently set as the default additional limit for the event. |
|
| 339 | + * @return int |
|
| 340 | + */ |
|
| 341 | + public static function get_default_additional_limit() |
|
| 342 | + { |
|
| 343 | + return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit); |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * get_question_groups |
|
| 349 | + * |
|
| 350 | + * @return array |
|
| 351 | + * @throws \EE_Error |
|
| 352 | + */ |
|
| 353 | + public function get_all_question_groups() |
|
| 354 | + { |
|
| 355 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
| 356 | + array( |
|
| 357 | + array('QSG_deleted' => false), |
|
| 358 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
| 359 | + ) |
|
| 360 | + ); |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * get_question_groups |
|
| 367 | + * |
|
| 368 | + * @param int $EVT_ID |
|
| 369 | + * @return array|bool |
|
| 370 | + * @throws \EE_Error |
|
| 371 | + */ |
|
| 372 | + public function get_all_event_question_groups($EVT_ID = 0) |
|
| 373 | + { |
|
| 374 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 375 | + EE_Error::add_error( |
|
| 376 | + esc_html__( |
|
| 377 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
| 378 | + 'event_espresso' |
|
| 379 | + ), |
|
| 380 | + __FILE__, |
|
| 381 | + __FUNCTION__, |
|
| 382 | + __LINE__ |
|
| 383 | + ); |
|
| 384 | + return false; |
|
| 385 | + } |
|
| 386 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all( |
|
| 387 | + array( |
|
| 388 | + array('EVT_ID' => $EVT_ID), |
|
| 389 | + ) |
|
| 390 | + ); |
|
| 391 | + } |
|
| 392 | + |
|
| 393 | + |
|
| 394 | + /** |
|
| 395 | + * get_question_groups |
|
| 396 | + * |
|
| 397 | + * @param int $EVT_ID |
|
| 398 | + * @param boolean $for_primary_attendee |
|
| 399 | + * @return array|bool |
|
| 400 | + * @throws EE_Error |
|
| 401 | + * @throws InvalidArgumentException |
|
| 402 | + * @throws ReflectionException |
|
| 403 | + * @throws InvalidDataTypeException |
|
| 404 | + * @throws InvalidInterfaceException |
|
| 405 | + */ |
|
| 406 | + public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true) |
|
| 407 | + { |
|
| 408 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 409 | + EE_Error::add_error( |
|
| 410 | + esc_html__( |
|
| 411 | + // @codingStandardsIgnoreStart |
|
| 412 | + 'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.', |
|
| 413 | + // @codingStandardsIgnoreEnd |
|
| 414 | + 'event_espresso' |
|
| 415 | + ), |
|
| 416 | + __FILE__, |
|
| 417 | + __FUNCTION__, |
|
| 418 | + __LINE__ |
|
| 419 | + ); |
|
| 420 | + return false; |
|
| 421 | + } |
|
| 422 | + $query_params = [ |
|
| 423 | + [ |
|
| 424 | + 'EVT_ID' => $EVT_ID, |
|
| 425 | + EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true |
|
| 426 | + ] |
|
| 427 | + ]; |
|
| 428 | + if ($for_primary_attendee) { |
|
| 429 | + $query_params[0]['EQG_primary'] = true; |
|
| 430 | + } else { |
|
| 431 | + $query_params[0]['EQG_additional'] = true; |
|
| 432 | + } |
|
| 433 | + return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params); |
|
| 434 | + } |
|
| 435 | + |
|
| 436 | + |
|
| 437 | + /** |
|
| 438 | + * get_question_groups |
|
| 439 | + * |
|
| 440 | + * @param int $EVT_ID |
|
| 441 | + * @param EE_Registration $registration |
|
| 442 | + * @return array|bool |
|
| 443 | + * @throws EE_Error |
|
| 444 | + * @throws InvalidArgumentException |
|
| 445 | + * @throws InvalidDataTypeException |
|
| 446 | + * @throws InvalidInterfaceException |
|
| 447 | + * @throws ReflectionException |
|
| 448 | + */ |
|
| 449 | + public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration) |
|
| 450 | + { |
|
| 451 | + if (! isset($EVT_ID) || ! absint($EVT_ID)) { |
|
| 452 | + EE_Error::add_error( |
|
| 453 | + esc_html__( |
|
| 454 | + 'An error occurred. No Question Groups could be retrieved because an Event ID was not received.', |
|
| 455 | + 'event_espresso' |
|
| 456 | + ), |
|
| 457 | + __FILE__, |
|
| 458 | + __FUNCTION__, |
|
| 459 | + __LINE__ |
|
| 460 | + ); |
|
| 461 | + return false; |
|
| 462 | + } |
|
| 463 | + return EE_Registry::instance()->load_model('Question_Group')->get_all( |
|
| 464 | + [ |
|
| 465 | + [ |
|
| 466 | + 'Event_Question_Group.EVT_ID' => $EVT_ID, |
|
| 467 | + 'Event_Question_Group.' |
|
| 468 | + . EEM_Event_Question_Group::instance()->fieldNameForContext( |
|
| 469 | + $registration->is_primary_registrant() |
|
| 470 | + ) => true |
|
| 471 | + ], |
|
| 472 | + 'order_by' => ['QSG_order' => 'ASC'], |
|
| 473 | + ] |
|
| 474 | + ); |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * get_question_target_db_column |
|
| 481 | + * |
|
| 482 | + * @param string $QSG_IDs csv list of $QSG IDs |
|
| 483 | + * @return array|bool |
|
| 484 | + * @throws \EE_Error |
|
| 485 | + */ |
|
| 486 | + public function get_questions_in_groups($QSG_IDs = '') |
|
| 487 | + { |
|
| 488 | + if (empty($QSG_IDs)) { |
|
| 489 | + EE_Error::add_error( |
|
| 490 | + esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'), |
|
| 491 | + __FILE__, |
|
| 492 | + __FUNCTION__, |
|
| 493 | + __LINE__ |
|
| 494 | + ); |
|
| 495 | + return false; |
|
| 496 | + } |
|
| 497 | + return EE_Registry::instance()->load_model('Question')->get_all( |
|
| 498 | + array( |
|
| 499 | + array( |
|
| 500 | + 'Question_Group.QSG_ID' => array('IN', $QSG_IDs), |
|
| 501 | + 'QST_deleted' => false, |
|
| 502 | + 'QST_admin_only' => is_admin(), |
|
| 503 | + ), |
|
| 504 | + 'order_by' => 'QST_order', |
|
| 505 | + ) |
|
| 506 | + ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + |
|
| 510 | + |
|
| 511 | + /** |
|
| 512 | + * get_options_for_question |
|
| 513 | + * |
|
| 514 | + * @param string $QST_IDs csv list of $QST IDs |
|
| 515 | + * @return array|bool |
|
| 516 | + * @throws \EE_Error |
|
| 517 | + */ |
|
| 518 | + public function get_options_for_question($QST_IDs) |
|
| 519 | + { |
|
| 520 | + if (empty($QST_IDs)) { |
|
| 521 | + EE_Error::add_error( |
|
| 522 | + esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'), |
|
| 523 | + __FILE__, |
|
| 524 | + __FUNCTION__, |
|
| 525 | + __LINE__ |
|
| 526 | + ); |
|
| 527 | + return false; |
|
| 528 | + } |
|
| 529 | + return EE_Registry::instance()->load_model('Question_Option')->get_all( |
|
| 530 | + array( |
|
| 531 | + array( |
|
| 532 | + 'Question.QST_ID' => array('IN', $QST_IDs), |
|
| 533 | + 'QSO_deleted' => false, |
|
| 534 | + ), |
|
| 535 | + 'order_by' => 'QSO_ID', |
|
| 536 | + ) |
|
| 537 | + ); |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + |
|
| 541 | + |
|
| 542 | + |
|
| 543 | + |
|
| 544 | + |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Gets all events that are published |
|
| 548 | + * and have event start time earlier than now and an event end time later than now |
|
| 549 | + * |
|
| 550 | + * @param array $query_params An array of query params to further filter on |
|
| 551 | + * (note that status and DTT_EVT_start and DTT_EVT_end will be overridden) |
|
| 552 | + * @param bool $count whether to return the count or not (default FALSE) |
|
| 553 | + * @return EE_Event[]|int |
|
| 554 | + * @throws \EE_Error |
|
| 555 | + */ |
|
| 556 | + public function get_active_events($query_params, $count = false) |
|
| 557 | + { |
|
| 558 | + if (array_key_exists(0, $query_params)) { |
|
| 559 | + $where_params = $query_params[0]; |
|
| 560 | + unset($query_params[0]); |
|
| 561 | + } else { |
|
| 562 | + $where_params = array(); |
|
| 563 | + } |
|
| 564 | + // if we have count make sure we don't include group by |
|
| 565 | + if ($count && isset($query_params['group_by'])) { |
|
| 566 | + unset($query_params['group_by']); |
|
| 567 | + } |
|
| 568 | + // let's add specific query_params for active_events |
|
| 569 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
| 570 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
| 571 | + // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions |
|
| 572 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 573 | + $where_params['Datetime.DTT_EVT_start******'] = array( |
|
| 574 | + '<', |
|
| 575 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 576 | + ); |
|
| 577 | + } else { |
|
| 578 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
| 579 | + '<', |
|
| 580 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 581 | + ); |
|
| 582 | + } |
|
| 583 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 584 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
| 585 | + '>', |
|
| 586 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 587 | + ); |
|
| 588 | + } else { |
|
| 589 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
| 590 | + '>', |
|
| 591 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 592 | + ); |
|
| 593 | + } |
|
| 594 | + $query_params[0] = $where_params; |
|
| 595 | + // don't use $query_params with count() |
|
| 596 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
| 597 | + return $count |
|
| 598 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 599 | + : $this->get_all($query_params); |
|
| 600 | + } |
|
| 601 | + |
|
| 602 | + |
|
| 603 | + |
|
| 604 | + /** |
|
| 605 | + * get all events that are published and have an event start time later than now |
|
| 606 | + * |
|
| 607 | + * @param array $query_params An array of query params to further filter on |
|
| 608 | + * (Note that status and DTT_EVT_start will be overridden) |
|
| 609 | + * @param bool $count whether to return the count or not (default FALSE) |
|
| 610 | + * @return EE_Event[]|int |
|
| 611 | + * @throws \EE_Error |
|
| 612 | + */ |
|
| 613 | + public function get_upcoming_events($query_params, $count = false) |
|
| 614 | + { |
|
| 615 | + if (array_key_exists(0, $query_params)) { |
|
| 616 | + $where_params = $query_params[0]; |
|
| 617 | + unset($query_params[0]); |
|
| 618 | + } else { |
|
| 619 | + $where_params = array(); |
|
| 620 | + } |
|
| 621 | + // if we have count make sure we don't include group by |
|
| 622 | + if ($count && isset($query_params['group_by'])) { |
|
| 623 | + unset($query_params['group_by']); |
|
| 624 | + } |
|
| 625 | + // let's add specific query_params for active_events |
|
| 626 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
| 627 | + // we need to pull events with a status of publish and sold_out |
|
| 628 | + $event_status = array('publish', EEM_Event::sold_out); |
|
| 629 | + // check if the user can read private events and if so add the 'private status to the were params' |
|
| 630 | + if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) { |
|
| 631 | + $event_status[] = 'private'; |
|
| 632 | + } |
|
| 633 | + $where_params['status'] = array('IN', $event_status); |
|
| 634 | + // if there are already query_params matching DTT_EVT_start then we need to modify that to add them. |
|
| 635 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 636 | + $where_params['Datetime.DTT_EVT_start*****'] = array( |
|
| 637 | + '>', |
|
| 638 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 639 | + ); |
|
| 640 | + } else { |
|
| 641 | + $where_params['Datetime.DTT_EVT_start'] = array( |
|
| 642 | + '>', |
|
| 643 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'), |
|
| 644 | + ); |
|
| 645 | + } |
|
| 646 | + $query_params[0] = $where_params; |
|
| 647 | + // don't use $query_params with count() |
|
| 648 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
| 649 | + return $count |
|
| 650 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 651 | + : $this->get_all($query_params); |
|
| 652 | + } |
|
| 653 | + |
|
| 654 | + |
|
| 655 | + |
|
| 656 | + /** |
|
| 657 | + * Gets all events that are published |
|
| 658 | + * and have an event end time later than now |
|
| 659 | + * |
|
| 660 | + * @param array $query_params An array of query params to further filter on |
|
| 661 | + * (note that status and DTT_EVT_end will be overridden) |
|
| 662 | + * @param bool $count whether to return the count or not (default FALSE) |
|
| 663 | + * @return EE_Event[]|int |
|
| 664 | + * @throws \EE_Error |
|
| 665 | + */ |
|
| 666 | + public function get_active_and_upcoming_events($query_params, $count = false) |
|
| 667 | + { |
|
| 668 | + if (array_key_exists(0, $query_params)) { |
|
| 669 | + $where_params = $query_params[0]; |
|
| 670 | + unset($query_params[0]); |
|
| 671 | + } else { |
|
| 672 | + $where_params = array(); |
|
| 673 | + } |
|
| 674 | + // if we have count make sure we don't include group by |
|
| 675 | + if ($count && isset($query_params['group_by'])) { |
|
| 676 | + unset($query_params['group_by']); |
|
| 677 | + } |
|
| 678 | + // let's add specific query_params for active_events |
|
| 679 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
| 680 | + $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out)); |
|
| 681 | + // add where params for DTT_EVT_end |
|
| 682 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 683 | + $where_params['Datetime.DTT_EVT_end*****'] = array( |
|
| 684 | + '>', |
|
| 685 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 686 | + ); |
|
| 687 | + } else { |
|
| 688 | + $where_params['Datetime.DTT_EVT_end'] = array( |
|
| 689 | + '>', |
|
| 690 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 691 | + ); |
|
| 692 | + } |
|
| 693 | + $query_params[0] = $where_params; |
|
| 694 | + // don't use $query_params with count() |
|
| 695 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
| 696 | + return $count |
|
| 697 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 698 | + : $this->get_all($query_params); |
|
| 699 | + } |
|
| 700 | + |
|
| 701 | + |
|
| 702 | + |
|
| 703 | + /** |
|
| 704 | + * This only returns events that are expired. |
|
| 705 | + * They may still be published but all their datetimes have expired. |
|
| 706 | + * |
|
| 707 | + * @param array $query_params An array of query params to further filter on |
|
| 708 | + * (note that status and DTT_EVT_end will be overridden) |
|
| 709 | + * @param bool $count whether to return the count or not (default FALSE) |
|
| 710 | + * @return EE_Event[]|int |
|
| 711 | + * @throws \EE_Error |
|
| 712 | + */ |
|
| 713 | + public function get_expired_events($query_params, $count = false) |
|
| 714 | + { |
|
| 715 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
| 716 | + // if we have count make sure we don't include group by |
|
| 717 | + if ($count && isset($query_params['group_by'])) { |
|
| 718 | + unset($query_params['group_by']); |
|
| 719 | + } |
|
| 720 | + // let's add specific query_params for active_events |
|
| 721 | + // keep in mind this will override any sent status in the query AND any date queries. |
|
| 722 | + if (isset($where_params['status'])) { |
|
| 723 | + unset($where_params['status']); |
|
| 724 | + } |
|
| 725 | + $exclude_query = $query_params; |
|
| 726 | + if (isset($exclude_query[0])) { |
|
| 727 | + unset($exclude_query[0]); |
|
| 728 | + } |
|
| 729 | + $exclude_query[0] = array( |
|
| 730 | + 'Datetime.DTT_EVT_end' => array( |
|
| 731 | + '>', |
|
| 732 | + EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'), |
|
| 733 | + ), |
|
| 734 | + ); |
|
| 735 | + // first get all events that have datetimes where its not expired. |
|
| 736 | + $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID'); |
|
| 737 | + $event_ids = array_keys($event_ids); |
|
| 738 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
| 739 | + $and_condition = array( |
|
| 740 | + 'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')), |
|
| 741 | + 'EVT_ID' => array('NOT IN', $event_ids), |
|
| 742 | + ); |
|
| 743 | + if (isset($where_params['OR'])) { |
|
| 744 | + $and_condition['OR'] = $where_params['OR']; |
|
| 745 | + unset($where_params['OR']); |
|
| 746 | + } |
|
| 747 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 748 | + $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
| 749 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
| 750 | + } |
|
| 751 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 752 | + $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
| 753 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
| 754 | + } |
|
| 755 | + // merge remaining $where params with the and conditions. |
|
| 756 | + $where_params['AND'] = array_merge($and_condition, $where_params); |
|
| 757 | + $query_params[0] = $where_params; |
|
| 758 | + // don't use $query_params with count() |
|
| 759 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
| 760 | + return $count |
|
| 761 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 762 | + : $this->get_all($query_params); |
|
| 763 | + } |
|
| 764 | + |
|
| 765 | + |
|
| 766 | + |
|
| 767 | + /** |
|
| 768 | + * This basically just returns the events that do not have the publish status. |
|
| 769 | + * |
|
| 770 | + * @param array $query_params An array of query params to further filter on |
|
| 771 | + * (note that status will be overwritten) |
|
| 772 | + * @param boolean $count whether to return the count or not (default FALSE) |
|
| 773 | + * @return EE_Event[]|int |
|
| 774 | + * @throws \EE_Error |
|
| 775 | + */ |
|
| 776 | + public function get_inactive_events($query_params, $count = false) |
|
| 777 | + { |
|
| 778 | + $where_params = isset($query_params[0]) ? $query_params[0] : array(); |
|
| 779 | + // let's add in specific query_params for inactive events. |
|
| 780 | + if (isset($where_params['status'])) { |
|
| 781 | + unset($where_params['status']); |
|
| 782 | + } |
|
| 783 | + // if we have count make sure we don't include group by |
|
| 784 | + if ($count && isset($query_params['group_by'])) { |
|
| 785 | + unset($query_params['group_by']); |
|
| 786 | + } |
|
| 787 | + // if we have any additional query_params, let's add them to the 'AND' condition |
|
| 788 | + $where_params['AND']['status'] = array('!=', 'publish'); |
|
| 789 | + if (isset($where_params['OR'])) { |
|
| 790 | + $where_params['AND']['OR'] = $where_params['OR']; |
|
| 791 | + unset($where_params['OR']); |
|
| 792 | + } |
|
| 793 | + if (isset($where_params['Datetime.DTT_EVT_end'])) { |
|
| 794 | + $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end']; |
|
| 795 | + unset($where_params['Datetime.DTT_EVT_end']); |
|
| 796 | + } |
|
| 797 | + if (isset($where_params['Datetime.DTT_EVT_start'])) { |
|
| 798 | + $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start']; |
|
| 799 | + unset($where_params['Datetime.DTT_EVT_start']); |
|
| 800 | + } |
|
| 801 | + $query_params[0] = $where_params; |
|
| 802 | + // don't use $query_params with count() |
|
| 803 | + // because we don't want to include additional query clauses like "GROUP BY" |
|
| 804 | + return $count |
|
| 805 | + ? $this->count(array($where_params), 'EVT_ID', true) |
|
| 806 | + : $this->get_all($query_params); |
|
| 807 | + } |
|
| 808 | + |
|
| 809 | + |
|
| 810 | + |
|
| 811 | + /** |
|
| 812 | + * This is just injecting into the parent add_relationship_to so we do special handling on price relationships |
|
| 813 | + * because we don't want to override any existing global default prices but instead insert NEW prices that get |
|
| 814 | + * attached to the event. See parent for param descriptions |
|
| 815 | + * |
|
| 816 | + * @param $id_or_obj |
|
| 817 | + * @param $other_model_id_or_obj |
|
| 818 | + * @param string $relationName |
|
| 819 | + * @param array $where_query |
|
| 820 | + * @return EE_Base_Class |
|
| 821 | + * @throws EE_Error |
|
| 822 | + */ |
|
| 823 | + public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array()) |
|
| 824 | + { |
|
| 825 | + if ($relationName === 'Price') { |
|
| 826 | + // let's get the PRC object for the given ID to make sure that we aren't dealing with a default |
|
| 827 | + $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj); |
|
| 828 | + // if EVT_ID = 0, then this is a default |
|
| 829 | + if ((int) $prc_chk->get('EVT_ID') === 0) { |
|
| 830 | + // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation |
|
| 831 | + $prc_chk->set('PRC_ID', 0); |
|
| 832 | + } |
|
| 833 | + // run parent |
|
| 834 | + return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query); |
|
| 835 | + } |
|
| 836 | + // otherwise carry on as normal |
|
| 837 | + return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query); |
|
| 838 | + } |
|
| 839 | + |
|
| 840 | + |
|
| 841 | + |
|
| 842 | + /******************** DEPRECATED METHODS ********************/ |
|
| 843 | + |
|
| 844 | + |
|
| 845 | + |
|
| 846 | + /** |
|
| 847 | + * _get_question_target_db_column |
|
| 848 | + * |
|
| 849 | + * @deprecated as of 4.8.32.rc.001. Instead consider using |
|
| 850 | + * EE_Registration_Custom_Questions_Form located in |
|
| 851 | + * admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php |
|
| 852 | + * @access public |
|
| 853 | + * @param EE_Registration $registration (so existing answers for registration are included) |
|
| 854 | + * @param int $EVT_ID so all question groups are included for event (not just answers from |
|
| 855 | + * registration). |
|
| 856 | + * @throws EE_Error |
|
| 857 | + * @return array |
|
| 858 | + */ |
|
| 859 | + public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0) |
|
| 860 | + { |
|
| 861 | + if (empty($EVT_ID)) { |
|
| 862 | + throw new EE_Error(__( |
|
| 863 | + 'An error occurred. No EVT_ID is included. Needed to know which question groups to retrieve.', |
|
| 864 | + 'event_espresso' |
|
| 865 | + )); |
|
| 866 | + } |
|
| 867 | + $questions = array(); |
|
| 868 | + // get all question groups for event |
|
| 869 | + $qgs = $this->get_question_groups_for_event($EVT_ID, $registration); |
|
| 870 | + if (! empty($qgs)) { |
|
| 871 | + foreach ($qgs as $qg) { |
|
| 872 | + $qsts = $qg->questions(); |
|
| 873 | + $questions[ $qg->ID() ] = $qg->model_field_array(); |
|
| 874 | + $questions[ $qg->ID() ]['QSG_questions'] = array(); |
|
| 875 | + foreach ($qsts as $qst) { |
|
| 876 | + if ($qst->is_system_question()) { |
|
| 877 | + continue; |
|
| 878 | + } |
|
| 879 | + $answer = EEM_Answer::instance()->get_one(array( |
|
| 880 | + array( |
|
| 881 | + 'QST_ID' => $qst->ID(), |
|
| 882 | + 'REG_ID' => $registration->ID(), |
|
| 883 | + ), |
|
| 884 | + )); |
|
| 885 | + $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object(); |
|
| 886 | + $qst_name = $qstn_id = $qst->ID(); |
|
| 887 | + $ans_id = $answer->ID(); |
|
| 888 | + $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']'; |
|
| 889 | + $input_name = ''; |
|
| 890 | + $input_id = sanitize_key($qst->display_text()); |
|
| 891 | + $input_class = ''; |
|
| 892 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array(); |
|
| 893 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn' |
|
| 894 | + . $input_name |
|
| 895 | + . $qst_name; |
|
| 896 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id; |
|
| 897 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class; |
|
| 898 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array(); |
|
| 899 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst; |
|
| 900 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer; |
|
| 901 | + // leave responses as-is, don't convert stuff into html entities please! |
|
| 902 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false; |
|
| 903 | + if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') { |
|
| 904 | + $QSOs = $qst->options(true, $answer->value()); |
|
| 905 | + if (is_array($QSOs)) { |
|
| 906 | + foreach ($QSOs as $QSO_ID => $QSO) { |
|
| 907 | + $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array(); |
|
| 908 | + } |
|
| 909 | + } |
|
| 910 | + } |
|
| 911 | + } |
|
| 912 | + } |
|
| 913 | + } |
|
| 914 | + return $questions; |
|
| 915 | + } |
|
| 916 | + |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value |
|
| 920 | + * or an stdClass where each property is the name of a column, |
|
| 921 | + * @return EE_Base_Class |
|
| 922 | + * @throws \EE_Error |
|
| 923 | + */ |
|
| 924 | + public function instantiate_class_from_array_or_object($cols_n_values) |
|
| 925 | + { |
|
| 926 | + $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values); |
|
| 927 | + if ($classInstance instanceof EE_Event) { |
|
| 928 | + // events have their timezone defined in the DB, so use it immediately |
|
| 929 | + $this->set_timezone($classInstance->get_timezone()); |
|
| 930 | + } |
|
| 931 | + return $classInstance; |
|
| 932 | + } |
|
| 933 | 933 | } |