| @@ -1,664 +1,411 @@ | ||
| 1 | -<?php | |
| 2 | - | |
| 3 | -/** | |
| 4 | - * The Form Class | |
| 5 | - * | |
| 6 | - * @since 1.1.0 | |
| 7 | - */ | |
| 8 | -class WeForms_Form { | |
| 9 | - | |
| 10 | - /** | |
| 11 | - * The form id | |
| 12 | - * | |
| 13 | - * @var int | |
| 14 | - */ | |
| 15 | - public $id = 0; | |
| 16 | - | |
| 17 | - /** | |
| 18 | - * The form title | |
| 19 | - * | |
| 20 | - * @var string | |
| 21 | - */ | |
| 22 | - public $name = ''; | |
| 23 | - | |
| 24 | - /** | |
| 25 | - * Holds the post data object | |
| 26 | - * | |
| 27 | - * @var WP_post|null | |
| 28 | - */ | |
| 29 | - public $data = null; | |
| 30 | - | |
| 31 | - /** | |
| 32 | - * Derived/formatted stats & metadata used by admin/AJAX/API responses. | |
| 33 | - * Declared explicitly to avoid PHP 8.2 "dynamic property" deprecations. | |
| 34 | - * | |
| 35 | - * @var int | |
| 36 | - */ | |
| 37 | - public $entries = 0; | |
| 38 | - | |
| 39 | - /** | |
| 40 | - * @var array | |
| 41 | - */ | |
| 42 | - public $settings = []; | |
| 43 | - | |
| 44 | - /** | |
| 45 | - * @var int | |
| 46 | - */ | |
| 47 | - public $views = 0; | |
| 48 | - | |
| 49 | - /** | |
| 50 | - * @var int | |
| 51 | - */ | |
| 52 | - public $payments = 0; | |
| 53 | - | |
| 54 | - /** | |
| 55 | - * @var array | |
| 56 | - */ | |
| 57 | - public $author = []; | |
| 58 | - | |
| 59 | - /** | |
| 60 | - * Form fields | |
| 61 | - * | |
| 62 | - * @var array | |
| 63 | - */ | |
| 64 | - public $form_fields = []; | |
| 65 | - | |
| 66 | - /** | |
| 67 | - * The Constructor | |
| 68 | - * | |
| 69 | - * @param int|WP_Post $form | |
| 70 | - */ | |
| 71 | - public function __construct( $form = null ) { | |
| 72 | - if ( is_numeric( $form ) ) { | |
| 73 | - $the_post = get_post( $form ); | |
| 74 | - | |
| 75 | - if ( $the_post ) { | |
| 76 | - $this->id = $the_post->ID; | |
| 77 | - $this->name = $the_post->post_title; | |
| 78 | - $this->data = $the_post; | |
| 79 | - } | |
| 80 | - } elseif ( is_a( $form, 'WP_Post' ) ) { | |
| 81 | - $this->id = $form->ID; | |
| 82 | - $this->name = $form->post_title; | |
| 83 | - $this->data = $form; | |
| 84 | - } | |
| 85 | - } | |
| 86 | - | |
| 87 | - /** | |
| 88 | - * Get the form ID | |
| 89 | - * | |
| 90 | - * @return int | |
| 91 | - */ | |
| 92 | - public function get_id() { | |
| 93 | - return $this->id; | |
| 94 | - } | |
| 95 | - | |
| 96 | - /** | |
| 97 | - * Get the form name | |
| 98 | - * | |
| 99 | - * @return string | |
| 100 | - */ | |
| 101 | - public function get_name() { | |
| 102 | - return $this->name; | |
| 103 | - } | |
| 104 | - | |
| 105 | - /** | |
| 106 | - * Get all form fields of this form | |
| 107 | - * | |
| 108 | - * @return array | |
| 109 | - */ | |
| 110 | - public function get_fields() { | |
| 111 | - | |
| 112 | - // return if already fetched | |
| 113 | - if ( $this->form_fields ) { | |
| 114 | - return $this->form_fields; | |
| 115 | - } | |
| 116 | - | |
| 117 | - $fields = get_children( [ | |
| 118 | - 'post_parent' => $this->id, | |
| 119 | - 'post_status' => 'publish', | |
| 120 | - 'post_type' => 'wpuf_input', | |
| 121 | - 'numberposts' => '-1', | |
| 122 | - 'orderby' => 'menu_order', | |
| 123 | - 'order' => 'ASC', | |
| 124 | - ] ); | |
| 125 | - | |
| 126 | - $form_fields = []; | |
| 127 | - | |
| 128 | - foreach ( $fields as $key => $content ) { | |
| 129 | - // Security fix: Prevent PHP Object Injection by restricting allowed classes | |
| 130 | - $field = is_serialized( $content->post_content ) | |
| 131 | - ? @unserialize( $content->post_content, [ 'allowed_classes' => false ] ) | |
| 132 | - : $content->post_content; | |
| 133 | - | |
| 134 | - if ( empty( $field['template'] ) ) { | |
| 135 | - continue; | |
| 136 | - } | |
| 137 | - | |
| 138 | - $field['id'] = $content->ID; | |
| 139 | - | |
| 140 | - // Add inline property for radio and checkbox fields | |
| 141 | - $inline_supported_fields = apply_filters( 'inline_supported_fields_list', [ 'radio_field', 'checkbox_field' ] ); | |
| 142 | - | |
| 143 | - if ( in_array( $field['template'], $inline_supported_fields ) ) { | |
| 144 | - if ( !isset( $field['inline'] ) ) { | |
| 145 | - $field['inline'] = 'no'; | |
| 146 | - } | |
| 147 | - } | |
| 148 | - | |
| 149 | - // Add 'selected' property | |
| 150 | - $option_based_fields = apply_filters( 'option_based_fields_list', [ 'dropdown_field', 'multiple_select', 'radio_field', 'checkbox_field' ] ); | |
| 151 | - | |
| 152 | - if ( in_array( $field['template'], $option_based_fields ) ) { | |
| 153 | - if ( !isset( $field['selected'] ) ) { | |
| 154 | - if ( 'dropdown_field' === $field['template'] || 'radio_field' === $field['template'] ) { | |
| 155 | - $field['selected'] = ''; | |
| 156 | - } else { | |
| 157 | - $field['selected'] = []; | |
| 158 | - } | |
| 159 | - } | |
| 160 | - } | |
| 161 | - | |
| 162 | - // Add 'multiple' key for template:repeat | |
| 163 | - if ( 'repeat_field' === $field['template'] && !isset( $field['multiple'] ) ) { | |
| 164 | - $field['multiple'] = ''; | |
| 165 | - } | |
| 166 | - | |
| 167 | - if ( 'recaptcha' === $field['template'] ) { | |
| 168 | - $field['name'] = 'recaptcha'; | |
| 169 | - $field['enable_no_captcha'] = isset( $field['enable_no_captcha'] ) ? $field['enable_no_captcha'] : ''; | |
| 170 | - $field['recaptcha_theme'] = isset( $field['recaptcha_theme'] ) ? $field['recaptcha_theme'] : 'light'; | |
| 171 | - } | |
| 172 | - | |
| 173 | - // Check if meta_key has changed when saving form compared current entries | |
| 174 | - if ( isset( $field['name'] ) ) { | |
| 175 | - $field['original_name'] = $field['name']; | |
| 176 | - } | |
| 177 | - $form_fields[] = apply_filters( 'weforms-get-form-field', $field, $this->id ); | |
| 178 | - } | |
| 179 | - | |
| 180 | - $this->form_fields = apply_filters( 'weforms-get-form-fields', $form_fields, $this->id ); | |
| 181 | - | |
| 182 | - return $this->form_fields; | |
| 183 | - } | |
| 184 | - | |
| 185 | - /** | |
| 186 | - * Check if any perticular field template is used in a form | |
| 187 | - * | |
| 188 | - * @return array | |
| 189 | - */ | |
| 190 | - public function has_field( $field_template ) { | |
| 191 | - foreach ( $this->get_fields() as $key => $field ) { | |
| 192 | - if ( isset( $field['template'] ) && $field['template'] == $field_template ) { | |
| 193 | - return true; | |
| 194 | - } | |
| 195 | - } | |
| 196 | - } | |
| 197 | - | |
| 198 | - /** | |
| 199 | - * Get all fields by a template | |
| 200 | - * | |
| 201 | - * @return array | |
| 202 | - */ | |
| 203 | - public function search_fields( $field_template ) { | |
| 204 | - $fields = []; | |
| 205 | - | |
| 206 | - foreach ( $this->get_fields() as $key => $field ) { | |
| 207 | - if ( isset( $field['template'] ) && $field['template'] == $field_template ) { | |
| 208 | - $fields[] = $field; | |
| 209 | - } | |
| 210 | - } | |
| 211 | - | |
| 212 | - return $fields; | |
| 213 | - } | |
| 214 | - | |
| 215 | - /** | |
| 216 | - * Search fileds and get the first one | |
| 217 | - * | |
| 218 | - * @return array | |
| 219 | - */ | |
| 220 | - public function search_field( $field_template ) { | |
| 221 | - $fields = $this->search_fields( $field_template ); | |
| 222 | - | |
| 223 | - return isset( $fields[0] ) ? $fields[0] : []; | |
| 224 | - } | |
| 225 | - | |
| 226 | - /** | |
| 227 | - * Get formatted field name/values | |
| 228 | - * | |
| 229 | - * @return array | |
| 230 | - */ | |
| 231 | - public function get_field_values() { | |
| 232 | - $values = []; | |
| 233 | - $fields = $this->get_fields(); | |
| 234 | - | |
| 235 | - if ( !$fields ) { | |
| 236 | - return $values; | |
| 237 | - } | |
| 238 | - | |
| 239 | - $ignore_fields = apply_filters( 'ignore_fields_list', [ 'recaptcha', 'section_break' ] ); | |
| 240 | - $options_fields = apply_filters( 'option_fields_list', [ 'dropdown_field', 'radio_field', 'multiple_select', 'checkbox_field' ] ); | |
| 241 | - | |
| 242 | - foreach ( $fields as $field ) { | |
| 243 | - if ( in_array( $field['template'], $ignore_fields ) ) { | |
| 244 | - continue; | |
| 245 | - } | |
| 246 | - | |
| 247 | - // Prepare column field data | |
| 248 | - if ( $field['template'] == 'column_field' ) { | |
| 249 | - $inner_columns = $field['inner_fields']; | |
| 250 | - | |
| 251 | - if ( !empty( $inner_columns ) ) { | |
| 252 | - foreach ( $inner_columns as $column => $column_fields ) { | |
| 253 | - if ( !empty( $column_fields ) ) { | |
| 254 | - foreach ( $column_fields as $field_obj ) { | |
| 255 | - if ( in_array( $field_obj['template'], $ignore_fields ) ) { | |
| 256 | - continue; | |
| 257 | - } | |
| 258 | - | |
| 259 | - if ( !isset( $field_obj['name'] ) ) { | |
| 260 | - continue; | |
| 261 | - } | |
| 262 | - | |
| 263 | - $field_value = [ | |
| 264 | - 'label' => isset( $field_obj['label'] ) ? $field_obj['label'] : '', | |
| 265 | - 'type' => $field_obj['template'], | |
| 266 | - ]; | |
| 267 | - | |
| 268 | - // put options if this is an option field | |
| 269 | - if ( in_array( $field_obj['template'], $options_fields ) ) { | |
| 270 | - $field_value['options'] = $field_obj['options']; | |
| 271 | - } | |
| 272 | - | |
| 273 | - $values[ $field_obj['name'] ] = array_merge( $field_obj, $field_value ); | |
| 274 | - } | |
| 275 | - } | |
| 276 | - } | |
| 277 | - } | |
| 278 | - } | |
| 279 | - | |
| 280 | - if ( !isset( $field['name'] ) ) { | |
| 281 | - continue; | |
| 282 | - } | |
| 283 | - | |
| 284 | - $value = [ | |
| 285 | - 'label' => isset( $field['label'] ) ? $field['label'] : '', | |
| 286 | - 'type' => $field['template'], | |
| 287 | - ]; | |
| 288 | - | |
| 289 | - // put options if this is an option field | |
| 290 | - if ( in_array( $field['template'], $options_fields ) ) { | |
| 291 | - $value['options'] = $field['options']; | |
| 292 | - } | |
| 293 | - | |
| 294 | - $values[ $field['name'] ] = array_merge( $field, $value ); | |
| 295 | - } | |
| 296 | - | |
| 297 | - return apply_filters( 'weforms_get_field_values', $values ); | |
| 298 | - } | |
| 299 | - | |
| 300 | - /** | |
| 301 | - * Get form settings | |
| 302 | - * | |
| 303 | - * @return array | |
| 304 | - */ | |
| 305 | - public function get_settings() { | |
| 306 | - $settings = get_post_meta( $this->id, 'wpuf_form_settings', true ); | |
| 307 | - $default = weforms_get_default_form_settings(); | |
| 308 | - | |
| 309 | - return apply_filters( 'weforms-get-form-settings', array_merge( $default, $settings ), $this->id ); | |
| 310 | - } | |
| 311 | - | |
| 312 | - /** | |
| 313 | - * Check if the form submission is open | |
| 314 | - * | |
| 315 | - * @return bool|WP_Error | |
| 316 | - */ | |
| 317 | - public function is_submission_open() { | |
| 318 | - $settings = $this->get_settings(); | |
| 319 | - | |
| 320 | - $needs_login = ( isset( $settings['require_login'] ) && $settings['require_login'] == 'true' ) ? true : false; | |
| 321 | - $has_limit = ( isset( $settings['limit_entries'] ) && $settings['limit_entries'] == 'true' ) ? true : false; | |
| 322 | - $is_scheduled = ( isset( $settings['schedule_form'] ) && $settings['schedule_form'] == 'true' ) ? true : false; | |
| 323 | - | |
| 324 | - if ( $this->data->post_status != 'publish' ) { | |
| 325 | - return new WP_Error( 'needs-publish', __( 'The form is not published yet.', 'weforms' ) ); | |
| 326 | - } | |
| 327 | - | |
| 328 | - if ( $needs_login && !is_user_logged_in() ) { | |
| 329 | - return new WP_Error( 'needs-login', $settings['req_login_message'] ); | |
| 330 | - } | |
| 331 | - | |
| 332 | - if ( $has_limit ) { | |
| 333 | - $limit = (int) $settings['limit_number']; | |
| 334 | - $form_entries = $this->num_form_entries(); | |
| 335 | - | |
| 336 | - if ( $limit <= $form_entries ) { | |
| 337 | - return new WP_Error( 'entry-limit', $settings['limit_message'] ); | |
| 338 | - } | |
| 339 | - } | |
| 340 | - | |
| 341 | - if ( $is_scheduled ) { | |
| 342 | - $start_time = strtotime( $settings['schedule_start'] ); | |
| 343 | - $end_time = strtotime( $settings['schedule_end'] ); | |
| 344 | - $current_time = current_time( 'timestamp' ); | |
| 345 | - | |
| 346 | - // too early? | |
| 347 | - if ( $current_time < $start_time ) { | |
| 348 | - return new WP_Error( 'form-pending', $settings['sc_pending_message'] ); | |
| 349 | - } elseif ( $current_time > $end_time ) { | |
| 350 | - return new WP_Error( 'form-expired', $settings['sc_expired_message'] ); | |
| 351 | - } | |
| 352 | - } | |
| 353 | - | |
| 354 | - return apply_filters( 'weforms_is_submission_open', true, $settings, $this ); | |
| 355 | - } | |
| 356 | - | |
| 357 | - /** | |
| 358 | - * Get form notifications | |
| 359 | - * | |
| 360 | - * @return array | |
| 361 | - */ | |
| 362 | - public function get_notifications() { | |
| 363 | - $notifications = get_post_meta( $this->id, 'notifications', true ); | |
| 364 | - $defualt = weforms_get_default_form_notification(); | |
| 365 | - | |
| 366 | - if ( !$notifications ) { | |
| 367 | - $notifications = []; | |
| 368 | - } | |
| 369 | - | |
| 370 | - $notifications = array_map( function ( $notification ) use ( $defualt ) { | |
| 371 | - if ( empty( $notification ) ) { | |
| 372 | - $notification = []; | |
| 373 | - } | |
| 374 | - | |
| 375 | - return array_merge( $defualt, $notification ); | |
| 376 | - }, $notifications ); | |
| 377 | - | |
| 378 | - return $notifications; | |
| 379 | - } | |
| 380 | - | |
| 381 | - /** | |
| 382 | - * Get all the integrations | |
| 383 | - * | |
| 384 | - * @return array | |
| 385 | - */ | |
| 386 | - public function get_integrations() { | |
| 387 | - $integrations = get_post_meta( $this->id, 'integrations', true ); | |
| 388 | - | |
| 389 | - if ( !$integrations ) { | |
| 390 | - return []; | |
| 391 | - } | |
| 392 | - | |
| 393 | - return $integrations; | |
| 394 | - } | |
| 395 | - | |
| 396 | - /** | |
| 397 | - * Get entries of this form | |
| 398 | - * | |
| 399 | - * @return \WeForms_Form_Entry_Manager | |
| 400 | - */ | |
| 401 | - public function entries() { | |
| 402 | - return new WeForms_Form_Entry_Manager( $this->id, $this ); | |
| 403 | - } | |
| 404 | - | |
| 405 | - /** | |
| 406 | - * When a user is editing their form they may change a fields name. | |
| 407 | - * This method will loop through existing entries to match the new field names. | |
| 408 | - * | |
| 409 | - * @since 1.6.9 | |
| 410 | - * | |
| 411 | - * @param int $form_id | |
| 412 | - * @param array $form_fields | |
| 413 | - */ | |
| 414 | - public function maybe_update_entries( $form_fields ) { | |
| 415 | - $changed_fields = $this->get_changed_fields( $form_fields ); | |
| 416 | - // Loop through changed fields and update entries | |
| 417 | - foreach ( $changed_fields as $old => $new) { | |
| 418 | - $updated_fields = $this->rename_field( $old, $new ); | |
| 419 | - } | |
| 420 | - } | |
| 421 | - | |
| 422 | - /** | |
| 423 | - * When a user is editing their form they may change a fields name. | |
| 424 | - * This method will loop through all fields that have changed. | |
| 425 | - * | |
| 426 | - * @since 1.6.9 | |
| 427 | - * | |
| 428 | - * @param int $form_id | |
| 429 | - * @param array $form_fields | |
| 430 | - * | |
| 431 | - * @return array | |
| 432 | - */ | |
| 433 | - public function get_changed_fields( $form_fields ) { | |
| 434 | - $changed_fields = array(); | |
| 435 | - foreach ( $form_fields as $field ) { | |
| 436 | - // All form fields should have an original name. | |
| 437 | - if ( empty( $field['original_name'] ) ) { | |
| 438 | - continue; | |
| 439 | - } | |
| 440 | - if ( $field['name'] !== $field['original_name'] ) { | |
| 441 | - $changed_fields[$field['original_name']] = $field['name']; | |
| 442 | - } else { | |
| 443 | - continue; | |
| 444 | - } | |
| 445 | - } | |
| 446 | - return $changed_fields; | |
| 447 | - | |
| 448 | - } | |
| 449 | - | |
| 450 | - /** | |
| 451 | - * When a user changes the field names of a form, the existing entries will need updated. | |
| 452 | - * This method will loop through the existing entries and update them will the new names. | |
| 453 | - * | |
| 454 | - * @since 1.6.9 | |
| 455 | - * | |
| 456 | - * @param int $form_id | |
| 457 | - * @param array $form_fields | |
| 458 | - * | |
| 459 | - * @return array | |
| 460 | - */ | |
| 461 | - public function rename_field ( $old, $new ) { | |
| 462 | - global $wpdb; | |
| 463 | - | |
| 464 | - $entries = weforms_get_form_entries( $this->id ); | |
| 465 | - | |
| 466 | - foreach ( $entries as $entry ) { | |
| 467 | - $entry_id = $entry->id; | |
| 468 | - $values = weforms_get_entry_meta( $entry_id ); | |
| 469 | - $update_keys = $wpdb->update( $wpdb->weforms_entrymeta, array( 'meta_key' => $new ), array( 'meta_key' => $old, 'weforms_entry_id' => $entry_id ) ); | |
| 470 | - } | |
| 471 | - } | |
| 472 | - | |
| 473 | - /** | |
| 474 | - * Get number of form entries | |
| 475 | - * | |
| 476 | - * @return int | |
| 477 | - */ | |
| 478 | - public function num_form_entries() { | |
| 479 | - return weforms_count_form_entries( $this->id ); | |
| 480 | - } | |
| 481 | - | |
| 482 | - /** | |
| 483 | - * Get number of form payments | |
| 484 | - * | |
| 485 | - * @return int | |
| 486 | - */ | |
| 487 | - public function num_form_payments() { | |
| 488 | - return weforms_count_form_payments( $this->id ); | |
| 489 | - } | |
| 490 | - | |
| 491 | - /** | |
| 492 | - * Get form author details | |
| 493 | - * | |
| 494 | - * @return array | |
| 495 | - */ | |
| 496 | - public function get_form_author_details() { | |
| 497 | - return weforms_get_form_author_details( $this->id ); | |
| 498 | - } | |
| 499 | - | |
| 500 | - /** | |
| 501 | - * Get the number of form views | |
| 502 | - * | |
| 503 | - * @return int | |
| 504 | - */ | |
| 505 | - public function num_form_views() { | |
| 506 | - return weforms_get_form_views( $this->id ); | |
| 507 | - } | |
| 508 | - | |
| 509 | - /** | |
| 510 | - * prepare_entries | |
| 511 | - * | |
| 512 | - * @return array | |
| 513 | - */ | |
| 514 | - public function prepare_entries( $args = [] ) { | |
| 515 | - $fields = weforms()->fields->get_fields(); | |
| 516 | - $form_fields = $this->get_fields(); | |
| 517 | - | |
| 518 | - $entry_fields = []; | |
| 519 | - | |
| 520 | - $ignore_list = apply_filters( 'wefroms_entry_ignore_list', [ | |
| 521 | - 'recaptcha', 'section_break', 'step_start', | |
| 522 | - ] ); | |
| 523 | - | |
| 524 | - foreach ( $form_fields as $field ) { | |
| 525 | - if ( in_array( $field['template'], $ignore_list ) ) { | |
| 526 | - continue; | |
| 527 | - } | |
| 528 | - | |
| 529 | - if ( !array_key_exists( $field['template'], $fields ) ) { | |
| 530 | - continue; | |
| 531 | - } | |
| 532 | - | |
| 533 | - // Prepare column field data | |
| 534 | - if ( $field['template'] == 'column_field' ) { | |
| 535 | - $inner_columns = $field['inner_fields']; | |
| 536 | - | |
| 537 | - if ( !empty( $inner_columns ) ) { | |
| 538 | - foreach ( $inner_columns as $column => $column_fields ) { | |
| 539 | - if ( !empty( $column_fields ) ) { | |
| 540 | - foreach ( $column_fields as $field_obj ) { | |
| 541 | - if ( in_array( $field_obj['template'], $ignore_list ) ) { | |
| 542 | - continue; | |
| 543 | - } | |
| 544 | - | |
| 545 | - $fieldClass = $fields[ $field_obj['template'] ]; | |
| 546 | - $entry_fields[ $field_obj['name'] ] = $fieldClass->prepare_entry( $field_obj ); | |
| 547 | - } | |
| 548 | - } | |
| 549 | - } | |
| 550 | - } | |
| 551 | - } | |
| 552 | - | |
| 553 | - $field_class = $fields[ $field['template'] ]; | |
| 554 | - | |
| 555 | - $entry_fields[ $field['name'] ] = $field_class->prepare_entry( $field, $args ); | |
| 556 | - } | |
| 557 | - | |
| 558 | - return apply_filters( 'weforms_prepare_entries', $entry_fields ); | |
| 559 | - } | |
| 560 | - | |
| 561 | - /** | |
| 562 | - * Check if the form submission is open On API | |
| 563 | - * | |
| 564 | - * @return bool|WP_Error | |
| 565 | - */ | |
| 566 | - public function is_api_form_submission_open() { | |
| 567 | - $response = []; | |
| 568 | - $settings = $this->get_settings(); | |
| 569 | - $form_entries = $this->num_form_entries(); | |
| 570 | - $needs_login = isset( $settings['require_login'] ) ? $settings['require_login'] : 'false'; | |
| 571 | - $limit_entries = isset( $settings['limit_entries'] ) ? $settings['limit_entries'] : 'false'; | |
| 572 | - $schedule_form = isset( $settings['schedule_form'] ) ? $settings['schedule_form'] : 'false'; | |
| 573 | - $limit_number = isset( $settings['limit_number'] ) ? $settings['limit_number'] : ''; | |
| 574 | - $schedule_start = isset( $settings['schedule_start'] ) ? $settings['schedule_start'] : ''; | |
| 575 | - $schedule_end = isset( $settings['schedule_end'] ) ? $settings['schedule_end'] : ''; | |
| 576 | - $schedule_start_date = date_i18n( 'M d, Y', strtotime( $schedule_start ) ); | |
| 577 | - $schedule_end_date = date_i18n( 'M d, Y', strtotime( $schedule_end ) ); | |
| 578 | - | |
| 579 | - if ( $this->data->post_status != 'publish' ) { | |
| 580 | - $response['type'] = __( 'Closed', 'weforms' ); | |
| 581 | - } | |
| 582 | - | |
| 583 | - if ( $this->isFormStatusClosed( $settings, $form_entries ) ) { | |
| 584 | - $response['type'] = __( 'Closed', 'weforms' ); | |
| 585 | - } else { | |
| 586 | - $response['type'] = __( 'Open', 'weforms' ); | |
| 587 | - } | |
| 588 | - | |
| 589 | - if ( $limit_entries === 'true' ) { | |
| 590 | - if ( $schedule_form === 'true' && $this->isExpiredForm( $schedule_end ) ) { | |
| 591 | - $response['message'] = __( "Expired at {$schedule_end_date}", 'weforms' ); | |
| 592 | - } elseif ( $schedule_form === 'true' && $this->isPendingForm( $schedule_start ) ) { | |
| 593 | - $response['message'] = __( "Starts at {$schedule_start_date}", 'weforms' ); | |
| 594 | - } elseif ( $form_entries >= $limit_number ) { | |
| 595 | - $response['message'] = __( 'Reached maximum entry limit', 'weforms' ); | |
| 596 | - } else { | |
| 597 | - $remaining_entries = $limit_number - $form_entries; | |
| 598 | - $response['message'] = __( "{$remaining_entries} entries remaining ", 'weforms' ); | |
| 599 | - } | |
| 600 | - } elseif ( $schedule_form === 'true' ) { | |
| 601 | - if ( $this->isPendingForm( $schedule_start ) ) { | |
| 602 | - $response['message'] = __( "Starts at {$schedule_start_date}", 'weforms' ); | |
| 603 | - } elseif ( $this->isExpiredForm( $schedule_end ) ) { | |
| 604 | - $response['message'] = __( "Expired at {$schedule_end_date}", 'weforms' ); | |
| 605 | - } elseif ( $this->isOpenForm( $schedule_start, $schedule_end ) ) { | |
| 606 | - $response['message'] = __( "Expires at {$schedule_end_date}", 'weforms' ); | |
| 607 | - } | |
| 608 | - } elseif ( $needs_login === 'true' ) { | |
| 609 | - $response['message'] =__( 'Requires login', 'weforms' ); | |
| 610 | - } | |
| 611 | - | |
| 612 | - return apply_filters( 'weforms_is_submission_open', $response, $settings, $this ); | |
| 613 | - } | |
| 614 | - | |
| 615 | - public function isPendingForm( $scheduleStart ) { | |
| 616 | - $currentTime = current_time( 'timestamp' ); | |
| 617 | - $startTime = strtotime( $scheduleStart ); | |
| 618 | - | |
| 619 | - if ( $currentTime < $startTime ) { | |
| 620 | - return true; | |
| 621 | - } | |
| 622 | - | |
| 623 | - return false; | |
| 624 | - } | |
| 625 | - | |
| 626 | - public function isExpiredForm( $scheduleEnd ) { | |
| 627 | - $currentTime = current_time( 'timestamp' ); | |
| 628 | - $endTime = strtotime( $scheduleEnd ); | |
| 629 | - | |
| 630 | - if ( $currentTime > $endTime ) { | |
| 631 | - return true; | |
| 632 | - } | |
| 633 | - | |
| 634 | - return false; | |
| 635 | - } | |
| 636 | - | |
| 637 | - public function isOpenForm( $scheduleStart, $scheduleEnd ) { | |
| 638 | - $currentTime = current_time( 'timestamp' ); | |
| 639 | - $startTime = strtotime( $scheduleStart ); | |
| 640 | - $endTime = strtotime( $scheduleEnd ); | |
| 641 | - | |
| 642 | - if ( $currentTime > $startTime && $currentTime < $endTime ) { | |
| 643 | - return true; | |
| 644 | - } | |
| 645 | - | |
| 646 | - return false; | |
| 647 | - } | |
| 648 | - | |
| 649 | - public function isFormStatusClosed( $formSettings, $entries ) { | |
| 650 | - if ( $formSettings['schedule_form'] === 'true' && $this->isPendingForm( $formSettings['schedule_start'] ) ) { | |
| 651 | - return true; | |
| 652 | - } | |
| 653 | - | |
| 654 | - if ( $formSettings['schedule_form'] === 'true' && $this->isExpiredForm( $formSettings['schedule_end'] ) ) { | |
| 655 | - return true; | |
| 656 | - } | |
| 657 | - | |
| 658 | - if ( $formSettings['limit_entries'] === 'true' && $entries >= $formSettings['limit_number'] ) { | |
| 659 | - return true; | |
| 660 | - } | |
| 661 | - | |
| 662 | - return false; | |
| 663 | - } | |
| 664 | -} | |
| 1 | +<?php | |
| 2 | + | |
| 3 | +/** | |
| 4 | + * The Form Class | |
| 5 | + * | |
| 6 | + * @since 1.1.0 | |
| 7 | + */ | |
| 8 | +class WeForms_Form { | |
| 9 | + | |
| 10 | + /** | |
| 11 | + * The form id | |
| 12 | + * | |
| 13 | + * @var integer | |
| 14 | + */ | |
| 15 | + public $id = 0; | |
| 16 | + | |
| 17 | + /** | |
| 18 | + * The form title | |
| 19 | + * | |
| 20 | + * @var string | |
| 21 | + */ | |
| 22 | + public $name = ''; | |
| 23 | + | |
| 24 | + /** | |
| 25 | + * Holds the post data object | |
| 26 | + * | |
| 27 | + * @var null|WP_post | |
| 28 | + */ | |
| 29 | + public $data = null; | |
| 30 | + | |
| 31 | + /** | |
| 32 | + * Form fields | |
| 33 | + * | |
| 34 | + * @var array | |
| 35 | + */ | |
| 36 | + public $form_fields = array(); | |
| 37 | + | |
| 38 | + /** | |
| 39 | + * The Constructor | |
| 40 | + * | |
| 41 | + * @param int|WP_Post $form | |
| 42 | + */ | |
| 43 | + public function __construct( $form = null ) { | |
| 44 | + | |
| 45 | + if ( is_numeric( $form ) ) { | |
| 46 | + | |
| 47 | + $the_post = get_post( $form ); | |
| 48 | + | |
| 49 | + if ( $the_post ) { | |
| 50 | + $this->id = $the_post->ID; | |
| 51 | + $this->name = $the_post->post_title; | |
| 52 | + $this->data = $the_post; | |
| 53 | + } | |
| 54 | + | |
| 55 | + } elseif ( is_a( $form, 'WP_Post' ) ) { | |
| 56 | + $this->id = $form->ID; | |
| 57 | + $this->name = $form->post_title; | |
| 58 | + $this->data = $form; | |
| 59 | + } | |
| 60 | + } | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * Get the form ID | |
| 64 | + * | |
| 65 | + * @return integer | |
| 66 | + */ | |
| 67 | + public function get_id() { | |
| 68 | + return $this->id; | |
| 69 | + } | |
| 70 | + | |
| 71 | + /** | |
| 72 | + * Get the form name | |
| 73 | + * | |
| 74 | + * @return string | |
| 75 | + */ | |
| 76 | + public function get_name() { | |
| 77 | + return $this->name; | |
| 78 | + } | |
| 79 | + | |
| 80 | + /** | |
| 81 | + * Get all form fields of this form | |
| 82 | + * | |
| 83 | + * @return array | |
| 84 | + */ | |
| 85 | + public function get_fields() { | |
| 86 | + | |
| 87 | + // return if already fetched | |
| 88 | + if ( $this->form_fields ) { | |
| 89 | + return $this->form_fields; | |
| 90 | + } | |
| 91 | + | |
| 92 | + $fields = get_children(array( | |
| 93 | + 'post_parent' => $this->id, | |
| 94 | + 'post_status' => 'publish', | |
| 95 | + 'post_type' => 'wpuf_input', | |
| 96 | + 'numberposts' => '-1', | |
| 97 | + 'orderby' => 'menu_order', | |
| 98 | + 'order' => 'ASC', | |
| 99 | + )); | |
| 100 | + | |
| 101 | + $form_fields = array(); | |
| 102 | + | |
| 103 | + foreach ( $fields as $key => $content ) { | |
| 104 | + | |
| 105 | + $field = maybe_unserialize( $content->post_content ); | |
| 106 | + | |
| 107 | + if ( empty( $field['template'] ) ) { | |
| 108 | + continue; | |
| 109 | + } | |
| 110 | + | |
| 111 | + | |
| 112 | + $field['id'] = $content->ID; | |
| 113 | + | |
| 114 | + // Add inline property for radio and checkbox fields | |
| 115 | + $inline_supported_fields = apply_filters( 'inline_supported_fields_list', array( 'radio_field', 'checkbox_field' ) ); | |
| 116 | + if ( in_array( $field['template'] , $inline_supported_fields ) ) { | |
| 117 | + if ( ! isset( $field['inline'] ) ) { | |
| 118 | + $field['inline'] = 'no'; | |
| 119 | + } | |
| 120 | + } | |
| 121 | + | |
| 122 | + // Add 'selected' property | |
| 123 | + $option_based_fields = apply_filters( 'option_based_fields_list', array( 'dropdown_field', 'multiple_select', 'radio_field', 'checkbox_field' ) ); | |
| 124 | + if ( in_array( $field['template'] , $option_based_fields ) ) { | |
| 125 | + if ( ! isset( $field['selected'] ) ) { | |
| 126 | + | |
| 127 | + if ( 'dropdown_field' === $field['template'] || 'radio_field' === $field['template'] ) { | |
| 128 | + $field['selected'] = ''; | |
| 129 | + } else { | |
| 130 | + $field['selected'] = array(); | |
| 131 | + } | |
| 132 | + | |
| 133 | + } | |
| 134 | + } | |
| 135 | + | |
| 136 | + // Add 'multiple' key for template:repeat | |
| 137 | + if ( 'repeat_field' === $field['template'] && ! isset( $field['multiple'] ) ) { | |
| 138 | + $field['multiple'] = ''; | |
| 139 | + } | |
| 140 | + | |
| 141 | + if ( 'recaptcha' === $field['template'] ) { | |
| 142 | + $field['name'] = 'recaptcha'; | |
| 143 | + $field['enable_no_captcha'] = isset( $field['enable_no_captcha'] ) ? $field['enable_no_captcha'] : ''; | |
| 144 | + | |
| 145 | + } | |
| 146 | + | |
| 147 | + if ( 'custom_html' === $field['template'] ) { | |
| 148 | + $field['name'] = 'custom_html'; | |
| 149 | + } | |
| 150 | + | |
| 151 | + $form_fields[] = apply_filters( 'weforms-get-form-field', $field ); | |
| 152 | + } | |
| 153 | + | |
| 154 | + $this->form_fields = apply_filters( 'weforms-get-form-fields', $form_fields ); | |
| 155 | + | |
| 156 | + return $this->form_fields; | |
| 157 | + } | |
| 158 | + | |
| 159 | + /** | |
| 160 | + * Check if any perticular field template is used in a form | |
| 161 | + * | |
| 162 | + * @return array | |
| 163 | + */ | |
| 164 | + public function has_field( $field_template ) { | |
| 165 | + | |
| 166 | + foreach ( $this->get_fields() as $key => $field) { | |
| 167 | + if ( isset( $field['template'] ) && $field['template'] == $field_template) { | |
| 168 | + return true; | |
| 169 | + } | |
| 170 | + } | |
| 171 | + } | |
| 172 | + | |
| 173 | + | |
| 174 | + /** | |
| 175 | + * Get all fields by a template | |
| 176 | + * | |
| 177 | + * @return array | |
| 178 | + */ | |
| 179 | + public function search_fields( $field_template ) { | |
| 180 | + | |
| 181 | + $fields = array(); | |
| 182 | + | |
| 183 | + foreach ( $this->get_fields() as $key => $field) { | |
| 184 | + if ( isset( $field['template'] ) && $field['template'] == $field_template) { | |
| 185 | + $fields[] = $field; | |
| 186 | + } | |
| 187 | + } | |
| 188 | + | |
| 189 | + return $fields; | |
| 190 | + } | |
| 191 | + | |
| 192 | + /** | |
| 193 | + * Search fileds and get the first one | |
| 194 | + * | |
| 195 | + * @return array | |
| 196 | + */ | |
| 197 | + public function search_field( $field_template ) { | |
| 198 | + | |
| 199 | + $fields = $this->search_fields($field_template); | |
| 200 | + | |
| 201 | + return isset($fields[0]) ? $fields[0] : array(); | |
| 202 | + } | |
| 203 | + | |
| 204 | + /** | |
| 205 | + * Get formatted field name/values | |
| 206 | + * | |
| 207 | + * @return array | |
| 208 | + */ | |
| 209 | + public function get_field_values() { | |
| 210 | + $values = array(); | |
| 211 | + $fields = $this->get_fields(); | |
| 212 | + | |
| 213 | + if ( ! $fields ) { | |
| 214 | + return $values; | |
| 215 | + } | |
| 216 | + | |
| 217 | + $ignore_fields = apply_filters( 'ignore_fields_list', array( 'recaptcha', 'section_break' ) ); | |
| 218 | + $options_fields = apply_filters( 'option_fields_list', array( 'dropdown_field', 'radio_field', 'multiple_select', 'checkbox_field' ) ); | |
| 219 | + | |
| 220 | + foreach ($fields as $field) { | |
| 221 | + | |
| 222 | + if ( in_array( $field['template'], $ignore_fields ) ) { | |
| 223 | + continue; | |
| 224 | + } | |
| 225 | + | |
| 226 | + if ( ! isset( $field['name'] ) ) { | |
| 227 | + continue; | |
| 228 | + } | |
| 229 | + | |
| 230 | + $value = array( | |
| 231 | + 'label' => isset( $field['label'] ) ? $field['label'] : '', | |
| 232 | + 'type' => $field['template'], | |
| 233 | + ); | |
| 234 | + | |
| 235 | + // put options if this is an option field | |
| 236 | + if ( in_array( $field['template'], $options_fields ) ) { | |
| 237 | + $value['options'] = $field['options']; | |
| 238 | + } | |
| 239 | + | |
| 240 | + $values[ $field['name'] ] = array_merge( $field, $value); | |
| 241 | + } | |
| 242 | + | |
| 243 | + return apply_filters( 'weforms_get_field_values', $values );; | |
| 244 | + } | |
| 245 | + | |
| 246 | + /** | |
| 247 | + * Get form settings | |
| 248 | + * | |
| 249 | + * @return array | |
| 250 | + */ | |
| 251 | + public function get_settings() { | |
| 252 | + | |
| 253 | + $settings = get_post_meta( $this->id, 'wpuf_form_settings', true ); | |
| 254 | + $default = weforms_get_default_form_settings(); | |
| 255 | + | |
| 256 | + return array_merge( $default, $settings); | |
| 257 | + } | |
| 258 | + | |
| 259 | + /** | |
| 260 | + * Check if the form submission is open | |
| 261 | + * | |
| 262 | + * @return boolean|WP_Error | |
| 263 | + */ | |
| 264 | + public function is_submission_open() { | |
| 265 | + $settings = $this->get_settings(); | |
| 266 | + | |
| 267 | + $needs_login = ( isset( $settings['require_login'] ) && $settings['require_login'] == 'true' ) ? true : false; | |
| 268 | + $has_limit = ( isset( $settings['limit_entries'] ) && $settings['limit_entries'] == 'true' ) ? true : false; | |
| 269 | + $is_scheduled = ( isset( $settings['schedule_form'] ) && $settings['schedule_form'] == 'true' ) ? true : false; | |
| 270 | + | |
| 271 | + if ( $this->data->post_status != 'publish' ) { | |
| 272 | + return new WP_Error( 'needs-publish', __( 'The form is not published yet.', 'weforms' ) ); | |
| 273 | + } | |
| 274 | + | |
| 275 | + if ( $needs_login && !is_user_logged_in() ) { | |
| 276 | + return new WP_Error( 'needs-login', $settings['req_login_message'] ); | |
| 277 | + } | |
| 278 | + | |
| 279 | + if ( $has_limit ) { | |
| 280 | + $limit = (int) $settings['limit_number']; | |
| 281 | + $form_entries = $this->num_form_entries(); | |
| 282 | + | |
| 283 | + if ( $limit < $form_entries ) { | |
| 284 | + return new WP_Error( 'entry-limit', $settings['limit_message'] ); | |
| 285 | + } | |
| 286 | + } | |
| 287 | + | |
| 288 | + if ( $is_scheduled ) { | |
| 289 | + $start_time = strtotime( $settings['schedule_start'] ); | |
| 290 | + $end_time = strtotime( $settings['schedule_end'] ); | |
| 291 | + $current_time = current_time( 'timestamp' ); | |
| 292 | + | |
| 293 | + // too early? | |
| 294 | + if ( $current_time < $start_time ) { | |
| 295 | + return new WP_Error( 'form-pending', $settings['sc_pending_message'] ); | |
| 296 | + } elseif ( $current_time > $end_time ) { | |
| 297 | + return new WP_Error( 'form-expired', $settings['sc_expired_message'] ); | |
| 298 | + } | |
| 299 | + } | |
| 300 | + | |
| 301 | + return true; | |
| 302 | + } | |
| 303 | + | |
| 304 | + /** | |
| 305 | + * Get form notifications | |
| 306 | + * | |
| 307 | + * @return array | |
| 308 | + */ | |
| 309 | + public function get_notifications() { | |
| 310 | + $notifications = get_post_meta( $this->id, 'notifications', true ); | |
| 311 | + $defualt = weforms_get_default_form_notification(); | |
| 312 | + | |
| 313 | + if ( ! $notifications ) { | |
| 314 | + $notifications = array(); | |
| 315 | + } | |
| 316 | + | |
| 317 | + $notifications = array_map( function( $notification ) use ( $defualt ) { | |
| 318 | + return array_merge( $defualt, $notification); | |
| 319 | + }, $notifications); | |
| 320 | + | |
| 321 | + return $notifications; | |
| 322 | + } | |
| 323 | + | |
| 324 | + /** | |
| 325 | + * Get all the integrations | |
| 326 | + * | |
| 327 | + * @return array | |
| 328 | + */ | |
| 329 | + public function get_integrations() { | |
| 330 | + $integrations = get_post_meta( $this->id, 'integrations', true ); | |
| 331 | + | |
| 332 | + if ( ! $integrations ) { | |
| 333 | + return array(); | |
| 334 | + } | |
| 335 | + | |
| 336 | + return $integrations; | |
| 337 | + } | |
| 338 | + | |
| 339 | + /** | |
| 340 | + * Get entries of this form | |
| 341 | + * | |
| 342 | + * @return \WeForms_Form_Entry_Manager | |
| 343 | + */ | |
| 344 | + public function entries() { | |
| 345 | + return new WeForms_Form_Entry_Manager( $this->id, $this ); | |
| 346 | + } | |
| 347 | + | |
| 348 | + /** | |
| 349 | + * Get number of form entries | |
| 350 | + * | |
| 351 | + * @return integer | |
| 352 | + */ | |
| 353 | + public function num_form_entries() { | |
| 354 | + return weforms_count_form_entries( $this->id ); | |
| 355 | + } | |
| 356 | + | |
| 357 | + /** | |
| 358 | + * Get number of form payments | |
| 359 | + * | |
| 360 | + * @return integer | |
| 361 | + */ | |
| 362 | + public function num_form_payments() { | |
| 363 | + return weforms_count_form_payments( $this->id ); | |
| 364 | + } | |
| 365 | + | |
| 366 | + /** | |
| 367 | + * Get the number of form views | |
| 368 | + * | |
| 369 | + * @return integer | |
| 370 | + */ | |
| 371 | + public function num_form_views() { | |
| 372 | + return weforms_get_form_views( $this->id ); | |
| 373 | + } | |
| 374 | + | |
| 375 | + | |
| 376 | + /** | |
| 377 | + * prepare_entries | |
| 378 | + * | |
| 379 | + * @return array | |
| 380 | + */ | |
| 381 | + public function prepare_entries() { | |
| 382 | + | |
| 383 | + $fields = weforms()->fields->get_fields(); | |
| 384 | + $form_fields = $this->get_fields(); | |
| 385 | + | |
| 386 | + $entry_fields = array(); | |
| 387 | + | |
| 388 | + $ignore_list = apply_filters('wefroms_entry_ignore_list', array( | |
| 389 | + 'section_break', | |
| 390 | + 'custom_html', | |
| 391 | + 'recaptcha' | |
| 392 | + ) ); | |
| 393 | + | |
| 394 | + foreach ($form_fields as $field) { | |
| 395 | + | |
| 396 | + if ( in_array( $field['template'], $ignore_list ) ) { | |
| 397 | + continue; | |
| 398 | + } | |
| 399 | + | |
| 400 | + if ( ! array_key_exists( $field['template'], $fields ) ) { | |
| 401 | + continue; | |
| 402 | + } | |
| 403 | + | |
| 404 | + $field_class = $fields[ $field['template'] ]; | |
| 405 | + | |
| 406 | + $entry_fields[ $field['name'] ] = $field_class->prepare_entry( $field ); | |
| 407 | + } | |
| 408 | + | |
| 409 | + return apply_filters( 'weforms_prepare_entries', $entry_fields ); | |
| 410 | + } | |
| 411 | +} | |
