3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class contains function for UFField
40 class CRM_Core_BAO_UFField
extends CRM_Core_DAO_UFField
{
45 private static $_contriBatchEntryFields = NULL;
46 private static $_memberBatchEntryFields = NULL;
50 * Takes a bunch of params that are needed to match certain criteria and
51 * retrieves the relevant objects. Typically the valid params are only
52 * contact_id. We'll tweak this function to be more full featured over a period
53 * of time. This is the inverse function of create. It also stores all the retrieved
54 * values in the default array
56 * @param array $params (reference ) an assoc array of name/value pairs
57 * @param array $defaults (reference ) an assoc array to hold the flattened values
59 * @return object CRM_Core_BAO_UFField object
63 static function retrieve(&$params, &$defaults) {
64 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_UFField', $params, $defaults);
70 * @param int $id id of uf_form
72 * @return string title
78 public static function getTitle($id) {
79 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFField', $groupId, 'title');
83 * update the is_active flag in the db
85 * @param int $id id of the database record
86 * @param boolean $is_active value we want to set the is_active field
88 * @return Object DAO object on sucess, null otherwise
92 static function setIsActive($id, $is_active) {
93 //check if custom data profile field is disabled
95 if (CRM_Core_BAO_UFField
::checkUFStatus($id)) {
96 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFField', $id, 'is_active', $is_active);
99 CRM_Core_Session
::setStatus(ts('Cannot enable this UF field since the used custom field is disabled.'), ts('Check Custom Field'), 'error');
103 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFField', $id, 'is_active', $is_active);
108 * Delete the profile Field.
110 * @param int $id Field Id
118 public static function del($id) {
120 $field = new CRM_Core_DAO_UFField();
127 * Function to check duplicate for duplicate field in a group
129 * @param array $params an associative array with field and values
133 * @ids array $ids array that containd ids
138 public static function duplicateField($params, $ids) {
139 $ufField = new CRM_Core_DAO_UFField();
140 $ufField->uf_group_id
= CRM_Utils_Array
::value('uf_group', $ids);
141 $ufField->field_type
= $params['field_name'][0];
142 $ufField->field_name
= $params['field_name'][1];
143 if ($params['field_name'][1] == 'url') {
144 $ufField->website_type_id
= CRM_Utils_Array
::value(2, $params['field_name'], NULL);
147 $ufField->location_type_id
= (CRM_Utils_Array
::value(2, $params['field_name'])) ?
$params['field_name'][2] : 'NULL';
149 $ufField->phone_type_id
= CRM_Utils_Array
::value(3, $params['field_name']);
151 if (!empty($ids['uf_field'])) {
152 $ufField->whereAdd("id <> " . CRM_Utils_Array
::value('uf_field', $ids));
155 return $ufField->find(TRUE);
159 * Does profile consists of a multi-record custom field
161 public static function checkMultiRecordFieldExists($gId) {
162 $queryString = "SELECT f.field_name
163 FROM civicrm_uf_field f, civicrm_uf_group g
164 WHERE f.uf_group_id = g.id
165 AND g.id = %1 AND f.field_name LIKE 'custom%'";
166 $p = array(1 => array($gId, 'Integer'));
167 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
168 $customFieldIds = array();
169 $isMultiRecordFieldPresent = FALSE;
170 while ($dao->fetch()) {
171 if ($customId = CRM_Core_BAO_CustomField
::getKeyID($dao->field_name
)) {
172 if (is_numeric($customId)) {
173 $customFieldIds[] = $customId;
178 if (!empty($customFieldIds) && count($customFieldIds) == 1) {
179 $customFieldId = array_pop($customFieldIds);
180 $isMultiRecordFieldPresent = CRM_Core_BAO_CustomField
::isMultiRecordField($customFieldId);
182 elseif (count($customFieldIds) > 1) {
183 $customFieldIds = implode(", ", $customFieldIds);
186 FROM civicrm_custom_group cg
187 INNER JOIN civicrm_custom_field cf
188 ON cg.id = cf.custom_group_id
189 WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1";
191 $dao = CRM_Core_DAO
::executeQuery($queryString);
193 $isMultiRecordFieldPresent = ($dao->cgId
) ?
$dao->cgId
: FALSE;
197 return $isMultiRecordFieldPresent;
201 * function to add the UF Field
203 * @param array $params (reference) array containing the values submitted by the form
204 * @param array $ids array containing the id
206 * @return object CRM_Core_BAO_UFField object
212 static function add(&$params, $ids = array()) {
213 // set values for uf field properties and save
214 $ufField = new CRM_Core_DAO_UFField();
215 $ufField->field_type
= $params['field_name'][0];
216 $ufField->field_name
= $params['field_name'][1];
218 //should not set location type id for Primary
219 $locationTypeId = NULL;
220 if ($params['field_name'][1] == 'url') {
221 $ufField->website_type_id
= CRM_Utils_Array
::value(2, $params['field_name']);
224 $locationTypeId = CRM_Utils_Array
::value(2, $params['field_name']);
225 $ufField->website_type_id
= NULL;
227 if ($locationTypeId) {
228 $ufField->location_type_id
= $locationTypeId;
231 $ufField->location_type_id
= 'null';
234 $ufField->phone_type_id
= CRM_Utils_Array
::value(3, $params['field_name'], 'NULL');
235 $ufField->listings_title
= CRM_Utils_Array
::value('listings_title', $params);
236 $ufField->visibility
= CRM_Utils_Array
::value('visibility', $params);
237 $ufField->help_pre
= CRM_Utils_Array
::value('help_pre', $params);
238 $ufField->help_post
= CRM_Utils_Array
::value('help_post', $params);
239 $ufField->label
= CRM_Utils_Array
::value('label', $params);
240 $ufField->is_required
= CRM_Utils_Array
::value('is_required', $params, FALSE);
241 $ufField->is_active
= CRM_Utils_Array
::value('is_active', $params, FALSE);
242 $ufField->in_selector
= CRM_Utils_Array
::value('in_selector', $params, FALSE);
243 $ufField->is_view
= CRM_Utils_Array
::value('is_view', $params, FALSE);
244 $ufField->is_registration
= CRM_Utils_Array
::value('is_registration', $params, FALSE);
245 $ufField->is_match
= CRM_Utils_Array
::value('is_match', $params, FALSE);
246 $ufField->is_searchable
= CRM_Utils_Array
::value('is_searchable', $params, FALSE);
247 $ufField->is_multi_summary
= CRM_Utils_Array
::value('is_multi_summary', $params, FALSE);
248 $ufField->weight
= CRM_Utils_Array
::value('weight', $params, 0);
250 // need the FKEY - uf group id
251 $ufField->uf_group_id
= CRM_Utils_Array
::value('uf_group', $ids, FALSE);
252 $ufField->id
= CRM_Utils_Array
::value('uf_field', $ids, FALSE);
254 return $ufField->save();
258 * Automatically determine one weight and modify others
260 * @param array $params UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id'
263 public static function autoWeight($params) {
267 if (!empty($params['field_id'])) {
268 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFField', $params['field_id'], 'weight', 'id');
270 $fieldValues = array('uf_group_id' => $params['group_id']);
271 return CRM_Utils_Weight
::updateOtherWeights('CRM_Core_DAO_UFField', $oldWeight, CRM_Utils_Array
::value('weight', $params, 0), $fieldValues);
275 * Function to enable/disable profile field given a custom field id
277 * @param int $customFieldId custom field id
278 * @param boolean $is_active set the is_active field
284 static function setUFField($customFieldId, $is_active) {
285 //find the profile id given custom field
286 $ufField = new CRM_Core_DAO_UFField();
287 $ufField->field_name
= "custom_" . $customFieldId;
290 while ($ufField->fetch()) {
291 //enable/ disable profile
292 CRM_Core_BAO_UFField
::setIsActive($ufField->id
, $is_active);
297 * Function to copy existing profile fields to
298 * new profile from the already built profile
300 * @param int $old_id from which we need to copy
301 * @param boolean $new_id in which to copy
307 static function copy($old_id, $new_id) {
308 $ufField = new CRM_Core_DAO_UFField();
309 $ufField->uf_group_id
= $old_id;
311 while ($ufField->fetch()) {
312 //copy the field records as it is on new ufgroup id
313 $ufField->uf_group_id
= $new_id;
320 * Function to delete profile field given a custom field
322 * @param int $customFieldId ID of the custom field to be deleted
329 static function delUFField($customFieldId) {
330 //find the profile id given custom field id
331 $ufField = new CRM_Core_DAO_UFField();
332 $ufField->field_name
= "custom_" . $customFieldId;
335 while ($ufField->fetch()) {
336 //enable/ disable profile
337 CRM_Core_BAO_UFField
::del($ufField->id
);
342 * Function to enable/disable profile field given a custom group id
344 * @param int $customGroupId custom group id
345 * @param boolean $is_active value we want to set the is_active field
351 static function setUFFieldStatus($customGroupId, $is_active) {
352 //find the profile id given custom group id
353 $queryString = "SELECT civicrm_custom_field.id as custom_field_id
354 FROM civicrm_custom_field, civicrm_custom_group
355 WHERE civicrm_custom_field.custom_group_id = civicrm_custom_group.id
356 AND civicrm_custom_group.id = %1";
357 $p = array(1 => array($customGroupId, 'Integer'));
358 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
360 while ($dao->fetch()) {
361 //enable/ disable profile
362 CRM_Core_BAO_UFField
::setUFField($dao->custom_field_id
, $is_active);
367 * Function to check the status of custom field used in uf fields
369 * @params int $UFFieldId uf field id
373 * @return boolean false if custom field are disabled else true
377 static function checkUFStatus($UFFieldId) {
378 $fieldName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFField', $UFFieldId, 'field_name');
379 // return if field is not a custom field
380 if (!$customFieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldName)) {
384 $customField = new CRM_Core_DAO_CustomField();
385 $customField->id
= $customFieldId;
386 // if uf field is custom field
387 if ($customField->find(TRUE)) {
388 if (!$customField->is_active
) {
398 * Function to find out whether given profile group using Activity
399 * Profile fields with contact fields
401 static function checkContactActivityProfileType($ufGroupId) {
402 $ufGroup = new CRM_Core_DAO_UFGroup();
403 $ufGroup->id
= $ufGroupId;
404 $ufGroup->find(TRUE);
406 return self
::checkContactActivityProfileTypeByGroupType($ufGroup->group_type
);
411 * @param $ufGroupType
414 public static function checkContactActivityProfileTypeByGroupType($ufGroupType) {
415 $profileTypes = array();
417 $typeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $ufGroupType);
418 $profileTypes = explode(',', $typeParts[0]);
421 if (empty($profileTypes)) {
424 $components = array('Contribution', 'Participant', 'Membership');
425 if (!in_array('Activity', $profileTypes)) {
428 elseif (count($profileTypes) == 1) {
432 if ($index = array_search('Contact', $profileTypes)) {
433 unset($profileTypes[$index]);
434 if (count($profileTypes) == 1) {
439 $contactTypes = array('Individual', 'Household', 'Organization');
440 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
442 $profileTypeComponent = array_intersect($components, $profileTypes);
443 if (!empty($profileTypeComponent) ||
444 count(array_intersect($contactTypes, $profileTypes)) > 1 ||
445 count(array_intersect($subTypes, $profileTypes)) > 1
454 * Function to find out whether given profile group uses $required
455 * and/or $optional profile types
457 * @param integer $ufGroupId profile id
458 * @param array $required array of types those are required
459 * @param array $optional array of types those are optional
461 * @return boolean $valid
464 static function checkValidProfileType($ufGroupId, $required, $optional = NULL) {
465 if (!is_array($required) ||
empty($required)) {
469 $ufGroup = new CRM_Core_DAO_UFGroup();
470 $ufGroup->id
= $ufGroupId;
471 $ufGroup->find(TRUE);
473 $profileTypes = array();
474 if ($ufGroup->group_type
) {
475 $typeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $ufGroup->group_type
);
476 $profileTypes = explode(',', $typeParts[0]);
479 if (empty($profileTypes)) {
484 foreach ($required as $key => $val) {
485 if (!in_array($val, $profileTypes)) {
491 if ($valid && is_array($optional)) {
492 foreach ($optional as $key => $val) {
493 if (in_array($val, $profileTypes)) {
504 * function to check for mix profile fields (eg: individual + other contact types)
506 * @params int $ufGroupId uf group id
507 * @params boolean $check this is to check mix profile (if true it will check if profile is
508 * pure ie. it contains only one contact type)
512 * @return true for mix profile else false
516 static function checkProfileType($ufGroupId) {
517 $ufGroup = new CRM_Core_DAO_UFGroup();
518 $ufGroup->id
= $ufGroupId;
519 $ufGroup->find(TRUE);
521 $profileTypes = array();
522 if ($ufGroup->group_type
) {
523 $typeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $ufGroup->group_type
);
524 $profileTypes = explode(',', $typeParts[0]);
527 //early return if new profile.
528 if (empty($profileTypes)) {
532 //we need to unset Contact
533 if (count($profileTypes) > 1) {
534 $index = array_search('Contact', $profileTypes);
535 if ($index !== FALSE) {
536 unset($profileTypes[$index]);
540 // suppress any subtypes if present
541 CRM_Contact_BAO_ContactType
::suppressSubTypes($profileTypes);
543 $contactTypes = array('Contact', 'Individual', 'Household', 'Organization');
544 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
547 // check for mix profile condition
548 if (count($profileTypes) > 1) {
549 //check the there are any components include in profile
550 foreach ($components as $value) {
551 if (in_array($value, $profileTypes)) {
555 //check if there are more than one contact types included in profile
556 if (count($profileTypes) > 1) {
560 elseif (count($profileTypes) == 1) {
561 // note for subtype case count would be zero
562 $profileTypes = array_values($profileTypes);
563 if (!in_array($profileTypes[0], $contactTypes)) {
572 * function to get the profile type (eg: individual/organization/household)
574 * @param int $ufGroupId uf group id
575 * @param boolean $returnMixType this is true, then field type of mix profile field is returned
576 * @param boolean $onlyPure true if only pure profiles are required
578 * @param bool $skipComponentType
580 * @return profile group_type
584 * TODO Why is this function in this class? It seems to be about the UFGroup.
586 static function getProfileType($ufGroupId, $returnMixType = TRUE, $onlyPure = FALSE, $skipComponentType = FALSE) {
587 $ufGroup = new CRM_Core_DAO_UFGroup();
588 $ufGroup->id
= $ufGroupId;
589 $ufGroup->is_active
= 1;
591 $ufGroup->find(TRUE);
592 return self
::calculateProfileType($ufGroup->group_type
, $returnMixType, $onlyPure, $skipComponentType);
596 * function to get the profile type (eg: individual/organization/household)
598 * @param $ufGroupType
599 * @param boolean $returnMixType this is true, then field type of mix profile field is returned
600 * @param boolean $onlyPure true if only pure profiles are required
602 * @param bool $skipComponentType
604 * @internal param int $ufGroupId uf group id
605 * @return profile group_type
609 * TODO Why is this function in this class? It seems to be about the UFGroup.
611 public static function calculateProfileType($ufGroupType, $returnMixType = TRUE, $onlyPure = FALSE, $skipComponentType= FALSE) {
613 $contactTypes = array('Contact', 'Individual', 'Household', 'Organization');
614 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
615 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
617 $profileTypes = array();
619 $typeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $ufGroupType);
620 $profileTypes = explode(',', $typeParts[0]);
624 if (count($profileTypes) == 1) {
625 return $profileTypes[0];
632 //we need to unset Contact
633 if (count($profileTypes) > 1) {
634 $index = array_search('Contact', $profileTypes);
635 if ($index !== FALSE) {
636 unset($profileTypes[$index]);
640 $profileType = $mixProfileType = NULL;
642 // this case handles pure profile
643 if (count($profileTypes) == 1) {
644 $profileType = array_pop($profileTypes);
647 //check the there are any components include in profile
648 $componentCount = array();
649 foreach ($components as $value) {
650 if (in_array($value, $profileTypes)) {
651 $componentCount[] = $value;
655 //check contact type included in profile
656 $contactTypeCount = array();
657 foreach ($contactTypes as $value) {
658 if (in_array($value, $profileTypes)) {
659 $contactTypeCount[] = $value;
663 $subTypeCount = array();
664 foreach ($subTypes as $value) {
665 if (in_array($value, $profileTypes)) {
666 $subTypeCount[] = $value;
669 if (!$skipComponentType && count($componentCount) == 1) {
670 $profileType = $componentCount[0];
672 elseif (count($componentCount) > 1) {
673 $mixProfileType = $componentCount[1];
675 elseif (count($subTypeCount) == 1) {
676 $profileType = $subTypeCount[0];
678 elseif (count($contactTypeCount) == 1) {
679 $profileType = $contactTypeCount[0];
681 elseif (count($subTypeCount) > 1) {
682 // this is mix subtype profiles
683 $mixProfileType = $subTypeCount[1];
685 elseif (count($contactTypeCount) > 1) {
686 // this is mix contact profiles
687 $mixProfileType = $contactTypeCount[1];
691 if ($mixProfileType) {
692 if ($returnMixType) {
693 return $mixProfileType;
705 * function to check for mix profiles groups (eg: individual + other contact types)
709 * @return true for mix profile group else false
713 static function checkProfileGroupType($ctype) {
714 $ufGroup = new CRM_Core_DAO_UFGroup();
718 FROM civicrm_uf_group as ufg, civicrm_uf_join as ufj
719 WHERE ufg.id = ufj.uf_group_id
720 AND ufj.module = 'User Registration'
721 AND ufg.is_active = 1 ";
723 $ufGroup = CRM_Core_DAO
::executeQuery($query);
726 $validProfiles = array('Individual', 'Organization', 'Household', 'Contribution');
727 while ($ufGroup->fetch()) {
728 $profileType = self
::getProfileType($ufGroup->id
);
729 if (in_array($profileType, $validProfiles)) {
732 elseif ($profileType) {
741 * check for searchable or in selector field for given profile.
743 * @params int $profileID profile id.
747 * @return boolean $result true/false.
749 static function checkSearchableORInSelector($profileID) {
757 From civicrm_uf_field
758 WHERE (in_selector = 1 OR is_searchable = 1)
759 AND uf_group_id = {$profileID}";
761 $ufFields = CRM_Core_DAO
::executeQuery($query);
762 while ($ufFields->fetch()) {
771 *Reset In selector and is seachable values for given $profileID.
773 * @params int $profileID profile id.
779 function resetInSelectorANDSearchable($profileID) {
783 $query = "UPDATE civicrm_uf_field SET in_selector = 0, is_searchable = 0 WHERE uf_group_id = {$profileID}";
784 CRM_Core_DAO
::executeQuery($query);
788 * Add fields to $profileAddressFields as appropriate.
789 * profileAddressFields is assigned to the template to tell it
790 * what fields are in the profile address
791 * that potentially should be copied to the Billing fields
792 * we want to give precedence to
794 * 2) then Primary designated as 'Primary
795 * 3) location_type is primary
796 * 4) if none of these apply then it just uses the first one
798 * as this will be used to
799 * transfer profile address data to billing fields
800 * http://issues.civicrm.org/jira/browse/CRM-5869
802 * @param string $key Field key - e.g. street_address-Primary, first_name
803 * @param array $profileAddressFields array of profile fields that relate to address fields
804 * @param array $profileFilter filter to apply to profile fields - expected usage is to only fill based on
805 * the bottom profile per CRM-13726
807 * @return bool Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118)
809 static function assignAddressField($key, &$profileAddressFields, $profileFilter) {
810 $billing_id = CRM_Core_BAO_LocationType
::getBilling();
811 list($prefixName, $index) = CRM_Utils_System
::explode('-', $key, 2);
813 $profileFields = civicrm_api3('uf_field', 'get', array_merge($profileFilter,
814 array('is_active' => 1, 'return' => 'field_name, is_required', 'options' => array(
818 //check for valid fields ( fields that are present in billing block )
819 $validBillingFields = array(
824 'supplemental_address_1',
830 $requiredBillingFields = array_diff($validBillingFields, array('middle_name','supplemental_address_1'));
831 $validProfileFields = array();
832 $requiredProfileFields = array();
834 foreach ($profileFields['values'] as $field) {
835 if(in_array($field['field_name'], $validBillingFields)) {
836 $validProfileFields[] = $field['field_name'];
838 if ($field['is_required']) {
839 $requiredProfileFields[] = $field['field_name'];
843 if (!in_array($prefixName, $validProfileFields) ) {
847 if (!empty($index) && (
848 // it's empty so we set it OR
849 !CRM_Utils_array
::value($prefixName, $profileAddressFields)
850 //we are dealing with billing id (precedence)
851 ||
$index == $billing_id
852 // we are dealing with primary & billing not set
853 ||
($index == 'Primary' && $profileAddressFields[$prefixName] != $billing_id)
854 ||
($index == CRM_Core_BAO_LocationType
::getDefault()->id
855 && $profileAddressFields[$prefixName] != $billing_id
856 && $profileAddressFields[$prefixName] != 'Primary'
860 $profileAddressFields[$prefixName] = $index;
863 $potentiallyMissingRequiredFields = array_diff($requiredBillingFields, $requiredProfileFields);
864 CRM_Core_Resources
::singleton()->addSetting(array('billing' => array('billingProfileIsHideable' => empty($potentiallyMissingRequiredFields))));
868 * Get a list of fields which can be added to profiles
870 * @param int $gid: UF group ID
871 * @param array $defaults: Form defaults
872 * @return array, multidimensional; e.g. $result['FieldGroup']['field_name']['label']
875 public static function getAvailableFields($gid = NULL, $defaults = array()) {
877 'Contact' => array(),
878 'Individual' => CRM_Contact_BAO_Contact
::importableFields('Individual', FALSE, FALSE, TRUE, TRUE, TRUE),
879 'Household' => CRM_Contact_BAO_Contact
::importableFields('Household', FALSE, FALSE, TRUE, TRUE, TRUE),
880 'Organization' => CRM_Contact_BAO_Contact
::importableFields('Organization', FALSE, FALSE, TRUE, TRUE, TRUE),
883 // include hook injected fields
884 $fields['Contact'] = array_merge($fields['Contact'], CRM_Contact_BAO_Query_Hook
::singleton()->getFields());
886 // add current employer for individuals
887 $fields['Individual']['current_employer'] = array(
888 'name' => 'organization_name',
889 'title' => ts('Current Employer'),
892 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
893 'address_options', TRUE, NULL, TRUE
896 if (!$addressOptions['county']) {
897 unset($fields['Individual']['county'], $fields['Household']['county'], $fields['Organization']['county']);
900 // break out common contact fields array CRM-3037.
901 // from a UI perspective this makes very little sense
902 foreach ($fields['Individual'] as $key => $value) {
903 if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) {
904 $fields['Contact'][$key] = $value;
905 unset($fields['Individual'][$key], $fields['Household'][$key], $fields['Organization'][$key]);
909 // Internal field not exposed to forms
910 unset($fields['Contact']['contact_type']);
911 unset($fields['Contact']['master_id']);
913 // convert phone extension in to psedo-field phone + phone extension
915 unset($fields['Contact']['phone_ext']);
917 $fields['Contact']['phone_and_ext'] = array(
918 'name' => 'phone_and_ext',
919 'title' => ts('Phone and Extension'),
920 'hasLocationType' => 1,
923 // include Subtypes For Profile
924 $subTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
925 foreach ($subTypes as $name => $val) {
926 //custom fields for sub type
927 $subTypeFields = CRM_Core_BAO_CustomField
::getFieldsForImport($name, FALSE, FALSE, FALSE, TRUE, TRUE);
928 if (array_key_exists($val['parent'], $fields)) {
929 $fields[$name] = $fields[$val['parent']] +
$subTypeFields;
932 $fields[$name] = $subTypeFields;
936 if (CRM_Core_Permission
::access('CiviContribute')) {
937 $contribFields = CRM_Contribute_BAO_Contribution
::getContributionFields(FALSE);
938 if (!empty($contribFields)) {
939 unset($contribFields['is_test']);
940 unset($contribFields['is_pay_later']);
941 unset($contribFields['contribution_id']);
942 $contribFields['contribution_note'] = array(
943 'name' => 'contribution_note',
944 'title' => ts('Contribution Note'),
946 $fields['Contribution'] = array_merge($contribFields, self
::getContribBatchEntryFields());
950 if (CRM_Core_Permission
::access('CiviEvent')) {
951 $participantFields = CRM_Event_BAO_Query
::getParticipantFields();
952 if ($participantFields) {
953 // Remove fields not supported by profiles
954 CRM_Utils_Array
::remove($participantFields,
955 'external_identifier',
957 'participant_contact_id',
958 'participant_role_id',
959 'participant_status_id',
960 'participant_is_test',
961 'participant_fee_level',
963 'participant_is_pay_later',
964 'participant_campaign'
966 if (isset($participantFields['participant_campaign_id'])) {
967 $participantFields['participant_campaign_id']['title'] = ts('Campaign');
969 $fields['Participant'] = $participantFields;
973 if (CRM_Core_Permission
::access('CiviMember')) {
974 $membershipFields = CRM_Member_BAO_Membership
::getMembershipFields();
975 // Remove fields not supported by profiles
976 CRM_Utils_Array
::remove($membershipFields,
978 'membership_type_id',
982 'member_is_pay_later'
984 if ($gid && CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'name') == 'membership_batch_entry') {
985 $fields['Membership'] = array_merge($membershipFields, self
::getMemberBatchEntryFields());
988 $fields['Membership'] = $membershipFields;
992 if (CRM_Core_Permission
::access('CiviCase')) {
993 $caseFields = CRM_Case_BAO_Query
::getFields(TRUE);
994 $caseFields = array_merge($caseFields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
996 // Remove fields not supported by profiles
997 CRM_Utils_Array
::remove($caseFields,
1007 $fields['Case'] = $caseFields;
1010 $activityFields = CRM_Activity_BAO_Activity
::getProfileFields();
1011 if ($activityFields) {
1012 // campaign related fields.
1013 if (isset($activityFields['activity_campaign_id'])) {
1014 $activityFields['activity_campaign_id']['title'] = ts('Campaign');
1016 $fields['Activity'] = $activityFields;
1019 $fields['Formatting']['format_free_html_' . rand(1000, 9999)] = array(
1020 'name' => 'free_html',
1023 'title' => 'Free HTML',
1027 foreach ($fields as &$values) {
1028 $values = CRM_Utils_Array
::crmArraySortByField($values, 'title');
1031 //group selected and unwanted fields list
1032 $ufFields = $gid ? CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE) : array();
1033 $groupFieldList = array_merge($ufFields, array(
1035 'email_greeting_custom',
1036 'postal_greeting_custom',
1040 //unset selected fields
1041 foreach ($groupFieldList as $key => $value) {
1042 if (is_integer($key)) {
1043 unset($fields['Individual'][$value], $fields['Household'][$value], $fields['Organization'][$value]);
1046 if (!empty($defaults['field_name'])
1047 && $defaults['field_name']['0'] == $value['field_type']
1048 && $defaults['field_name']['1'] == $key
1052 unset($fields[$value['field_type']][$key]);
1059 * Get a list of fields which can be added to profiles
1061 * @param bool $force
1063 * @return array, multidimensional; e.g. $result['field_name']['label']
1066 public static function getAvailableFieldsFlat($force = FALSE) {
1067 // FIXME reset when data model changes
1068 static $result = NULL;
1069 if ($result === NULL ||
$force) {
1070 $fieldTree = self
::getAvailableFields();
1072 foreach ($fieldTree as $field_type => $fields) {
1073 foreach ($fields as $field_name => $field) {
1074 if (!isset($result[$field_name])) {
1075 $field['field_type'] = $field_type;
1076 $result[$field_name] = $field;
1085 * Determine whether the given field_name is valid
1087 * @param string $fieldName
1090 static function isValidFieldName($fieldName) {
1091 $availableFields = CRM_Core_BAO_UFField
::getAvailableFieldsFlat();
1092 return isset($availableFields[$fieldName]);
1096 * @return array|null
1098 static function getContribBatchEntryFields() {
1099 if (self
::$_contriBatchEntryFields === NULL) {
1100 self
::$_contriBatchEntryFields = array(
1101 'send_receipt' => array(
1102 'name' => 'send_receipt',
1103 'title' => ts('Send Receipt'),
1105 'soft_credit' => array(
1106 'name' => 'soft_credit',
1107 'title' => ts('Soft Credit'),
1109 'soft_credit_type' => array(
1110 'name' => 'soft_credit_type',
1111 'title' => ts('Soft Credit Type'),
1113 'product_name' => array(
1114 'name' => 'product_name',
1115 'title' => ts('Premiums'),
1117 'contribution_note' => array(
1118 'name' => 'contribution_note',
1119 'title' => ts('Contribution Note'),
1123 return self
::$_contriBatchEntryFields;
1127 * @return array|null
1129 public static function getMemberBatchEntryFields() {
1130 if (self
::$_memberBatchEntryFields === NULL) {
1131 self
::$_memberBatchEntryFields = array(
1132 'send_receipt' => array(
1133 'name' => 'send_receipt',
1134 'title' => ts('Send Receipt'),
1136 'soft_credit' => array(
1137 'name' => 'soft_credit',
1138 'title' => ts('Soft Credit'),
1140 'product_name' => array(
1141 'name' => 'product_name',
1142 'title' => ts('Premiums'),
1144 'financial_type' => array(
1145 'name' => 'financial_type',
1146 'title' => ts('Financial Type'),
1148 'total_amount' => array(
1149 'name' => 'total_amount',
1150 'title' => ts('Total Amount'),
1152 'receive_date' => array(
1153 'name' => 'receive_date',
1154 'title' => ts('Receive Date'),
1156 'payment_instrument' => array(
1157 'name' => 'payment_instrument',
1158 'title' => ts('Payment Instrument'),
1160 'contribution_status_id' => array(
1161 'name' => 'contribution_status_id',
1162 'title' => ts('Contribution Status'),
1166 return self
::$_memberBatchEntryFields;