diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php deleted file mode 100755 index b79e978..0000000 --- a/CRM/Core/BAO/UFField.php +++ /dev/null @@ -1,1167 +0,0 @@ -id = $params['id']; - if ($UFField->find(TRUE)) { - $defaults = $UFField->toArray(); - // This will be calculated based on field name - unset($defaults['field_type']); - $params += $defaults; - } - else { - throw new API_Exception("UFFIeld id {$params['id']} not found."); - } - } - - // Validate field_name - if (strpos($params['field_name'], 'formatting') !== 0 && !CRM_Core_BAO_UFField::isValidFieldName($params['field_name'])) { - throw new API_Exception('The field_name is not valid'); - } - - // Supply default label if not set - if (empty($id) && !isset($params['label'])) { - $params['label'] = self::getAvailableFieldTitles()[$params['field_name']]; - } - - // Supply field_type if not set - if (empty($params['field_type']) && strpos($params['field_name'], 'formatting') !== 0) { - $params['field_type'] = CRM_Utils_Array::pathGet(self::getAvailableFieldsFlat(), [$params['field_name'], 'field_type']); - } - elseif (empty($params['field_type'])) { - $params['field_type'] = 'Formatting'; - } - - // Generate unique name for formatting fields - if ($params['field_name'] === 'formatting') { - $params['field_name'] = 'formatting_' . substr(uniqid(), -4); - } - - if (self::duplicateField($params)) { - throw new API_Exception("The field was not added. It already exists in this profile."); - } - - //@todo why is this even optional? Surely weight should just be 'managed' ?? - if (CRM_Utils_Array::value('option.autoweight', $params, TRUE)) { - $params['weight'] = CRM_Core_BAO_UFField::autoWeight($params); - } - - // Set values for uf field properties and save - $ufField = new CRM_Core_DAO_UFField(); - $ufField->copyValues($params); - - if ($params['field_name'] == 'url') { - $ufField->location_type_id = 'null'; - } - else { - $ufField->website_type_id = 'null'; - } - if (!strstr($params['field_name'], 'phone')) { - $ufField->phone_type_id = 'null'; - } - - $ufField->save(); - - $fieldsType = CRM_Core_BAO_UFGroup::calculateGroupType($ufField->uf_group_id, TRUE); - CRM_Core_BAO_UFGroup::updateGroupTypes($ufField->uf_group_id, $fieldsType); - - civicrm_api3('profile', 'getfields', ['cache_clear' => TRUE]); - return $ufField; - } - - /** - * Fetch object based on array of properties. - * - * @param array $params - * (reference ) an assoc array of name/value pairs. - * @param array $defaults - * (reference ) an assoc array to hold the flattened values. - * - * @return CRM_Core_BAO_UFField - */ - public static function retrieve(&$params, &$defaults) { - return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_UFField', $params, $defaults); - } - - /** - * Update the is_active flag in the db. - * - * @param int $id - * Id of the database record. - * @param bool $is_active - * Value we want to set the is_active field. - * - * @return bool - * true if we found and updated the object, else false - */ - public static function setIsActive($id, $is_active) { - //check if custom data profile field is disabled - if ($is_active) { - if (CRM_Core_BAO_UFField::checkUFStatus($id)) { - return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFField', $id, 'is_active', $is_active); - } - else { - CRM_Core_Session::setStatus(ts('Cannot enable this UF field since the used custom field is disabled.'), ts('Check Custom Field'), 'error'); - } - } - else { - return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFField', $id, 'is_active', $is_active); - } - } - - /** - * Delete the profile Field. - * - * @param int $id - * Field Id. - * - * @return bool - * - */ - public static function del($id) { - //delete field field - $field = new CRM_Core_DAO_UFField(); - $field->id = $id; - $field->delete(); - return TRUE; - } - - /** - * Check duplicate for duplicate field in a group. - * - * @param array $params - * An associative array with field and values. - * - * @return bool - */ - public static function duplicateField($params) { - $ufField = new CRM_Core_DAO_UFField(); - $ufField->uf_group_id = CRM_Utils_Array::value('uf_group_id', $params); - $ufField->field_type = CRM_Utils_Array::value('field_type', $params); - $ufField->field_name = CRM_Utils_Array::value('field_name', $params); - $ufField->website_type_id = CRM_Utils_Array::value('website_type_id', $params); - if (is_null(CRM_Utils_Array::value('location_type_id', $params, ''))) { - // primary location type have NULL value in DB - $ufField->whereAdd("location_type_id IS NULL"); - } - else { - $ufField->location_type_id = CRM_Utils_Array::value('location_type_id', $params); - } - $ufField->phone_type_id = CRM_Utils_Array::value('phone_type_id', $params); - - if (!empty($params['id'])) { - $ufField->whereAdd("id <> " . $params['id']); - } - - return (bool) $ufField->find(TRUE); - } - - /** - * Does profile consists of a multi-record custom field. - * - * @param int $gId - * - * @return bool - */ - public static function checkMultiRecordFieldExists($gId) { - $queryString = "SELECT f.field_name - FROM civicrm_uf_field f, civicrm_uf_group g - WHERE f.uf_group_id = g.id - AND g.id = %1 AND f.field_name LIKE 'custom%'"; - $p = [1 => [$gId, 'Integer']]; - $dao = CRM_Core_DAO::executeQuery($queryString, $p); - $customFieldIds = []; - $isMultiRecordFieldPresent = FALSE; - while ($dao->fetch()) { - if ($customId = CRM_Core_BAO_CustomField::getKeyID($dao->field_name)) { - if (is_numeric($customId)) { - $customFieldIds[] = $customId; - } - } - } - - if (!empty($customFieldIds) && count($customFieldIds) == 1) { - $customFieldId = array_pop($customFieldIds); - $isMultiRecordFieldPresent = CRM_Core_BAO_CustomField::isMultiRecordField($customFieldId); - } - elseif (count($customFieldIds) > 1) { - $customFieldIds = implode(", ", $customFieldIds); - $queryString = " - SELECT cg.id as cgId - FROM civicrm_custom_group cg - INNER JOIN civicrm_custom_field cf - ON cg.id = cf.custom_group_id -WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; - - $dao = CRM_Core_DAO::executeQuery($queryString); - if ($dao->fetch()) { - $isMultiRecordFieldPresent = ($dao->cgId) ? $dao->cgId : FALSE; - } - } - - return $isMultiRecordFieldPresent; - } - - /** - * Automatically determine one weight and modify others. - * - * @param array $params - * UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id'. - * @return int - */ - public static function autoWeight($params) { - // fix for CRM-316 - $oldWeight = NULL; - - if (!empty($params['field_id']) || !empty($params['id'])) { - $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFField', !empty($params['id']) ? $params['id'] : $params['field_id'], 'weight', 'id'); - } - $fieldValues = ['uf_group_id' => !empty($params['uf_group_id']) ? $params['uf_group_id'] : $params['group_id']]; - return CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_UFField', $oldWeight, CRM_Utils_Array::value('weight', $params, 0), $fieldValues); - } - - /** - * Enable/disable profile field given a custom field id - * - * @param int $customFieldId - * Custom field id. - * @param bool $is_active - * Set the is_active field. - */ - public static function setUFField($customFieldId, $is_active) { - // Find the profile id given custom field. - $ufField = new CRM_Core_DAO_UFField(); - $ufField->field_name = "custom_" . $customFieldId; - - $ufField->find(); - while ($ufField->fetch()) { - // Enable/ disable profile. - CRM_Core_BAO_UFField::setIsActive($ufField->id, $is_active); - } - } - - /** - * Copy existing profile fields to - * new profile from the already built profile - * - * @param int $old_id - * From which we need to copy. - * @param bool $new_id - * In which to copy. - */ - public static function copy($old_id, $new_id) { - $ufField = new CRM_Core_DAO_UFField(); - $ufField->uf_group_id = $old_id; - $ufField->find(); - while ($ufField->fetch()) { - //copy the field records as it is on new ufgroup id - $ufField->uf_group_id = $new_id; - $ufField->id = NULL; - $ufField->save(); - } - } - - /** - * Delete profile field given a custom field. - * - * @param int $customFieldId - * ID of the custom field to be deleted. - */ - public static function delUFField($customFieldId) { - //find the profile id given custom field id - $ufField = new CRM_Core_DAO_UFField(); - $ufField->field_name = "custom_" . $customFieldId; - - $ufField->find(); - while ($ufField->fetch()) { - //enable/ disable profile - CRM_Core_BAO_UFField::del($ufField->id); - } - } - - /** - * Enable/disable profile field given a custom group id - * - * @param int $customGroupId - * Custom group id. - * @param bool $is_active - * Value we want to set the is_active field. - */ - public static function setUFFieldStatus($customGroupId, $is_active) { - //find the profile id given custom group id - $queryString = "SELECT civicrm_custom_field.id as custom_field_id - FROM civicrm_custom_field, civicrm_custom_group - WHERE civicrm_custom_field.custom_group_id = civicrm_custom_group.id - AND civicrm_custom_group.id = %1"; - $p = [1 => [$customGroupId, 'Integer']]; - $dao = CRM_Core_DAO::executeQuery($queryString, $p); - - while ($dao->fetch()) { - // Enable/ disable profile. - CRM_Core_BAO_UFField::setUFField($dao->custom_field_id, $is_active); - } - } - - /** - * Check the status of custom field used in uf fields. - * - * @param int $UFFieldId - * - * @return bool - * false if custom field are disabled else true - */ - public static function checkUFStatus($UFFieldId) { - $fieldName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFField', $UFFieldId, 'field_name'); - // return if field is not a custom field - if (!$customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldName)) { - return TRUE; - } - - $customField = new CRM_Core_DAO_CustomField(); - $customField->id = $customFieldId; - // if uf field is custom field - if ($customField->find(TRUE)) { - if (!$customField->is_active) { - return FALSE; - } - else { - return TRUE; - } - } - } - - /** - * Find out whether given profile group using Activity - * Profile fields with contact fields - * - * @param int $ufGroupId - * - * @return bool - */ - public static function checkContactActivityProfileType($ufGroupId) { - $ufGroup = new CRM_Core_DAO_UFGroup(); - $ufGroup->id = $ufGroupId; - $ufGroup->find(TRUE); - - return self::checkContactActivityProfileTypeByGroupType($ufGroup->group_type); - } - - /** - * FIXME say 10 ha - * @param $ufGroupType - * @return bool - */ - public static function checkContactActivityProfileTypeByGroupType($ufGroupType) { - $profileTypes = []; - if ($ufGroupType) { - $typeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $ufGroupType); - $profileTypes = explode(',', $typeParts[0]); - } - - if (empty($profileTypes)) { - return FALSE; - } - $components = ['Contribution', 'Participant', 'Membership']; - if (!in_array('Activity', $profileTypes)) { - return FALSE; - } - elseif (count($profileTypes) == 1) { - return FALSE; - } - - if ($index = array_search('Contact', $profileTypes)) { - unset($profileTypes[$index]); - if (count($profileTypes) == 1) { - return TRUE; - } - } - - $contactTypes = ['Individual', 'Household', 'Organization']; - $subTypes = CRM_Contact_BAO_ContactType::subTypes(); - - $profileTypeComponent = array_intersect($components, $profileTypes); - if (!empty($profileTypeComponent) || - count(array_intersect($contactTypes, $profileTypes)) > 1 || - count(array_intersect($subTypes, $profileTypes)) > 1 - ) { - return FALSE; - } - - return TRUE; - } - - /** - * Find out whether given profile group uses $required - * and/or $optional profile types - * - * @param int $ufGroupId - * Profile id. - * @param array $required - * Array of types those are required. - * @param array $optional - * Array of types those are optional. - * - * @return bool - */ - public static function checkValidProfileType($ufGroupId, $required, $optional = NULL) { - if (!is_array($required) || empty($required)) { - return FALSE; - } - - $ufGroup = new CRM_Core_DAO_UFGroup(); - $ufGroup->id = $ufGroupId; - $ufGroup->find(TRUE); - - $profileTypes = []; - if ($ufGroup->group_type) { - $typeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $ufGroup->group_type); - $profileTypes = explode(',', $typeParts[0]); - } - - if (empty($profileTypes)) { - return FALSE; - } - - $valid = TRUE; - foreach ($required as $key => $val) { - if (!in_array($val, $profileTypes)) { - $valid = FALSE; - break; - } - } - - if ($valid && is_array($optional)) { - foreach ($optional as $key => $val) { - if (in_array($val, $profileTypes)) { - $valid = TRUE; - break; - } - } - } - - return $valid; - } - - /** - * Check for mix profile fields (eg: individual + other contact types) - * - * @param int $ufGroupId - * - * @return bool - * true for mix profile else false - */ - public static function checkProfileType($ufGroupId) { - $ufGroup = new CRM_Core_DAO_UFGroup(); - $ufGroup->id = $ufGroupId; - $ufGroup->find(TRUE); - - $profileTypes = []; - if ($ufGroup->group_type) { - $typeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $ufGroup->group_type); - $profileTypes = explode(',', $typeParts[0]); - } - - //early return if new profile. - if (empty($profileTypes)) { - return FALSE; - } - - //we need to unset Contact - if (count($profileTypes) > 1) { - $index = array_search('Contact', $profileTypes); - if ($index !== FALSE) { - unset($profileTypes[$index]); - } - } - - // suppress any subtypes if present - CRM_Contact_BAO_ContactType::suppressSubTypes($profileTypes); - - $contactTypes = ['Contact', 'Individual', 'Household', 'Organization']; - $components = ['Contribution', 'Participant', 'Membership', 'Activity', 'Grant']; - $fields = []; - - // check for mix profile condition - if (count($profileTypes) > 1) { - //check the there are any components include in profile - foreach ($components as $value) { - if (in_array($value, $profileTypes)) { - return TRUE; - } - } - //check if there are more than one contact types included in profile - if (count($profileTypes) > 1) { - return TRUE; - } - } - elseif (count($profileTypes) == 1) { - // note for subtype case count would be zero - $profileTypes = array_values($profileTypes); - if (!in_array($profileTypes[0], $contactTypes)) { - return TRUE; - } - } - - return FALSE; - } - - /** - * Get the profile type (eg: individual/organization/household) - * - * @param int $ufGroupId - * Uf group id. - * @param bool $returnMixType - * This is true, then field type of mix profile field is returned. - * @param bool $onlyPure - * True if only pure profiles are required. - * - * @param bool $skipComponentType - * - * @return string - * profile group_type - * - */ - public static function getProfileType($ufGroupId, $returnMixType = TRUE, $onlyPure = FALSE, $skipComponentType = FALSE) { - $ufGroup = new CRM_Core_DAO_UFGroup(); - $ufGroup->id = $ufGroupId; - $ufGroup->is_active = 1; - - $ufGroup->find(TRUE); - return self::calculateProfileType($ufGroup->group_type, $returnMixType, $onlyPure, $skipComponentType); - } - - /** - * Get the profile type (eg: individual/organization/household) - * - * @param string $ufGroupType - * @param bool $returnMixType - * This is true, then field type of mix profile field is returned. - * @param bool $onlyPure - * True if only pure profiles are required. - * @param bool $skipComponentType - * - * @return string profile group_type - * - */ - public static function calculateProfileType($ufGroupType, $returnMixType = TRUE, $onlyPure = FALSE, $skipComponentType = FALSE) { - // profile types - $contactTypes = ['Contact', 'Individual', 'Household', 'Organization']; - $subTypes = CRM_Contact_BAO_ContactType::subTypes(); - $components = ['Contribution', 'Participant', 'Membership', 'Activity', 'Grant']; - - $profileTypes = []; - if ($ufGroupType) { - $typeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $ufGroupType); - $profileTypes = explode(',', $typeParts[0]); - } - - if ($onlyPure) { - if (count($profileTypes) == 1) { - return $profileTypes[0]; - } - else { - return NULL; - } - } - - //we need to unset Contact - if (count($profileTypes) > 1) { - $index = array_search('Contact', $profileTypes); - if ($index !== FALSE) { - unset($profileTypes[$index]); - } - } - - $profileType = $mixProfileType = NULL; - - // this case handles pure profile - if (count($profileTypes) == 1) { - $profileType = array_pop($profileTypes); - } - else { - //check the there are any components include in profile - $componentCount = []; - foreach ($components as $value) { - if (in_array($value, $profileTypes)) { - $componentCount[] = $value; - } - } - - //check contact type included in profile - $contactTypeCount = []; - foreach ($contactTypes as $value) { - if (in_array($value, $profileTypes)) { - $contactTypeCount[] = $value; - } - } - // subtype counter - $subTypeCount = []; - foreach ($subTypes as $value) { - if (in_array($value, $profileTypes)) { - $subTypeCount[] = $value; - } - } - if (!$skipComponentType && count($componentCount) == 1) { - $profileType = $componentCount[0]; - } - elseif (count($componentCount) > 1) { - $mixProfileType = $componentCount[1]; - } - elseif (count($subTypeCount) == 1) { - $profileType = $subTypeCount[0]; - } - elseif (count($contactTypeCount) == 1) { - $profileType = $contactTypeCount[0]; - } - elseif (count($subTypeCount) > 1) { - // this is mix subtype profiles - $mixProfileType = $subTypeCount[1]; - } - elseif (count($contactTypeCount) > 1) { - // this is mix contact profiles - $mixProfileType = $contactTypeCount[1]; - } - } - - if ($mixProfileType) { - if ($returnMixType) { - return $mixProfileType; - } - else { - return 'Mixed'; - } - } - else { - return $profileType; - } - } - - /** - * Check for mix profiles groups (eg: individual + other contact types) - * - * @param $ctype - * - * @return bool - * true for mix profile group else false - */ - public static function checkProfileGroupType($ctype) { - $ufGroup = new CRM_Core_DAO_UFGroup(); - - $query = " -SELECT ufg.id as id - FROM civicrm_uf_group as ufg, civicrm_uf_join as ufj - WHERE ufg.id = ufj.uf_group_id - AND ufj.module = 'User Registration' - AND ufg.is_active = 1 "; - - $ufGroup = CRM_Core_DAO::executeQuery($query); - - $fields = []; - $validProfiles = ['Individual', 'Organization', 'Household', 'Contribution']; - while ($ufGroup->fetch()) { - $profileType = self::getProfileType($ufGroup->id); - if (in_array($profileType, $validProfiles)) { - continue; - } - elseif ($profileType) { - return FALSE; - } - } - - return TRUE; - } - - /** - * Check for searchable or in selector field for given profile. - * - * @param int $profileID - * - * @return bool - */ - public static function checkSearchableORInSelector($profileID) { - $result = FALSE; - if (!$profileID) { - return $result; - } - - $query = " -SELECT id - From civicrm_uf_field - WHERE (in_selector = 1 OR is_searchable = 1) - AND uf_group_id = {$profileID}"; - - $ufFields = CRM_Core_DAO::executeQuery($query); - while ($ufFields->fetch()) { - $result = TRUE; - break; - } - - return $result; - } - - /** - * Reset In selector and is searchable values for given $profileID. - * - * @param int $profileID - */ - public function resetInSelectorANDSearchable($profileID) { - if (!$profileID) { - return; - } - $query = "UPDATE civicrm_uf_field SET in_selector = 0, is_searchable = 0 WHERE uf_group_id = {$profileID}"; - CRM_Core_DAO::executeQuery($query); - } - - /** - * Add fields to $profileAddressFields as appropriate. - * profileAddressFields is assigned to the template to tell it - * what fields are in the profile address - * that potentially should be copied to the Billing fields - * we want to give precedence to - * 1) Billing & - * 2) then Primary designated as 'Primary - * 3) location_type is primary - * 4) if none of these apply then it just uses the first one - * - * as this will be used to - * transfer profile address data to billing fields - * http://issues.civicrm.org/jira/browse/CRM-5869 - * - * @param string $key - * Field key - e.g. street_address-Primary, first_name. - * @param array $profileAddressFields - * Array of profile fields that relate to address fields. - * @param array $profileFilter - * Filter to apply to profile fields - expected usage is to only fill based on. - * the bottom profile per CRM-13726 - * - * @return bool - * Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118) - */ - public static function assignAddressField($key, &$profileAddressFields, $profileFilter) { - $billing_id = CRM_Core_BAO_LocationType::getBilling(); - list($prefixName, $index) = CRM_Utils_System::explode('-', $key, 2); - - $profileFields = civicrm_api3('uf_field', 'get', array_merge($profileFilter, - [ - 'is_active' => 1, - 'return' => 'field_name, is_required', - 'options' => [ - 'limit' => 0, - ], - ] - )); - //check for valid fields ( fields that are present in billing block ) - $validBillingFields = [ - 'first_name', - 'middle_name', - 'last_name', - 'street_address', - 'supplemental_address_1', - 'city', - 'state_province', - 'postal_code', - 'country', - ]; - $requiredBillingFields = array_diff($validBillingFields, ['middle_name', 'supplemental_address_1']); - $validProfileFields = []; - $requiredProfileFields = []; - - foreach ($profileFields['values'] as $field) { - if (in_array($field['field_name'], $validBillingFields)) { - $validProfileFields[] = $field['field_name']; - } - if (!empty($field['is_required'])) { - $requiredProfileFields[] = $field['field_name']; - } - } - - if (!in_array($prefixName, $validProfileFields)) { - return FALSE; - } - - if (!empty($index) && ( - // it's empty so we set it OR - !CRM_Utils_Array::value($prefixName, $profileAddressFields) - //we are dealing with billing id (precedence) - || $index == $billing_id - // we are dealing with primary & billing not set - || ($index == 'Primary' && $profileAddressFields[$prefixName] != $billing_id) - || ($index == CRM_Core_BAO_LocationType::getDefault()->id - && $profileAddressFields[$prefixName] != $billing_id - && $profileAddressFields[$prefixName] != 'Primary' - ) - ) - ) { - $profileAddressFields[$prefixName] = $index; - } - - $potentiallyMissingRequiredFields = array_diff($requiredBillingFields, $requiredProfileFields); - CRM_Core_Resources::singleton() - ->addSetting(['billing' => ['billingProfileIsHideable' => empty($potentiallyMissingRequiredFields)]]); - } - - /** - * Get a list of fields which can be added to profiles. - * - * @param int $gid : UF group ID - * @param array $defaults : Form defaults - * @return array, multidimensional; e.g. $result['FieldGroup']['field_name']['label'] - */ - public static function getAvailableFields($gid = NULL, $defaults = []) { - $fields = [ - 'Contact' => [], - 'Individual' => CRM_Contact_BAO_Contact::importableFields('Individual', FALSE, FALSE, TRUE, TRUE, TRUE), - 'Household' => CRM_Contact_BAO_Contact::importableFields('Household', FALSE, FALSE, TRUE, TRUE, TRUE), - 'Organization' => CRM_Contact_BAO_Contact::importableFields('Organization', FALSE, FALSE, TRUE, TRUE, TRUE), - ]; - - // include hook injected fields - $fields['Contact'] = array_merge($fields['Contact'], CRM_Contact_BAO_Query_Hook::singleton()->getFields()); - - // add current employer for individuals - $fields['Individual']['current_employer'] = [ - 'name' => 'organization_name', - 'title' => ts('Current Employer'), - ]; - - $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, - 'address_options', TRUE, NULL, TRUE - ); - - if (empty($addressOptions['county'])) { - unset($fields['Individual']['county'], $fields['Household']['county'], $fields['Organization']['county']); - } - - // break out common contact fields array CRM-3037. - // from a UI perspective this makes very little sense - foreach ($fields['Individual'] as $key => $value) { - if (!empty($fields['Household'][$key]) && !empty($fields['Organization'][$key])) { - $fields['Contact'][$key] = $value; - unset($fields['Individual'][$key], $fields['Household'][$key], $fields['Organization'][$key]); - } - } - - // Internal field not exposed to forms - unset($fields['Contact']['contact_type']); - unset($fields['Contact']['master_id']); - - // convert phone extension in to psedo-field phone + phone extension - //unset extension - unset($fields['Contact']['phone_ext']); - //add psedo field - $fields['Contact']['phone_and_ext'] = [ - 'name' => 'phone_and_ext', - 'title' => ts('Phone and Extension'), - 'hasLocationType' => 1, - ]; - - // include Subtypes For Profile - $subTypes = CRM_Contact_BAO_ContactType::subTypeInfo(); - foreach ($subTypes as $name => $val) { - //custom fields for sub type - $subTypeFields = CRM_Core_BAO_CustomField::getFieldsForImport($name, FALSE, FALSE, FALSE, TRUE, TRUE); - if (array_key_exists($val['parent'], $fields)) { - $fields[$name] = $fields[$val['parent']] + $subTypeFields; - } - else { - $fields[$name] = $subTypeFields; - } - } - - if (CRM_Core_Permission::access('CiviContribute')) { - $contribFields = CRM_Contribute_BAO_Contribution::getContributionFields(FALSE); - if (!empty($contribFields)) { - unset($contribFields['is_test']); - unset($contribFields['is_pay_later']); - unset($contribFields['contribution_id']); - $contribFields['contribution_note'] = [ - 'name' => 'contribution_note', - 'title' => ts('Contribution Note'), - ]; - $fields['Contribution'] = array_merge($contribFields, self::getContribBatchEntryFields()); - } - } - - if (CRM_Core_Permission::access('CiviGrant')) { - $grantFields = CRM_Grantapplications_BAO_GrantApplicationProfile::getGrantFields(); - if (!empty($grantFields)) { - $fields['Grant'] = $grantFields; - } - } - - if (CRM_Core_Permission::access('CiviEvent')) { - $participantFields = CRM_Event_BAO_Query::getParticipantFields(); - if ($participantFields) { - // Remove fields not supported by profiles - CRM_Utils_Array::remove($participantFields, - 'external_identifier', - 'event_id', - 'participant_contact_id', - 'participant_role_id', - 'participant_status_id', - 'participant_is_test', - 'participant_fee_level', - 'participant_id', - 'participant_is_pay_later', - 'participant_campaign' - ); - if (isset($participantFields['participant_campaign_id'])) { - $participantFields['participant_campaign_id']['title'] = ts('Campaign'); - } - $fields['Participant'] = $participantFields; - } - } - - if (CRM_Core_Permission::access('CiviMember')) { - $membershipFields = CRM_Member_BAO_Membership::getMembershipFields(); - // Remove fields not supported by profiles - CRM_Utils_Array::remove($membershipFields, - 'membership_id', - 'membership_type_id', - 'member_is_test', - 'is_override', - 'member_is_override', - 'status_override_end_date', - 'status_id', - 'member_is_pay_later' - ); - if ($gid && CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'name') == 'membership_batch_entry') { - $fields['Membership'] = array_merge($membershipFields, self::getMemberBatchEntryFields()); - } - else { - $fields['Membership'] = $membershipFields; - } - } - - if (CRM_Core_Permission::access('CiviCase')) { - $caseFields = CRM_Case_BAO_Query::getFields(TRUE); - $caseFields = array_merge($caseFields, CRM_Core_BAO_CustomField::getFieldsForImport('Case')); - if ($caseFields) { - // Remove fields not supported by profiles - CRM_Utils_Array::remove($caseFields, - 'case_id', - 'case_type', - 'case_role', - 'case_deleted' - ); - } - $fields['Case'] = $caseFields; - } - - $activityFields = CRM_Activity_BAO_Activity::getProfileFields(); - if ($activityFields) { - // campaign related fields. - if (isset($activityFields['activity_campaign_id'])) { - $activityFields['activity_campaign_id']['title'] = ts('Campaign'); - } - $fields['Activity'] = $activityFields; - } - - $fields['Formatting']['format_free_html_' . rand(1000, 9999)] = [ - 'name' => 'free_html', - 'import' => FALSE, - 'export' => FALSE, - 'title' => 'Free HTML', - ]; - - // Sort by title - foreach ($fields as &$values) { - $values = CRM_Utils_Array::crmArraySortByField($values, 'title'); - } - - //group selected and unwanted fields list - $ufFields = $gid ? CRM_Core_BAO_UFGroup::getFields($gid, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE) : []; - $groupFieldList = array_merge($ufFields, [ - 'note', - 'email_greeting_custom', - 'postal_greeting_custom', - 'addressee_custom', - 'id', - ]); - //unset selected fields - foreach ($groupFieldList as $key => $value) { - if (is_int($key)) { - unset($fields['Individual'][$value], $fields['Household'][$value], $fields['Organization'][$value]); - continue; - } - if (!empty($defaults['field_name']) - && $defaults['field_name']['0'] == $value['field_type'] - && $defaults['field_name']['1'] == $key - ) { - continue; - } - unset($fields[$value['field_type']][$key]); - } - - return $fields; - } - - /** - * Get a list of fields which can be added to profiles. - * - * @param bool $force - * - * @return array - * e.g. $result['field_name']['label'] - */ - public static function getAvailableFieldsFlat($force = FALSE) { - if (!isset(Civi::$statics['UFFieldsFlat']) || $force) { - Civi::$statics['UFFieldsFlat'] = []; - foreach (self::getAvailableFields() as $fieldType => $fields) { - foreach ($fields as $fieldName => $field) { - if (!isset(Civi::$statics['UFFieldsFlat'][$fieldName])) { - $field['field_type'] = $fieldType; - Civi::$statics['UFFieldsFlat'][$fieldName] = $field; - } - } - } - } - return Civi::$statics['UFFieldsFlat']; - } - - /** - * Get a list of fields which can be added to profiles in the format [name => title] - * - * @return array - */ - public static function getAvailableFieldTitles() { - $fields = self::getAvailableFieldsFlat(); - $fields['formatting'] = ['title' => ts('Formatting')]; - return CRM_Utils_Array::collect('title', $fields); - } - - /** - * Determine whether the given field_name is valid. - * - * @param string $fieldName - * @return bool - */ - public static function isValidFieldName($fieldName) { - $availableFields = CRM_Core_BAO_UFField::getAvailableFieldsFlat(); - return isset($availableFields[$fieldName]); - } - - /** - * @return array|null - */ - public static function getContribBatchEntryFields() { - if (self::$_contriBatchEntryFields === NULL) { - self::$_contriBatchEntryFields = [ - 'send_receipt' => [ - 'name' => 'send_receipt', - 'title' => ts('Send Receipt'), - ], - 'soft_credit' => [ - 'name' => 'soft_credit', - 'title' => ts('Soft Credit'), - ], - 'soft_credit_type' => [ - 'name' => 'soft_credit_type', - 'title' => ts('Soft Credit Type'), - ], - 'product_name' => [ - 'name' => 'product_name', - 'title' => ts('Premiums'), - ], - 'contribution_note' => [ - 'name' => 'contribution_note', - 'title' => ts('Contribution Note'), - ], - 'contribution_soft_credit_pcp_id' => [ - 'name' => 'contribution_soft_credit_pcp_id', - 'title' => ts('Personal Campaign Page'), - ], - ]; - } - return self::$_contriBatchEntryFields; - } - - /** - * @return array|null - */ - public static function getMemberBatchEntryFields() { - if (self::$_memberBatchEntryFields === NULL) { - self::$_memberBatchEntryFields = [ - 'send_receipt' => [ - 'name' => 'send_receipt', - 'title' => ts('Send Receipt'), - ], - 'soft_credit' => [ - 'name' => 'soft_credit', - 'title' => ts('Soft Credit'), - ], - 'product_name' => [ - 'name' => 'product_name', - 'title' => ts('Premiums'), - ], - 'financial_type' => [ - 'name' => 'financial_type', - 'title' => ts('Financial Type'), - ], - 'total_amount' => [ - 'name' => 'total_amount', - 'title' => ts('Total Amount'), - ], - 'receive_date' => [ - 'name' => 'receive_date', - 'title' => ts('Date Received'), - ], - 'payment_instrument' => [ - 'name' => 'payment_instrument', - 'title' => ts('Payment Method'), - ], - 'contribution_status_id' => [ - 'name' => 'contribution_status_id', - 'title' => ts('Contribution Status'), - ], - 'trxn_id' => [ - 'name' => 'contribution_trxn_id', - 'title' => ts('Contribution Transaction ID'), - ], - ]; - } - return self::$_memberBatchEntryFields; - } - -} diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php deleted file mode 100644 index fa72db3..0000000 --- a/CRM/Core/BAO/UFGroup.php +++ /dev/null @@ -1,3649 +0,0 @@ - $title) { - if ($ctype) { - $fieldType = CRM_Core_BAO_UFField::getProfileType($id); - if (($fieldType != 'Contact') && - ($fieldType != $ctype) && - !CRM_Contact_BAO_ContactType::isExtendsContactType($fieldType, $ctype) - ) { - continue; - } - if (CRM_Contact_BAO_ContactType::isaSubType($fieldType)) { - $profileSubType = $fieldType; - } - } - - $subset = self::getFields($id, TRUE, $action, - NULL, NULL, FALSE, NULL, TRUE, $ctype - ); - - // we do not allow duplicates. the first field is the winner - foreach ($subset as $name => $field) { - if (empty($fields[$name])) { - $fields[$name] = $field; - } - } - } - - return $fields; - } - - /** - * Get all the listing fields. - * - * @param int $action - * What action are we doing. - * @param int $visibility - * Visibility of fields we are interested in. - * @param bool $considerSelector - * Whether to consider the in_selector parameter. - * @param array $ufGroupIds - * @param bool $searchable - * - * @param null $restrict - * @param bool $skipPermission - * @param int $permissionType - * - * @return array - * the fields that are listings related - * - * @throws \Exception - */ - public static function getListingFields( - $action, - $visibility, - $considerSelector = FALSE, - $ufGroupIds = NULL, - $searchable = NULL, - $restrict = NULL, - $skipPermission = FALSE, - $permissionType = CRM_Core_Permission::SEARCH - ) { - if ($ufGroupIds) { - $subset = self::getFields($ufGroupIds, FALSE, $action, - $visibility, $searchable, - FALSE, $restrict, - $skipPermission, - NULL, - $permissionType - ); - if ($considerSelector) { - // drop the fields not meant for the selector - foreach ($subset as $name => $field) { - if (!$field['in_selector']) { - unset($subset[$name]); - } - } - } - $fields = $subset; - } - else { - $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id'); - - $fields = []; - foreach ($ufGroups as $id => $title) { - $subset = self::getFields($id, FALSE, $action, - $visibility, $searchable, - FALSE, $restrict, - $skipPermission, - NULL, - $permissionType - ); - if ($considerSelector) { - // drop the fields not meant for the selector - foreach ($subset as $name => $field) { - if (!$field['in_selector']) { - unset($subset[$name]); - } - } - } - $fields = array_merge($fields, $subset); - } - } - return $fields; - } - - /** - * Get all the fields that belong to the group with the name title, - * and format for use with buildProfile. This is the SQL analog of - * formatUFFields(). - * - * @param mix $id - * The id of the UF group or ids of ufgroup. - * @param bool|int $register are we interested in registration fields - * @param int $action - * What action are we doing. - * @param int $visibility - * Visibility of fields we are interested in. - * @param $searchable - * @param bool $showAll - * @param string $restrict - * Should we restrict based on a specified profile type. - * @param bool $skipPermission - * @param null $ctype - * @param int $permissionType - * @param string $orderBy - * @param null $orderProfiles - * - * @param bool $eventProfile - * - * @return array - * The fields that belong to this ufgroup(s) - * - * @throws \CRM_Core_Exception - */ - public static function getFields( - $id, - $register = FALSE, - $action = NULL, - $visibility = NULL, - $searchable = NULL, - $showAll = FALSE, - $restrict = NULL, - $skipPermission = FALSE, - $ctype = NULL, - $permissionType = CRM_Core_Permission::CREATE, - $orderBy = 'field_name', - $orderProfiles = NULL, - $eventProfile = FALSE - ) { - if (!is_array($id)) { - $id = CRM_Utils_Type::escape($id, 'Positive'); - $profileIds = [$id]; - } - else { - $profileIds = $id; - } - - $gids = implode(',', $profileIds); - $params = []; - if ($restrict) { - $query = "SELECT g.* from civicrm_uf_group g - LEFT JOIN civicrm_uf_join j ON (j.uf_group_id = g.id) - WHERE g.id IN ( {$gids} ) - AND ((j.uf_group_id IN ( {$gids} ) AND j.module = %1) OR g.is_reserved = 1 ) - "; - $params = [1 => [$restrict, 'String']]; - } - else { - $query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) "; - } - - if (!$showAll) { - $query .= " AND g.is_active = 1"; - } - - $checkPermission = [ - [ - 'administer CiviCRM', - 'manage event profiles', - ], - ]; - if ($eventProfile && CRM_Core_Permission::check($checkPermission)) { - $skipPermission = TRUE; - } - - // add permissioning for profiles only if not registration - if (!$skipPermission) { - $permissionClause = CRM_Core_Permission::ufGroupClause($permissionType, 'g.'); - $query .= " AND $permissionClause "; - } - - if ($orderProfiles and count($profileIds) > 1) { - $query .= " ORDER BY FIELD( g.id, {$gids} )"; - } - $group = CRM_Core_DAO::executeQuery($query, $params); - $fields = []; - $validGroup = FALSE; - - while ($group->fetch()) { - $validGroup = TRUE; - $query = self::createUFFieldQuery($group->id, $searchable, $showAll, $visibility, $orderBy); - $field = CRM_Core_DAO::executeQuery($query); - - $importableFields = self::getProfileFieldMetadata($showAll); - list($customFields, $addressCustomFields) = self::getCustomFields($ctype); - - while ($field->fetch()) { - list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType); - if ($formattedField !== NULL) { - $fields[$name] = $formattedField; - } - } - } - - if (empty($fields) && !$validGroup) { - throw new CRM_Core_Exception(ts('The requested Profile (gid=%1) is disabled OR it is not configured to be used for \'Profile\' listings in its Settings OR there is no Profile with that ID OR you do not have permission to access this profile. Please contact the site administrator if you need assistance.', - [1 => implode(',', $profileIds)] - )); - } - else { - self::reformatProfileFields($fields); - } - - return $fields; - } - - /** - * Format a list of UFFields for use with buildProfile. This is the in-memory analog - * of getFields(). - * - * @param array $groupArr - * (mimic CRM_UF_DAO_UFGroup). - * @param array $fieldArrs - * List of fields (each mimics CRM_UF_DAO_UFField). - * @param bool $visibility - * Visibility of fields we are interested in. - * @param bool $searchable - * @param bool $showAll - * @param null $ctype - * @param int $permissionType - * - * @return array - * @see self::getFields - */ - public static function formatUFFields( - $groupArr, - $fieldArrs, - $visibility = NULL, - $searchable = NULL, - $showAll = FALSE, - $ctype = NULL, - $permissionType = CRM_Core_Permission::CREATE - ) { - // $group = new CRM_Core_DAO_UFGroup(); - // $group->copyValues($groupArr); // no... converts string('') to string('null') - $group = (object) $groupArr; - - // Refactoring note: The $fieldArrs here may be slightly different than the $ufFields - // used by calculateGroupType, but I don't think the missing fields matter, and -- if - // they did -- the obvious fix would produce mutual recursion. - $ufGroupType = self::_calculateGroupType($fieldArrs); - $profileType = CRM_Core_BAO_UFField::calculateProfileType(implode(',', $ufGroupType)); - $contactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileTypeByGroupType(implode(',', $ufGroupType)); - $importableFields = self::getImportableFields($showAll, $profileType, $contactActivityProfile); - list($customFields, $addressCustomFields) = self::getCustomFields($ctype); - - $formattedFields = []; - foreach ($fieldArrs as $fieldArr) { - $field = (object) $fieldArr; - if (!self::filterUFField($field, $searchable, $showAll, $visibility)) { - continue; - } - - list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType); - if ($formattedField !== NULL) { - $formattedFields[$name] = $formattedField; - } - } - return $formattedFields; - } - - /** - * Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile. - * - * @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group - * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field - * @param array $customFields - * @param array $addressCustomFields - * @param array $importableFields - * @param int $permissionType - * Eg CRM_Core_Permission::CREATE. - * - * @return array - */ - protected static function formatUFField( - $group, - $field, - $customFields, - $addressCustomFields, - $importableFields, - $permissionType = CRM_Core_Permission::CREATE - ) { - $name = $field->field_name; - $title = $field->label; - - $addressCustom = FALSE; - if (in_array($permissionType, [CRM_Core_Permission::CREATE, CRM_Core_Permission::EDIT]) && - in_array($field->field_name, array_keys($addressCustomFields)) - ) { - $addressCustom = TRUE; - $name = "address_{$name}"; - } - if ($field->field_name == 'url') { - $name .= "-{$field->website_type_id}"; - } - elseif (!empty($field->location_type_id)) { - $name .= "-{$field->location_type_id}"; - } - else { - $locationFields = self::getLocationFields(); - if (in_array($field->field_name, $locationFields) || $addressCustom) { - $name .= '-Primary'; - } - } - - if (isset($field->phone_type_id)) { - $name .= "-{$field->phone_type_id}"; - } - $fieldMetaData = CRM_Utils_Array::value($name, $importableFields, (isset($importableFields[$field->field_name]) ? $importableFields[$field->field_name] : [])); - - // No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields? - // I guess to make field self sufficient with all the required data and avoid additional calls - $formattedField = [ - 'name' => $name, - 'groupTitle' => $group->title, - 'groupName' => $group->name, - 'groupDisplayTitle' => (!empty($group->frontend_title)) ? $group->frontend_title : $group->title, - 'groupHelpPre' => empty($group->help_pre) ? '' : $group->help_pre, - 'groupHelpPost' => empty($group->help_post) ? '' : $group->help_post, - 'title' => $title, - 'where' => CRM_Utils_Array::value('where', CRM_Utils_Array::value($field->field_name, $importableFields)), - 'attributes' => CRM_Core_DAO::makeAttribute(CRM_Utils_Array::value($field->field_name, $importableFields)), - 'is_required' => $field->is_required, - 'is_view' => $field->is_view, - 'help_pre' => $field->help_pre, - 'help_post' => $field->help_post, - 'visibility' => $field->visibility, - 'in_selector' => $field->in_selector, - 'rule' => CRM_Utils_Array::value('rule', CRM_Utils_Array::value($field->field_name, $importableFields)), - 'location_type_id' => isset($field->location_type_id) ? $field->location_type_id : NULL, - 'website_type_id' => isset($field->website_type_id) ? $field->website_type_id : NULL, - 'phone_type_id' => isset($field->phone_type_id) ? $field->phone_type_id : NULL, - 'group_id' => $group->id, - 'add_to_group_id' => isset($group->add_to_group_id) ? $group->add_to_group_id : NULL, - 'add_captcha' => isset($group->add_captcha) ? $group->add_captcha : NULL, - 'field_type' => $field->field_type, - 'field_id' => $field->id, - 'pseudoconstant' => CRM_Utils_Array::value( - 'pseudoconstant', - CRM_Utils_Array::value($field->field_name, $importableFields) - ), - // obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix - 'dbName' => CRM_Utils_Array::value( - 'dbName', - CRM_Utils_Array::value($field->field_name, $importableFields) - ), - 'skipDisplay' => 0, - 'data_type' => CRM_Utils_Type::getDataTypeFromFieldMetadata($fieldMetaData), - 'bao' => CRM_Utils_Array::value('bao', $fieldMetaData), - ]; - - $formattedField = CRM_Utils_Date::addDateMetadataToField($fieldMetaData, $formattedField); - - //adding custom field property - if (substr($field->field_name, 0, 6) == 'custom' || - substr($field->field_name, 0, 14) === 'address_custom' - ) { - // if field is not present in customFields, that means the user - // DOES NOT HAVE permission to access that field - if (array_key_exists($field->field_name, $customFields)) { - $formattedField['is_search_range'] = $customFields[$field->field_name]['is_search_range']; - // fix for CRM-1994 - $formattedField['options_per_line'] = $customFields[$field->field_name]['options_per_line']; - $formattedField['html_type'] = $customFields[$field->field_name]['html_type']; - - if (CRM_Utils_Array::value('html_type', $formattedField) == 'Select Date') { - $formattedField['date_format'] = $customFields[$field->field_name]['date_format']; - $formattedField['time_format'] = $customFields[$field->field_name]['time_format']; - $formattedField['is_datetime_field'] = TRUE; - $formattedField['smarty_view_format'] = CRM_Utils_Date::getDateFieldViewFormat($formattedField['date_format']); - } - - $formattedField['is_multi_summary'] = $field->is_multi_summary; - return [$name, $formattedField]; - } - else { - $formattedField = NULL; - return [$name, $formattedField]; - } - } - return [$name, $formattedField]; - } - - /** - * Create a query to find all visible UFFields in a UFGroup. - * - * This is the SQL-variant of checkUFFieldDisplayable(). - * - * @param int $groupId - * @param bool $searchable - * @param bool $showAll - * @param int $visibility - * @param string $orderBy - * Comma-delimited list of SQL columns. - * - * @return string - */ - protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) { - $where = " WHERE uf_group_id = {$groupId}"; - - if ($searchable) { - $where .= " AND is_searchable = 1"; - } - - if (!$showAll) { - $where .= " AND is_active = 1"; - } - - if ($visibility) { - $clause = []; - if ($visibility & self::PUBLIC_VISIBILITY) { - $clause[] = 'visibility = "Public Pages"'; - } - if ($visibility & self::ADMIN_VISIBILITY) { - $clause[] = 'visibility = "User and User Admin Only"'; - } - if ($visibility & self::LISTINGS_VISIBILITY) { - $clause[] = 'visibility = "Public Pages and Listings"'; - } - if (!empty($clause)) { - $where .= ' AND ( ' . implode(' OR ', $clause) . ' ) '; - } - } - - $query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight"; - if ($orderBy) { - $query .= ", " . $orderBy; - return $query; - } - return $query; - } - - /** - * Create a query to find all visible UFFields in a UFGroup. - * - * This is the PHP in-memory variant of createUFFieldQuery(). - * - * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field - * @param bool $searchable - * @param bool $showAll - * @param int $visibility - * - * @return bool - * TRUE if field is displayable - */ - protected static function filterUFField($field, $searchable, $showAll, $visibility) { - if ($searchable && $field->is_searchable != 1) { - return FALSE; - } - - if (!$showAll && $field->is_active != 1) { - return FALSE; - } - - if ($visibility) { - $allowedVisibilities = []; - if ($visibility & self::PUBLIC_VISIBILITY) { - $allowedVisibilities[] = 'Public Pages'; - } - if ($visibility & self::ADMIN_VISIBILITY) { - $allowedVisibilities[] = 'User and User Admin Only'; - } - if ($visibility & self::LISTINGS_VISIBILITY) { - $allowedVisibilities[] = 'Public Pages and Listings'; - } - // !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL - if (!empty($allowedVisibilities) && !in_array($field->visibility, $allowedVisibilities)) { - return FALSE; - } - } - - return TRUE; - } - - /** - * Get a list of filtered field metadata. - * - * @param $showAll - * @param $profileType - * @param $contactActivityProfile - * @param bool $filterMode - * Filter mode means you are using importable fields for filtering rather than just getting metadata. - * With filter mode = FALSE BOTH activity fields and component fields are returned. - * I can't see why you would ever want to use this function in filter mode as the component fields are - * still unfiltered. However, I feel scared enough to leave it as it is. I have marked this function as - * deprecated and am recommending the wrapper 'getProfileFieldMetadata' in order to try to - * send this confusion to history. - * - * @return array - * @deprecated use getProfileFieldMetadata - * - */ - protected static function getImportableFields($showAll, $profileType, $contactActivityProfile, $filterMode = TRUE) { - if (!$showAll) { - $importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE); - } - else { - $importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE); - } - - $activityFields = CRM_Activity_BAO_Activity::getProfileFields(); - $componentFields = CRM_Core_Component::getQueryFields(); - if ($filterMode == TRUE) { - if ($profileType == 'Activity' || $contactActivityProfile) { - $importableFields = array_merge($importableFields, $activityFields); - } - else { - $importableFields = array_merge($importableFields, $componentFields); - } - } - else { - $importableFields = array_merge($importableFields, $activityFields, $componentFields); - } - - $importableFields['group']['title'] = ts('Group(s)'); - $importableFields['group']['where'] = NULL; - $importableFields['tag']['title'] = ts('Tag(s)'); - $importableFields['tag']['where'] = NULL; - return $importableFields; - } - - /** - * Get the metadata for all potential profile fields. - * - * @param bool $isIncludeInactive - * Should disabled fields be included. - * - * @return array - * Field metadata for all fields that might potentially be in a profile. - */ - protected static function getProfileFieldMetadata($isIncludeInactive) { - return self::getImportableFields($isIncludeInactive, NULL, NULL, NULL, TRUE); - } - - /** - * Get the fields relating to locations. - * - * @return array - */ - public static function getLocationFields() { - static $locationFields = [ - 'street_address', - 'supplemental_address_1', - 'supplemental_address_2', - 'supplemental_address_3', - 'city', - 'postal_code', - 'postal_code_suffix', - 'geo_code_1', - 'geo_code_2', - 'state_province', - 'country', - 'county', - 'phone', - 'phone_and_ext', - 'email', - 'im', - 'address_name', - 'phone_ext', - ]; - return $locationFields; - } - - /** - * @param $ctype - * - * @return mixed - */ - protected static function getCustomFields($ctype) { - $cacheKey = 'uf_group_custom_fields_' . $ctype; - if (!Civi::cache('metadata')->has($cacheKey)) { - $customFields = CRM_Core_BAO_CustomField::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE); - - // hack to add custom data for components - $components = ['Contribution', 'Participant', 'Membership', 'Activity', 'Case', 'Grant']; - foreach ($components as $value) { - $customFields = array_merge($customFields, CRM_Core_BAO_CustomField::getFieldsForImport($value)); - } - $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address'); - $customFields = array_merge($customFields, $addressCustomFields); - Civi::cache('metadata')->set($cacheKey, [$customFields, $addressCustomFields]); - } - return Civi::cache('metadata')->get($cacheKey); - } - - /** - * Check the data validity. - * - * @param int $userID - * The user id that we are actually editing. - * @param string $name - * The machine-name of the group we are interested in. - * @param bool $register - * @param int $action - * The action of the form. - * - * @pram boolean $register is this the registrtion form - * @return bool - * true if form is valid - */ - public static function isValid($userID, $name, $register = FALSE, $action = NULL) { - if ($register) { - $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', - ts('Dynamic Form Creator'), - $action - ); - $controller->set('id', $userID); - $controller->set('register', 1); - $controller->process(); - return $controller->validate(); - } - else { - // make sure we have a valid group - $group = new CRM_Core_DAO_UFGroup(); - - $group->name = $name; - - if ($group->find(TRUE) && $userID) { - $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action); - $controller->set('gid', $group->id); - $controller->set('id', $userID); - $controller->set('register', 0); - $controller->process(); - return $controller->validate(); - } - return TRUE; - } - } - - /** - * Get the html for the form that represents this particular group. - * - * @param int $userID - * The user id that we are actually editing. - * @param string $title - * The title of the group we are interested in. - * @param int $action - * The action of the form. - * @param bool $register - * Is this the registration form. - * @param bool $reset - * Should we reset the form?. - * @param int $profileID - * Do we have the profile ID?. - * - * @param bool $doNotProcess - * @param null $ctype - * - * @return string - * the html for the form on success, otherwise empty string - */ - public static function getEditHTML( - $userID, - $title, - $action = NULL, - $register = FALSE, - $reset = FALSE, - $profileID = NULL, - $doNotProcess = FALSE, - $ctype = NULL - ) { - - if ($register) { - $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', - ts('Dynamic Form Creator'), - $action - ); - if ($reset || $doNotProcess) { - // hack to make sure we do not process this form - $oldQFDefault = CRM_Utils_Array::value('_qf_default', - $_POST - ); - unset($_POST['_qf_default']); - unset($_REQUEST['_qf_default']); - if ($reset) { - $controller->reset(); - } - } - - $controller->set('id', $userID); - $controller->set('register', 1); - $controller->set('skipPermission', 1); - $controller->set('ctype', $ctype); - $controller->process(); - if ($doNotProcess || !empty($_POST)) { - $controller->validate(); - } - $controller->setEmbedded(TRUE); - - //CRM-5839 - though we want to process form, get the control back. - $controller->setSkipRedirection(($doNotProcess) ? FALSE : TRUE); - - $controller->run(); - - // we are done processing so restore the POST/REQUEST vars - if (($reset || $doNotProcess) && $oldQFDefault) { - $_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault; - } - - $template = CRM_Core_Smarty::singleton(); - - // Hide CRM error messages if they are displayed using drupal form_set_error. - if (!empty($_POST)) { - $template->assign('suppressForm', TRUE); - } - - return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl')); - } - else { - if (!$profileID) { - // make sure we have a valid group - $group = new CRM_Core_DAO_UFGroup(); - - $group->title = $title; - - if ($group->find(TRUE)) { - $profileID = $group->id; - } - } - - if ($profileID) { - // make sure profileID and ctype match if ctype exists - if ($ctype) { - $profileType = CRM_Core_BAO_UFField::getProfileType($profileID); - if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) { - $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType); - } - - if (($profileType != 'Contact') && ($profileType != $ctype)) { - return NULL; - } - } - - $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', - ts('Dynamic Form Creator'), - $action - ); - if ($reset) { - $controller->reset(); - } - $controller->set('gid', $profileID); - $controller->set('id', $userID); - $controller->set('register', 0); - $controller->set('skipPermission', 1); - if ($ctype) { - $controller->set('ctype', $ctype); - } - $controller->process(); - $controller->setEmbedded(TRUE); - - //CRM-5846 - give the control back to drupal. - $controller->setSkipRedirection(($doNotProcess) ? FALSE : TRUE); - $controller->run(); - - $template = CRM_Core_Smarty::singleton(); - - // Hide CRM error messages if they are displayed using drupal form_set_error. - if (!empty($_POST) && CRM_Core_Config::singleton()->userFramework == 'Drupal') { - if (arg(0) == 'user' || (arg(0) == 'admin' && arg(1) == 'people')) { - $template->assign('suppressForm', TRUE); - } - } - - $templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl"; - if (!$template->template_exists($templateFile)) { - $templateFile = 'CRM/Profile/Form/Dynamic.tpl'; - } - return trim($template->fetch($templateFile)); - } - else { - $userEmail = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID); - - // if post not empty then only proceed - if (!empty($_POST)) { - // get the new email - $config = CRM_Core_Config::singleton(); - $email = CRM_Utils_Array::value('mail', $_POST); - - if (CRM_Utils_Rule::email($email) && ($email != $userEmail[1])) { - CRM_Core_BAO_UFMatch::updateContactEmail($userID, $email); - } - } - } - } - return ''; - } - - /** - * Given a contact id and a field set, return the values from the db. - * - * @param int $cid - * @param array $fields - * The profile fields of interest. - * @param array $values - * The values for the above fields. - * @param bool $searchable - * Searchable or not. - * @param array $componentWhere - * Component condition. - * @param bool $absolute - * Return urls in absolute form (useful when sending an email). - * @param null $additionalWhereClause - * - * @return null|array - */ - public static function getValues( - $cid, &$fields, &$values, - $searchable = TRUE, $componentWhere = NULL, - $absolute = FALSE, $additionalWhereClause = NULL - ) { - if (empty($cid) && empty($componentWhere)) { - return NULL; - } - - // get the contact details (hier) - $returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($fields); - $params = $cid ? [['contact_id', '=', $cid, 0, 0]] : []; - - // add conditions specified by components. eg partcipant_id etc - if (!empty($componentWhere)) { - $params = array_merge($params, $componentWhere); - } - - $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields); - - $details = $query->searchQuery(0, 0, NULL, FALSE, FALSE, - FALSE, FALSE, FALSE, $additionalWhereClause); - while ($details->fetch()) { - if (!$details) { - return; - } - } - $query->convertToPseudoNames($details); - - $locationTypes = CRM_Core_BAO_Address::buildOptions('location_type_id', 'validate'); - $imProviders = CRM_Core_DAO_IM::buildOptions('provider_id'); - $websiteTypes = CRM_Core_DAO_Website::buildOptions('website_type_id'); - - $multipleFields = ['url']; - - //start of code to set the default values - foreach ($fields as $name => $field) { - // fix for CRM-3962 - if ($name == 'id') { - $name = 'contact_id'; - } - - // skip fields that should not be displayed separately - if (!empty($field['skipDisplay'])) { - continue; - } - - // Create a unique, non-empty index for each field. - $index = $field['title']; - if ($index === '') { - $index = ' '; - } - while (array_key_exists($index, $values)) { - $index .= ' '; - } - - $params[$index] = $values[$index] = ''; - $customFieldName = NULL; - // hack for CRM-665 - if (isset($details->$name) || $name == 'group' || $name == 'tag') { - // to handle gender / suffix / prefix - if (in_array(substr($name, 0, -3), ['gender', 'prefix', 'suffix'])) { - $params[$index] = $details->$name; - $values[$index] = $details->$name; - } - elseif (in_array($name, CRM_Contact_BAO_Contact::$_greetingTypes)) { - $dname = $name . '_display'; - $values[$index] = $details->$dname; - $name = $name . '_id'; - $params[$index] = $details->$name; - } - elseif (in_array($name, [ - 'state_province', - 'country', - 'county', - ])) { - $values[$index] = $details->$name; - $idx = $name . '_id'; - $params[$index] = $details->$idx; - } - elseif ($name === 'preferred_language') { - $params[$index] = $details->$name; - $values[$index] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name); - } - elseif ($name == 'group') { - $groups = CRM_Contact_BAO_GroupContact::getContactGroup($cid, 'Added', NULL, FALSE, TRUE); - $title = $ids = []; - - foreach ($groups as $g) { - // CRM-8362: User and User Admin visibility groups should be included in display if user has - // VIEW permission on that group - $groupPerm = CRM_Contact_BAO_Group::checkPermission($g['group_id'], TRUE); - - if ($g['visibility'] != 'User and User Admin Only' || - CRM_Utils_Array::key(CRM_Core_Permission::VIEW, $groupPerm) - ) { - $title[] = $g['title']; - if ($g['visibility'] == 'Public Pages') { - $ids[] = $g['group_id']; - } - } - } - $values[$index] = implode(', ', $title); - $params[$index] = implode(',', $ids); - } - elseif ($name == 'tag') { - $entityTags = CRM_Core_BAO_EntityTag::getTag($cid); - $allTags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', ['onlyActive' => FALSE]); - $title = []; - foreach ($entityTags as $tagId) { - $title[] = $allTags[$tagId]; - } - $values[$index] = implode(', ', $title); - $params[$index] = implode(',', $entityTags); - } - elseif ($name == 'activity_status_id') { - $activityStatus = CRM_Core_PseudoConstant::activityStatus(); - $values[$index] = $activityStatus[$details->$name]; - $params[$index] = $details->$name; - } - elseif ($name == 'activity_date_time') { - $values[$index] = CRM_Utils_Date::customFormat($details->$name); - $params[$index] = $details->$name; - } - elseif ($name == 'contact_sub_type') { - $contactSubTypeNames = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details->$name); - if (!empty($contactSubTypeNames)) { - $contactSubTypeLabels = []; - // get all contact subtypes - $allContactSubTypes = CRM_Contact_BAO_ContactType::subTypeInfo(); - // build contact subtype labels array - foreach ($contactSubTypeNames as $cstName) { - if ($cstName) { - $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label']; - } - } - $values[$index] = implode(',', $contactSubTypeLabels); - } - - $params[$index] = $details->$name; - } - else { - if (substr($name, 0, 7) === 'do_not_' || substr($name, 0, 3) === 'is_') { - if ($details->$name) { - $values[$index] = '[ x ]'; - } - } - else { - if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name)) { - $htmlType = $field['html_type']; - - // field_type is only set when we are retrieving profile values - // when sending email, we call the same function to get custom field - // values etc, i.e. emulating a profile - $fieldType = CRM_Utils_Array::value('field_type', $field); - - if ($htmlType == 'File') { - $entityId = $cid; - if (!$cid && - $fieldType == 'Activity' && !empty($componentWhere[0][2]) - ) { - $entityId = $componentWhere[0][2]; - } - - $fileURL = CRM_Core_BAO_CustomField::getFileURL($entityId, - $cfID, - NULL, - $absolute, - $additionalWhereClause - ); - $params[$index] = $values[$index] = $fileURL['file_url']; - } - else { - $customVal = NULL; - if (isset($dao) && property_exists($dao, 'data_type') && - ($dao->data_type == 'Int' || - $dao->data_type == 'Boolean' - ) - ) { - $customVal = (int ) ($details->{$name}); - } - elseif (isset($dao) && property_exists($dao, 'data_type') - && $dao->data_type == 'Float' - ) { - $customVal = (float ) ($details->{$name}); - } - elseif (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR, - $details->{$name} - )) - ) { - $customVal = $details->{$name}; - } - - //CRM-4582 - if (CRM_Utils_System::isNull($customVal)) { - continue; - } - - $params[$index] = $customVal; - $values[$index] = CRM_Core_BAO_CustomField::displayValue($customVal, $cfID); - if ($field['data_type'] == 'ContactReference') { - $params[$index] = $values[$index]; - } - if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', - $cfID, 'is_search_range' - ) - ) { - $customFieldName = "{$name}_from"; - } - } - } - elseif ($name == 'image_URL') { - list($width, $height) = getimagesize(CRM_Utils_String::unstupifyUrl($details->$name)); - list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($width, $height); - - $image_URL = ''; - $values[$index] = "{$image_URL}"; - } - elseif (in_array($name, [ - 'birth_date', - 'deceased_date', - ])) { - // @todo this set should be determined from metadata, not hard-coded. - $values[$index] = CRM_Utils_Date::customFormat($details->$name); - $params[$index] = CRM_Utils_Date::isoToMysql($details->$name); - } - else { - $dao = ''; - if ($index == 'Campaign') { - $dao = 'CRM_Campaign_DAO_Campaign'; - } - elseif ($index == 'Contribution Page') { - $dao = 'CRM_Contribute_DAO_ContributionPage'; - } - if ($dao) { - $value = CRM_Core_DAO::getFieldValue($dao, $details->$name, 'title'); - } - else { - $value = $details->$name; - } - $values[$index] = $value; - } - } - } - } - elseif (strpos($name, '-') !== FALSE) { - list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3); - - if (!in_array($fieldName, $multipleFields)) { - if ($id == 'Primary') { - // fix for CRM-1543 - // not sure why we'd every use Primary location type id - // we need to fix the source if we are using it - // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid ); - $locationTypeName = 1; - } - else { - $locationTypeName = CRM_Utils_Array::value($id, $locationTypes); - } - - if (!$locationTypeName) { - continue; - } - - $detailName = "{$locationTypeName}-{$fieldName}"; - $detailName = str_replace(' ', '_', $detailName); - - if (in_array($fieldName, [ - 'phone', - 'im', - 'email', - 'openid', - ])) { - if ($type) { - $detailName .= "-{$type}"; - } - } - - if (in_array($fieldName, [ - 'state_province', - 'country', - 'county', - ])) { - $values[$index] = $details->$detailName; - $idx = $detailName . '_id'; - $params[$index] = $details->$idx; - } - elseif ($fieldName == 'im') { - $providerId = $detailName . '-provider_id'; - if (isset($imProviders[$details->$providerId])) { - $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")"; - } - else { - $values[$index] = $details->$detailName; - } - $params[$index] = $details->$detailName; - } - elseif ($fieldName == 'phone') { - $phoneExtField = str_replace('phone', 'phone_ext', $detailName); - if (isset($details->$phoneExtField)) { - $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")"; - } - else { - $values[$index] = $details->$detailName; - } - $params[$index] = $details->$detailName; - } - else { - $values[$index] = $params[$index] = $details->$detailName; - } - } - else { - $detailName = "website-{$id}-{$fieldName}"; - $url = CRM_Utils_System::fixURL($details->$detailName); - if ($details->$detailName) { - $websiteTypeId = "website-{$id}-website_type_id"; - $websiteType = $websiteTypes[$details->$websiteTypeId]; - $values[$index] = "{$details->$detailName} ( {$websiteType} )"; - } - else { - $values[$index] = ''; - } - } - } - - if ((CRM_Utils_Array::value('visibility', $field) == 'Public Pages and Listings') && - CRM_Core_Permission::check('profile listings and forms') - ) { - - if (CRM_Utils_System::isNull($params[$index])) { - $params[$index] = $values[$index]; - } - if (!isset($params[$index])) { - continue; - } - if (!$customFieldName) { - $fieldName = $field['name']; - } - else { - $fieldName = $customFieldName; - } - - $url = NULL; - if (CRM_Core_BAO_CustomField::getKeyID($field['name'])) { - $htmlType = $field['html_type']; - if ($htmlType == 'Link') { - $url = $params[$index]; - } - elseif (in_array($htmlType, [ - 'CheckBox', - 'Multi-Select', - 'AdvMulti-Select', - 'Multi-Select State/Province', - 'Multi-Select Country', - ])) { - $valSeperator = CRM_Core_DAO::VALUE_SEPARATOR; - $selectedOptions = explode($valSeperator, $params[$index]); - - foreach ($selectedOptions as $key => $multiOption) { - if ($multiOption) { - $url[] = CRM_Utils_System::url('civicrm/profile', - 'reset=1&force=1&gid=' . $field['group_id'] . '&' . - urlencode($fieldName) . - '=' . - urlencode($multiOption) - ); - } - } - } - else { - $url = CRM_Utils_System::url('civicrm/profile', - 'reset=1&force=1&gid=' . $field['group_id'] . '&' . - urlencode($fieldName) . - '=' . - urlencode($params[$index]) - ); - } - } - else { - $url = CRM_Utils_System::url('civicrm/profile', - 'reset=1&force=1&gid=' . $field['group_id'] . '&' . - urlencode($fieldName) . - '=' . - urlencode($params[$index]) - ); - } - - if ($url && - !empty($values[$index]) && - $searchable - ) { - - if (is_array($url) && !empty($url)) { - $links = []; - $eachMultiValue = explode(', ', $values[$index]); - foreach ($eachMultiValue as $key => $valueLabel) { - $links[] = '' . $valueLabel . ''; - } - $values[$index] = implode(', ', $links); - } - else { - $values[$index] = '' . $values[$index] . ''; - } - } - } - } - } - - /** - * Check if profile Group used by any module. - * - * @param int $id - * Profile Id. - * - * @return bool - * - */ - public static function usedByModule($id) { - //check whether this group is used by any module(check uf join records) - $sql = "SELECT id - FROM civicrm_uf_join - WHERE civicrm_uf_join.uf_group_id=$id"; - - $dao = new CRM_Core_DAO(); - $dao->query($sql); - if ($dao->fetch()) { - return TRUE; - } - else { - return FALSE; - } - } - - /** - * Delete the profile Group. - * - * @param int $id - * Profile Id. - * - * @return bool - * - */ - public static function del($id) { - //check whether this group contains any profile fields - $profileField = new CRM_Core_DAO_UFField(); - $profileField->uf_group_id = $id; - $profileField->find(); - while ($profileField->fetch()) { - CRM_Core_BAO_UFField::del($profileField->id); - } - - //delete records from uf join table - $ufJoin = new CRM_Core_DAO_UFJoin(); - $ufJoin->uf_group_id = $id; - $ufJoin->delete(); - - //delete profile group - $group = new CRM_Core_DAO_UFGroup(); - $group->id = $id; - $group->delete(); - return 1; - } - - /** - * Add the UF Group. - * - * @param array $params - * Reference array contains the values submitted by the form. - * @param array $ids - * Reference array contains the id. - * - * - * @return object - */ - public static function add(&$params, $ids = []) { - $fields = [ - 'is_active', - 'add_captcha', - 'is_map', - 'is_update_dupe', - 'is_edit_link', - 'is_uf_link', - 'is_cms_user', - ]; - foreach ($fields as $field) { - $params[$field] = CRM_Utils_Array::value($field, $params, FALSE); - } - - $params['limit_listings_group_id'] = CRM_Utils_Array::value('group', $params); - $params['add_to_group_id'] = CRM_Utils_Array::value('add_contact_to_group', $params); - - //CRM-15427 - if (!empty($params['group_type']) && is_array($params['group_type'])) { - $params['group_type'] = implode(',', $params['group_type']); - } - $ufGroup = new CRM_Core_DAO_UFGroup(); - $ufGroup->copyValues($params); - - $ufGroupID = CRM_Utils_Array::value('ufgroup', $ids, CRM_Utils_Array::value('id', $params)); - if (!$ufGroupID && empty($params['name'])) { - $ufGroup->name = CRM_Utils_String::munge($ufGroup->title, '_', 56); - } - $ufGroup->id = $ufGroupID; - - $ufGroup->save(); - - if (!$ufGroupID && empty($params['name'])) { - $ufGroup->name = $ufGroup->name . "_{$ufGroup->id}"; - $ufGroup->save(); - } - - return $ufGroup; - } - - /** - * Make uf join entries for an uf group. - * - * @param array $params - * (reference) an assoc array of name/value pairs. - * @param int $ufGroupId - * Ufgroup id. - */ - public static function createUFJoin(&$params, $ufGroupId) { - $groupTypes = CRM_Utils_Array::value('uf_group_type', $params); - - // get ufjoin records for uf group - $ufGroupRecord = CRM_Core_BAO_UFGroup::getUFJoinRecord($ufGroupId); - - // get the list of all ufgroup types - $allUFGroupType = CRM_Core_SelectValues::ufGroupTypes(); - - // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input - if (!is_array($groupTypes)) { - $groupTypes = []; - } - - // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input - if (!is_array($ufGroupRecord)) { - $ufGroupRecord = []; - } - - // check which values has to be inserted/deleted for contact - $menuRebuild = FALSE; - foreach ($allUFGroupType as $key => $value) { - $joinParams = []; - $joinParams['uf_group_id'] = $ufGroupId; - $joinParams['module'] = $key; - if ($key == 'User Account') { - $menuRebuild = TRUE; - } - if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) { - // insert a new record - CRM_Core_BAO_UFGroup::addUFJoin($joinParams); - } - elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) { - // delete a record for existing ufgroup - CRM_Core_BAO_UFGroup::delUFJoin($joinParams); - } - } - - //update the weight - $query = " -UPDATE civicrm_uf_join -SET weight = %1 -WHERE uf_group_id = %2 -AND ( entity_id IS NULL OR entity_id <= 0 ) -"; - $p = [ - 1 => [$params['weight'], 'Integer'], - 2 => [$ufGroupId, 'Integer'], - ]; - CRM_Core_DAO::executeQuery($query, $p); - - // Do a menu rebuild, so it gets all the new menu entries for user account - if ($menuRebuild) { - $config = CRM_Core_Config::singleton(); - $config->userSystem->updateCategories(); - } - } - - /** - * Get the UF Join records for an ufgroup id. - * - * @param int $ufGroupId - * Uf group id. - * @param int $displayName - * If set return display name in array. - * @param int $status - * If set return module other than default modules (User Account/User registration/Profile). - * - * @return array - * - */ - public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) { - if ($displayName) { - $UFGroupType = []; - $UFGroupType = CRM_Core_SelectValues::ufGroupTypes(); - } - - $ufJoin = []; - $dao = new CRM_Core_DAO_UFJoin(); - - if ($ufGroupId) { - $dao->uf_group_id = $ufGroupId; - } - - $dao->find(); - $ufJoin = []; - - while ($dao->fetch()) { - if (!$displayName) { - $ufJoin[$dao->id] = $dao->module; - } - else { - if (isset($UFGroupType[$dao->module])) { - // skip the default modules - if (!$status) { - $ufJoin[$dao->id] = $UFGroupType[$dao->module]; - } - // added for CRM-1475 - } - elseif (!CRM_Utils_Array::key($dao->module, $ufJoin)) { - $ufJoin[$dao->id] = $dao->module; - } - } - } - return $ufJoin; - } - - /** - * Function takes an associative array and creates a ufjoin record for ufgroup. - * - * @param array $params - * (reference) an assoc array of name/value pairs. - * - * @return CRM_Core_BAO_UFJoin - */ - public static function addUFJoin(&$params) { - $ufJoin = new CRM_Core_DAO_UFJoin(); - $ufJoin->copyValues($params); - $ufJoin->save(); - return $ufJoin; - } - - /** - * Delete the uf join record for an uf group. - * - * @param array $params - * (reference) an assoc array of name/value pairs. - */ - public static function delUFJoin(&$params) { - $ufJoin = new CRM_Core_DAO_UFJoin(); - $ufJoin->copyValues($params); - $ufJoin->delete(); - } - - /** - * Get the weight for ufjoin record. - * - * @param int $ufGroupId - * If $ufGroupId get update weight or add weight. - * - * @return int - * weight of the UFGroup - */ - public static function getWeight($ufGroupId = NULL) { - //calculate the weight - $p = []; - if (!$ufGroupId) { - $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight - FROM civicrm_uf_join - WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'"; - } - else { - $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight - FROM civicrm_uf_join - WHERE civicrm_uf_join.uf_group_id = %1 - AND ( entity_id IS NULL OR entity_id <= 0 )"; - $p[1] = [$ufGroupId, 'Integer']; - } - - $dao = CRM_Core_DAO::executeQuery($queryString, $p); - $dao->fetch(); - return ($dao->new_weight) ? $dao->new_weight : 1; - } - - /** - * Get the uf group for a module. - * - * @param string $moduleName - * Module name. - * @param int $count - * No to increment the weight. - * @param bool $skipPermission - * @param int $op - * Which operation (view, edit, create, etc) to check permission for. - * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default - * - * @return array - * array of ufgroups for a module - */ - public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission::VIEW, $returnFields = NULL) { - $selectFields = ['id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type']; - - if (CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_uf_group', 'description')) { - // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade - $selectFields[] = 'description'; - } - - if (CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_uf_group', 'frontend_title')) { - $selectFields[] = 'frontend_title'; - } - - if (!empty($returnFields)) { - $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields)); - } - - $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . ' - FROM civicrm_uf_group - LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)'; - $p = []; - if ($moduleName) { - $queryString .= ' AND civicrm_uf_group.is_active = 1 - WHERE civicrm_uf_join.module = %2'; - $p[2] = [$moduleName, 'String']; - } - - // add permissioning for profiles only if not registration - if (!$skipPermission) { - $permissionClause = CRM_Core_Permission::ufGroupClause($op, 'civicrm_uf_group.'); - if (strpos($queryString, 'WHERE') !== FALSE) { - $queryString .= " AND $permissionClause "; - } - else { - $queryString .= " $permissionClause "; - } - } - - $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title'; - $dao = CRM_Core_DAO::executeQuery($queryString, $p); - - $ufGroups = []; - while ($dao->fetch()) { - //skip mix profiles in user Registration / User Account - if (($moduleName === 'User Registration' || $moduleName === 'User Account') && - CRM_Core_BAO_UFField::checkProfileType($dao->id) - ) { - continue; - } - foreach ($selectFields as $key => $field) { - if ($field === 'id') { - continue; - } - $ufGroups[$dao->id][$field] = $dao->$field; - } - } - - // Allow other modules to alter/override the UFGroups. - CRM_Utils_Hook::buildUFGroupsForModule($moduleName, $ufGroups); - - return $ufGroups; - } - - /** - * Filter ufgroups based on logged in user contact type. - * - * @param int $ufGroupId - * Uf group id (profile id). - * @param int $contactID - * - * @return bool - * true or false - */ - public static function filterUFGroups($ufGroupId, $contactID = NULL) { - if (!$contactID) { - $session = CRM_Core_Session::singleton(); - $contactID = $session->get('userID'); - } - - if ($contactID) { - //get the contact type - $contactType = CRM_Contact_BAO_Contact::getContactType($contactID); - - //match if exixting contact type is same as profile contact type - $profileType = CRM_Core_BAO_UFField::getProfileType($ufGroupId); - - if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) { - $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType); - - //in some cases getBasicType() returns a cached array instead of string. Example: array ('sponsor' => 'organization') - if (is_array($profileType)) { - $profileType = array_shift($profileType); - } - } - - //allow special mix profiles for Contribution and Participant - $specialProfiles = ['Contribution', 'Participant', 'Membership', 'Grant']; - - if (in_array($profileType, $specialProfiles)) { - return TRUE; - } - - if (($contactType == $profileType) || $profileType == 'Contact') { - return TRUE; - } - } - - return FALSE; - } - - /** - * Add profile field to a form. - * - * @param CRM_Core_Form $form - * @param array $field - * Properties. - * @param int $mode - * Profile mode. - * @param int $contactId - * @param bool $online - * @param string $usedFor - * For building up prefixed fieldname for special cases (e.g. onBehalf, Honor). - * @param int $rowNumber - * @param string $prefix - * - * @return null - */ - public static function buildProfile( - &$form, - &$field, - $mode, - $contactId = NULL, - $online = FALSE, - $usedFor = NULL, - $rowNumber = NULL, - $prefix = '' - ) { - $defaultValues = []; - $fieldName = $field['name']; - $title = $field['title']; - $attributes = $field['attributes']; - $rule = $field['rule']; - $view = $field['is_view']; - $required = ($mode == CRM_Profile_Form::MODE_SEARCH) ? FALSE : $field['is_required']; - $search = ($mode == CRM_Profile_Form::MODE_SEARCH) ? TRUE : FALSE; - $isShared = CRM_Utils_Array::value('is_shared', $field, 0); - - // do not display view fields in drupal registration form - // CRM-4632 - if ($view && $mode == CRM_Profile_Form::MODE_REGISTER) { - return NULL; - } - - if ($usedFor == 'onbehalf') { - $name = "onbehalf[$fieldName]"; - } - elseif ($usedFor == 'honor') { - $name = "honor[$fieldName]"; - } - elseif ($contactId && !$online) { - $name = "field[$contactId][$fieldName]"; - } - elseif ($rowNumber) { - $name = "field[$rowNumber][$fieldName]"; - } - elseif (!empty($prefix)) { - $name = $prefix . "[$fieldName]"; - } - else { - $name = $fieldName; - } - - $selectAttributes = ['class' => 'crm-select2', 'placeholder' => TRUE]; - - if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form::MODE_EDIT) { - $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.')); - $deleteURL = [ - CRM_Core_Action::DELETE => [ - 'name' => ts('Delete Contact Image'), - 'url' => 'civicrm/contact/image', - 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete', - 'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"', - ], - ]; - $deleteURL = CRM_Core_Action::formLink($deleteURL, - CRM_Core_Action::DELETE, - [ - 'id' => $form->get('id'), - 'gid' => $form->get('gid'), - ], - ts('more'), - FALSE, - 'contact.profileimage.delete', - 'Contact', - $form->get('id') - ); - $form->assign('deleteURL', $deleteURL); - } - $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, - 'address_options', TRUE, NULL, TRUE - ); - - if (substr($fieldName, 0, 14) === 'state_province') { - $form->addChainSelect($name, ['label' => $title, 'required' => $required]); - $config = CRM_Core_Config::singleton(); - if (!in_array($mode, [CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH]) && - $config->defaultContactStateProvince - ) { - $defaultValues[$name] = $config->defaultContactStateProvince; - $form->setDefaults($defaultValues); - } - } - elseif (substr($fieldName, 0, 7) === 'country') { - $form->add('select', $name, $title, ['' => ts('- select -')] + CRM_Core_PseudoConstant::country(), $required, $selectAttributes); - $config = CRM_Core_Config::singleton(); - if (!in_array($mode, [CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH]) && - $config->defaultContactCountry - ) { - $defaultValues[$name] = $config->defaultContactCountry; - $form->setDefaults($defaultValues); - } - } - elseif (substr($fieldName, 0, 6) === 'county') { - if ($addressOptions['county']) { - $form->addChainSelect($name, ['label' => $title, 'required' => $required]); - } - } - elseif (substr($fieldName, 0, 9) === 'image_URL') { - $form->add('file', $name, $title, $attributes, $required); - $form->addUploadElement($name); - } - elseif (substr($fieldName, 0, 2) === 'im') { - $form->add('text', $name, $title, $attributes, $required); - if (!$contactId) { - if ($usedFor) { - if (substr($name, -1) === ']') { - $providerName = substr($name, 0, -1) . '-provider_id]'; - } - $form->add('select', $providerName, NULL, - [ - '' => ts('- select -'), - ] + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required - ); - } - else { - $form->add('select', $name . '-provider_id', $title, - [ - '' => ts('- select -'), - ] + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required - ); - } - - if ($view && $mode != CRM_Profile_Form::MODE_SEARCH) { - $form->freeze($name . '-provider_id'); - } - } - } - elseif (CRM_Utils_Array::value('name', $field) == 'membership_type') { - list($orgInfo, $types) = CRM_Member_BAO_MembershipType::getMembershipTypeInfo(); - $sel = &$form->addElement('hierselect', $name, $title); - $select = ['' => ts('- select -')]; - if (count($orgInfo) == 1 && $field['is_required']) { - // we only have one org - so we should default to it. Not sure about defaulting to first type - // as it could be missed - so adding a select - // however, possibly that is more similar to the membership form - if (count($types[1]) > 1) { - $types[1] = $select + $types[1]; - } - } - else { - $orgInfo = $select + $orgInfo; - } - $sel->setOptions([$orgInfo, $types]); - } - elseif (CRM_Utils_Array::value('name', $field) == 'membership_status') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'), $required - ); - } - elseif (in_array($fieldName, ['gender_id', 'communication_style_id'])) { - $options = []; - $pseudoValues = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $fieldName); - foreach ($pseudoValues as $key => $var) { - $options[$key] = $form->createElement('radio', NULL, ts($title), $var, $key); - } - $group = $form->addGroup($options, $name, $title); - if ($required) { - $form->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required'); - } - else { - $group->setAttribute('allowClear', TRUE); - } - } - elseif ($fieldName === 'prefix_id' || $fieldName === 'suffix_id') { - $form->addSelect($name, [ - 'label' => $title, - 'entity' => 'contact', - 'field' => $fieldName, - 'class' => 'six', - 'placeholder' => '', - ], $required); - } - elseif ($fieldName === 'contact_sub_type') { - $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field); - if ($usedFor == 'onbehalf') { - $profileType = 'Organization'; - } - elseif ($usedFor == 'honor') { - $profileType = CRM_Core_BAO_UFField::getProfileType($form->_params['honoree_profile_id']); - } - else { - $profileType = $gId ? CRM_Core_BAO_UFField::getProfileType($gId) : NULL; - if ($profileType == 'Contact') { - $profileType = 'Individual'; - } - } - - $setSubtype = FALSE; - if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) { - $setSubtype = $profileType; - $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType); - } - - $subtypes = $profileType ? CRM_Contact_BAO_ContactType::subTypePairs($profileType) : []; - - if ($setSubtype) { - $subtypeList = []; - $subtypeList[$setSubtype] = $subtypes[$setSubtype]; - } - else { - $subtypeList = $subtypes; - } - - $form->add('select', $name, $title, $subtypeList, $required, ['class' => 'crm-select2', 'multiple' => TRUE]); - } - elseif (in_array($fieldName, CRM_Contact_BAO_Contact::$_greetingTypes)) { - // Get contact type for greeting selector - $gId = $form->get('gid') ?: CRM_Utils_Array::value('group_id', $field); - $profileType = CRM_Core_BAO_UFField::getProfileType($gId, TRUE, FALSE, TRUE); - - if (!$profileType || in_array($profileType, ['Contact', 'Contribution', 'Participant', 'Membership', 'Grant'])) { - $profileType = ($profileType == 'Contact' && $form->get('id')) ? CRM_Contact_BAO_Contact::getContactType($form->get('id')) : 'Individual'; - } - if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) { - $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType); - } - $greeting = [ - 'contact_type' => $profileType, - 'greeting_type' => $fieldName, - ]; - $form->add('select', $name, $title, ['' => ts('- select -')] + CRM_Core_PseudoConstant::greeting($greeting), $required); - // add custom greeting element - $form->add('text', $fieldName . '_custom', ts('Custom %1', [1 => ucwords(str_replace('_', ' ', $fieldName))]), - NULL, FALSE - ); - } - elseif ($fieldName === 'preferred_communication_method') { - $communicationFields = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method'); - foreach ($communicationFields as $key => $var) { - if ($key == '') { - continue; - } - $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var); - } - $form->addGroup($communicationOptions, $name, $title, '
'); - } - elseif ($fieldName === 'preferred_mail_format') { - $form->add('select', $name, $title, CRM_Core_SelectValues::pmf()); - } - elseif ($fieldName === 'preferred_language') { - $form->add('select', $name, $title, ['' => ts('- select -')] + CRM_Contact_BAO_Contact::buildOptions('preferred_language')); - } - elseif ($fieldName == 'external_identifier') { - $form->add('text', $name, $title, $attributes, $required); - $contID = $contactId; - if (!$contID) { - $contID = $form->get('id'); - } - $form->addRule($name, - ts('External ID already exists in Database.'), - 'objectExists', - ['CRM_Contact_DAO_Contact', $contID, 'external_identifier'] - ); - } - elseif ($fieldName === 'group') { - CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId, - CRM_Contact_Form_Edit_TagsAndGroups::GROUP, - TRUE, $required, - $title, NULL, $name - ); - } - elseif ($fieldName === 'tag') { - CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId, - CRM_Contact_Form_Edit_TagsAndGroups::TAG, - FALSE, $required, - NULL, $title, $name - ); - } - elseif (substr($fieldName, 0, 4) === 'url-') { - $form->add('text', $name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Website', 'url'), $required); - $form->addRule($name, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'url'); - } - // Note should be rendered as textarea - elseif (substr($fieldName, -4) == 'note') { - $form->add('textarea', $name, $title, $attributes, $required); - } - elseif (substr($fieldName, 0, 6) === 'custom') { - $customFieldID = CRM_Core_BAO_CustomField::getKeyID($fieldName); - if ($customFieldID) { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, $required, $search, $title); - } - } - elseif (substr($fieldName, 0, 14) === 'address_custom') { - list($fName, $locTypeId) = CRM_Utils_System::explode('-', $fieldName, 2); - $customFieldID = CRM_Core_BAO_CustomField::getKeyID(substr($fName, 8)); - if ($customFieldID) { - CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, $required, $search, $title); - } - } - elseif ($fieldName == 'send_receipt') { - $form->addElement('checkbox', $name, $title); - } - elseif ($fieldName == 'soft_credit') { - $form->addEntityRef("soft_credit_contact_id[$rowNumber]", ts('Soft Credit To'), ['create' => TRUE]); - $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE); - } - elseif ($fieldName === 'product_name') { - list($products, $options) = CRM_Contribute_BAO_Premium::getPremiumProductInfo(); - $sel = &$form->addElement('hierselect', $name, $title); - $products = ['0' => ts('- select -')] + $products; - $sel->setOptions([$products, $options]); - } - elseif ($fieldName === 'payment_instrument') { - $form->add('select', $name, $title, - ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(), $required); - } - elseif ($fieldName === 'financial_type') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Contribute_PseudoConstant::financialType(), $required - ); - } - elseif ($fieldName === 'contribution_status_id') { - $contributionStatuses = CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses(); - - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + $contributionStatuses, $required - ); - } - elseif ($fieldName === 'soft_credit_type') { - $name = "soft_credit_type[$rowNumber]"; - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Core_OptionGroup::values("soft_credit_type") - ); - //CRM-15350: choose SCT field default value as 'Gift' for membership use - //else (for contribution), use configured SCT default value - $SCTDefaultValue = CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"); - if ($field['field_type'] == 'Membership') { - $SCTDefaultValue = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'gift'); - } - $form->addElement('hidden', 'sct_default_id', $SCTDefaultValue, ['id' => 'sct_default_id']); - } - elseif ($fieldName == 'contribution_soft_credit_pcp_id') { - CRM_Contribute_Form_SoftCredit::addPCPFields($form, "[$rowNumber]"); - } - elseif ($fieldName == 'currency') { - $form->addCurrency($name, $title, $required, NULL, FALSE, FALSE); - } - elseif ($fieldName == 'contribution_page_id') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Contribute_PseudoConstant::contributionPage(), $required, 'class="big"' - ); - } - elseif ($fieldName == 'activity_status_id') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Core_PseudoConstant::activityStatus(), $required - ); - } - elseif ($fieldName == 'activity_engagement_level') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Campaign_PseudoConstant::engagementLevel(), $required - ); - } - elseif ($fieldName == 'participant_status') { - $cond = NULL; - if ($online == TRUE) { - $cond = 'visibility_id = 1'; - } - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Event_PseudoConstant::participantStatus(NULL, $cond, 'label'), $required - ); - } - elseif ($fieldName == 'participant_role') { - if (!empty($field['is_multiple'])) { - $form->addCheckBox($name, $title, CRM_Event_PseudoConstant::participantRole(), NULL, NULL, NULL, NULL, ' ', TRUE); - } - else { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Event_PseudoConstant::participantRole(), $required - ); - } - } - elseif ($fieldName == 'world_region') { - $form->add('select', $name, $title, CRM_Core_PseudoConstant::worldRegion(), $required, $selectAttributes); - } - elseif ($fieldName == 'signature_html') { - $form->add('wysiwyg', $name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName)); - } - elseif ($fieldName == 'signature_text') { - $form->add('textarea', $name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName)); - } - elseif (substr($fieldName, -11) == 'campaign_id') { - if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) { - $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value($contactId, - $form->_componentCampaigns - )); - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + $campaigns, $required, 'class="crm-select2 big"' - ); - } - } - elseif ($fieldName == 'activity_details') { - $form->add('wysiwyg', $fieldName, $title, ['rows' => 4, 'cols' => 60], $required); - } - elseif ($fieldName == 'activity_duration') { - $form->add('text', $name, $title, $attributes, $required); - $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger'); - } - elseif ($fieldName == 'case_status') { - $form->add('select', $name, $title, - [ - '' => ts('- select -'), - ] + CRM_Case_BAO_Case::buildOptions('case_status_id', 'create'), - $required - ); - } - else { - if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') { - $form->add('advcheckbox', $name, $title, $attributes, $required); - } - elseif (CRM_Utils_Array::value('html_type', $field) === 'Select Date') { - $extra = isset($field['datepicker']) ? $field['datepicker']['extra'] : CRM_Utils_Date::getDatePickerExtra($field); - $attributes = isset($field['datepicker']) ? $field['datepicker']['attributes'] : CRM_Utils_Date::getDatePickerAttributes($field); - $form->add('datepicker', $name, $title, $attributes, $required, $extra); - } - else { - $form->add('text', $name, $title, $attributes, $required); - } - } - - static $hiddenSubtype = FALSE; - if (!$hiddenSubtype && CRM_Contact_BAO_ContactType::isaSubType($field['field_type'])) { - // In registration mode params are submitted via POST and we don't have any clue - // about profile-id or the profile-type (which could be a subtype) - // To generalize the behavior and simplify the process, - // lets always add the hidden - //subtype value if there is any, and we won't have to - // compute it while processing. - if ($usedFor) { - $form->addElement('hidden', $usedFor . '[contact_sub_type]', $field['field_type']); - } - else { - $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']); - } - $hiddenSubtype = TRUE; - } - - if (($view && $mode != CRM_Profile_Form::MODE_SEARCH) || $isShared) { - $form->freeze($name); - } - - //add the rules - if (in_array($fieldName, [ - 'non_deductible_amount', - 'total_amount', - 'fee_amount', - 'net_amount', - ])) { - $form->addRule($name, ts('Please enter a valid amount.'), 'money'); - } - if ($rule) { - if (!($rule == 'email' && $mode == CRM_Profile_Form::MODE_SEARCH)) { - $form->addRule($name, ts('Please enter a valid %1', [1 => $title]), $rule); - } - } - } - - /** - * Set profile defaults. - * - * @param int $contactId - * Contact id. - * @param array $fields - * Associative array of fields. - * @param array $defaults - * Defaults array. - * @param bool $singleProfile - * True for single profile else false(Update multiple items). - * @param int $componentId - * Id for specific components like contribute, event etc. - * @param null $component - */ - public static function setProfileDefaults( - $contactId, &$fields, &$defaults, - $singleProfile = TRUE, $componentId = NULL, $component = NULL - ) { - if (!$componentId) { - //get the contact details - $contactDetails = CRM_Contact_BAO_Contact::getHierContactDetails($contactId, $fields); - $details = CRM_Utils_Array::value($contactId, $contactDetails); - $multipleFields = ['website' => 'url']; - - //start of code to set the default values - foreach ($fields as $name => $field) { - // skip pseudo fields - if (substr($name, 0, 9) == 'phone_ext') { - continue; - } - - //set the field name depending upon the profile mode(single/multiple) - if ($singleProfile) { - $fldName = $name; - } - else { - $fldName = "field[$contactId][$name]"; - } - - if ($name == 'group') { - CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::GROUP, $fldName); - } - if ($name == 'tag') { - CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::TAG, $fldName); - } - - if (!empty($details[$name]) || isset($details[$name])) { - //to handle custom data (checkbox) to be written - // to handle birth/deceased date, greeting_type and few other fields - if (in_array($name, CRM_Contact_BAO_Contact::$_greetingTypes)) { - $defaults[$fldName] = $details[$name . '_id']; - $defaults[$name . '_custom'] = $details[$name . '_custom']; - } - elseif ($name == 'preferred_communication_method') { - $v = $details[$name]; - if (!is_array($details[$name])) { - $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $v); - } - foreach ($v as $item) { - if ($item) { - $defaults[$fldName . "[$item]"] = 1; - } - } - } - elseif ($name == 'contact_sub_type') { - $defaults[$fldName] = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($details[$name], CRM_Core_DAO::VALUE_SEPARATOR)); - } - elseif ($name == 'world_region') { - $defaults[$fldName] = $details['worldregion_id']; - } - elseif ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($name)) { - $defaults[$fldName] = self::reformatProfileDefaults($field, $details[$name]); - } - else { - $defaults[$fldName] = $details[$name]; - } - } - else { - $blocks = ['email', 'phone', 'im', 'openid']; - list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System::explode('-', $name, 3); - if (!in_array($fieldName, $multipleFields)) { - if (is_array($details)) { - foreach ($details as $key => $value) { - // when we fixed CRM-5319 - get primary loc - // type as per loc field and removed below code. - $primaryLocationType = FALSE; - if ($locTypeId == 'Primary') { - if (is_array($value) && array_key_exists($fieldName, $value)) { - $primaryLocationType = TRUE; - if (in_array($fieldName, $blocks)) { - $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, $fieldName); - } - else { - $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, 'address'); - } - } - } - - // fixed for CRM-665 - if (is_numeric($locTypeId)) { - if ($primaryLocationType || $locTypeId == CRM_Utils_Array::value('location_type_id', $value)) { - if (!empty($value[$fieldName])) { - //to handle stateprovince and country - if ($fieldName == 'state_province') { - $defaults[$fldName] = $value['state_province_id']; - } - elseif ($fieldName == 'county') { - $defaults[$fldName] = $value['county_id']; - } - elseif ($fieldName == 'country') { - if (!isset($value['country_id']) || !$value['country_id']) { - $config = CRM_Core_Config::singleton(); - if ($config->defaultContactCountry) { - $defaults[$fldName] = $config->defaultContactCountry; - } - } - else { - $defaults[$fldName] = $value['country_id']; - } - } - elseif ($fieldName == 'phone') { - if ($phoneTypeId) { - if (isset($value['phone'][$phoneTypeId])) { - $defaults[$fldName] = $value['phone'][$phoneTypeId]; - } - if (isset($value['phone_ext'][$phoneTypeId])) { - $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId]; - } - } - else { - $phoneDefault = CRM_Utils_Array::value('phone', $value); - // CRM-9216 - if (!is_array($phoneDefault)) { - $defaults[$fldName] = $phoneDefault; - } - } - } - elseif ($fieldName == 'email') { - //adding the first email (currently we don't support multiple emails of same location type) - $defaults[$fldName] = $value['email']; - } - elseif ($fieldName == 'im') { - //adding the first im (currently we don't support multiple ims of same location type) - $defaults[$fldName] = $value['im']; - $defaults[$fldName . '-provider_id'] = $value['im_provider_id']; - } - else { - $defaults[$fldName] = $value[$fieldName]; - } - } - elseif (substr($fieldName, 0, 14) === 'address_custom' && - CRM_Utils_Array::value(substr($fieldName, 8), $value) - ) { - $defaults[$fldName] = self::reformatProfileDefaults($field, $value[substr($fieldName, 8)]); - } - } - } - else { - if (substr($fieldName, 0, 14) === 'address_custom' && - CRM_Utils_Array::value(substr($fieldName, 8), $value) - ) { - $defaults[$fldName] = self::reformatProfileDefaults($field, $value[substr($fieldName, 8)]); - } - } - } - } - } - else { - if (is_array($details)) { - if ($fieldName === 'url' - && !empty($details['website']) - && !empty($details['website'][$locTypeId]) - ) { - $defaults[$fldName] = CRM_Utils_Array::value('url', $details['website'][$locTypeId]); - } - } - } - } - } - } - - // Handling Contribution Part of the batch profile - if (CRM_Core_Permission::access('CiviContribute') && $component == 'Contribute') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - - // Handling Event Participation Part of the batch profile - if (CRM_Core_Permission::access('CiviEvent') && $component == 'Event') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - - //Handling Grant Part of the batch profile - if (CRM_Core_Permission::access('CiviGrant') && $component == 'Grant') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - - // Handling membership Part of the batch profile - if (CRM_Core_Permission::access('CiviMember') && $component == 'Membership') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - - // Handling Activity Part of the batch profile - if ($component == 'Activity') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - - // Handling Case Part of the batch profile - if (CRM_Core_Permission::access('CiviCase') && $component == 'Case') { - self::setComponentDefaults($fields, $componentId, $component, $defaults); - } - } - - /** - * Get profiles by type eg: pure Individual etc - * - * @param array $types - * Associative array of types eg: types('Individual'). - * @param bool $onlyPure - * True if only pure profiles are required. - * - * @return array - * associative array of profiles - */ - public static function getProfiles($types, $onlyPure = FALSE) { - $profiles = []; - $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id'); - - CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups); - - // Exclude Batch Data Entry profiles - CRM-10901 - $batchProfiles = CRM_Core_BAO_UFGroup::getBatchProfiles(); - - foreach ($ufGroups as $id => $title) { - $ptype = CRM_Core_BAO_UFField::getProfileType($id, FALSE, $onlyPure); - if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) { - $profiles[$id] = $title; - } - } - return $profiles; - } - - /** - * Check whether a profile is valid combination of - * required and/or optional profile types - * - * @param array $required - * Array of types those are required. - * @param array $optional - * Array of types those are optional. - * - * @return array - * associative array of profiles - */ - public static function getValidProfiles($required, $optional = NULL) { - if (!is_array($required) || empty($required)) { - return NULL; - } - - $profiles = []; - $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id'); - - CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups); - - foreach ($ufGroups as $id => $title) { - $type = CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional); - if ($type) { - $profiles[$id] = $title; - } - } - - return $profiles; - } - - /** - * Check whether a profile is valid combination of - * required profile fields - * - * @param array $ufId - * Integer id of the profile. - * @param array $required - * Array of fields those are required in the profile. - * - * @return array - * associative array of profiles - */ - public static function checkValidProfile($ufId, $required = NULL) { - $validProfile = FALSE; - if (!$ufId) { - return $validProfile; - } - - if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) { - return $validProfile; - } - - $profileFields = self::getFields($ufId, FALSE, CRM_Core_Action::VIEW, NULL, - NULL, FALSE, NULL, FALSE, NULL, - CRM_Core_Permission::CREATE, NULL - ); - - $validProfile = []; - if (!empty($profileFields)) { - $fields = array_keys($profileFields); - foreach ($fields as $val) { - foreach ($required as $key => $field) { - if (strpos($val, $field) === 0) { - unset($required[$key]); - } - } - } - - $validProfile = (empty($required)) ? TRUE : FALSE; - } - - return $validProfile; - } - - /** - * Get default value for Register. - * - * @param array $fields - * @param array $defaults - * - * @return array - */ - public static function setRegisterDefaults(&$fields, &$defaults) { - $config = CRM_Core_Config::singleton(); - foreach ($fields as $name => $field) { - if (substr($name, 0, 8) == 'country-') { - if (!empty($config->defaultContactCountry)) { - $defaults[$name] = $config->defaultContactCountry; - } - } - elseif (substr($name, 0, 15) == 'state_province-') { - if (!empty($config->defaultContactStateProvince)) { - $defaults[$name] = $config->defaultContactStateProvince; - } - } - } - return $defaults; - } - - /** - * make a copy of a profile, including - * all the fields in the profile - * - * @param int $id - * The profile id to copy. - * - * @return \CRM_Core_DAO - */ - public static function copy($id) { - $maxId = CRM_Core_DAO::singleValueQuery("SELECT max(id) FROM civicrm_uf_group"); - - $title = ts('[Copy id %1]', [1 => $maxId + 1]); - $fieldsFix = [ - 'suffix' => [ - 'title' => ' ' . $title, - 'name' => '__Copy_id_' . ($maxId + 1) . '_', - ], - ]; - - $copy = CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFGroup', - ['id' => $id], - NULL, - $fieldsFix - ); - - if ($pos = strrpos($copy->name, "_{$id}")) { - $copy->name = substr_replace($copy->name, '', $pos); - } - $copy->name = CRM_Utils_String::munge($copy->name, '_', 56) . "_{$copy->id}"; - $copy->save(); - - $copyUFJoin = CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFJoin', - ['uf_group_id' => $id], - ['uf_group_id' => $copy->id], - NULL, - 'entity_table' - ); - - $copyUFField = CRM_Core_DAO::copyGeneric('CRM_Core_BAO_UFField', - ['uf_group_id' => $id], - ['uf_group_id' => $copy->id] - ); - - $maxWeight = CRM_Utils_Weight::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight'); - - //update the weight - $query = " -UPDATE civicrm_uf_join -SET weight = %1 -WHERE uf_group_id = %2 -AND ( entity_id IS NULL OR entity_id <= 0 ) -"; - $p = [ - 1 => [$maxWeight + 1, 'Integer'], - 2 => [$copy->id, 'Integer'], - ]; - CRM_Core_DAO::executeQuery($query, $p); - if ($copy->is_reserved) { - $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1"; - $params = [1 => [$copy->id, 'Integer']]; - CRM_Core_DAO::executeQuery($query, $params); - } - CRM_Utils_Hook::copy('UFGroup', $copy); - - return $copy; - } - - /** - * Process that send notification e-mails - * - * @param int $contactID - * Contact id. - * @param array $values - * Associative array of name/value pair. - */ - public static function commonSendMail($contactID, &$values) { - if (!$contactID || !$values) { - return; - - } - $template = CRM_Core_Smarty::singleton(); - - $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', - $contactID, - 'display_name' - ); - - self::profileDisplay($values['id'], $values['values'], $template); - $emailList = explode(',', $values['email']); - - $contactLink = CRM_Utils_System::url('civicrm/contact/view', - "reset=1&cid=$contactID", - TRUE, NULL, FALSE, FALSE, TRUE - ); - - //get the default domain email address. - list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail(); - - if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') { - $fixUrl = CRM_Utils_System::url('civicrm/admin/domain', 'action=update&reset=1'); - CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in Administer CiviCRM » Communications » FROM Email Addresses. The email address used may need to be a valid mail account with your email service provider.', [1 => $fixUrl])); - } - - foreach ($emailList as $emailTo) { - // FIXME: take the below out of the foreach loop - CRM_Core_BAO_MessageTemplate::sendTemplate( - [ - 'groupName' => 'msg_tpl_workflow_uf', - 'valueName' => 'uf_notify', - 'contactId' => $contactID, - 'tplParams' => [ - 'displayName' => $displayName, - 'currentDate' => date('r'), - 'contactLink' => $contactLink, - ], - 'from' => "$domainEmailName <$domainEmailAddress>", - 'toEmail' => $emailTo, - ] - ); - } - } - - /** - * Given a contact id and a group id, returns the field values from the db - * for this group and notify email only if group's notify field is - * set and field values are not empty - * - * @param int $gid - * Group id. - * @param int $cid - * Contact id. - * @param array $params - * @param bool $skipCheck - * - * @return array - */ - public function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) { - if ($gid) { - if (CRM_Core_BAO_UFGroup::filterUFGroups($gid, $cid) || $skipCheck) { - $values = []; - $fields = CRM_Core_BAO_UFGroup::getFields($gid, FALSE, CRM_Core_Action::VIEW); - CRM_Core_BAO_UFGroup::getValues($cid, $fields, $values, FALSE, $params, TRUE); - - $email = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify'); - - if (!empty($values) && - !empty($email) - ) { - $val = [ - 'id' => $gid, - 'values' => $values, - 'email' => $email, - ]; - return $val; - } - } - } - return NULL; - } - - /** - * Assign uf fields to template. - * - * @param int $gid - * Group id. - * @param array $values - * @param CRM_Core_Smarty $template - */ - public static function profileDisplay($gid, $values, $template) { - $groupTitle = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title'); - $template->assign('grouptitle', $groupTitle); - if (count($values)) { - $template->assign('values', $values); - } - } - - /** - * Format fields for dupe Contact Matching. - * - * @param array $params - * - * @param int $contactId - * - * @return array - * associated formatted array - */ - public static function formatFields($params, $contactId = NULL) { - if ($contactId) { - // get the primary location type id and email - list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactId); - } - else { - $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); - $primaryLocationType = $defaultLocationType->id; - } - - $data = []; - $locationType = []; - $count = 1; - $primaryLocation = 0; - foreach ($params as $key => $value) { - list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key); - - if ($locTypeId == 'Primary') { - $locTypeId = $primaryLocationType; - } - - if (is_numeric($locTypeId)) { - if (!in_array($locTypeId, $locationType)) { - $locationType[$count] = $locTypeId; - $count++; - } - $loc = CRM_Utils_Array::key($locTypeId, $locationType); - - $data['location'][$loc]['location_type_id'] = $locTypeId; - - // if we are getting in a new primary email, dont overwrite the new one - if ($locTypeId == $primaryLocationType) { - if (!empty($params['email-' . $primaryLocationType])) { - $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType]; - } - elseif (isset($primaryEmail)) { - $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail; - } - $primaryLocation++; - } - - if ($loc == 1) { - $data['location'][$loc]['is_primary'] = 1; - } - if ($fieldName == 'phone') { - if ($phoneTypeId) { - $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId; - } - else { - $data['location'][$loc]['phone'][$loc]['phone_type_id'] = ''; - } - $data['location'][$loc]['phone'][$loc]['phone'] = $value; - } - elseif ($fieldName == 'email') { - $data['location'][$loc]['email'][$loc]['email'] = $value; - } - elseif ($fieldName == 'im') { - $data['location'][$loc]['im'][$loc]['name'] = $value; - } - else { - if ($fieldName === 'state_province') { - $data['location'][$loc]['address']['state_province_id'] = $value; - } - elseif ($fieldName === 'country') { - $data['location'][$loc]['address']['country_id'] = $value; - } - else { - $data['location'][$loc]['address'][$fieldName] = $value; - } - } - } - else { - // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs - if ($key === 'individual_suffix') { - $data['suffix_id'] = $value; - } - elseif ($key === 'individual_prefix') { - $data['prefix_id'] = $value; - } - elseif ($key === 'gender') { - $data['gender_id'] = $value; - } - elseif (substr($key, 0, 6) === 'custom') { - if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) { - //fix checkbox - if ($customFields[$customFieldID]['html_type'] == 'CheckBox') { - $value = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($value)); - } - // fix the date field - if ($customFields[$customFieldID]['data_type'] == 'Date') { - $date = CRM_Utils_Date::format($value); - if (!$date) { - $date = ''; - } - $value = $date; - } - - $data['custom'][$customFieldID] = [ - 'id' => $id, - 'value' => $value, - 'extends' => $customFields[$customFieldID]['extends'], - 'type' => $customFields[$customFieldID]['data_type'], - 'custom_field_id' => $customFieldID, - ]; - } - } - elseif ($key == 'edit') { - continue; - } - else { - $data[$key] = $value; - } - } - } - - if (!$primaryLocation) { - $loc++; - $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail; - } - - return $data; - } - - /** - * Calculate the profile type 'group_type' as per profile fields. - * - * @param int $gId - * Profile id. - * @param bool $includeTypeValues - * @param int $ignoreFieldId - * Ignore particular profile field. - * - * @return array - * list of calculated group type - */ - public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { - //get the profile fields. - $ufFields = self::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE); - return self::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId); - } - - /** - * Calculate the profile type 'group_type' as per profile fields. - * - * @param $ufFields - * @param bool $includeTypeValues - * @param int $ignoreFieldId - * Ignore perticular profile field. - * - * @return array - * list of calculated group type - */ - public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { - $groupType = $groupTypeValues = $customFieldIds = []; - if (!empty($ufFields)) { - foreach ($ufFields as $fieldName => $fieldValue) { - //ignore field from group type when provided. - //in case of update profile field. - if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) { - continue; - } - if (!in_array($fieldValue['field_type'], $groupType)) { - $groupType[$fieldValue['field_type']] = $fieldValue['field_type']; - } - - if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField::getKeyID($fieldName))) { - $customFieldIds[$fldId] = $fldId; - } - } - } - - if (!empty($customFieldIds)) { - $query = 'SELECT DISTINCT(cg.id), cg.extends, cg.extends_entity_column_id, cg.extends_entity_column_value FROM civicrm_custom_group cg LEFT JOIN civicrm_custom_field cf ON cf.custom_group_id = cg.id WHERE cg.extends_entity_column_value IS NOT NULL AND cf.id IN (' . implode(',', $customFieldIds) . ')'; - - $customGroups = CRM_Core_DAO::executeQuery($query); - while ($customGroups->fetch()) { - if (!$customGroups->extends_entity_column_value) { - continue; - } - - $groupTypeName = "{$customGroups->extends}Type"; - if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id) { - $groupTypeName = CRM_Core_PseudoConstant::getName('CRM_Core_DAO_CustomGroup', 'extends_entity_column_id', $customGroups->extends_entity_column_id); - } - - foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $customGroups->extends_entity_column_value) as $val) { - if ($val) { - $groupTypeValues[$groupTypeName][$val] = $val; - } - } - } - - if (!empty($groupTypeValues)) { - $groupType = array_merge($groupType, $groupTypeValues); - } - } - - return $groupType; - } - - /** - * Update the profile type 'group_type' as per profile fields including group types and group subtype values. - * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2 - * - * FIELDS GROUP_TYPE - * BirthDate + Email Individual,Contact - * BirthDate + Subject Individual,Activity - * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28 - * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed) - * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28 - * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28 - * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28 - * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28 - * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28 - * - * @param int $gId - * @param array $groupTypes - * With key having group type names. - * - * @return bool - */ - public static function updateGroupTypes($gId, $groupTypes = []) { - if (!is_array($groupTypes) || !$gId) { - return FALSE; - } - - // If empty group types set group_type as 'null' - if (empty($groupTypes)) { - return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null'); - } - - $componentGroupTypes = ['Contribution', 'Participant', 'Membership', 'Activity', 'Case', 'Grant']; - $validGroupTypes = array_merge([ - 'Contact', - 'Individual', - 'Organization', - 'Household', - ], $componentGroupTypes, CRM_Contact_BAO_ContactType::subTypes()); - - $gTypes = $gTypeValues = []; - - $participantExtends = ['ParticipantRole', 'ParticipantEventName', 'ParticipantEventType']; - // Get valid group type and group subtypes - foreach ($groupTypes as $groupType => $value) { - if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) { - $gTypes[] = $groupType; - } - - $subTypesOf = NULL; - - if (in_array($groupType, $participantExtends)) { - $subTypesOf = $groupType; - } - elseif (strpos($groupType, 'Type') > 0) { - $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type')); - } - else { - continue; - } - - if (!empty($value) && - (in_array($subTypesOf, $componentGroupTypes) || - in_array($subTypesOf, $participantExtends) - ) - ) { - $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value); - } - } - - if (empty($gTypes)) { - return FALSE; - } - - // Build String to store group types and group subtypes - $groupTypeString = implode(',', $gTypes); - if (!empty($gTypeValues)) { - $groupTypeString .= CRM_Core_DAO::VALUE_SEPARATOR . implode(',', $gTypeValues); - } - - return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString); - } - - /** - * Create a "group_type" string. - * - * @param array $coreTypes - * E.g. array('Individual','Contact','Student'). - * @param array $subTypes - * E.g. array('ActivityType' => array(7, 11)). - * @param string $delim - * - * @return string - * @throws CRM_Core_Exception - */ - public static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO::VALUE_SEPARATOR) { - $groupTypeExpr = ''; - if ($coreTypes) { - $groupTypeExpr .= implode(',', $coreTypes); - } - if ($subTypes) { - //CRM-15427 Allow Multiple subtype filtering - //if (count($subTypes) > 1) { - //throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget."); - //} - foreach ($subTypes as $subType => $subTypeIds) { - $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds); - } - } - return $groupTypeExpr; - } - - /** - * setDefault componet specific profile fields. - * - * @param array $fields - * Profile fields. - * @param int $componentId - * ComponetID. - * @param string $component - * Component name. - * @param array $defaults - * An array of default values. - * - * @param bool $isStandalone - */ - public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) { - if (!$componentId || - !in_array($component, ['Contribute', 'Membership', 'Event', 'Activity', 'Case', 'Grant']) - ) { - return; - } - - $componentBAO = $componentSubType = NULL; - switch ($component) { - case 'Membership': - $componentBAO = 'CRM_Member_BAO_Membership'; - $componentBAOName = 'Membership'; - $componentSubType = ['membership_type_id']; - break; - - case 'Contribute': - $componentBAO = 'CRM_Contribute_BAO_Contribution'; - $componentBAOName = 'Contribution'; - $componentSubType = ['financial_type_id']; - break; - - case 'Event': - $componentBAO = 'CRM_Event_BAO_Participant'; - $componentBAOName = 'Participant'; - $componentSubType = ['role_id', 'event_id', 'event_type_id']; - break; - - case 'Activity': - $componentBAO = 'CRM_Activity_BAO_Activity'; - $componentBAOName = 'Activity'; - $componentSubType = ['activity_type_id']; - break; - - case 'Case': - $componentBAO = 'CRM_Case_BAO_Case'; - $componentBAOName = 'Case'; - $componentSubType = ['case_type_id']; - break; - - case 'Grant': - $componentBAO = 'CRM_Grant_BAO_Grant'; - $componentBAOName = 'Grant'; - $componentSubType = array('grant_type_id'); - break; - } - - $values = []; - $params = ['id' => $componentId]; - - //get the component values. - CRM_Core_DAO::commonRetrieve($componentBAO, $params, $values); - if ($componentBAOName == 'Participant') { - $values += ['event_type_id' => CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $values['event_id'], 'event_type_id')]; - } - - $formattedGroupTree = []; - - foreach ($fields as $name => $field) { - $fldName = $isStandalone ? $name : "field[$componentId][$name]"; - if (array_key_exists($name, $values)) { - $defaults[$fldName] = $values[$name]; - } - elseif ($name == 'participant_note') { - $noteDetails = CRM_Core_BAO_Note::getNote($componentId, 'civicrm_participant'); - $defaults[$fldName] = array_pop($noteDetails); - } - elseif (in_array($name, [ - 'financial_type', - 'payment_instrument', - 'participant_status', - 'participant_role', - ])) { - $defaults[$fldName] = $values["{$name}_id"]; - } - elseif ($name == 'membership_type') { - // since membership_type field is a hierselect - - $defaults[$fldName][0] - = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'member_of_contact_id', 'id'); - $defaults[$fldName][1] = $values['membership_type_id']; - } - elseif ($name == 'membership_status') { - $defaults[$fldName] = $values['status_id']; - } - elseif ($name == 'case_status') { - $defaults[$fldName] = $values['case_status_id']; - } - elseif (CRM_Core_BAO_CustomField::getKeyID($name, TRUE) !== [NULL, NULL]) { - if (empty($formattedGroupTree)) { - //get the groupTree as per subTypes. - $groupTree = []; - foreach ($componentSubType as $subType) { - $subTree = CRM_Core_BAO_CustomGroup::getTree($componentBAOName, NULL, - $componentId, 0, $values[$subType] - ); - $groupTree = CRM_Utils_Array::crmArrayMerge($groupTree, $subTree); - } - $formattedGroupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1); - CRM_Core_BAO_CustomGroup::setDefaults($formattedGroupTree, $defaults); - } - - //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified. - foreach ($defaults as $customKey => $customValue) { - if ($customFieldDetails = CRM_Core_BAO_CustomField::getKeyID($customKey, TRUE)) { - if ($name == 'custom_' . $customFieldDetails[0]) { - - //hack to set default for checkbox - //basically this is for weired field name like field[33][custom_19] - //we are converting this field name to array structure and assign value. - $skipValue = FALSE; - - foreach ($formattedGroupTree as $tree) { - if (!empty($tree['fields'][$customFieldDetails[0]])) { - if ('CheckBox' == CRM_Utils_Array::value('html_type', $tree['fields'][$customFieldDetails[0]])) { - $skipValue = TRUE; - $defaults['field'][$componentId][$name] = $customValue; - break; - } - elseif (CRM_Utils_Array::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') { - $skipValue = TRUE; - - // CRM-6681, $default contains formatted date, time values. - $defaults[$fldName] = $customValue; - if (!empty($defaults[$customKey . '_time'])) { - $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time']; - } - } - } - } - - if (!$skipValue || $isStandalone) { - $defaults[$fldName] = $customValue; - } - unset($defaults[$customKey]); - break; - } - } - } - } - elseif (isset($values[$fldName])) { - $defaults[$fldName] = $values[$fldName]; - } - } - } - - /** - * Retrieve groups of profiles. - * - * @param int $profileID - * Id of the profile. - * - * @return array - * returns array - */ - public static function profileGroups($profileID) { - $groupTypes = []; - $profileTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type'); - if ($profileTypes) { - $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $profileTypes); - $groupTypes = explode(',', $groupTypeParts[0]); - } - return $groupTypes; - } - - /** - * Alter contact params by filtering existing subscribed groups and returns - * unsubscribed groups array for subscription. - * - * @param array $params - * Contact params. - * @param int $contactId - * User contact id. - * - * @return array - * This contains array of groups for subscription - */ - public static function getDoubleOptInGroupIds(&$params, $contactId = NULL) { - $config = CRM_Core_Config::singleton(); - $subscribeGroupIds = []; - - // process further only if profileDoubleOptIn enabled and if groups exist - if (!array_key_exists('group', $params) || - !self::isProfileDoubleOptin() || - CRM_Utils_System::isNull($params['group']) - ) { - return $subscribeGroupIds; - } - - //check if contact email exist. - $hasEmails = FALSE; - foreach ($params as $name => $value) { - if (strpos($name, 'email-') !== FALSE) { - $hasEmails = TRUE; - break; - } - } - - //Proceed furthur only if email present - if (!$hasEmails) { - return $subscribeGroupIds; - } - - //do check for already subscriptions. - $contactGroups = []; - if ($contactId) { - $query = " -SELECT group_id - FROM civicrm_group_contact - WHERE status = 'Added' - AND contact_id = %1"; - - $dao = CRM_Core_DAO::executeQuery($query, [1 => [$contactId, 'Integer']]); - while ($dao->fetch()) { - $contactGroups[$dao->group_id] = $dao->group_id; - } - } - - //since we don't have names, compare w/ label. - $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup::values('group_type')); - - //actual processing start. - foreach ($params['group'] as $groupId => $isSelected) { - //unset group those are not selected. - if (!$isSelected) { - unset($params['group'][$groupId]); - continue; - } - - $groupTypes = explode(CRM_Core_DAO::VALUE_SEPARATOR, - CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id') - ); - //get only mailing type group and unset it from params - if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) { - $subscribeGroupIds[$groupId] = $groupId; - unset($params['group'][$groupId]); - } - } - - return $subscribeGroupIds; - } - - /** - * Check if we are rendering mixed profiles. - * - * @param array $profileIds - * Associated array of profile ids. - * - * @return bool - * true if profile is mixed - */ - public static function checkForMixProfiles($profileIds) { - $mixProfile = FALSE; - - $contactTypes = ['Individual', 'Household', 'Organization']; - $subTypes = CRM_Contact_BAO_ContactType::subTypes(); - - $components = ['Contribution', 'Participant', 'Membership', 'Activity', 'Grant']; - - $typeCount = ['ctype' => [], 'subtype' => []]; - foreach ($profileIds as $gid) { - $profileType = CRM_Core_BAO_UFField::getProfileType($gid); - // ignore profile of type Contact - if ($profileType == 'Contact') { - continue; - } - if (in_array($profileType, $contactTypes)) { - if (!isset($typeCount['ctype'][$profileType])) { - $typeCount['ctype'][$profileType] = 1; - } - - // check if we are rendering profile of different contact types - if (count($typeCount['ctype']) == 2) { - $mixProfile = TRUE; - break; - } - } - elseif (in_array($profileType, $components)) { - $mixProfile = TRUE; - break; - } - else { - if (!isset($typeCount['subtype'][$profileType])) { - $typeCount['subtype'][$profileType] = 1; - } - // check if we are rendering profile of different contact sub types - if (count($typeCount['subtype']) == 2) { - $mixProfile = TRUE; - break; - } - } - } - return $mixProfile; - } - - /** - * Determine of we show overlay profile or not. - * - * @return bool - * true if profile should be shown else false - */ - public static function showOverlayProfile() { - $showOverlay = TRUE; - - // get the id of overlay profile - $overlayProfileId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name'); - $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') "; - - $count = CRM_Core_DAO::singleValueQuery($query); - - //check if there are no public fields and use is anonymous - $session = CRM_Core_Session::singleton(); - if (!$count && !$session->get('userID')) { - $showOverlay = FALSE; - } - - return $showOverlay; - } - - /** - * Get group type values of the profile. - * - * @param int $profileId - * @param string $groupType - * - * @return array - * group type values - */ - public static function groupTypeValues($profileId, $groupType = NULL) { - $groupTypeValue = []; - $groupTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type'); - - $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $groupTypes); - if (empty($groupTypeParts[1])) { - return $groupTypeValue; - } - $participantExtends = ['ParticipantRole', 'ParticipantEventName', 'ParticipantEventType']; - - foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) { - $values = []; - $valueParts = explode(':', $groupTypeValues); - if ($groupType && - ($valueParts[0] != "{$groupType}Type" || - ($groupType == 'Participant' && - !in_array($valueParts[0], $participantExtends) - ) - ) - ) { - continue; - } - foreach ($valueParts as $val) { - if (CRM_Utils_Rule::integer($val)) { - $values[$val] = $val; - } - } - if (!empty($values)) { - $typeName = substr($valueParts[0], 0, -4); - if (in_array($valueParts[0], $participantExtends)) { - $typeName = $valueParts[0]; - } - $groupTypeValue[$typeName] = $values; - } - } - - return $groupTypeValue; - } - - /** - * @return bool|object - */ - public static function isProfileDoubleOptin() { - // check for double optin - $config = CRM_Core_Config::singleton(); - if (in_array('CiviMail', $config->enableComponents)) { - return Civi::settings()->get('profile_double_optin'); - } - return FALSE; - } - - /** - * @return bool|object - */ - public static function isProfileAddToGroupDoubleOptin() { - // check for add to group double optin - $config = CRM_Core_Config::singleton(); - if (in_array('CiviMail', $config->enableComponents)) { - return Civi::settings()->get('profile_add_to_group_double_optin'); - } - return FALSE; - } - - /** - * Get profiles used for batch entry. - * - * @return array - * profileIds profile ids - */ - public static function getBatchProfiles() { - $query = "SELECT id - FROM civicrm_uf_group - WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')"; - $dao = CRM_Core_DAO::executeQuery($query); - $profileIds = []; - while ($dao->fetch()) { - $profileIds[$dao->id] = $dao->id; - } - return $profileIds; - } - - /** - * @param $source - * @param $destination - * @param bool $returnMultiSummaryFields - * - * @return array|null - * @todo what do I do? - */ - public static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) { - $multiSummaryFields = $returnMultiSummaryFields ? [] : NULL; - foreach ($source as $field => $properties) { - if (!CRM_Core_BAO_CustomField::getKeyID($field)) { - continue; - } - if (CRM_Core_BAO_CustomField::isMultiRecordField($field)) { - $destination[$field] = $properties; - if ($returnMultiSummaryFields) { - if ($properties['is_multi_summary']) { - $multiSummaryFields[$field] = $properties; - } - } - unset($source[$field]); - } - } - return $multiSummaryFields; - } - - /** - * This is function is used to format pseudo fields. - * - * @param array $fields - * Associated array of profile fields. - * - */ - public static function reformatProfileFields(&$fields) { - //reformat fields array - foreach ($fields as $name => $field) { - //reformat phone and extension field - if (substr($field['name'], 0, 13) == 'phone_and_ext') { - $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']); - - // retain existing element properties and just update and replace key - CRM_Utils_Array::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}"); - $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}"; - $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone'; - - // add additional phone extension field - $fields["phone_ext-{$fieldSuffix}"] = $field; - $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] . ' - ' . ts('Ext.'); - $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}"; - $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext'; - $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1; - //ignore required for extension field - $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0; - } - } - } - - /** - * Get the frontend_title for the profile, falling back on 'title' if none. - * - * @param int $profileID - * - * @return string - * - * @throws \CiviCRM_API3_Exception - */ - public static function getFrontEndTitle(int $profileID) { - $profile = civicrm_api3('UFGroup', 'getsingle', ['id' => $profileID, 'return' => ['title', 'frontend_title']]); - return $profile['frontend_title'] ?? $profile['title']; - } - - /** - * This function is used to format the profile default values. - * - * @param array $field - * Associated array of profile fields to render. - * @param string $value - * Value to render - * - * @return $defaults - * String or array, depending on the html type - */ - public static function reformatProfileDefaults($field, $value) { - $defaults = []; - - switch ($field['html_type']) { - case 'Multi-Select State/Province': - case 'Multi-Select Country': - case 'Multi-Select': - $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($value)); - foreach ($v as $item) { - if ($item) { - $defaults[$item] = $item; - } - } - break; - - case 'CheckBox': - $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); - foreach ($v as $item) { - if ($item) { - $defaults[$item] = 1; - // seems like we need this for QF style checkboxes in profile where its multiindexed - // CRM-2969 - $defaults["[{$item}]"] = 1; - } - } - break; - - default: - $defaults = $value; - break; - } - return $defaults; - } - -} diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 32129ef..06accaf 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -442,7 +442,7 @@ public function addPages(&$stateMachine, $action = CRM_Core_Action::NONE) { $$stateName->setOptions($options); } if (property_exists($$stateName, 'urlPath')) { - $$stateName->urlPath = explode('/', (string) CRM_Utils_System::getUrlPath()); + $$stateName->urlPath = explode('/', (string) CRM_Utils_System::currentPath()); } $this->addPage($$stateName); $this->addAction($stateName, new HTML_QuickForm_Action_Direct()); diff --git a/CRM/Core/Page/AJAX/Location.php b/CRM/Core/Page/AJAX/Location.php index a976280..afe32f9 100644 --- a/CRM/Core/Page/AJAX/Location.php +++ b/CRM/Core/Page/AJAX/Location.php @@ -28,6 +28,8 @@ class CRM_Core_Page_AJAX_Location { * obtain the location of given contact-id. * This method is used by on-behalf-of form to dynamically generate poulate the * location field values for selected permissioned contact. + * + * @throws \CRM_Core_Exception */ public static function getPermissionedLocation() { $cid = CRM_Utils_Request::retrieve('cid', 'Integer', CRM_Core_DAO::$_nullObject, TRUE); diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index 5d3d94b..f7239f5 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -69,6 +69,13 @@ public static function select(&$query) { $query->_tables['grant_note'] = 1; } + if (!empty($query->_returnProperties['amount_requested'])) { + $query->_select['amount_requested'] = 'civicrm_grant.amount_requested as amount_requested'; + $query->_element['amount_requested'] = 1; + $query->_tables['amount_requested'] = $query->_whereTables['amount_requested'] = 1; + $query->_tables['civicrm_grant'] = $query->_whereTables['civicrm_grant'] = 1; + } + if ($query->_mode & CRM_Contact_BAO_Query::MODE_GRANT) { $query->_select['grant_amount_requested'] = 'civicrm_grant.amount_requested as grant_amount_requested'; $query->_select['grant_amount_granted'] = 'civicrm_grant.amount_granted as grant_amount_granted'; diff --git a/CRM/Grant/Form/Grant/Confirm.php b/CRM/Grant/Form/Grant/Confirm.php index c4d4305..d5c8e7a 100755 --- a/CRM/Grant/Form/Grant/Confirm.php +++ b/CRM/Grant/Form/Grant/Confirm.php @@ -211,6 +211,14 @@ public function preProcess() { } } } + $numericFields = $this->get('numericFields'); + if (!empty($numericFields)) { + foreach ($numericFields as $numericField => $type) { + if (!empty($this->_params[$numericField])) { + $this->_params[$numericField] = CRM_Utils_Money::format($this->_params[$numericField]); + } + } + } $this->set('params', $this->_params); } diff --git a/CRM/Grant/Form/Grant/Main.php b/CRM/Grant/Form/Grant/Main.php index 74d4626..0a99b3f 100755 --- a/CRM/Grant/Form/Grant/Main.php +++ b/CRM/Grant/Form/Grant/Main.php @@ -186,9 +186,6 @@ public function buildQuickForm() { $this->assign('showMainEmail', TRUE); $this->addRule("email-Primary", ts('Email is not valid.'), 'email'); } - else { - $this->addElement('hidden', "email-{$this->_bltID}", 1); - } if (!CRM_Utils_Array::value('amount_requested', $this->_fields)) { $defaultAmount = isset($this->_values['default_amount']) ? $this->_values['default_amount'] : '0.00'; @@ -207,7 +204,11 @@ public function buildQuickForm() { if ( !empty( $this->_fields ) ) { $profileAddressFields = array(); - $numericFields['amount_total'] = 'Float'; + $numericFields = [ + 'amount_total' => 'Float', + 'amount_requested' => 'Float', + 'amount_granted' => 'Float', + ]; foreach( $this->_fields as $key => $value ) { CRM_Core_BAO_UFField::assignAddressField($key, $profileAddressFields, array('uf_group_id' => $this->_values['custom_pre_id'])); $dataType = CRM_Utils_Array::value('data_type', $value); @@ -220,6 +221,7 @@ public function buildQuickForm() { } $this->assign('numericFields', json_encode($numericFields)); $this->set('profileAddressFields', $profileAddressFields); + $this->set('numericFields', $numericFields); } //to create an cms user diff --git a/CRM/Grant/Form/Grant/ThankYou.php b/CRM/Grant/Form/Grant/ThankYou.php index 44b6de4..ea1e602 100755 --- a/CRM/Grant/Form/Grant/ThankYou.php +++ b/CRM/Grant/Form/Grant/ThankYou.php @@ -134,6 +134,11 @@ public function buildQuickForm() { } $this->_submitValues = array_merge($this->_submitValues, $defaults); + foreach ($defaults as $key => $field) { + if (substr($key, 0, strlen('email-')) === 'email-') { + $this->assign('email', $defaults[$key]); + } + } $this->setDefaults($defaults); $this->freeze(); diff --git a/CRM/Grant/Form/GrantBase.php b/CRM/Grant/Form/GrantBase.php index 5bdef6d..cc0bff8 100755 --- a/CRM/Grant/Form/GrantBase.php +++ b/CRM/Grant/Form/GrantBase.php @@ -121,6 +121,10 @@ class CRM_Grant_Form_GrantBase extends CRM_Core_Form { * @access public */ public function preProcess() { + CRM_Core_Resources::singleton()->addStyle('#crm-container.crm-public .calc-value, #crm-container.crm-public .content { + padding-top: 6px !important; + font-size: 15px !important; + }'); // current grant application page id $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this); diff --git a/CRM/Grantapplications/BAO/GrantApplicationProfile.php b/CRM/Grantapplications/BAO/GrantApplicationProfile.php index 16c874b..43f17a1 100755 --- a/CRM/Grantapplications/BAO/GrantApplicationProfile.php +++ b/CRM/Grantapplications/BAO/GrantApplicationProfile.php @@ -35,10 +35,10 @@ /** * This class contains function for Grant Applications - * */ class CRM_Grantapplications_BAO_GrantApplicationProfile extends CRM_Core_DAO { - static function getGrantFields() { + + public static function getGrantFields() { $exportableFields = self::exportableFields('Grant'); $skipFields = array('grant_id', 'grant_contact_id'); @@ -50,7 +50,7 @@ static function getGrantFields() { return $exportableFields; } - static function exportableFields() { + public static function exportableFields() { $grantFields = array( 'grant_status_id' => array( 'title' => ts('Grant Status'), @@ -87,10 +87,170 @@ static function exportableFields() { * * return array of enabled extensions */ - static function checkRelatedExtensions($name = 'biz.jmaconsulting.bugp') { + public static function checkRelatedExtensions($name = 'biz.jmaconsulting.bugp') { $enableDisable = NULL; $sql = "SELECT is_active FROM civicrm_extension WHERE full_name = '{name}'"; $enableDisable = CRM_Core_DAO::singleValueQuery($sql); return $enableDisable; } -} \ No newline at end of file + + /** + * Calculate the profile type 'group_type' as per profile fields. + * + * @param int $gId + * Profile id. + * @param bool $includeTypeValues + * @param int $ignoreFieldId + * Ignore particular profile field. + * + * @return array + * list of calculated group type + */ + public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { + //get the profile fields. + $ufFields = CRM_Core_BAO_UFGroup::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE); + return self::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId); + } + + /** + * Calculate the profile type 'group_type' as per profile fields. + * + * @param $ufFields + * @param bool $includeTypeValues + * @param int $ignoreFieldId + * Ignore perticular profile field. + * + * @return array + * list of calculated group type + */ + public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) { + $groupType = $groupTypeValues = $customFieldIds = []; + if (!empty($ufFields)) { + foreach ($ufFields as $fieldName => $fieldValue) { + //ignore field from group type when provided. + //in case of update profile field. + if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) { + continue; + } + if (!in_array($fieldValue['field_type'], $groupType)) { + $groupType[$fieldValue['field_type']] = $fieldValue['field_type']; + } + + if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField::getKeyID($fieldName))) { + $customFieldIds[$fldId] = $fldId; + } + } + } + + if (!empty($customFieldIds)) { + $query = 'SELECT DISTINCT(cg.id), cg.extends, cg.extends_entity_column_id, cg.extends_entity_column_value FROM civicrm_custom_group cg LEFT JOIN civicrm_custom_field cf ON cf.custom_group_id = cg.id WHERE cg.extends_entity_column_value IS NOT NULL AND cf.id IN (' . implode(',', $customFieldIds) . ')'; + + $customGroups = CRM_Core_DAO::executeQuery($query); + while ($customGroups->fetch()) { + if (!$customGroups->extends_entity_column_value) { + continue; + } + + $groupTypeName = "{$customGroups->extends}Type"; + if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id) { + $groupTypeName = CRM_Core_PseudoConstant::getName('CRM_Core_DAO_CustomGroup', 'extends_entity_column_id', $customGroups->extends_entity_column_id); + } + + foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $customGroups->extends_entity_column_value) as $val) { + if ($val) { + $groupTypeValues[$groupTypeName][$val] = $val; + } + } + } + + if (!empty($groupTypeValues)) { + $groupType = array_merge($groupType, $groupTypeValues); + } + } + + return $groupType; + } + + /** + * Update the profile type 'group_type' as per profile fields including group types and group subtype values. + * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2 + * + * FIELDS GROUP_TYPE + * BirthDate + Email Individual,Contact + * BirthDate + Subject Individual,Activity + * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28 + * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed) + * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28 + * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28 + * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28 + * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28 + * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28 + * + * @param int $gId + * @param array $groupTypes + * With key having group type names. + * + * @return bool + */ + public static function updateGroupTypes($gId, $groupTypes = []) { + if (!is_array($groupTypes) || !$gId) { + return FALSE; + } + + // If empty group types set group_type as 'null' + if (empty($groupTypes)) { + return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null'); + } + + $componentGroupTypes = ['Contribution', 'Participant', 'Membership', 'Activity', 'Case', 'Grant']; + $validGroupTypes = array_merge([ + 'Contact', + 'Individual', + 'Organization', + 'Household', + ], $componentGroupTypes, CRM_Contact_BAO_ContactType::subTypes()); + + $gTypes = $gTypeValues = []; + + $participantExtends = ['ParticipantRole', 'ParticipantEventName', 'ParticipantEventType']; + // Get valid group type and group subtypes + foreach ($groupTypes as $groupType => $value) { + if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) { + $gTypes[] = $groupType; + } + + $subTypesOf = NULL; + + if (in_array($groupType, $participantExtends)) { + $subTypesOf = $groupType; + } + elseif (strpos($groupType, 'Type') > 0) { + $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type')); + } + else { + continue; + } + + if (!empty($value) && + (in_array($subTypesOf, $componentGroupTypes) || + in_array($subTypesOf, $participantExtends) + ) + ) { + $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value); + } + } + + if (empty($gTypes)) { + return FALSE; + } + + // Build String to store group types and group subtypes + $groupTypeString = implode(',', $gTypes); + if (!empty($gTypeValues)) { + $groupTypeString .= CRM_Core_DAO::VALUE_SEPARATOR . implode(',', $gTypeValues); + } + + return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString); + } + +} diff --git a/CRM/Grantapplications/Upgrader.php b/CRM/Grantapplications/Upgrader.php index 64f167f..e1e0ae1 100644 --- a/CRM/Grantapplications/Upgrader.php +++ b/CRM/Grantapplications/Upgrader.php @@ -131,6 +131,27 @@ public static function migrateOnBehalfOfInfo() { return TRUE; } + /** + * Upgrade to add workflow name + * + * @return TRUE on success + * @throws Exception + */ + public function upgrade_4800() { + $this->ctx->log->info('Applying update 4800 | Add workflow name to message template'); + // Get workflow name and id. + $sql = "SELECT ov.id, ov.name + FROM civicrm_option_value ov + INNER JOIN civicrm_option_group og ON og.id = ov.option_group_id + WHERE og.name = 'msg_tpl_workflow_grant'"; + $workflowDetails = CRM_Core_DAO::executeQuery($sql)->fetchAll()[0]; + $sql = "UPDATE civicrm_msg_template + SET workflow_name = %1 + WHERE workflow_id = %2"; + CRM_Core_DAO::executeQuery($sql, [1 => [$workflowDetails['name'], 'String'], 2 => [$workflowDetails['id'], 'Integer']]); + return TRUE; + } + /** * Example: Run a slow upgrade process by breaking it up into smaller chunk diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php index de37871..a42cd9a 100644 --- a/CRM/UF/Page/ProfileEditor.php +++ b/CRM/UF/Page/ProfileEditor.php @@ -54,17 +54,17 @@ public static function registerProfileScripts() { 'profilePreviewKey' => CRM_Core_Key::get('CRM_UF_Form_Inline_Preview', TRUE), ]; }) - ->addScriptFile('civicrm', 'packages/backbone/json2.js', 100, 'html-header', FALSE) - ->addScriptFile('civicrm', 'packages/backbone/backbone.js', 120, 'html-header') - ->addScriptFile('civicrm', 'packages/backbone/backbone.marionette.js', 125, 'html-header', FALSE) - ->addScriptFile('civicrm', 'packages/backbone/backbone.collectionsubset.js', 125, 'html-header', FALSE) - ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/backbone-forms.js', 130, 'html-header', FALSE) - ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE) - ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE) - ->addStyleFile('civicrm', 'packages/backbone-forms/distribution/templates/default.css', 140, 'html-header') + ->addScriptFile('civicrm.packages', 'backbone/json2.js', 100, 'html-header', FALSE) + ->addScriptFile('civicrm.packages', 'backbone/backbone.js', 120, 'html-header') + ->addScriptFile('civicrm.packages', 'backbone/backbone.marionette.js', 125, 'html-header', FALSE) + ->addScriptFile('civicrm.packages', 'backbone/backbone.collectionsubset.js', 125, 'html-header', FALSE) + ->addScriptFile('civicrm.packages', 'backbone-forms/distribution/backbone-forms.js', 130, 'html-header', FALSE) + ->addScriptFile('civicrm.packages', 'backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE) + ->addScriptFile('civicrm.packages', 'backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE) + ->addStyleFile('civicrm.packages', 'backbone-forms/distribution/templates/default.css', 140, 'html-header') ->addScript('CRM.BB = Backbone.noConflict();', 300, 'html-header') - ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE) - ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header') + ->addScriptFile('civicrm.packages', 'jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE) + ->addStyleFile('civicrm.packages', 'jquery/plugins/jstree/themes/default/style.css', 0, 'html-header') ->addStyleFile('civicrm', 'css/crm.designer.css', 140, 'html-header') ->addScriptFile('civicrm', 'js/crm.backbone.js', 150) ->addScriptFile('civicrm', 'js/model/crm.schema-mapped.js', 200) @@ -247,10 +247,10 @@ public static function convertCiviModelToBackboneModel($extends, $title, $availa // schema in format array($fieldName => $fieldSchema) // sections in format array($sectionName => $section) - $result = array( - 'schema' => array(), - 'sections' => array(), - ); + $result = [ + 'schema' => [], + 'sections' => [], + ]; // build field list foreach ($availableFields as $fieldName => $field) { diff --git a/grantapplications.php b/grantapplications.php index 7f79625..c30910e 100644 --- a/grantapplications.php +++ b/grantapplications.php @@ -253,6 +253,11 @@ function grantapplications_civicrm_buildForm($formName, &$form) { $form->setDefaults($defaults); } } + if ($formName == "CRM_Grant_Form_GrantView") { + CRM_Core_Resources::singleton()->addStyle('.crm-info-panel td { + width: 50% !important; + }'); + } } function grantapplications_civicrm_pageRun(&$page) { @@ -588,6 +593,17 @@ function grantapplications_enableDisableNavigationMenu($action) { grantapplications_addRemoveMenu($action); } +function grantapplications_civicrm_alterUFFields(&$fields) { + $fields['Grant'] = CRM_Grant_BAO_Grant::exportableFields(); +} + +function grantapplications_civicrm_post($entity, $op, $id, $object) { + if ($entity === 'UFField' && in_array($op, ['edit', 'create'])) { + $fieldsType = CRM_Grantapplications_BAO_GrantApplicationProfile::calculateGroupType($object->uf_group_id, TRUE); + CRM_Grantapplications_BAO_GrantApplicationProfile::updateGroupTypes($object->uf_group_id, $fieldsType); + } +} + function grantapplications_dashboardActionLinks() { return array( CRM_Core_Action::UPDATE => array( diff --git a/templates/CRM/Grant/Form/Grant/Confirm.tpl b/templates/CRM/Grant/Form/Grant/Confirm.tpl index 35d261a..6792a98 100755 --- a/templates/CRM/Grant/Form/Grant/Confirm.tpl +++ b/templates/CRM/Grant/Form/Grant/Confirm.tpl @@ -89,4 +89,4 @@

