Personal/drupal-civicrm
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
drupal-civicrm/sites/all/modules/civicrm/api/v3/examples/Contact/GetFieldsOptions.php

1089 lines
35 KiB
PHP
Raw Permalink Normal View History

First commit
2018-01-14 15:10:16 +02:00
<?php
/**
* Test Generated example demonstrating the Contact.getfields API.
*
* Demonstrates retrieving metadata with custom field options.
*
* @return array
* API result array
*/
function contact_getfields_example() {
$params = array(
'options' => array(
'get_options' => 'custom_1',
),
'action' => 'create',
);
try{
$result = civicrm_api3('Contact', 'getfields', $params);
}
catch (CiviCRM_API3_Exception $e) {
// Handle error here.
$errorMessage = $e->getMessage();
$errorCode = $e->getErrorCode();
$errorData = $e->getExtraParams();
return array(
'is_error' => 1,
'error_message' => $errorMessage,
'error_code' => $errorCode,
'error_data' => $errorData,
);
}
return $result;
}
/**
* Function returns array of result expected from previous function.
*
* @return array
* API result array
*/
function contact_getfields_expectedresult() {
$expectedResult = array(
'is_error' => 0,
'version' => 3,
'count' => 55,
'values' => array(
'id' => array(
'name' => 'id',
'type' => 1,
'title' => 'Contact ID',
'description' => 'Unique Contact ID',
'required' => TRUE,
'import' => TRUE,
'where' => 'civicrm_contact.id',
'headerPattern' => '/internal|contact?|id$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'api.aliases' => array(
'0' => 'contact_id',
),
),
'contact_type' => array(
'name' => 'contact_type',
'type' => 2,
'title' => 'Contact Type',
'description' => 'Type of Contact.',
'maxlength' => 64,
'size' => 30,
'export' => TRUE,
'where' => 'civicrm_contact.contact_type',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'maxlength' => 64,
'size' => 30,
),
'pseudoconstant' => array(
'table' => 'civicrm_contact_type',
'keyColumn' => 'name',
'labelColumn' => 'label',
'condition' => 'parent_id IS NULL',
),
'api.required' => 1,
),
'contact_sub_type' => array(
'name' => 'contact_sub_type',
'type' => 2,
'title' => 'Contact Subtype',
'description' => 'May be used to over-ride contact view and edit templates.',
'maxlength' => 255,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.contact_sub_type',
'headerPattern' => '/C(ontact )?(subtype|sub-type|sub type)/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'maxlength' => 255,
'size' => 45,
),
'pseudoconstant' => array(
'table' => 'civicrm_contact_type',
'keyColumn' => 'name',
'labelColumn' => 'label',
'condition' => 'parent_id IS NOT NULL',
),
),
'do_not_email' => array(
'name' => 'do_not_email',
'type' => 16,
'title' => 'Do Not Email',
'import' => TRUE,
'where' => 'civicrm_contact.do_not_email',
'headerPattern' => '/d(o )?(not )?(email)/i',
'dataPattern' => '/^\\d{1,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'do_not_phone' => array(
'name' => 'do_not_phone',
'type' => 16,
'title' => 'Do Not Phone',
'import' => TRUE,
'where' => 'civicrm_contact.do_not_phone',
'headerPattern' => '/d(o )?(not )?(call|phone)/i',
'dataPattern' => '/^\\d{1,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'do_not_mail' => array(
'name' => 'do_not_mail',
'type' => 16,
'title' => 'Do Not Mail',
'import' => TRUE,
'where' => 'civicrm_contact.do_not_mail',
'headerPattern' => '/^(d(o\\s)?n(ot\\s)?mail)|(\\w*)?bulk\\s?(\\w*)$/i',
'dataPattern' => '/^\\d{1,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'do_not_sms' => array(
'name' => 'do_not_sms',
'type' => 16,
'title' => 'Do Not Sms',
'import' => TRUE,
'where' => 'civicrm_contact.do_not_sms',
'headerPattern' => '/d(o )?(not )?(sms)/i',
'dataPattern' => '/^\\d{1,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'do_not_trade' => array(
'name' => 'do_not_trade',
'type' => 16,
'title' => 'Do Not Trade',
'import' => TRUE,
'where' => 'civicrm_contact.do_not_trade',
'headerPattern' => '/d(o )?(not )?(trade)/i',
'dataPattern' => '/^\\d{1,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'is_opt_out' => array(
'name' => 'is_opt_out',
'type' => 16,
'title' => 'No Bulk Emails (User Opt Out)',
'description' => 'Has the contact opted out from receiving all bulk email from the organization or site domain?',
'required' => TRUE,
'import' => TRUE,
'where' => 'civicrm_contact.is_opt_out',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'legal_identifier' => array(
'name' => 'legal_identifier',
'type' => 2,
'title' => 'Legal Identifier',
'description' => 'May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.
',
'maxlength' => 32,
'size' => 20,
'import' => TRUE,
'where' => 'civicrm_contact.legal_identifier',
'headerPattern' => '/legal\\s?id/i',
'dataPattern' => '/\\w+?\\d{5,}/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 32,
'size' => 20,
),
),
'external_identifier' => array(
'name' => 'external_identifier',
'type' => 2,
'title' => 'External Identifier',
'description' => 'Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.',
'maxlength' => 64,
'size' => 8,
'import' => TRUE,
'where' => 'civicrm_contact.external_identifier',
'headerPattern' => '/external\\s?id/i',
'dataPattern' => '/^\\d{11,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 64,
'size' => 8,
),
),
'sort_name' => array(
'name' => 'sort_name',
'type' => 2,
'title' => 'Sort Name',
'description' => 'Name used for sorting different contact types',
'maxlength' => 128,
'size' => 30,
'export' => TRUE,
'where' => 'civicrm_contact.sort_name',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'display_name' => array(
'name' => 'display_name',
'type' => 2,
'title' => 'Display Name',
'description' => 'Formatted name representing preferred format for display/print/other output.',
'maxlength' => 128,
'size' => 30,
'export' => TRUE,
'where' => 'civicrm_contact.display_name',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'nick_name' => array(
'name' => 'nick_name',
'type' => 2,
'title' => 'Nickname',
'description' => 'Nickname.',
'maxlength' => 128,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.nick_name',
'headerPattern' => '/n(ick\\s)name|nick$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'legal_name' => array(
'name' => 'legal_name',
'type' => 2,
'title' => 'Legal Name',
'description' => 'Legal Name.',
'maxlength' => 128,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.legal_name',
'headerPattern' => '/^legal|(l(egal\\s)?name)$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'image_URL' => array(
'name' => 'image_URL',
'type' => 32,
'title' => 'Image Url',
'description' => 'optional URL for preferred image (photo, logo, etc.) to display for this contact.',
'import' => TRUE,
'where' => 'civicrm_contact.image_URL',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'File',
'rows' => 2,
'cols' => 80,
),
),
'preferred_communication_method' => array(
'name' => 'preferred_communication_method',
'type' => 2,
'title' => 'Preferred Communication Method',
'description' => 'What is the preferred mode of communication.',
'maxlength' => 255,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.preferred_communication_method',
'headerPattern' => '/^p(ref\\w*\\s)?c(omm\\w*)|( meth\\w*)$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'maxlength' => 255,
'size' => 45,
),
'pseudoconstant' => array(
'optionGroupName' => 'preferred_communication_method',
'optionEditPath' => 'civicrm/admin/options/preferred_communication_method',
),
),
'preferred_language' => array(
'name' => 'preferred_language',
'type' => 2,
'title' => 'Preferred Language',
'description' => 'Which language is preferred for communication. FK to languages in civicrm_option_value.',
'maxlength' => 5,
'size' => 6,
'import' => TRUE,
'where' => 'civicrm_contact.preferred_language',
'headerPattern' => '/^lang/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'maxlength' => 5,
'size' => 6,
),
'pseudoconstant' => array(
'optionGroupName' => 'languages',
'keyColumn' => 'name',
'optionEditPath' => 'civicrm/admin/options/languages',
),
),
'preferred_mail_format' => array(
'name' => 'preferred_mail_format',
'type' => 2,
'title' => 'Preferred Mail Format',
'description' => 'What is the preferred mode of sending an email.',
'maxlength' => 8,
'size' => 8,
'import' => TRUE,
'where' => 'civicrm_contact.preferred_mail_format',
'headerPattern' => '/^p(ref\\w*\\s)?m(ail\\s)?f(orm\\w*)$/i',
'export' => TRUE,
'default' => 'Both',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'maxlength' => 8,
'size' => 8,
),
'pseudoconstant' => array(
'callback' => 'CRM_Core_SelectValues::pmf',
),
),
'hash' => array(
'name' => 'hash',
'type' => 2,
'title' => 'Contact Hash',
'description' => 'Key for validating requests related to this contact.',
'maxlength' => 32,
'size' => 20,
'export' => TRUE,
'where' => 'civicrm_contact.hash',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'api_key' => array(
'name' => 'api_key',
'type' => 2,
'title' => 'Api Key',
'description' => 'API Key for validating requests related to this contact.',
'maxlength' => 32,
'size' => 20,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'first_name' => array(
'name' => 'first_name',
'type' => 2,
'title' => 'First Name',
'description' => 'First Name.',
'maxlength' => 64,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.first_name',
'headerPattern' => '/^first|(f(irst\\s)?name)$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 64,
'size' => 30,
),
),
'middle_name' => array(
'name' => 'middle_name',
'type' => 2,
'title' => 'Middle Name',
'description' => 'Middle Name.',
'maxlength' => 64,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.middle_name',
'headerPattern' => '/^middle|(m(iddle\\s)?name)$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 64,
'size' => 30,
),
),
'last_name' => array(
'name' => 'last_name',
'type' => 2,
'title' => 'Last Name',
'description' => 'Last Name.',
'maxlength' => 64,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.last_name',
'headerPattern' => '/^last|(l(ast\\s)?name)$/i',
'dataPattern' => '/^\\w+(\\s\\w+)?+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 64,
'size' => 30,
),
),
'prefix_id' => array(
'name' => 'prefix_id',
'type' => 1,
'title' => 'Individual Prefix',
'description' => 'Prefix or Title for name (Ms, Mr...). FK to prefix ID',
'import' => TRUE,
'where' => 'civicrm_contact.prefix_id',
'headerPattern' => '/^(prefix|title)/i',
'dataPattern' => '/^(mr|ms|mrs|sir|dr)\\.?$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'size' => 6,
'maxlength' => 14,
),
'pseudoconstant' => array(
'optionGroupName' => 'individual_prefix',
'optionEditPath' => 'civicrm/admin/options/individual_prefix',
),
'api.aliases' => array(
'0' => 'individual_prefix',
'1' => 'individual_prefix_id',
),
),
'suffix_id' => array(
'name' => 'suffix_id',
'type' => 1,
'title' => 'Individual Suffix',
'description' => 'Suffix for name (Jr, Sr...). FK to suffix ID',
'import' => TRUE,
'where' => 'civicrm_contact.suffix_id',
'headerPattern' => '/^suffix$/i',
'dataPattern' => '/^(sr|jr)\\.?|i{2,}$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'size' => 6,
'maxlength' => 14,
),
'pseudoconstant' => array(
'optionGroupName' => 'individual_suffix',
'optionEditPath' => 'civicrm/admin/options/individual_suffix',
),
'api.aliases' => array(
'0' => 'individual_suffix',
'1' => 'individual_suffix_id',
),
),
'formal_title' => array(
'name' => 'formal_title',
'type' => 2,
'title' => 'Formal Title',
'description' => 'Formal (academic or similar) title in front of name. (Prof., Dr. etc.)',
'maxlength' => 64,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.formal_title',
'headerPattern' => '/^title/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 64,
'size' => 30,
),
),
'communication_style_id' => array(
'name' => 'communication_style_id',
'type' => 1,
'title' => 'Communication Style',
'description' => 'Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.',
'export' => TRUE,
'where' => 'civicrm_contact.communication_style_id',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'size' => 6,
'maxlength' => 14,
),
'pseudoconstant' => array(
'optionGroupName' => 'communication_style',
'optionEditPath' => 'civicrm/admin/options/communication_style',
),
),
'email_greeting_id' => array(
'name' => 'email_greeting_id',
'type' => 1,
'title' => 'Email Greeting ID',
'description' => 'FK to civicrm_option_value.id, that has to be valid registered Email Greeting.',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'email_greeting_custom' => array(
'name' => 'email_greeting_custom',
'type' => 2,
'title' => 'Email Greeting Custom',
'description' => 'Custom Email Greeting.',
'maxlength' => 128,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.email_greeting_custom',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 45,
),
),
'email_greeting_display' => array(
'name' => 'email_greeting_display',
'type' => 2,
'title' => 'Email Greeting',
'description' => 'Cache Email Greeting.',
'maxlength' => 255,
'size' => 45,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 45,
),
),
'postal_greeting_id' => array(
'name' => 'postal_greeting_id',
'type' => 1,
'title' => 'Postal Greeting ID',
'description' => 'FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'size' => 6,
'maxlength' => 14,
),
),
'postal_greeting_custom' => array(
'name' => 'postal_greeting_custom',
'type' => 2,
'title' => 'Postal Greeting Custom',
'description' => 'Custom Postal greeting.',
'maxlength' => 128,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.postal_greeting_custom',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 45,
),
),
'postal_greeting_display' => array(
'name' => 'postal_greeting_display',
'type' => 2,
'title' => 'Postal Greeting',
'description' => 'Cache Postal greeting.',
'maxlength' => 255,
'size' => 45,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 45,
),
),
'addressee_id' => array(
'name' => 'addressee_id',
'type' => 1,
'title' => 'Addressee ID',
'description' => 'FK to civicrm_option_value.id, that has to be valid registered Addressee.',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'addressee_custom' => array(
'name' => 'addressee_custom',
'type' => 2,
'title' => 'Addressee Custom',
'description' => 'Custom Addressee.',
'maxlength' => 128,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.addressee_custom',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 45,
),
),
'addressee_display' => array(
'name' => 'addressee_display',
'type' => 2,
'title' => 'Addressee',
'description' => 'Cache Addressee.',
'maxlength' => 255,
'size' => 45,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 45,
),
),
'job_title' => array(
'name' => 'job_title',
'type' => 2,
'title' => 'Job Title',
'description' => 'Job Title',
'maxlength' => 255,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.job_title',
'headerPattern' => '/^job|(j(ob\\s)?title)$/i',
'dataPattern' => '//',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 30,
),
),
'gender_id' => array(
'name' => 'gender_id',
'type' => 1,
'title' => 'Gender',
'description' => 'FK to gender ID',
'import' => TRUE,
'where' => 'civicrm_contact.gender_id',
'headerPattern' => '/^gender$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select',
'size' => 6,
'maxlength' => 14,
),
'pseudoconstant' => array(
'optionGroupName' => 'gender',
'optionEditPath' => 'civicrm/admin/options/gender',
),
'api.aliases' => array(
'0' => 'gender',
),
),
'birth_date' => array(
'name' => 'birth_date',
'type' => 4,
'title' => 'Birth Date',
'description' => 'Date of birth',
'import' => TRUE,
'where' => 'civicrm_contact.birth_date',
'headerPattern' => '/^birth|(b(irth\\s)?date)|D(\\W*)O(\\W*)B(\\W*)$/i',
'dataPattern' => '/\\d{4}-?\\d{2}-?\\d{2}/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select Date',
'format' => 'birth',
),
),
'is_deceased' => array(
'name' => 'is_deceased',
'type' => 16,
'title' => 'Deceased',
'import' => TRUE,
'where' => 'civicrm_contact.is_deceased',
'headerPattern' => '/i(s\\s)?d(eceased)$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
),
'deceased_date' => array(
'name' => 'deceased_date',
'type' => 4,
'title' => 'Deceased Date',
'description' => 'Date of deceased',
'import' => TRUE,
'where' => 'civicrm_contact.deceased_date',
'headerPattern' => '/^deceased|(d(eceased\\s)?date)$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Select Date',
'format' => 'birth',
),
),
'household_name' => array(
'name' => 'household_name',
'type' => 2,
'title' => 'Household Name',
'description' => 'Household Name.',
'maxlength' => 128,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.household_name',
'headerPattern' => '/^household|(h(ousehold\\s)?name)$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'primary_contact_id' => array(
'name' => 'primary_contact_id',
'type' => 1,
'title' => 'Household Primary Contact ID',
'description' => 'Optional FK to Primary Contact for this household.',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'FKClassName' => 'CRM_Contact_DAO_Contact',
'html' => array(
'type' => 'Select',
'size' => 6,
'maxlength' => 14,
),
'FKApiName' => 'Contact',
),
'organization_name' => array(
'name' => 'organization_name',
'type' => 2,
'title' => 'Organization Name',
'description' => 'Organization Name.',
'maxlength' => 128,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.organization_name',
'headerPattern' => '/^organization|(o(rganization\\s)?name)$/i',
'dataPattern' => '/^\\w+$/',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 128,
'size' => 30,
),
),
'sic_code' => array(
'name' => 'sic_code',
'type' => 2,
'title' => 'Sic Code',
'description' => 'Standard Industry Classification Code.',
'maxlength' => 8,
'size' => 8,
'import' => TRUE,
'where' => 'civicrm_contact.sic_code',
'headerPattern' => '/^sic|(s(ic\\s)?code)$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 8,
'size' => 8,
),
),
'user_unique_id' => array(
'name' => 'user_unique_id',
'type' => 2,
'title' => 'Unique ID (OpenID)',
'description' => 'the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM',
'maxlength' => 255,
'size' => 45,
'import' => TRUE,
'where' => 'civicrm_contact.user_unique_id',
'headerPattern' => '/^Open\\s?ID|u(niq\\w*)?\\s?ID/i',
'dataPattern' => '/^[\\w\\/\\:\\.]+$/',
'export' => TRUE,
'rule' => 'url',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 45,
),
),
'created_date' => array(
'name' => 'created_date',
'type' => 256,
'title' => 'Created Date',
'description' => 'When was the contact was created.',
'required' => '',
'export' => TRUE,
'where' => 'civicrm_contact.created_date',
'default' => 'NULL',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'modified_date' => array(
'name' => 'modified_date',
'type' => 256,
'title' => 'Modified Date',
'description' => 'When was the contact (or closely related entity) was created or modified or deleted.',
'required' => '',
'export' => TRUE,
'where' => 'civicrm_contact.modified_date',
'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
),
'source' => array(
'name' => 'source',
'type' => 2,
'title' => 'Contact Source',
'description' => 'where contact come from, e.g. import, donate module insert...',
'maxlength' => 255,
'size' => 30,
'import' => TRUE,
'where' => 'civicrm_contact.source',
'headerPattern' => '/(C(ontact\\s)?Source)$/i',
'export' => TRUE,
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'Text',
'maxlength' => 255,
'size' => 30,
),
'uniqueName' => 'contact_source',
),
'employer_id' => array(
'name' => 'employer_id',
'type' => 1,
'title' => 'Current Employer',
'description' => 'OPTIONAL FK to civicrm_contact record.',
'export' => TRUE,
'where' => 'civicrm_contact.employer_id',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'FKClassName' => 'CRM_Contact_DAO_Contact',
'html' => array(
'type' => 'EntityRef',
'size' => 6,
'maxlength' => 14,
),
'uniqueName' => 'current_employer_id',
'FKApiName' => 'Contact',
),
'is_deleted' => array(
'name' => 'is_deleted',
'type' => 16,
'title' => 'Contact is in Trash',
'required' => TRUE,
'export' => TRUE,
'where' => 'civicrm_contact.is_deleted',
'table_name' => 'civicrm_contact',
'entity' => 'Contact',
'bao' => 'CRM_Contact_BAO_Contact',
'html' => array(
'type' => 'CheckBox',
),
'uniqueName' => 'contact_is_deleted',
),
'custom_1' => array(
'label' => 'Our special field',
'groupTitle' => 'select_test_g',
'data_type' => 'String',
'html_type' => 'Select',
'default_value' => '',
'text_length' => '',
'options_per_line' => '',
'custom_group_id' => '1',
'extends' => 'Contact',
'is_search_range' => 0,
'extends_entity_column_value' => '',
'extends_entity_column_id' => '',
'is_view' => 0,
'is_multiple' => 0,
'option_group_id' => '105',
'date_format' => '',
'time_format' => '',
'is_required' => '1',
'table_name' => 'civicrm_value_select_test_g_1',
'column_name' => 'our_special_field_1',
'pseudoconstant' => array(
'optionGroupName' => 'our_special_field_20170207021937',
'optionEditPath' => 'civicrm/admin/options/our_special_field_20170207021937',
),
'name' => 'custom_1',
'title' => 'Our special field',
'type' => 2,
'options' => array(
'1' => 'Label1',
'2' => 'Label2',
),
),
'current_employer' => array(
'title' => 'Current Employer',
'description' => 'Name of Current Employer',
'type' => 2,
'name' => 'current_employer',
),
'dupe_check' => array(
'title' => 'Check for Duplicates',
'description' => 'Throw error if contact create matches dedupe rule',
'type' => 16,
'name' => 'dupe_check',
),
),
);
return $expectedResult;
}
/*
* This example has been generated from the API test suite.
* The test that created it is called "testCustomFieldCreateWithOptionValues"
* and can be found at:
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
*
* You can see the outcome of the API tests at
* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
Reference in a new issue Copy permalink