5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Contact/Contact.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:e2181ea97a3e309b7e74b636757b6aac)
13 * Database access object for the Contact entity.
15 class CRM_Contact_DAO_Contact
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_contact';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
46 * May be used to over-ride contact view and edit templates.
50 public $contact_sub_type;
78 * Has the contact opted out from receiving all bulk email from the organization or site domain?
85 * May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.
89 public $legal_identifier;
92 * Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.
96 public $external_identifier;
99 * Name used for sorting different contact types
106 * Formatted name representing preferred format for display/print/other output.
110 public $display_name;
127 * optional URL for preferred image (photo, logo, etc.) to display for this contact.
134 * What is the preferred mode of communication.
138 public $preferred_communication_method;
141 * Which language is preferred for communication. FK to languages in civicrm_option_value.
145 public $preferred_language;
148 * What is the preferred mode of sending an email.
152 public $preferred_mail_format;
155 * Key for validating requests related to this contact.
162 * API Key for validating requests related to this contact.
169 * where contact come from, e.g. import, donate module insert...
197 * Prefix or Title for name (Ms, Mr...). FK to prefix ID
204 * Suffix for name (Jr, Sr...). FK to suffix ID
211 * Formal (academic or similar) title in front of name. (Prof., Dr. etc.)
215 public $formal_title;
218 * Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.
222 public $communication_style_id;
225 * FK to civicrm_option_value.id, that has to be valid registered Email Greeting.
229 public $email_greeting_id;
232 * Custom Email Greeting.
236 public $email_greeting_custom;
239 * Cache Email Greeting.
243 public $email_greeting_display;
246 * FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.
250 public $postal_greeting_id;
253 * Custom Postal greeting.
257 public $postal_greeting_custom;
260 * Cache Postal greeting.
264 public $postal_greeting_display;
267 * FK to civicrm_option_value.id, that has to be valid registered Addressee.
271 public $addressee_id;
278 public $addressee_custom;
285 public $addressee_display;
318 public $deceased_date;
325 public $household_name;
328 * Optional FK to Primary Contact for this household.
332 public $primary_contact_id;
339 public $organization_name;
342 * Standard Industry Classification Code.
349 * the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM
353 public $user_unique_id;
356 * OPTIONAL FK to civicrm_contact record.
368 * When was the contact was created.
372 public $created_date;
375 * When was the contact (or closely related entity) was created or modified or deleted.
379 public $modified_date;
384 public function __construct() {
385 $this->__table
= 'civicrm_contact';
386 parent
::__construct();
390 * Returns foreign keys and entity references.
393 * [CRM_Core_Reference_Interface]
395 public static function getReferenceColumns() {
396 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
397 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
398 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'primary_contact_id', 'civicrm_contact', 'id');
399 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'employer_id', 'civicrm_contact', 'id');
400 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
402 return Civi
::$statics[__CLASS__
]['links'];
406 * Returns all the column names of this table
410 public static function &fields() {
411 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
412 Civi
::$statics[__CLASS__
]['fields'] = [
415 'type' => CRM_Utils_Type
::T_INT
,
416 'title' => ts('Contact ID'),
417 'description' => ts('Unique Contact ID'),
420 'where' => 'civicrm_contact.id',
421 'headerPattern' => '/internal|contact?|id$/i',
423 'table_name' => 'civicrm_contact',
424 'entity' => 'Contact',
425 'bao' => 'CRM_Contact_BAO_Contact',
429 'name' => 'contact_type',
430 'type' => CRM_Utils_Type
::T_STRING
,
431 'title' => ts('Contact Type'),
432 'description' => ts('Type of Contact.'),
434 'size' => CRM_Utils_Type
::BIG
,
435 'where' => 'civicrm_contact.contact_type',
437 'table_name' => 'civicrm_contact',
438 'entity' => 'Contact',
439 'bao' => 'CRM_Contact_BAO_Contact',
444 'pseudoconstant' => [
445 'table' => 'civicrm_contact_type',
446 'keyColumn' => 'name',
447 'labelColumn' => 'label',
448 'condition' => 'parent_id IS NULL',
451 'contact_sub_type' => [
452 'name' => 'contact_sub_type',
453 'type' => CRM_Utils_Type
::T_STRING
,
454 'title' => ts('Contact Subtype'),
455 'description' => ts('May be used to over-ride contact view and edit templates.'),
457 'size' => CRM_Utils_Type
::HUGE
,
459 'where' => 'civicrm_contact.contact_sub_type',
460 'headerPattern' => '/C(ontact )?(subtype|sub-type|sub type)/i',
462 'table_name' => 'civicrm_contact',
463 'entity' => 'Contact',
464 'bao' => 'CRM_Contact_BAO_Contact',
466 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
470 'pseudoconstant' => [
471 'table' => 'civicrm_contact_type',
472 'keyColumn' => 'name',
473 'labelColumn' => 'label',
474 'condition' => 'parent_id IS NOT NULL',
478 'name' => 'do_not_email',
479 'type' => CRM_Utils_Type
::T_BOOLEAN
,
480 'title' => ts('Do Not Email'),
482 'where' => 'civicrm_contact.do_not_email',
483 'headerPattern' => '/d(o )?(not )?(email)/i',
484 'dataPattern' => '/^\d{1,}$/',
487 'table_name' => 'civicrm_contact',
488 'entity' => 'Contact',
489 'bao' => 'CRM_Contact_BAO_Contact',
492 'type' => 'CheckBox',
496 'name' => 'do_not_phone',
497 'type' => CRM_Utils_Type
::T_BOOLEAN
,
498 'title' => ts('Do Not Phone'),
500 'where' => 'civicrm_contact.do_not_phone',
501 'headerPattern' => '/d(o )?(not )?(call|phone)/i',
502 'dataPattern' => '/^\d{1,}$/',
505 'table_name' => 'civicrm_contact',
506 'entity' => 'Contact',
507 'bao' => 'CRM_Contact_BAO_Contact',
510 'type' => 'CheckBox',
514 'name' => 'do_not_mail',
515 'type' => CRM_Utils_Type
::T_BOOLEAN
,
516 'title' => ts('Do Not Mail'),
518 'where' => 'civicrm_contact.do_not_mail',
519 'headerPattern' => '/^(d(o\s)?n(ot\s)?mail)|(\w*)?bulk\s?(\w*)$/i',
520 'dataPattern' => '/^\d{1,}$/',
523 'table_name' => 'civicrm_contact',
524 'entity' => 'Contact',
525 'bao' => 'CRM_Contact_BAO_Contact',
528 'type' => 'CheckBox',
532 'name' => 'do_not_sms',
533 'type' => CRM_Utils_Type
::T_BOOLEAN
,
534 'title' => ts('Do Not Sms'),
536 'where' => 'civicrm_contact.do_not_sms',
537 'headerPattern' => '/d(o )?(not )?(sms)/i',
538 'dataPattern' => '/^\d{1,}$/',
541 'table_name' => 'civicrm_contact',
542 'entity' => 'Contact',
543 'bao' => 'CRM_Contact_BAO_Contact',
546 'type' => 'CheckBox',
550 'name' => 'do_not_trade',
551 'type' => CRM_Utils_Type
::T_BOOLEAN
,
552 'title' => ts('Do Not Trade'),
554 'where' => 'civicrm_contact.do_not_trade',
555 'headerPattern' => '/d(o )?(not )?(trade)/i',
556 'dataPattern' => '/^\d{1,}$/',
559 'table_name' => 'civicrm_contact',
560 'entity' => 'Contact',
561 'bao' => 'CRM_Contact_BAO_Contact',
564 'type' => 'CheckBox',
568 'name' => 'is_opt_out',
569 'type' => CRM_Utils_Type
::T_BOOLEAN
,
570 'title' => ts('No Bulk Emails (User Opt Out)'),
571 'description' => ts('Has the contact opted out from receiving all bulk email from the organization or site domain?'),
574 'where' => 'civicrm_contact.is_opt_out',
577 'table_name' => 'civicrm_contact',
578 'entity' => 'Contact',
579 'bao' => 'CRM_Contact_BAO_Contact',
582 'type' => 'CheckBox',
585 'legal_identifier' => [
586 'name' => 'legal_identifier',
587 'type' => CRM_Utils_Type
::T_STRING
,
588 'title' => ts('Legal Identifier'),
589 'description' => ts('May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.'),
591 'size' => CRM_Utils_Type
::MEDIUM
,
593 'where' => 'civicrm_contact.legal_identifier',
594 'headerPattern' => '/legal\s?id/i',
595 'dataPattern' => '/\w+?\d{5,}/',
597 'table_name' => 'civicrm_contact',
598 'entity' => 'Contact',
599 'bao' => 'CRM_Contact_BAO_Contact',
605 'external_identifier' => [
606 'name' => 'external_identifier',
607 'type' => CRM_Utils_Type
::T_STRING
,
608 'title' => ts('External Identifier'),
609 'description' => ts('Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.'),
613 'where' => 'civicrm_contact.external_identifier',
614 'headerPattern' => '/external\s?id/i',
615 'dataPattern' => '/^\d{11,}$/',
617 'table_name' => 'civicrm_contact',
618 'entity' => 'Contact',
619 'bao' => 'CRM_Contact_BAO_Contact',
626 'name' => 'sort_name',
627 'type' => CRM_Utils_Type
::T_STRING
,
628 'title' => ts('Sort Name'),
629 'description' => ts('Name used for sorting different contact types'),
632 'where' => 'civicrm_contact.sort_name',
634 'table_name' => 'civicrm_contact',
635 'entity' => 'Contact',
636 'bao' => 'CRM_Contact_BAO_Contact',
643 'name' => 'display_name',
644 'type' => CRM_Utils_Type
::T_STRING
,
645 'title' => ts('Display Name'),
646 'description' => ts('Formatted name representing preferred format for display/print/other output.'),
649 'where' => 'civicrm_contact.display_name',
651 'table_name' => 'civicrm_contact',
652 'entity' => 'Contact',
653 'bao' => 'CRM_Contact_BAO_Contact',
660 'name' => 'nick_name',
661 'type' => CRM_Utils_Type
::T_STRING
,
662 'title' => ts('Nickname'),
663 'description' => ts('Nickname.'),
667 'where' => 'civicrm_contact.nick_name',
668 'headerPattern' => '/n(ick\s)name|nick$/i',
669 'dataPattern' => '/^\w+$/',
671 'table_name' => 'civicrm_contact',
672 'entity' => 'Contact',
673 'bao' => 'CRM_Contact_BAO_Contact',
680 'name' => 'legal_name',
681 'type' => CRM_Utils_Type
::T_STRING
,
682 'title' => ts('Legal Name'),
683 'description' => ts('Legal Name.'),
687 'where' => 'civicrm_contact.legal_name',
688 'headerPattern' => '/^legal|(l(egal\s)?name)$/i',
690 'table_name' => 'civicrm_contact',
691 'entity' => 'Contact',
692 'bao' => 'CRM_Contact_BAO_Contact',
699 'name' => 'image_URL',
700 'type' => CRM_Utils_Type
::T_TEXT
,
701 'title' => ts('Image Url'),
702 'description' => ts('optional URL for preferred image (photo, logo, etc.) to display for this contact.'),
704 'where' => 'civicrm_contact.image_URL',
706 'table_name' => 'civicrm_contact',
707 'entity' => 'Contact',
708 'bao' => 'CRM_Contact_BAO_Contact',
714 'preferred_communication_method' => [
715 'name' => 'preferred_communication_method',
716 'type' => CRM_Utils_Type
::T_STRING
,
717 'title' => ts('Preferred Communication Method'),
718 'description' => ts('What is the preferred mode of communication.'),
720 'size' => CRM_Utils_Type
::HUGE
,
722 'where' => 'civicrm_contact.preferred_communication_method',
723 'headerPattern' => '/^p(ref\w*\s)?c(omm\w*)|( meth\w*)$/i',
724 'dataPattern' => '/^\w+$/',
726 'table_name' => 'civicrm_contact',
727 'entity' => 'Contact',
728 'bao' => 'CRM_Contact_BAO_Contact',
730 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
734 'pseudoconstant' => [
735 'optionGroupName' => 'preferred_communication_method',
736 'optionEditPath' => 'civicrm/admin/options/preferred_communication_method',
739 'preferred_language' => [
740 'name' => 'preferred_language',
741 'type' => CRM_Utils_Type
::T_STRING
,
742 'title' => ts('Preferred Language'),
743 'description' => ts('Which language is preferred for communication. FK to languages in civicrm_option_value.'),
745 'size' => CRM_Utils_Type
::SIX
,
747 'where' => 'civicrm_contact.preferred_language',
748 'headerPattern' => '/^lang/i',
750 'table_name' => 'civicrm_contact',
751 'entity' => 'Contact',
752 'bao' => 'CRM_Contact_BAO_Contact',
757 'pseudoconstant' => [
758 'optionGroupName' => 'languages',
759 'keyColumn' => 'name',
760 'optionEditPath' => 'civicrm/admin/options/languages',
763 'preferred_mail_format' => [
764 'name' => 'preferred_mail_format',
765 'type' => CRM_Utils_Type
::T_STRING
,
766 'title' => ts('Preferred Mail Format'),
767 'description' => ts('What is the preferred mode of sending an email.'),
769 'size' => CRM_Utils_Type
::EIGHT
,
771 'where' => 'civicrm_contact.preferred_mail_format',
772 'headerPattern' => '/^p(ref\w*\s)?m(ail\s)?f(orm\w*)$/i',
775 'table_name' => 'civicrm_contact',
776 'entity' => 'Contact',
777 'bao' => 'CRM_Contact_BAO_Contact',
782 'pseudoconstant' => [
783 'callback' => 'CRM_Core_SelectValues::pmf',
788 'type' => CRM_Utils_Type
::T_STRING
,
789 'title' => ts('Contact Hash'),
790 'description' => ts('Key for validating requests related to this contact.'),
792 'size' => CRM_Utils_Type
::MEDIUM
,
793 'where' => 'civicrm_contact.hash',
795 'table_name' => 'civicrm_contact',
796 'entity' => 'Contact',
797 'bao' => 'CRM_Contact_BAO_Contact',
802 'type' => CRM_Utils_Type
::T_STRING
,
803 'title' => ts('Api Key'),
804 'description' => ts('API Key for validating requests related to this contact.'),
806 'size' => CRM_Utils_Type
::MEDIUM
,
807 'where' => 'civicrm_contact.api_key',
808 'protected' => 'true',
809 'table_name' => 'civicrm_contact',
810 'entity' => 'Contact',
811 'bao' => 'CRM_Contact_BAO_Contact',
814 'contact_source' => [
816 'type' => CRM_Utils_Type
::T_STRING
,
817 'title' => ts('Contact Source'),
818 'description' => ts('where contact come from, e.g. import, donate module insert...'),
822 'where' => 'civicrm_contact.source',
823 'headerPattern' => '/(C(ontact\s)?Source)$/i',
825 'table_name' => 'civicrm_contact',
826 'entity' => 'Contact',
827 'bao' => 'CRM_Contact_BAO_Contact',
834 'name' => 'first_name',
835 'type' => CRM_Utils_Type
::T_STRING
,
836 'title' => ts('First Name'),
837 'description' => ts('First Name.'),
841 'where' => 'civicrm_contact.first_name',
842 'headerPattern' => '/^first|(f(irst\s)?name)$/i',
843 'dataPattern' => '/^\w+$/',
845 'table_name' => 'civicrm_contact',
846 'entity' => 'Contact',
847 'bao' => 'CRM_Contact_BAO_Contact',
854 'name' => 'middle_name',
855 'type' => CRM_Utils_Type
::T_STRING
,
856 'title' => ts('Middle Name'),
857 'description' => ts('Middle Name.'),
861 'where' => 'civicrm_contact.middle_name',
862 'headerPattern' => '/^middle|(m(iddle\s)?name)$/i',
863 'dataPattern' => '/^\w+$/',
865 'table_name' => 'civicrm_contact',
866 'entity' => 'Contact',
867 'bao' => 'CRM_Contact_BAO_Contact',
874 'name' => 'last_name',
875 'type' => CRM_Utils_Type
::T_STRING
,
876 'title' => ts('Last Name'),
877 'description' => ts('Last Name.'),
881 'where' => 'civicrm_contact.last_name',
882 'headerPattern' => '/^last|(l(ast\s)?name)$/i',
883 'dataPattern' => '/^\w+(\s\w+)?+$/',
885 'table_name' => 'civicrm_contact',
886 'entity' => 'Contact',
887 'bao' => 'CRM_Contact_BAO_Contact',
894 'name' => 'prefix_id',
895 'type' => CRM_Utils_Type
::T_INT
,
896 'title' => ts('Individual Prefix'),
897 'description' => ts('Prefix or Title for name (Ms, Mr...). FK to prefix ID'),
899 'where' => 'civicrm_contact.prefix_id',
900 'headerPattern' => '/^(prefix|title)/i',
901 'dataPattern' => '/^(mr|ms|mrs|sir|dr)\.?$/i',
903 'table_name' => 'civicrm_contact',
904 'entity' => 'Contact',
905 'bao' => 'CRM_Contact_BAO_Contact',
910 'pseudoconstant' => [
911 'optionGroupName' => 'individual_prefix',
912 'optionEditPath' => 'civicrm/admin/options/individual_prefix',
916 'name' => 'suffix_id',
917 'type' => CRM_Utils_Type
::T_INT
,
918 'title' => ts('Individual Suffix'),
919 'description' => ts('Suffix for name (Jr, Sr...). FK to suffix ID'),
921 'where' => 'civicrm_contact.suffix_id',
922 'headerPattern' => '/^suffix$/i',
923 'dataPattern' => '/^(sr|jr)\.?|i{2,}$/',
925 'table_name' => 'civicrm_contact',
926 'entity' => 'Contact',
927 'bao' => 'CRM_Contact_BAO_Contact',
932 'pseudoconstant' => [
933 'optionGroupName' => 'individual_suffix',
934 'optionEditPath' => 'civicrm/admin/options/individual_suffix',
938 'name' => 'formal_title',
939 'type' => CRM_Utils_Type
::T_STRING
,
940 'title' => ts('Formal Title'),
941 'description' => ts('Formal (academic or similar) title in front of name. (Prof., Dr. etc.)'),
943 'size' => CRM_Utils_Type
::BIG
,
945 'where' => 'civicrm_contact.formal_title',
946 'headerPattern' => '/^title/i',
948 'table_name' => 'civicrm_contact',
949 'entity' => 'Contact',
950 'bao' => 'CRM_Contact_BAO_Contact',
956 'communication_style_id' => [
957 'name' => 'communication_style_id',
958 'type' => CRM_Utils_Type
::T_INT
,
959 'title' => ts('Communication Style'),
960 'description' => ts('Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.'),
961 'where' => 'civicrm_contact.communication_style_id',
963 'table_name' => 'civicrm_contact',
964 'entity' => 'Contact',
965 'bao' => 'CRM_Contact_BAO_Contact',
970 'pseudoconstant' => [
971 'optionGroupName' => 'communication_style',
972 'optionEditPath' => 'civicrm/admin/options/communication_style',
975 'email_greeting_id' => [
976 'name' => 'email_greeting_id',
977 'type' => CRM_Utils_Type
::T_INT
,
978 'title' => ts('Email Greeting ID'),
979 'description' => ts('FK to civicrm_option_value.id, that has to be valid registered Email Greeting.'),
980 'where' => 'civicrm_contact.email_greeting_id',
982 'table_name' => 'civicrm_contact',
983 'entity' => 'Contact',
984 'bao' => 'CRM_Contact_BAO_Contact',
986 'pseudoconstant' => [
987 'optionGroupName' => 'email_greeting',
988 'optionEditPath' => 'civicrm/admin/options/email_greeting',
991 'email_greeting_custom' => [
992 'name' => 'email_greeting_custom',
993 'type' => CRM_Utils_Type
::T_STRING
,
994 'title' => ts('Email Greeting Custom'),
995 'description' => ts('Custom Email Greeting.'),
997 'size' => CRM_Utils_Type
::HUGE
,
999 'where' => 'civicrm_contact.email_greeting_custom',
1001 'table_name' => 'civicrm_contact',
1002 'entity' => 'Contact',
1003 'bao' => 'CRM_Contact_BAO_Contact',
1009 'email_greeting_display' => [
1010 'name' => 'email_greeting_display',
1011 'type' => CRM_Utils_Type
::T_STRING
,
1012 'title' => ts('Email Greeting'),
1013 'description' => ts('Cache Email Greeting.'),
1015 'size' => CRM_Utils_Type
::HUGE
,
1016 'where' => 'civicrm_contact.email_greeting_display',
1017 'table_name' => 'civicrm_contact',
1018 'entity' => 'Contact',
1019 'bao' => 'CRM_Contact_BAO_Contact',
1025 'postal_greeting_id' => [
1026 'name' => 'postal_greeting_id',
1027 'type' => CRM_Utils_Type
::T_INT
,
1028 'title' => ts('Postal Greeting ID'),
1029 'description' => ts('FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.'),
1030 'where' => 'civicrm_contact.postal_greeting_id',
1032 'table_name' => 'civicrm_contact',
1033 'entity' => 'Contact',
1034 'bao' => 'CRM_Contact_BAO_Contact',
1039 'pseudoconstant' => [
1040 'optionGroupName' => 'postal_greeting',
1041 'optionEditPath' => 'civicrm/admin/options/postal_greeting',
1044 'postal_greeting_custom' => [
1045 'name' => 'postal_greeting_custom',
1046 'type' => CRM_Utils_Type
::T_STRING
,
1047 'title' => ts('Postal Greeting Custom'),
1048 'description' => ts('Custom Postal greeting.'),
1050 'size' => CRM_Utils_Type
::HUGE
,
1052 'where' => 'civicrm_contact.postal_greeting_custom',
1054 'table_name' => 'civicrm_contact',
1055 'entity' => 'Contact',
1056 'bao' => 'CRM_Contact_BAO_Contact',
1062 'postal_greeting_display' => [
1063 'name' => 'postal_greeting_display',
1064 'type' => CRM_Utils_Type
::T_STRING
,
1065 'title' => ts('Postal Greeting'),
1066 'description' => ts('Cache Postal greeting.'),
1068 'size' => CRM_Utils_Type
::HUGE
,
1069 'where' => 'civicrm_contact.postal_greeting_display',
1070 'table_name' => 'civicrm_contact',
1071 'entity' => 'Contact',
1072 'bao' => 'CRM_Contact_BAO_Contact',
1079 'name' => 'addressee_id',
1080 'type' => CRM_Utils_Type
::T_INT
,
1081 'title' => ts('Addressee ID'),
1082 'description' => ts('FK to civicrm_option_value.id, that has to be valid registered Addressee.'),
1083 'where' => 'civicrm_contact.addressee_id',
1085 'table_name' => 'civicrm_contact',
1086 'entity' => 'Contact',
1087 'bao' => 'CRM_Contact_BAO_Contact',
1089 'pseudoconstant' => [
1090 'optionGroupName' => 'addressee',
1091 'optionEditPath' => 'civicrm/admin/options/addressee',
1094 'addressee_custom' => [
1095 'name' => 'addressee_custom',
1096 'type' => CRM_Utils_Type
::T_STRING
,
1097 'title' => ts('Addressee Custom'),
1098 'description' => ts('Custom Addressee.'),
1100 'size' => CRM_Utils_Type
::HUGE
,
1102 'where' => 'civicrm_contact.addressee_custom',
1104 'table_name' => 'civicrm_contact',
1105 'entity' => 'Contact',
1106 'bao' => 'CRM_Contact_BAO_Contact',
1112 'addressee_display' => [
1113 'name' => 'addressee_display',
1114 'type' => CRM_Utils_Type
::T_STRING
,
1115 'title' => ts('Addressee'),
1116 'description' => ts('Cache Addressee.'),
1118 'size' => CRM_Utils_Type
::HUGE
,
1119 'where' => 'civicrm_contact.addressee_display',
1120 'table_name' => 'civicrm_contact',
1121 'entity' => 'Contact',
1122 'bao' => 'CRM_Contact_BAO_Contact',
1129 'name' => 'job_title',
1130 'type' => CRM_Utils_Type
::T_STRING
,
1131 'title' => ts('Job Title'),
1132 'description' => ts('Job Title'),
1136 'where' => 'civicrm_contact.job_title',
1137 'headerPattern' => '/^job|(j(ob\s)?title)$/i',
1138 'dataPattern' => '//',
1140 'table_name' => 'civicrm_contact',
1141 'entity' => 'Contact',
1142 'bao' => 'CRM_Contact_BAO_Contact',
1149 'name' => 'gender_id',
1150 'type' => CRM_Utils_Type
::T_INT
,
1151 'title' => ts('Gender'),
1152 'description' => ts('FK to gender ID'),
1154 'where' => 'civicrm_contact.gender_id',
1155 'headerPattern' => '/^gender$/i',
1157 'table_name' => 'civicrm_contact',
1158 'entity' => 'Contact',
1159 'bao' => 'CRM_Contact_BAO_Contact',
1164 'pseudoconstant' => [
1165 'optionGroupName' => 'gender',
1166 'optionEditPath' => 'civicrm/admin/options/gender',
1170 'name' => 'birth_date',
1171 'type' => CRM_Utils_Type
::T_DATE
,
1172 'title' => ts('Birth Date'),
1173 'description' => ts('Date of birth'),
1175 'where' => 'civicrm_contact.birth_date',
1176 'headerPattern' => '/^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i',
1177 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
1179 'table_name' => 'civicrm_contact',
1180 'entity' => 'Contact',
1181 'bao' => 'CRM_Contact_BAO_Contact',
1184 'type' => 'Select Date',
1185 'formatType' => 'birth',
1189 'name' => 'is_deceased',
1190 'type' => CRM_Utils_Type
::T_BOOLEAN
,
1191 'title' => ts('Deceased'),
1193 'where' => 'civicrm_contact.is_deceased',
1194 'headerPattern' => '/i(s\s)?d(eceased)$/i',
1197 'table_name' => 'civicrm_contact',
1198 'entity' => 'Contact',
1199 'bao' => 'CRM_Contact_BAO_Contact',
1202 'type' => 'CheckBox',
1205 'deceased_date' => [
1206 'name' => 'deceased_date',
1207 'type' => CRM_Utils_Type
::T_DATE
,
1208 'title' => ts('Deceased Date'),
1209 'description' => ts('Date of deceased'),
1211 'where' => 'civicrm_contact.deceased_date',
1212 'headerPattern' => '/^deceased|(d(eceased\s)?date)$/i',
1214 'table_name' => 'civicrm_contact',
1215 'entity' => 'Contact',
1216 'bao' => 'CRM_Contact_BAO_Contact',
1219 'type' => 'Select Date',
1220 'formatType' => 'birth',
1223 'household_name' => [
1224 'name' => 'household_name',
1225 'type' => CRM_Utils_Type
::T_STRING
,
1226 'title' => ts('Household Name'),
1227 'description' => ts('Household Name.'),
1231 'where' => 'civicrm_contact.household_name',
1232 'headerPattern' => '/^household|(h(ousehold\s)?name)$/i',
1233 'dataPattern' => '/^\w+$/',
1235 'table_name' => 'civicrm_contact',
1236 'entity' => 'Contact',
1237 'bao' => 'CRM_Contact_BAO_Contact',
1243 'primary_contact_id' => [
1244 'name' => 'primary_contact_id',
1245 'type' => CRM_Utils_Type
::T_INT
,
1246 'title' => ts('Household Primary Contact ID'),
1247 'description' => ts('Optional FK to Primary Contact for this household.'),
1248 'where' => 'civicrm_contact.primary_contact_id',
1249 'table_name' => 'civicrm_contact',
1250 'entity' => 'Contact',
1251 'bao' => 'CRM_Contact_BAO_Contact',
1253 'FKClassName' => 'CRM_Contact_DAO_Contact',
1258 'organization_name' => [
1259 'name' => 'organization_name',
1260 'type' => CRM_Utils_Type
::T_STRING
,
1261 'title' => ts('Organization Name'),
1262 'description' => ts('Organization Name.'),
1266 'where' => 'civicrm_contact.organization_name',
1267 'headerPattern' => '/^organization|(o(rganization\s)?name)$/i',
1268 'dataPattern' => '/^\w+$/',
1270 'table_name' => 'civicrm_contact',
1271 'entity' => 'Contact',
1272 'bao' => 'CRM_Contact_BAO_Contact',
1279 'name' => 'sic_code',
1280 'type' => CRM_Utils_Type
::T_STRING
,
1281 'title' => ts('Sic Code'),
1282 'description' => ts('Standard Industry Classification Code.'),
1284 'size' => CRM_Utils_Type
::EIGHT
,
1286 'where' => 'civicrm_contact.sic_code',
1287 'headerPattern' => '/^sic|(s(ic\s)?code)$/i',
1289 'table_name' => 'civicrm_contact',
1290 'entity' => 'Contact',
1291 'bao' => 'CRM_Contact_BAO_Contact',
1297 'user_unique_id' => [
1298 'name' => 'user_unique_id',
1299 'type' => CRM_Utils_Type
::T_STRING
,
1300 'title' => ts('Unique ID (OpenID)'),
1301 'description' => ts('the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM'),
1303 'size' => CRM_Utils_Type
::HUGE
,
1305 'where' => 'civicrm_contact.user_unique_id',
1306 'headerPattern' => '/^Open\s?ID|u(niq\w*)?\s?ID/i',
1307 'dataPattern' => '/^[\w\/\:\.]+$/',
1310 'table_name' => 'civicrm_contact',
1311 'entity' => 'Contact',
1312 'bao' => 'CRM_Contact_BAO_Contact',
1318 'current_employer_id' => [
1319 'name' => 'employer_id',
1320 'type' => CRM_Utils_Type
::T_INT
,
1321 'title' => ts('Current Employer'),
1322 'description' => ts('OPTIONAL FK to civicrm_contact record.'),
1323 'where' => 'civicrm_contact.employer_id',
1325 'table_name' => 'civicrm_contact',
1326 'entity' => 'Contact',
1327 'bao' => 'CRM_Contact_BAO_Contact',
1329 'FKClassName' => 'CRM_Contact_DAO_Contact',
1331 'type' => 'EntityRef',
1334 'contact_is_deleted' => [
1335 'name' => 'is_deleted',
1336 'type' => CRM_Utils_Type
::T_BOOLEAN
,
1337 'title' => ts('Contact is in Trash'),
1339 'where' => 'civicrm_contact.is_deleted',
1342 'table_name' => 'civicrm_contact',
1343 'entity' => 'Contact',
1344 'bao' => 'CRM_Contact_BAO_Contact',
1347 'type' => 'CheckBox',
1351 'name' => 'created_date',
1352 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
1353 'title' => ts('Created Date'),
1354 'description' => ts('When was the contact was created.'),
1355 'required' => FALSE,
1356 'where' => 'civicrm_contact.created_date',
1358 'default' => 'NULL',
1359 'table_name' => 'civicrm_contact',
1360 'entity' => 'Contact',
1361 'bao' => 'CRM_Contact_BAO_Contact',
1364 'modified_date' => [
1365 'name' => 'modified_date',
1366 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
1367 'title' => ts('Modified Date'),
1368 'description' => ts('When was the contact (or closely related entity) was created or modified or deleted.'),
1369 'required' => FALSE,
1370 'where' => 'civicrm_contact.modified_date',
1372 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
1373 'table_name' => 'civicrm_contact',
1374 'entity' => 'Contact',
1375 'bao' => 'CRM_Contact_BAO_Contact',
1379 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
1381 return Civi
::$statics[__CLASS__
]['fields'];
1385 * Return a mapping from field-name to the corresponding key (as used in fields()).
1388 * Array(string $name => string $uniqueName).
1390 public static function &fieldKeys() {
1391 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
1392 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
1394 return Civi
::$statics[__CLASS__
]['fieldKeys'];
1398 * Returns the names of this table
1402 public static function getTableName() {
1403 return self
::$_tableName;
1407 * Returns if this table needs to be logged
1411 public function getLog() {
1416 * Returns the list of fields that can be imported
1418 * @param bool $prefix
1422 public static function &import($prefix = FALSE) {
1423 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'contact', $prefix, []);
1428 * Returns the list of fields that can be exported
1430 * @param bool $prefix
1434 public static function &export($prefix = FALSE) {
1435 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'contact', $prefix, []);
1440 * Returns the list of indices
1442 * @param bool $localize
1446 public static function indices($localize = TRUE) {
1448 'index_contact_type' => [
1449 'name' => 'index_contact_type',
1451 0 => 'contact_type',
1453 'localizable' => FALSE,
1454 'sig' => 'civicrm_contact::0::contact_type',
1456 'index_contact_sub_type' => [
1457 'name' => 'index_contact_sub_type',
1459 0 => 'contact_sub_type',
1461 'localizable' => FALSE,
1462 'sig' => 'civicrm_contact::0::contact_sub_type',
1464 'UI_external_identifier' => [
1465 'name' => 'UI_external_identifier',
1467 0 => 'external_identifier',
1469 'localizable' => FALSE,
1471 'sig' => 'civicrm_contact::1::external_identifier',
1473 'index_sort_name' => [
1474 'name' => 'index_sort_name',
1478 'localizable' => FALSE,
1479 'sig' => 'civicrm_contact::0::sort_name',
1481 'index_preferred_communication_method' => [
1482 'name' => 'index_preferred_communication_method',
1484 0 => 'preferred_communication_method',
1486 'localizable' => FALSE,
1487 'sig' => 'civicrm_contact::0::preferred_communication_method',
1490 'name' => 'index_hash',
1494 'localizable' => FALSE,
1495 'sig' => 'civicrm_contact::0::hash',
1497 'index_api_key' => [
1498 'name' => 'index_api_key',
1502 'localizable' => FALSE,
1503 'sig' => 'civicrm_contact::0::api_key',
1505 'index_first_name' => [
1506 'name' => 'index_first_name',
1510 'localizable' => FALSE,
1511 'sig' => 'civicrm_contact::0::first_name',
1513 'index_last_name' => [
1514 'name' => 'index_last_name',
1518 'localizable' => FALSE,
1519 'sig' => 'civicrm_contact::0::last_name',
1522 'name' => 'UI_prefix',
1526 'localizable' => FALSE,
1527 'sig' => 'civicrm_contact::0::prefix_id',
1530 'name' => 'UI_suffix',
1534 'localizable' => FALSE,
1535 'sig' => 'civicrm_contact::0::suffix_id',
1537 'index_communication_style_id' => [
1538 'name' => 'index_communication_style_id',
1540 0 => 'communication_style_id',
1542 'localizable' => FALSE,
1543 'sig' => 'civicrm_contact::0::communication_style_id',
1546 'name' => 'UI_gender',
1550 'localizable' => FALSE,
1551 'sig' => 'civicrm_contact::0::gender_id',
1553 'index_is_deceased' => [
1554 'name' => 'index_is_deceased',
1558 'localizable' => FALSE,
1559 'sig' => 'civicrm_contact::0::is_deceased',
1561 'index_household_name' => [
1562 'name' => 'index_household_name',
1564 0 => 'household_name',
1566 'localizable' => FALSE,
1567 'sig' => 'civicrm_contact::0::household_name',
1569 'index_organization_name' => [
1570 'name' => 'index_organization_name',
1572 0 => 'organization_name',
1574 'localizable' => FALSE,
1575 'sig' => 'civicrm_contact::0::organization_name',
1577 'index_is_deleted_sort_name' => [
1578 'name' => 'index_is_deleted_sort_name',
1584 'localizable' => FALSE,
1585 'sig' => 'civicrm_contact::0::is_deleted::sort_name::id',
1588 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;