{$confirm_footer}

-{include file="CRM/Grant/Form/Grant/File.tpl"} \ No newline at end of file +{include file="CRM/Grant/Form/Grant/File.tpl"} diff --git a/templates/CRM/Grant/Form/Grant/Main.tpl b/templates/CRM/Grant/Form/Grant/Main.tpl index 47f1fd1..f72405b 100755 --- a/templates/CRM/Grant/Form/Grant/Main.tpl +++ b/templates/CRM/Grant/Form/Grant/Main.tpl @@ -37,7 +37,7 @@
{$intro_text}
- {assign var=n value=email} + {assign var=n value=email-Primary}
{$form.$n.label}
@@ -97,9 +97,10 @@ value = value.replace(/[^0-9|,]/g, ''); } else { - value = value.replace(/[^\d|.|,]/g, ''); + value = value.replace(/[^0-9.]/g, ""); } - cj(this).val(value); + value = parseFloat(value).toFixed(2); + cj(this).val(value); } } }); diff --git a/templates/CRM/Grant/Form/Grant/ThankYou.tpl b/templates/CRM/Grant/Form/Grant/ThankYou.tpl index 4702b48..e573246 100755 --- a/templates/CRM/Grant/Form/Grant/ThankYou.tpl +++ b/templates/CRM/Grant/Form/Grant/ThankYou.tpl @@ -84,4 +84,4 @@

-{include file="CRM/Grant/Form/Grant/File.tpl"} \ No newline at end of file +{include file="CRM/Grant/Form/Grant/File.tpl"} diff --git a/templates/CRM/Grant/Page/GrantApplicationDashboard.tpl b/templates/CRM/Grant/Page/GrantApplicationDashboard.tpl index 40fc86e..4ce4e9e 100755 --- a/templates/CRM/Grant/Page/GrantApplicationDashboard.tpl +++ b/templates/CRM/Grant/Page/GrantApplicationDashboard.tpl @@ -24,7 +24,7 @@ +--------------------------------------------------------------------+ *}
-
+

{ts}Manage Grant Application Pages{/ts}

{include file="CRM/common/enableDisableApi.tpl"} {include file="CRM/common/crmeditable.tpl"} @@ -63,4 +63,5 @@ {/foreach} {/if} -
\ No newline at end of file +
+