class-gf-field-name.php
29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
<?php
// If Gravity Forms isn't loaded, bail.
if ( ! class_exists( 'GFForms' ) ) {
die();
}
/**
* Class GF_Field_Name
*
* Handles the behavior of the Name field.
*
* @since Unknown
*/
class GF_Field_Name extends GF_Field {
/**
* Sets the field type.
*
* @since Unknown
* @access public
*
* @var string The type of field.
*/
public $type = 'name';
/**
* Sets the field title of the Name field.
*
* @since Unknown
* @access public
*
* @used-by GFCommon::get_field_type_title()
* @used-by GF_Field::get_form_editor_button()
*
* @return string
*/
public function get_form_editor_field_title() {
return esc_attr__( 'Name', 'gravityforms' );
}
/**
* Defines if conditional logic is supported by the Name field.
*
* @since Unknown
* @access public
*
* @used-by GFFormDetail::inline_scripts()
* @used-by GFFormSettings::output_field_scripts()
*
* @return bool true
*/
public function is_conditional_logic_supported() {
return true;
}
/**
* Validates Name field inputs.
*
* @since Unknown
* @access public
*
* @used-by GFFormDisplay::validate()
* @uses GF_Field_Name::$isRequired
* @uses GF_Field_Name::$nameFormat
* @uses GF_Field_Name::get_input_property
* @uses GF_Field_Name::$failed_validation
* @uses GF_Field_Name::$validation_message
* @uses GF_Field_Name::$errorMessage
*
* @param array|string $value The value of the field to validate. Not used here.
* @param array $form The Form Object. Not used here.
*
* @return void
*/
function validate( $value, $form ) {
if ( $this->isRequired && $this->nameFormat != 'simple' ) {
$first = rgpost( 'input_' . $this->id . '_3' );
$last = rgpost( 'input_' . $this->id . '_6' );
if ( ( empty( $first ) && ! $this->get_input_property( '3', 'isHidden' ) )
|| ( empty( $last ) && ! $this->get_input_property( '6', 'isHidden' ) ) ) {
$this->failed_validation = true;
$this->validation_message = empty( $this->errorMessage ) ? esc_html__( 'This field is required. Please enter the first and last name.', 'gravityforms' ) : $this->errorMessage;
}
}
}
/**
* Defines the field settings available for the Name field in the form editor.
*
* @since Unknown
* @access public
*
* @used-by GFFormDetail::inline_scripts()
*
* @return array The field settings available.
*/
function get_form_editor_field_settings() {
return array(
'conditional_logic_field_setting',
'prepopulate_field_setting',
'error_message_setting',
'label_setting',
'admin_label_setting',
'label_placement_setting',
'sub_label_placement_setting',
'default_input_values_setting',
'input_placeholders_setting',
'name_setting',
'rules_setting',
'visibility_setting',
'description_setting',
'css_class_setting',
);
}
/**
* Gets the HTML markup for the field input.
*
* @since Unknown
* @access public
*
* @used-by GFCommon::get_field_input()
* @uses GF_Field::is_entry_detail()
* @uses GF_Field::is_form_editor()
* @uses GF_Field_Name::$size
* @uses GF_Field_Name::$id
* @uses GF_Field_Name::$subLabelPlacement
* @uses GF_Field_Name::$isRequired
* @uses GF_Field_Name::$failed_validation
* @uses GFForms::get()
* @uses GFFormsModel::get_input()
* @uses GFCommon::get_input_placeholder_attribute()
* @uses GFCommon::get_tabindex()
* @uses GFCommon::get_field_placeholder_attribute()
* @uses GF_Field_Name::get_css_class()
*
* @param array $form The Form Object.
* @param string $value The value of the field. Defaults to empty string.
* @param array|null $entry The Entry Object. Defaults to null.
*
* @return string The HTML markup for the field input.
*/
public function get_field_input( $form, $value = '', $entry = null ) {
$is_entry_detail = $this->is_entry_detail();
$is_form_editor = $this->is_form_editor();
$is_admin = $is_entry_detail || $is_form_editor;
$form_id = $form['id'];
$id = intval( $this->id );
$field_id = $is_entry_detail || $is_form_editor || $form_id == 0 ? "input_$id" : 'input_' . $form_id . "_$id";
$form_id = ( $is_entry_detail || $is_form_editor ) && empty( $form_id ) ? rgget( 'id' ) : $form_id;
$size = $this->size;
$class_suffix = RG_CURRENT_VIEW == 'entry' ? '_admin' : '';
$class = $size . $class_suffix;
$disabled_text = $is_form_editor ? "disabled='disabled'" : '';
$class_suffix = $is_entry_detail ? '_admin' : '';
$form_sub_label_placement = rgar( $form, 'subLabelPlacement' );
$field_sub_label_placement = $this->subLabelPlacement;
$is_sub_label_above = $field_sub_label_placement == 'above' || ( empty( $field_sub_label_placement ) && $form_sub_label_placement == 'above' );
$sub_label_class_attribute = $field_sub_label_placement == 'hidden_label' ? "class='hidden_sub_label screen-reader-text'" : '';
$prefix = '';
$first = '';
$middle = '';
$last = '';
$suffix = '';
if ( is_array( $value ) ) {
$prefix = esc_attr( GFForms::get( $this->id . '.2', $value ) );
$first = esc_attr( GFForms::get( $this->id . '.3', $value ) );
$middle = esc_attr( GFForms::get( $this->id . '.4', $value ) );
$last = esc_attr( GFForms::get( $this->id . '.6', $value ) );
$suffix = esc_attr( GFForms::get( $this->id . '.8', $value ) );
}
$prefix_input = GFFormsModel::get_input( $this, $this->id . '.2' );
$first_input = GFFormsModel::get_input( $this, $this->id . '.3' );
$middle_input = GFFormsModel::get_input( $this, $this->id . '.4' );
$last_input = GFFormsModel::get_input( $this, $this->id . '.6' );
$suffix_input = GFFormsModel::get_input( $this, $this->id . '.8' );
$first_placeholder_attribute = GFCommon::get_input_placeholder_attribute( $first_input );
$middle_placeholder_attribute = GFCommon::get_input_placeholder_attribute( $middle_input );
$last_placeholder_attribute = GFCommon::get_input_placeholder_attribute( $last_input );
$suffix_placeholder_attribute = GFCommon::get_input_placeholder_attribute( $suffix_input );
// ARIA labels. Prefix is handled in self::get_name_prefix_field().
$first_name_aria_label = esc_attr__( 'First name', 'gravityforms' );
$middle_name_aria_label = esc_attr__( 'Middle name', 'gravityforms' );
$last_name_aria_label = esc_attr__( 'Last name', 'gravityforms' );
$suffix_aria_label = esc_attr__( 'Name suffix', 'gravityforms' );
$required_attribute = $this->isRequired ? 'aria-required="true"' : '';
$invalid_attribute = $this->failed_validation ? 'aria-invalid="true"' : 'aria-invalid="false"';
switch ( $this->nameFormat ) {
case 'advanced' :
case 'extended' :
$prefix_tabindex = GFCommon::get_tabindex();
$first_tabindex = GFCommon::get_tabindex();
$middle_tabindex = GFCommon::get_tabindex();
$last_tabindex = GFCommon::get_tabindex();
$suffix_tabindex = GFCommon::get_tabindex();
$prefix_sub_label = rgar( $prefix_input, 'customLabel' ) != '' ? $prefix_input['customLabel'] : gf_apply_filters( array( 'gform_name_prefix', $form_id ), esc_html__( 'Prefix', 'gravityforms' ), $form_id );
$first_name_sub_label = rgar( $first_input, 'customLabel' ) != '' ? $first_input['customLabel'] : gf_apply_filters( array( 'gform_name_first', $form_id ), esc_html__( 'First', 'gravityforms' ), $form_id );
$middle_name_sub_label = rgar( $middle_input, 'customLabel' ) != '' ? $middle_input['customLabel'] : gf_apply_filters( array( 'gform_name_middle', $form_id ), esc_html__( 'Middle', 'gravityforms' ), $form_id );
$last_name_sub_label = rgar( $last_input, 'customLabel' ) != '' ? $last_input['customLabel'] : gf_apply_filters( array( 'gform_name_last', $form_id ), esc_html__( 'Last', 'gravityforms' ), $form_id );
$suffix_sub_label = rgar( $suffix_input, 'customLabel' ) != '' ? $suffix_input['customLabel'] : gf_apply_filters( array( 'gform_name_suffix', $form_id ), esc_html__( 'Suffix', 'gravityforms' ), $form_id );
$prefix_markup = '';
$first_markup = '';
$middle_markup = '';
$last_markup = '';
$suffix_markup = '';
if ( $is_sub_label_above ) {
$style = ( $is_admin && rgar( $prefix_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $prefix_input, 'isHidden' ) ) {
$prefix_select_class = isset( $prefix_input['choices'] ) && is_array( $prefix_input['choices'] ) ? 'name_prefix_select' : '';
$prefix_markup = self::get_name_prefix_field( $prefix_input, $id, $field_id, $prefix, $disabled_text, $prefix_tabindex );
$prefix_markup = "<span id='{$field_id}_2_container' class='name_prefix {$prefix_select_class}' {$style}>
<label for='{$field_id}_2' {$sub_label_class_attribute}>{$prefix_sub_label}</label>
{$prefix_markup}
</span>";
}
$style = ( $is_admin && rgar( $first_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $first_input, 'isHidden' ) ) {
$first_markup = "<span id='{$field_id}_3_container' class='name_first' {$style}>
<label for='{$field_id}_3' {$sub_label_class_attribute}>{$first_name_sub_label}</label>
<input type='text' name='input_{$id}.3' id='{$field_id}_3' value='{$first}' aria-label='{$first_name_aria_label}' {$first_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$first_placeholder_attribute}/>
</span>";
}
$style = ( $is_admin && ( ! isset( $middle_input['isHidden'] ) || rgar( $middle_input, 'isHidden' ) ) ) ? "style='display:none;'" : '';
if ( $is_admin || ( isset( $middle_input['isHidden'] ) && $middle_input['isHidden'] == false ) ) {
$middle_markup = "<span id='{$field_id}_4_container' class='name_middle' {$style}>
<label for='{$field_id}_4' {$sub_label_class_attribute}>{$middle_name_sub_label}</label>
<input type='text' name='input_{$id}.4' id='{$field_id}_4' value='{$middle}' aria-label='{$middle_name_aria_label}' {$middle_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$middle_placeholder_attribute}/>
</span>";
}
$style = ( $is_admin && rgar( $last_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $last_input, 'isHidden' ) ) {
$last_markup = "<span id='{$field_id}_6_container' class='name_last' {$style}>
<label for='{$field_id}_6' {$sub_label_class_attribute}>{$last_name_sub_label}</label>
<input type='text' name='input_{$id}.6' id='{$field_id}_6' value='{$last}' aria-label='{$last_name_aria_label}' {$last_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$last_placeholder_attribute}/>
</span>";
}
$style = ( $is_admin && rgar( $suffix_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $suffix_input, 'isHidden' ) ) {
$suffix_select_class = isset( $suffix_input['choices'] ) && is_array( $suffix_input['choices'] ) ? 'name_suffix_select' : '';
$suffix_markup = "<span id='{$field_id}_8_container' class='name_suffix {$suffix_select_class}' {$style}>
<label for='{$field_id}_8' {$sub_label_class_attribute}>{$suffix_sub_label}</label>
<input type='text' name='input_{$id}.8' id='{$field_id}_8' value='{$suffix}' aria-label='{$suffix_aria_label}' {$suffix_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$suffix_placeholder_attribute}/>
</span>";
}
} else {
$style = ( $is_admin && rgar( $prefix_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $prefix_input, 'isHidden' ) ) {
$prefix_select_class = isset( $prefix_input['choices'] ) && is_array( $prefix_input['choices'] ) ? 'name_prefix_select' : '';
$prefix_markup = self::get_name_prefix_field( $prefix_input, $id, $field_id, $prefix, $disabled_text, $prefix_tabindex );
$prefix_markup = "<span id='{$field_id}_2_container' class='name_prefix {$prefix_select_class}' {$style}>
{$prefix_markup}
<label for='{$field_id}_2' {$sub_label_class_attribute}>{$prefix_sub_label}</label>
</span>";
}
$style = ( $is_admin && rgar( $first_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $first_input, 'isHidden' ) ) {
$first_markup = "<span id='{$field_id}_3_container' class='name_first' {$style}>
<input type='text' name='input_{$id}.3' id='{$field_id}_3' value='{$first}' aria-label='{$first_name_aria_label}' {$first_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$first_placeholder_attribute}/>
<label for='{$field_id}_3' {$sub_label_class_attribute}>{$first_name_sub_label}</label>
</span>";
}
$style = ( $is_admin && ( ! isset( $middle_input['isHidden'] ) || rgar( $middle_input, 'isHidden' ) ) ) ? "style='display:none;'" : '';
if ( $is_admin || ( isset( $middle_input['isHidden'] ) && $middle_input['isHidden'] == false ) ) {
$middle_markup = "<span id='{$field_id}_4_container' class='name_middle' {$style}>
<input type='text' name='input_{$id}.4' id='{$field_id}_4' value='{$middle}' aria-label='{$middle_name_aria_label}' {$middle_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$middle_placeholder_attribute}/>
<label for='{$field_id}_4' {$sub_label_class_attribute}>{$middle_name_sub_label}</label>
</span>";
}
$style = ( $is_admin && rgar( $last_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $last_input, 'isHidden' ) ) {
$last_markup = "<span id='{$field_id}_6_container' class='name_last' {$style}>
<input type='text' name='input_{$id}.6' id='{$field_id}_6' value='{$last}' aria-label='{$last_name_aria_label}' {$last_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$last_placeholder_attribute}/>
<label for='{$field_id}_6' {$sub_label_class_attribute}>{$last_name_sub_label}</label>
</span>";
}
$style = ( $is_admin && rgar( $suffix_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $suffix_input, 'isHidden' ) ) {
$suffix_select_class = isset( $suffix_input['choices'] ) && is_array( $suffix_input['choices'] ) ? 'name_suffix_select' : '';
$suffix_markup = "<span id='{$field_id}_8_container' class='name_suffix {$suffix_select_class}' {$style}>
<input type='text' name='input_{$id}.8' id='{$field_id}_8' value='{$suffix}' aria-label='{$suffix_aria_label}' {$suffix_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$suffix_placeholder_attribute}/>
<label for='{$field_id}_8' {$sub_label_class_attribute}>{$suffix_sub_label}</label>
</span>";
}
}
$css_class = $this->get_css_class();
return "<div class='ginput_complex{$class_suffix} ginput_container {$css_class} gfield_trigger_change' id='{$field_id}'>
{$prefix_markup}
{$first_markup}
{$middle_markup}
{$last_markup}
{$suffix_markup}
</div>";
case 'simple' :
$value = esc_attr( $value );
$class = esc_attr( $class );
$tabindex = GFCommon::get_tabindex();
$placeholder_attribute = GFCommon::get_field_placeholder_attribute( $this );
return "<div class='ginput_container ginput_container_name'>
<input name='input_{$id}' id='{$field_id}' type='text' value='{$value}' class='{$class}' {$tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$placeholder_attribute}/>
</div>";
default :
$first_tabindex = GFCommon::get_tabindex();
$last_tabindex = GFCommon::get_tabindex();
$first_name_sub_label = rgar( $first_input, 'customLabel' ) != '' ? $first_input['customLabel'] : gf_apply_filters( array( 'gform_name_first', $form_id ), esc_html__( 'First', 'gravityforms' ), $form_id );
$last_name_sub_label = rgar( $last_input, 'customLabel' ) != '' ? $last_input['customLabel'] : gf_apply_filters( array( 'gform_name_last', $form_id ), esc_html__( 'Last', 'gravityforms' ), $form_id );
if ( $is_sub_label_above ) {
$first_markup = '';
$style = ( $is_admin && rgar( $first_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $first_input, 'isHidden' ) ) {
$first_markup = "<span id='{$field_id}_3_container' class='name_first' {$style}>
<label for='{$field_id}_3' {$sub_label_class_attribute}>{$first_name_sub_label}</label>
<input type='text' name='input_{$id}.3' id='{$field_id}_3' value='{$first}' aria-label='{$first_name_aria_label}' {$first_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$first_placeholder_attribute}/>
</span>";
}
$last_markup = '';
$style = ( $is_admin && rgar( $last_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $last_input, 'isHidden' ) ) {
$last_markup = "<span id='{$field_id}_6_container' class='name_last' {$style}>
<label for='{$field_id}_6' {$sub_label_class_attribute}>" . $last_name_sub_label . "</label>
<input type='text' name='input_{$id}.6' id='{$field_id}_6' value='{$last}' aria-label='{$last_name_aria_label}' {$last_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$last_placeholder_attribute}/>
</span>";
}
} else {
$first_markup = '';
$style = ( $is_admin && rgar( $first_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $first_input, 'isHidden' ) ) {
$first_markup = "<span id='{$field_id}_3_container' class='name_first' {$style}>
<input type='text' name='input_{$id}.3' id='{$field_id}_3' value='{$first}' aria-label='{$first_name_aria_label}' {$first_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$first_placeholder_attribute}/>
<label for='{$field_id}_3' {$sub_label_class_attribute}>{$first_name_sub_label}</label>
</span>";
}
$last_markup = '';
$style = ( $is_admin && rgar( $last_input, 'isHidden' ) ) ? "style='display:none;'" : '';
if ( $is_admin || ! rgar( $last_input, 'isHidden' ) ) {
$last_markup = "<span id='{$field_id}_6_container' class='name_last' {$style}>
<input type='text' name='input_{$id}.6' id='{$field_id}_6' value='{$last}' aria-label='{$last_name_aria_label}' {$last_tabindex} {$disabled_text} {$required_attribute} {$invalid_attribute} {$last_placeholder_attribute}/>
<label for='{$field_id}_6' {$sub_label_class_attribute}>{$last_name_sub_label}</label>
</span>";
}
}
$css_class = $this->get_css_class();
return "<div class='ginput_complex{$class_suffix} ginput_container {$css_class}' id='{$field_id}'>
{$first_markup}
{$last_markup}
<div class='gf_clear gf_clear_complex'></div>
</div>";
}
}
/**
* Defines the CSS class to be applied to the field label.
*
* @since Unknown
* @access public
*
* @used-by GF_Field::get_field_content()
*
* @return string The CSS class.
*/
public function get_field_label_class() {
return 'gfield_label gfield_label_before_complex';
}
/**
* Sets the CSS class to be used by the field input.
*
* @since Unknown
* @access public
*
* @used-by GF_Field_Name::get_field_input()
* @uses GFFormsModel::get_input()
*
* @return string The CSS class to use for the field.
*/
public function get_css_class() {
$prefix_input = GFFormsModel::get_input( $this, $this->id . '.2' );
$first_input = GFFormsModel::get_input( $this, $this->id . '.3' );
$middle_input = GFFormsModel::get_input( $this, $this->id . '.4' );
$last_input = GFFormsModel::get_input( $this, $this->id . '.6' );
$suffix_input = GFFormsModel::get_input( $this, $this->id . '.8' );
$css_class = '';
$visible_input_count = 0;
if ( $prefix_input && ! rgar( $prefix_input, 'isHidden' ) ) {
$visible_input_count++;
$css_class .= 'has_prefix ';
} else {
$css_class .= 'no_prefix ';
}
if ( $first_input && ! rgar( $first_input, 'isHidden' ) ) {
$visible_input_count++;
$css_class .= 'has_first_name ';
} else {
$css_class .= 'no_first_name ';
}
if ( $middle_input && ! rgar( $middle_input, 'isHidden' ) ) {
$visible_input_count++;
$css_class .= 'has_middle_name ';
} else {
$css_class .= 'no_middle_name ';
}
if ( $last_input && ! rgar( $last_input, 'isHidden' ) ) {
$visible_input_count++;
$css_class .= 'has_last_name ';
} else {
$css_class .= 'no_last_name ';
}
if ( $suffix_input && ! rgar( $suffix_input, 'isHidden' ) ) {
$visible_input_count++;
$css_class .= 'has_suffix ';
} else {
$css_class .= 'no_suffix ';
}
$css_class .= "gf_name_has_{$visible_input_count} ginput_container_name ";
return trim( $css_class );
}
/**
* Defines the field markup to be used for the name prefix.
*
* @since Unknown
* @access public
*
* @used-by GF_Field_Name::get_field_input()
* @uses GFCommon::get_input_placeholder_value()
* @uses GFCommon::get_input_placeholder_attribute()
*
* @param array $input The input item choices.
* @param int $id The ID of the name field.
* @param int $field_id The field ID of the name field.
* @param string $value The value to be used in the prefix field item.
* @param string $disabled_text The text to be used if the prefix field item is disabled.
* @param int $tabindex The tab index of the prefix field item.
*
* @return string The field HTML markup.
*/
public static function get_name_prefix_field( $input, $id, $field_id, $value, $disabled_text, $tabindex ) {
$prefix_aria_label = esc_attr__( 'Name prefix', 'gravityforms' );
if ( isset( $input['choices'] ) && is_array( $input['choices'] ) ) {
$placeholder_value = GFCommon::get_input_placeholder_value( $input );
$options = "<option value=''>{$placeholder_value}</option>";
$value_enabled = rgar( $input, 'enableChoiceValue' );
foreach ( $input['choices'] as $choice ) {
$choice_value = $value_enabled ? $choice['value'] : $choice['text'];
$is_selected_by_default = rgar( $choice, 'isSelected' );
$is_this_choice_selected = empty( $value ) ? $is_selected_by_default : strtolower( $choice_value ) == strtolower( $value );
$selected = $is_this_choice_selected ? "selected='selected'" : '';
$options .= "<option value='{$choice_value}' {$selected}>{$choice['text']}</option>";
}
$markup = "<select name='input_{$id}.2' id='{$field_id}_2' aria-label='{$prefix_aria_label}' {$tabindex} {$disabled_text}>
{$options}
</select>";
} else {
$placeholder_attribute = GFCommon::get_input_placeholder_attribute( $input );
$markup = "<input type='text' name='input_{$id}.2' id='{$field_id}_2' value='{$value}' aria-label='{$prefix_aria_label}' {$tabindex} {$disabled_text} {$placeholder_attribute}/>";
}
return $markup;
}
/**
* Gets the field value to be displayed on the entry detail page.
*
* @since Unknown
* @access public
*
* @used-by GFCommon::get_lead_field_display()
* @uses GF_Field_Name::$id
*
* @param array|string $value The value of the field input.
* @param string $currency Not used.
* @param bool $use_text Not used.
* @param string $format The format to output the value. Defaults to 'html'.
* @param string $media Not used.
*
* @return array|string The value to be displayed on the entry detail page.
*/
public function get_value_entry_detail( $value, $currency = '', $use_text = false, $format = 'html', $media = 'screen' ) {
if ( is_array( $value ) ) {
$prefix = trim( rgget( $this->id . '.2', $value ) );
$first = trim( rgget( $this->id . '.3', $value ) );
$middle = trim( rgget( $this->id . '.4', $value ) );
$last = trim( rgget( $this->id . '.6', $value ) );
$suffix = trim( rgget( $this->id . '.8', $value ) );
$name = $prefix;
$name .= ! empty( $name ) && ! empty( $first ) ? " $first" : $first;
$name .= ! empty( $name ) && ! empty( $middle ) ? " $middle" : $middle;
$name .= ! empty( $name ) && ! empty( $last ) ? " $last" : $last;
$name .= ! empty( $name ) && ! empty( $suffix ) ? " $suffix" : $suffix;
$return = $name;
} else {
$return = $value;
}
if ( $format === 'html' ) {
$return = esc_html( $return );
}
return $return;
}
/**
* Gets a property value from an input.
*
* @since Unknown
* @access public
*
* @used-by GF_Field_Name::validate()
* @uses GFFormsModel::get_input()
*
* @param int $input_id The input ID to obtain the property from.
* @param string $property_name The property name to search for.
*
* @return null|string The property value if found. Otherwise, null.
*/
public function get_input_property( $input_id, $property_name ) {
$input = GFFormsModel::get_input( $this, $this->id . '.' . (string) $input_id );
return rgar( $input, $property_name );
}
/**
* Sanitizes the field settings choices.
*
* @since Unknown
* @access public
*
* @used-by GFFormDetail::add_field()
* @used-by GFFormsModel::sanitize_settings()
* @uses GF_Field::sanitize_settings()
* @uses GF_Field::sanitize_settings_choices()
*
* @return void
*/
public function sanitize_settings() {
parent::sanitize_settings();
if ( is_array( $this->inputs ) ) {
foreach ( $this->inputs as &$input ) {
if ( isset ( $input['choices'] ) && is_array( $input['choices'] ) ) {
$input['choices'] = $this->sanitize_settings_choices( $input['choices'] );
}
}
}
}
/**
* Gets the field value to be used when exporting.
*
* @since Unknown
* @access public
*
* @used-by GFExport::start_export()
* @used-by GFAddOn::get_field_value()
* @used-by GFAddOn::get_full_name()
*
* @param array $entry The Entry Object.
* @param string $input_id The input ID to format. Defaults to empty string. If not set, uses t
* @param bool $use_text Not used.
* @param bool $is_csv Not used.
*
* @return string The field value.
*/
public function get_value_export( $entry, $input_id = '', $use_text = false, $is_csv = false ) {
if ( empty( $input_id ) ) {
$input_id = $this->id;
}
if ( absint( $input_id ) == $input_id ) {
// If field is simple (one input), simply return full content.
$name = rgar( $entry, $input_id );
if ( ! empty( $name ) ) {
return $name;
}
// Complex field (multiple inputs). Join all pieces and create name.
$prefix = trim( rgar( $entry, $input_id . '.2' ) );
$first = trim( rgar( $entry, $input_id . '.3' ) );
$middle = trim( rgar( $entry, $input_id . '.4' ) );
$last = trim( rgar( $entry, $input_id . '.6' ) );
$suffix = trim( rgar( $entry, $input_id . '.8' ) );
$name = $prefix;
$name .= ! empty( $name ) && ! empty( $first ) ? ' ' . $first : $first;
$name .= ! empty( $name ) && ! empty( $middle ) ? ' ' . $middle : $middle;
$name .= ! empty( $name ) && ! empty( $last ) ? ' ' . $last : $last;
$name .= ! empty( $name ) && ! empty( $suffix ) ? ' ' . $suffix : $suffix;
return $name;
} else {
return rgar( $entry, $input_id );
}
}
}
// Registers the Name field with the field framework.
GF_Fields::register( new GF_Field_Name() );