-
Notifications
You must be signed in to change notification settings - Fork 2
/
name.module
1951 lines (1809 loc) · 62.9 KB
/
name.module
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
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Defines an API for displaying and inputing names.
*
* @todo Make sure that all labels are based on the _name_translations()
* function and use a name:: prefix. This can be parsed out here to allow
* string overrides to work and to integrate with i18n too.
* t('!name_given', array('!name_given' => t('Given')))
*/
// To be removed after fixing Feeds issue 1224836, 1139676.
include_once 'name.feeds.inc';
/**
* This is the main function that formats a name from an array of components.
*
* @param array $name_components
* A keyed array of name components.
* These are: title, given, middle, family, generational and credentials.
* @param string $format
* The string specifying what format to use.
* @param array $settings
* A keyed array of additional parameters to pass into the function.
* Includes:
* 'object' - An object or array.
* This entity is used for Token module subsitutions.
* Currently not used.
* 'type' - A string.
* The entity identifier: node, user, etc.
*/
function name_format($name_components, $format, $settings = array()) {
module_load_include('inc', 'name', 'includes/name.parser');
return _name_format($name_components, $format, $settings);
}
/**
* Implements hook_config_info().
*/
function name_config_info() {
$prefixes['name.settings'] = array(
'label' => t('Name Field settings'),
'group' => t('Configuration'),
);
return $prefixes;
}
/**
* Handles the initialization of the Name module settings that are stored in
* the {variables} table.
*/
function name_settings($key = NULL) {
$settings = config_get('name.settings', 'name_settings');
$settings += array(
'default_format' => '((((t+ig)+im)+if)+is)+jc',
'sep1' => ' ',
'sep2' => ', ',
'sep3' => '',
);
if ($key) {
return $settings[$key];
}
return $settings;
}
/**
* Helper function to find the components used.
*/
function name_get_instance_components($field_components, $instance_components) {
return array_filter($instance_components) ? $instance_components : $field_components;
}
/**
* Implements hook_menu().
*/
function name_menu() {
$items = array();
// Provides autocomplete functionality for name widgets.
$items['name/autocomplete/%/%'] = array(
'title' => 'Name autocomplete',
'page callback' => 'name_autocomplete',
'page arguments' => array(2, 3),
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
'file' => 'name.admin.inc',
);
// Admin menu items.
$items['admin/config/content/name'] = array(
'title' => 'Name field',
'page callback' => 'name_list_custom_formats',
'description' => 'Configure, edit and maintain names and name custom formats.',
'access arguments' => array('administer site configuration'),
'file' => 'name.admin.inc',
'type' => MENU_NORMAL_ITEM,
);
$items['admin/config/content/name/formats'] = array(
'title' => 'Name formats',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/config/content/name/add'] = array(
'title' => 'Add name format',
'page callback' => 'backdrop_get_form',
'page arguments' => array('name_custom_formats_form'),
'access arguments' => array('administer site configuration'),
'file' => 'name.admin.inc',
'type' => MENU_LOCAL_ACTION,
);
$items['admin/config/content/name/settings'] = array(
'title' => 'Settings',
'page callback' => 'backdrop_get_form',
'page arguments' => array('name_admin_settings_form'),
'access arguments' => array('administer site configuration'),
'file' => 'name.admin.inc',
'type' => MENU_LOCAL_TASK,
'weight' => 10,
);
$items['admin/config/content/name/%'] = array(
'title' => 'Edit custom format',
'page callback' => 'name_custom_format_edit',
'page arguments' => array(4),
'access arguments' => array('administer site configuration'),
'file' => 'name.admin.inc',
'type' => MENU_CALLBACK,
);
$items['admin/config/content/name/%/delete'] = array(
'title' => 'Delete custom name format',
'page callback' => 'backdrop_get_form',
'page arguments' => array('name_custom_format_delete_form', 4),
'access arguments' => array('administer site configuration'),
'file' => 'name.admin.inc',
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_theme().
*/
function name_theme() {
$theme = array(
// Themes an individual name element. This is only used by the webform
// integration but will be extended at some stage to theme the formatter
// items too.
'name_item' => array(
'variables' => array(
'item' => array(),
'format' => NULL,
'settings' => array(),
),
),
// This themes an element into the "name et al" format.
'name_item_list' => array(
'variables' => array(
'items' => array(),
'settings' => array(),
),
),
// Themes the FAPI element.
'name_element' => array(
'render element' => 'element',
),
// Provides a marker to highlight that the component is required.
'name_component_required_marker' => array(
'variables' => array(
'base_element' => NULL,
'component_key' => NULL,
'components' => NULL,
),
),
// Provides the help for the recognized characters in the name_format()
// format parameter.
'name_format_parameter_help' => array(
'file' => 'includes/name.parser.inc',
),
);
return $theme;
}
/**
* Wrapper theming function for name_format().
*/
function theme_name_item($variables) {
$variables['settings'] += array(
'markup' => 0,
);
$format = name_get_format_by_machine_name($variables['format']);
if (empty($format)) {
$format = name_get_format_by_machine_name('default');
}
return name_format($variables['item'], $format, $variables['settings']);
}
/**
* Renders a name component value.
*
* This function does not by default sanatise the output unless the markup
* flag is set. If this is set, it runs the component through check_plain() and
* wraps the component in a span with the component name set as the class.
*/
function name_render_component($value, $component_key, $markup, $modifier = NULL) {
if (empty($value) || !strlen($value)) {
return NULL;
}
switch ($modifier) {
case 'initial':
$value = backdrop_substr($value, 0, 1);
break;
}
if ($markup) {
return '<span class="' . check_plain($component_key) . '">' . check_plain($value) . '</span>';
}
return $value;
}
/**
* Returns HTML for a marker for required name components.
*
* @param $variables
* An associative array containing:
* - element: An associative array containing the properties of the component.
*
* @ingroup themeable
*/
function theme_name_component_required_marker($variables) {
$base_element = $variables['base_element'];
$components = $variables['components'];
$component_key = $variables['component_key'];
$name_translations = _name_translations();
$title = empty($base_element['#title'])?t('Name') : $base_element['#title'];
if (!empty($base_element['#allow_family_or_given']) && ($component_key == 'given' || $component_key == 'family')) {
$title_attribute = t('!given_title or !family_title is required when entering a !title.', array(
'!given_title' => empty($components['given']['title']) ? $name_translations['given'] : $components['given']['title'],
'!family_title' => empty($components['family']['title']) ? $name_translations['family'] : $components['family']['title'],
'!title' => $title,
));
}
else {
$component_title = empty($components[$component_key]['title']) ? $name_translations[$component_key] : $components[$component_key]['title'];
$title_attribute = t('!component_title is required when entering a !title.', array('!component_title' => $component_title, '!title' => $title));
}
// Both field label and component labels have already been sanitized.
return ' <span class="name-required-component-marker" title="' . $title_attribute . '">' . config_get('name.settings', 'name_component_required_marker') . '</span>';
}
/**
* Implements hook_username_alter().
*/
function name_username_alter(&$name, $account) {
// Don't alter anonymous users or objects that do not have any user ID.
if (empty($account->uid)) {
return;
}
// Try and load the realname in case this is a partial user object or
// another object, such as a node or comment.
if (!isset($account->realname)) {
name_username_alter_preload($account);
}
if (isset($account->realname) && backdrop_strlen($account->realname)) {
$name = $account->realname;
}
}
/**
* Internal helper function to load the user account if required.
*
* Recursion check in place after RealName module issue queue suggested that
* there were issues with token based recursion on load.
*/
function name_username_alter_preload(&$account) {
static $in_preload = FALSE;
if (!$in_preload && !isset($account->realname)) {
$field_name = config_get('name.settings', 'name_user_preferred');
if ($field_name && $instance = field_info_instance('user', $field_name, 'user')) {
$in_preload = TRUE;
$account = user_load($account->uid);
$in_preload = FALSE;
}
}
}
/**
* Implements hook_user_load().
*/
function name_user_load(array $accounts) {
// In the event there are a lot of user_load() calls, cache the results.
$names = &backdrop_static(__FUNCTION__, array());
$field_name = config_get('name.settings', 'name_user_preferred');
if ($field_name && $instance = field_info_instance('user', $field_name, 'user')) {
$format = name_get_format_by_machine_name($instance['settings']['override_format']);
if (empty($format)) {
$format = name_get_format_by_machine_name('default');
}
foreach ($accounts as $uid => $acccount) {
if (isset($names[$uid])) {
$accounts[$uid]->realname = $names[$uid];
}
else {
if ($items = field_get_items('user', $acccount, $instance['field_name'])) {
// We still have raw user input here.
$items[0] += name_field_parse_additional_components('user', $acccount, $instance);
$accounts[$uid]->realname = name_format($items[0], $format, array('object' => $acccount, 'type' => 'user'));
$names[$uid] = $accounts[$uid]->realname;
}
}
}
}
}
/**
* Loads a list of all user defined formats.
*/
function name_get_custom_formats() {
static $formats;
if (!isset($formats)) {
$formats = array();
$result = db_query("SELECT * FROM {name_custom_format} ORDER BY name ASC");
foreach ($result as $row) {
$formats[$row->ncfid] = $row;
}
}
return $formats;
}
/**
* Helper function to generate a list of all defined custom formatting options.
*/
function name_get_custom_format_options() {
$options = array();
foreach (name_get_custom_formats() as $wcfid => $row) {
$options[$row->machine_name] = $row->name;
}
natcasesort($options);
return $options;
}
/**
* Loads a format based on the machine name.
*
* @param string $machine_name
*
* @return string
* The name format.
*/
function name_get_format_by_machine_name($machine_name) {
static $backdrop_static_fast;
if (!isset($backdrop_static_fast)) {
$backdrop_static_fast['formats'] = &backdrop_static(__FUNCTION__);
}
$formats = &$backdrop_static_fast['formats'];
if (!isset($formats[$machine_name])) {
if ($machine_name == 'default') {
$formats[$machine_name] = name_settings('default_format');
}
else {
$formats[$machine_name] = (string) db_query("SELECT format FROM {name_custom_format} WHERE machine_name = :machine_name", array(':machine_name' => $machine_name))->fetchField();
}
}
return $formats[$machine_name];
}
/**
* Static cache to reuse translated name components.
*
* These have double encoding to allow easy and targeted string overrides in the
* sites settings.php file.
*/
function _name_translations($intersect = NULL) {
static $nt = NULL;
if (!isset($nt)) {
$nt = config_get('name.settings', 'name_field_part_overrides');
if (!$nt) {
$nt = array(
'title' => t('!name_title', array('!name_title' => t('Title'))),
'given' => t('!name_given', array('!name_given' => t('Given'))),
'middle' => t('!name_middle', array('!name_middle' => t('Middle name(s)'))),
'family' => t('!name_family', array('!name_family' => t('Family'))),
'generational' => t('!name_generational', array('!name_generational' => t('Generational'))),
'credentials' => t('!name_credentials', array('!name_credentials' => t('Credentials'))),
);
}
}
return empty($intersect) ? $nt : array_intersect_key($nt, $intersect);
}
/**
* Private helper function to define the formatter types that are available for
* the CCK and Token modules.
*/
function _name_formatter_output_types() {
static $ot = NULL;
if (!isset($ot)) {
return array(
'default' => t('Default'),
'plain' => t('Plain'),
'raw' => t('Raw'),
);
}
return $ot;
}
/* ------------------------- WebForm integration ---------------------------- */
/**
* Implements hook_webform_component_info().
*/
function name_webform_component_info() {
return array(
'name' => array(
'label' => t('Name'),
'description' => t('Defines a multi-value field for a persons name.'),
'features' => array(
'email_name' => TRUE,
// @todo Maybe allow?
'conditional' => FALSE,
// @todo More likely to trigger false hits?
'spam_analysis' => FALSE,
),
'file' => 'includes/webform.components.inc',
),
);
}
/* ------------------------- FAPI Element Code ------------------------------ */
/**
* Implements hook_element_info().
*/
function name_element_info() {
$parts = _name_translations();
$field_info = name_field_info();
$field_settings = $field_info['name']['settings'];
$instance_settings = $field_info['name']['instance_settings'];
return array(
'name_element' => array(
'#input' => TRUE,
'#process' => array('name_element_expand'),
'#pre_render' => array('name_element_pre_render'),
'#element_validate' => array('name_element_validate'),
'#theme_wrappers' => array('form_element'),
'#theme' => 'name_element',
'#show_component_required_marker' => 0,
'#default_value' => array(
'title' => '',
'given' => '',
'middle' => '',
'family' => '',
'generational' => '',
'credentials' => '',
),
'#minimum_components' => $field_settings['minimum_components'],
'#allow_family_or_given' => $field_settings['allow_family_or_given'],
'#components' => array(
'title' => array(
'type' => $instance_settings['title_field'],
'title' => $parts['title'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['title']) ? $instance_settings['inline_css']['title'] : NULL,
'size' => isset($instance_settings['size']['title']) ? $instance_settings['size']['title'] : NULL,
'maxlength' => $field_settings['max_length']['title'],
'options' => $field_settings['title_options'],
'autocomplete' => FALSE,
),
'given' => array(
'type' => 'textfield',
'title' => $parts['given'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['given']) ? $instance_settings['inline_css']['given'] : NULL,
'size' => isset($instance_settings['size']['given']) ? $instance_settings['size']['given'] : NULL,
'maxlength' => $field_settings['max_length']['given'],
'autocomplete' => FALSE,
),
'middle' => array(
'type' => 'textfield',
'title' => $parts['middle'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['middle']) ? $instance_settings['inline_css']['middle'] : NULL,
'size' => isset($instance_settings['size']['middle']) ? $instance_settings['size']['middle'] : NULL,
'maxlength' => $field_settings['max_length']['middle'],
'autocomplete' => FALSE,
),
'family' => array(
'type' => 'textfield',
'title' => $parts['family'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['family']) ? $instance_settings['inline_css']['family'] : NULL,
'size' => isset($instance_settings['size']['family']) ? $instance_settings['size']['family'] : NULL,
'maxlength' => $field_settings['max_length']['family'],
'autocomplete' => FALSE,
),
'generational' => array(
'type' => $instance_settings['generational_field'],
'title' => $parts['generational'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['generational']) ? $instance_settings['inline_css']['generational'] : NULL,
'size' => isset($instance_settings['size']['generational']) ? $instance_settings['size']['generational'] : NULL,
'maxlength' => $field_settings['max_length']['generational'],
'options' => $field_settings['generational_options'],
'autocomplete' => FALSE,
),
'credentials' => array(
'type' => 'textfield',
'title' => $parts['credentials'],
'title_display' => 'description',
'inline_css' => isset($instance_settings['inline_css']['credentials']) ? $instance_settings['inline_css']['credentials'] : NULL,
'size' => isset($instance_settings['size']['credentials']) ? $instance_settings['size']['credentials'] : NULL,
'maxlength' => $field_settings['max_length']['credentials'],
'autocomplete' => FALSE,
),
),
),
);
}
/**
* Custom theme callback for the name_element.
*/
function theme_name_element($variables) {
$element = $variables['element'];
return backdrop_render_children($element);
}
/**
* Themes a list of names.
*
* Note: This function expects a list of sanitised name items.
*/
function theme_name_item_list($variables) {
$items = $variables['items'];
if (empty($items)) {
return '';
}
$original_count = count($items);
if ($original_count == 1) {
return array_pop($items);
}
$settings = $variables['settings'];
$settings += array(
// default, plain, or raw.
'output' => 'default',
'multiple_delimiter' => ', ',
// And or symbol.
'multiple_and' => 'text',
// contextual, always, never.
'multiple_delimiter_precedes_last' => 'never',
'multiple_el_al_min' => 3,
'multiple_el_al_first' => 1,
);
$delimiter = $settings['multiple_delimiter'];
if ($settings['output'] == 'default') {
$etal = t('<em>et al</em>', array(), array('context' => 'name'));
$delimiter = check_plain($delimiter);
}
else {
$etal = t('et al', array(), array('context' => 'name'));
if ($settings['output'] == 'plain') {
$delimiter = strip_tags($delimiter);
}
}
$t_args = array(
'!delimiter' => $delimiter,
'!etal' => $etal,
);
if ($settings['multiple_el_al_min'] && ($original_count > $settings['multiple_el_al_min'])) {
$limit = min(array($settings['multiple_el_al_min'], $settings['multiple_el_al_first']));
$items = array_slice($items, 0, $limit);
if (count($items) == 1) {
$t_args['!name'] = $items[0];
return t('!name !etal', $t_args);
}
else {
$t_args['!names'] = implode($delimiter . ' ', $items);
return t('!names!delimiter !etal', $t_args);
}
}
else {
if ($settings['multiple_and'] == 'inherit') {
return implode($delimiter . ' ', $items);
}
$t_args['!lastname'] = array_pop($items);
$t_args['!names'] = implode($delimiter . ' ', $items);
if ($settings['multiple_and'] == 'text') {
$t_args['!and'] = t('and', array(), array('context' => 'name'));
}
else {
$t_args['!and'] = $settings['output'] == 'default' ? '&' : '&';
}
// Strange rule from http://citationstyles.org/downloads/specification.html.
if (($settings['multiple_delimiter_precedes_last'] == 'contextual' && $original_count > 2)
|| $settings['multiple_delimiter_precedes_last'] == 'always') {
return t('!names!delimiter !and !lastname', $t_args);
}
else {
return t('!names !and !lastname', $t_args);
}
}
}
/**
* The #process callback to create the element.
*/
function name_element_expand($element, &$form_state, $complete_form) {
$config = config('name.settings');
global $language;
$element['#tree'] = TRUE;
if (empty($element['#value'])) {
$element['#value'] = array();
}
$parts = _name_translations();
$element['#value'] += array_combine(array_keys($parts), array_fill(0, count($parts), ''));
$components = $element['#components'];
$min_components = (array) $element['#minimum_components'];
if (empty($element['#field'])) {
$element['#field'] = isset($form_state['field']) ? $form_state['field'] : NULL;
}
// Provides an override on the inline CSS.
if (!empty($element['#component_css'])) {
if ($element['#component_css'] == '<none>') {
$inline_css = '';
}
else {
$inline_css = ' style="' . check_plain($element['#component_css']) . '"';
}
}
else {
// Language will be LANGUAGE_LTR (0) or LANGUAGE_RTL (1).
if ($language->direction) {
if ($style = $config->get('name_inline_styles_rtl')) {
$inline_css = ' style="' . $style . '"';
}
}
else {
if ($style = $config->get('name_inline_styles')) {
$inline_css = ' style="' . $style . '"';
}
}
}
foreach ($parts as $key => $title) {
if (!isset($components[$key]['exclude'])) {
$element[$key] = _name_render_component($components, $key, $element, isset($min_components[$key]));
$class = 'name-' . $key . '-wrapper';
if ($key == 'credentials' && empty($element['#credentials_inline'])) {
$element[$key]['#prefix'] = '<div class="' . $class
. ' clearfix" style="float: ' . ($language->direction ? 'right' : 'left')
. ';">';
$element[$key]['#suffix'] = '</div>';
}
else {
$element[$key]['#prefix'] = '<div class="' . $class . '"' . $inline_css . '>';
$element[$key]['#suffix'] = '</div>';
}
}
}
if ($config->get('name_element_wrapper')) {
$element['#prefix'] = '<div class="clearfix">';
$element['#suffix'] = '</div>';
}
return $element;
}
/**
* Helper function to render a component within a name element.
*
* @param array $components
* Core properties for all components.
* @param string $component_key
* The component key of the component that is being rendered.
* @param array $base_element
* Base FAPI element that makes up a name element.
* @param bool $core
* Flag that indicates that the component is required as part of a valid
* name.
*
* @return array
* The constructed component FAPI structure for a name element.
*/
function _name_render_component($components, $component_key, $base_element, $core) {
$component = $components[$component_key];
$element = array();
// Allow other modules to append additional FAPI properties to the element.
foreach (element_properties($component) as $key) {
$element[$key] = $component[$key];
}
$element['#attributes']['class'][] = 'name-element';
$element['#attributes']['class'][] = 'name-' . $component_key;
if ($core) {
$element['#attributes']['class'][] = 'name-core-component';
}
if (isset($component['attributes'])) {
foreach ($component['attributes'] as $key => $attribute) {
if (isset($element['#attributes'][$key])) {
if (is_array($attribute)) {
$element['#attributes'][$key] = array_merge($element['#attributes'][$key], $attribute);
}
else {
$element['#attributes'][$key] .= ' ' . $attribute;
}
}
else {
$element['#attributes'][$key] = $attribute;
}
}
}
$base_attributes = array('type', 'title', 'size', 'maxlength');
foreach ($base_attributes as $key) {
$element['#' . $key] = $component[$key];
}
$element['#default_value'] = $base_element['#value'][$component_key];
if ($component['type'] == 'select') {
$element['#options'] = $component['options'];
$element['#size'] = 1;
}
elseif (!empty($component['autocomplete'])) {
$element['#autocomplete_path'] = $component['autocomplete'];
}
if ($core && !empty($base_element['#show_component_required_marker'])) {
$element['#title'] .= theme('name_component_required_marker', array(
'components' => $components,
'component_key' => $component_key,
'base_element' => $base_element,
));
}
// Enable the title options.
$title_display = isset($component['title_display']) ? $component['title_display'] : 'description';
switch ($title_display) {
case 'title':
break;
case 'placeholder':
$element['#attributes']['placeholder'] = t($element['#title']);
$element['#title_display'] = 'invisible';
break;
case 'none':
$element['#title_display'] = 'invisible';
break;
case 'description':
default:
$element['#title_display'] = 'invisible';
$element['#description'] = t($element['#title']);
break;
}
return $element;
}
/**
* A custom validator to check the components of a name_element element.
*/
function name_element_validate($element, &$form_state) {
// Limits validation to posted values only.
if (empty($element['#needs_validation'])) {
return $element;
}
$minimum_components = array_filter($element['#minimum_components']);
$labels = array();
foreach ($element['#components'] as $key => $component) {
if (!isset($component['exclude'])) {
$labels[$key] = $component['title'];
}
}
$item = $element['#value'];
$empty = name_field_is_empty($item, NULL);
$item_components = array();
foreach (_name_translations() as $key => $title) {
if (isset($labels[$key]) && !empty($item[$key])) {
$item_components[$key] = 1;
}
}
// Conditionally allow either a single given or family name.
if (!empty($element['#allow_family_or_given'])) {
// This option is only valid if there are both components.
if (isset($labels['given']) && isset($labels['family'])) {
if (!empty($item['given']) || !empty($item['family'])) {
$item_components['given'] = 1;
$item_components['family'] = 1;
}
}
}
if (!$empty && (count($minimum_components) != count(array_intersect_key($minimum_components, $item_components)))) {
$missing_labels = array_diff_key(array_intersect_key($labels, $minimum_components), $item_components);
$label = empty($element['#title']) ? (empty($element['#label']) ? 'Field' : $element['#label']) : $element['#title'];
// Note that field_default_form() has already sanitized #title.
form_error($element[key($missing_labels)], t('!name also requires the following parts: <em>!components</em>.',
array('!name' => $label, '!components' => implode(', ', $missing_labels))));
}
if ($empty && $element['#required']) {
form_error($element, t('<em>!name</em> is required.', array('!name' => t($element['#title']))));
}
return $element;
}
/**
* This function themes the element and controls the title display.
*/
function name_element_pre_render($element) {
// Add a wrapper to fields if required.
if (config_get('name.settings', 'name_element_wrapper')) {
$element['_name'] = array(
'#prefix' => '<div class="clearfix">',
'#suffix' => '</div>',
);
}
foreach (_name_translations() as $key => $title) {
if (isset($element[$key])) {
$element['_name'][$key] = $element[$key];
unset($element[$key]);
}
}
if (!empty($element['#component_layout'])) {
_name_component_layout($element['_name'], $element['#component_layout']);
}
if (!empty($element['#description'])) {
$field = isset($element['#field']) ? $element['#field'] : NULL;
if (!$field || $field['cardinality'] != 1) {
$element['_description'] = array(
'#value' => '<div class="clearfix description">' . $element['#description'] . '</div>',
);
unset($element['#description']);
}
}
return $element;
}
/**
* Sorts the widgets according to the language type.
*/
function _name_component_layout(&$element, $layout = 'default') {
$weights = array(
'asian' => array(
'family' => 1,
'middle' => 2,
'given' => 3,
'title' => 4,
// 'generational' is removed from the display
'generational' => 5,
'credentials' => 6,
),
'eastern' => array(
'title' => 1,
'family' => 2,
'given' => 3,
'middle' => 4,
// 'generational' is removed from the display
'generational' => 5,
'credentials' => 6,
),
);
if (isset($weights[$layout])) {
foreach ($weights[$layout] as $component => $weight) {
if (isset($element[$component])) {
$element[$component]['#weight'] = $weight;
}
}
}
if ($layout == 'asian') {
if (isset($element['generational'])) {
$element['generational']['#default_value'] = '';
$element['generational']['#access'] = FALSE;
}
}
}
/* ----------------------------- Field Code --------------------------------- */
/**
* Implements hook_field_info().
*/
function name_field_info() {
$parts = _name_translations();
$keys = array_keys($parts);
$count = count($keys);
return array(
'name' => array(
'label' => t('Name'),
'description' => t('This field stores a users title, given, middle, family name, generational suffix and credentials in the database.'),
'default_widget' => 'name_widget',
'default_formatter' => 'name_formatter',
'settings' => array(
// Components used. At least given or family name is required.
'components' => backdrop_map_assoc($keys),
// Minimal set of components before considered incomplete.
'minimum_components' => array(
'given' => 'given',
'family' => 'family',
),
// Allows a given or family component value to filful either both the
// minimal components. Allows singular names like "Prince".
'allow_family_or_given' => 0,
'labels' => _name_translations(),
'max_length' => array(
'title' => 31,
'given' => 63,
'middle' => 127,
'family' => 63,
'generational' => 15,
'credentials' => 255,
),
'autocomplete_source' => array(
'title' => array('title'),
'given' => array(),
'middle' => array(),
'family' => array(),
'generational' => array('generation'),
'credentials' => array(),
),
'autocomplete_separator' => array(
'title' => ' ',
'given' => ' -',
'middle' => ' -',
'family' => ' -',
'generational' => ' ',
'credentials' => ', ',
),
'title_options' => implode("\n", array(t('-- --'), t('Mr.'), t('Mrs.'), t('Miss'), t('Ms.'), t('Dr.'), t('Prof.'))),
'generational_options' => implode("\n", array(t('-- --'), t('Jr.'), t('Sr.'), t('I'), t('II'), t('III'), t('IV'), t('V'), t('VI'), t('VII'), t('VIII'), t('IX'), t('X'))),
'sort_options' => array(
'title' => 'title',
'generational' => 0,
),
),
'instance_settings' => array(
// Possible elements for either (free) text, autocomplete, select.
'title_field' => 'select',
'generational_field' => 'select',
'size' => array(
'title' => 6,
'given' => 20,
'middle' => 20,
'family' => 20,
'generational' => 5,
'credentials' => 35,
),
'inline_css' => array_combine($keys, array_fill(0, $count, '')),
'title_display' => array_combine($keys, array_fill(0, $count, 'description')),
// Field instance overrides.
'components' => array(),
'minimum_components' => array(),
'labels' => array_combine($keys, array_fill(0, $count, '')),
// New settings to override the user name. Only applies to user entities.
'override_format' => 'default',
'preferred_field_reference' => '',
// Prevents the default break between the name components and credentials.
'credentials_inline' => 0,
'component_css' => '',
'component_layout' => 'default',
'show_component_required_marker' => 0,
),
'property_type' => 'field_item_name',
'property_callbacks' => array('name_field_property_info_callback'),
),
);
}
/**
* Implements hook_field_settings_form().
*/
function name_field_settings_form($field, $instance, $has_data) {
module_load_include('inc', 'name', 'includes/name.content');
return _name_field_settings_form($field, $instance, $has_data);
}
/**
* Implements hook_field_settings_form_validate().
*
* Called via #element_validate from name_field_settings_form().
*/
function name_field_settings_form_validate($form, &$form_state) {
module_load_include('inc', 'name', 'includes/name.content');