3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Class contains functions for individual contact type.
21 class CRM_Contact_BAO_Individual
extends CRM_Contact_DAO_Contact
{
26 public function __construct() {
30 * Function is used to format the individual contact values.
32 * @param array $params
33 * (reference ) an assoc array of name/value pairs.
34 * @param CRM_Contact_BAO_Contact $contact
37 * @return CRM_Contact_BAO_Contact
39 public static function format(&$params, &$contact) {
40 if (!self
::dataExists($params)) {
44 // "null" value for example is passed by dedupe merge in order to empty.
45 // Display name computation shouldn't consider such values.
46 foreach (['first_name', 'middle_name', 'last_name', 'nick_name', 'formal_title', 'birth_date', 'deceased_date'] as $displayField) {
47 if (CRM_Utils_Array
::value($displayField, $params) == "null") {
48 $params[$displayField] = '';
52 $sortName = $displayName = '';
53 $firstName = trim($params['first_name'] ??
'');
54 $middleName = trim($params['middle_name'] ??
'');
55 $lastName = trim($params['last_name'] ??
'');
56 $nickName = CRM_Utils_Array
::value('nick_name', $params, '');
57 $prefix_id = CRM_Utils_Array
::value('prefix_id', $params, '');
58 $suffix_id = CRM_Utils_Array
::value('suffix_id', $params, '');
59 $formalTitle = CRM_Utils_Array
::value('formal_title', $params, '');
61 // get prefix and suffix names
62 $prefix = $suffix = NULL;
64 $params['individual_prefix'] = $prefix = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'prefix_id', $prefix_id);
67 $params['individual_suffix'] = $suffix = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'suffix_id', $suffix_id);
70 $params['is_deceased'] = CRM_Utils_Array
::value('is_deceased', $params, FALSE);
74 $individual = new CRM_Contact_BAO_Contact();
75 $individual->id
= $contact->id
;
76 if ($individual->find(TRUE)) {
78 //lets allow to update single name field though preserveDBName
79 //but if db having null value and params contain value, CRM-4330.
82 foreach (['last', 'middle', 'first', 'nick'] as $name) {
83 $dbName = "{$name}_name";
84 $value = $individual->$dbName;
86 // the db has name values
87 if ($value && !empty($params['preserveDBName'])) {
88 $useDBNames[] = $name;
92 foreach (['prefix', 'suffix'] as $name) {
93 $dbName = "{$name}_id";
94 $value = $individual->$dbName;
95 if ($value && !empty($params['preserveDBName'])) {
96 $useDBNames[] = $name;
100 if ($individual->formal_title
&& !empty($params['preserveDBName'])) {
101 $useDBNames[] = 'formal_title';
105 //1. preserve db name if want
106 //2. lets get value from param if exists.
107 //3. if not in params, lets get from db.
109 foreach (['last', 'middle', 'first', 'nick'] as $name) {
110 $phpName = "{$name}Name";
111 $dbName = "{$name}_name";
112 $value = $individual->$dbName;
113 if (in_array($name, $useDBNames)) {
114 $params[$dbName] = $value;
115 $contact->$dbName = $value;
118 elseif (array_key_exists($dbName, $params)) {
119 $
$phpName = $params[$dbName];
126 foreach (['prefix', 'suffix'] as $name) {
127 $dbName = "{$name}_id";
129 $value = $individual->$dbName;
130 if (in_array($name, $useDBNames)) {
131 $params[$dbName] = $value;
132 $contact->$dbName = $value;
134 $
$name = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $dbName, $value);
140 elseif (array_key_exists($dbName, $params)) {
142 if (!empty($params[$dbName])) {
143 $
$name = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $dbName, $params[$dbName]);
147 $
$name = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', $dbName, $value);
151 if (in_array('formal_title', $useDBNames)) {
152 $params['formal_title'] = $individual->formal_title
;
153 $contact->formal_title
= $individual->formal_title
;
154 $formalTitle = $individual->formal_title
;
156 elseif (array_key_exists('formal_title', $params)) {
157 $formalTitle = $params['formal_title'];
159 elseif ($individual->formal_title
) {
160 $formalTitle = $individual->formal_title
;
165 if ($lastName ||
$firstName ||
$middleName) {
166 // make sure we have values for all the name fields.
167 $formatted = $params;
169 'first_name' => $firstName,
170 'middle_name' => $middleName,
171 'last_name' => $lastName,
172 'nick_name' => $nickName,
173 'individual_suffix' => $suffix,
174 'individual_prefix' => $prefix,
175 'prefix_id' => $prefix_id,
176 'suffix_id' => $suffix_id,
177 'formal_title' => $formalTitle,
179 // make sure we have all the name fields.
180 foreach ($nameParams as $name => $value) {
181 if (empty($formatted[$name]) && $value) {
182 $formatted[$name] = $value;
187 CRM_Utils_Hook
::tokens($tokens);
189 foreach ($tokens as $catTokens) {
190 foreach ($catTokens as $token => $label) {
191 $tokenFields[] = $token;
195 //build the sort name.
196 $format = Civi
::settings()->get('sort_name_format');
197 $sortName = CRM_Utils_Address
::format($formatted, $format,
198 FALSE, FALSE, $tokenFields
200 $sortName = trim($sortName);
202 //build the display name.
203 $format = Civi
::settings()->get('display_name_format');
204 $displayName = CRM_Utils_Address
::format($formatted, $format,
205 FALSE, FALSE, $tokenFields
207 $displayName = trim($displayName);
210 //start further check for email.
211 if (empty($sortName) ||
empty($displayName)) {
213 if (!empty($params['email']) &&
214 is_array($params['email'])
216 foreach ($params['email'] as $emailBlock) {
217 if (isset($emailBlock['is_primary'])) {
218 $email = $emailBlock['email'];
223 $uniqId = $params['user_unique_id'] ??
NULL;
224 if (!$email && $contact->id
) {
225 $email = CRM_Contact_BAO_Contact
::getPrimaryEmail($contact->id
);
230 $names = ['displayName' => 'display_name', 'sortName' => 'sort_name'];
231 foreach ($names as $value => $name) {
232 if (empty($
$value)) {
239 elseif (!empty($params[$name])) {
240 $
$value = $params[$name];
242 // If we have nothing else going on set sort_name to display_name.
243 elseif ($displayName) {
244 $
$value = $displayName;
247 //finally if we could not pass anything lets keep db.
248 if (!empty($
$value)) {
249 $contact->$name = $
$value;
253 $format = CRM_Utils_Date
::getDateFormat('birth');
254 if ($date = CRM_Utils_Array
::value('birth_date', $params)) {
255 if (in_array($format, [
260 if ($format == 'dd-mm') {
263 $date = $date . $separator . '1902';
265 elseif (in_array($format, [
268 $date = $date . '-01';
270 elseif (in_array($format, [
273 $date = $date . '-01';
275 elseif (in_array($format, [
278 $date = $date . '-01-01';
280 $contact->birth_date
= CRM_Utils_Date
::processDate($date);
282 elseif ($contact->birth_date
) {
283 $contact->birth_date
= CRM_Utils_Date
::isoToMysql($contact->birth_date
);
286 if ($date = CRM_Utils_Array
::value('deceased_date', $params)) {
287 if (in_array($format, [
292 if ($format == 'dd-mm') {
295 $date = $date . $separator . '1902';
297 elseif (in_array($format, [
300 $date = $date . '-01';
302 elseif (in_array($format, [
305 $date = $date . '-01';
307 elseif (in_array($format, [
310 $date = $date . '-01-01';
313 $contact->deceased_date
= CRM_Utils_Date
::processDate($date);
315 elseif ($contact->deceased_date
) {
316 $contact->deceased_date
= CRM_Utils_Date
::isoToMysql($contact->deceased_date
);
319 if ($middle_name = CRM_Utils_Array
::value('middle_name', $params)) {
320 $contact->middle_name
= $middle_name;
327 * Regenerates display_name for contacts with given prefixes/suffixes.
330 * The array with the prefix/suffix id governing which contacts to regenerate.
332 * The action describing whether prefix/suffix was UPDATED or DELETED.
334 public static function updateDisplayNames(&$ids, $action) {
335 // get the proper field name (prefix_id or suffix_id) and its value
337 foreach ($ids as $key => $value) {
339 case 'individualPrefix':
340 $fieldName = 'prefix_id';
341 $fieldValue = $value;
344 case 'individualSuffix':
345 $fieldName = 'suffix_id';
346 $fieldValue = $value;
350 if ($fieldName == '') {
354 // query for the affected individuals
355 $fieldValue = CRM_Utils_Type
::escape($fieldValue, 'Integer');
356 $contact = new CRM_Contact_BAO_Contact();
357 $contact->$fieldName = $fieldValue;
360 // iterate through the affected individuals and rebuild their display_names
361 while ($contact->fetch()) {
362 $contact = new CRM_Contact_BAO_Contact();
363 $contact->id
= $contact->contact_id
;
364 if ($action == CRM_Core_Action
::DELETE
) {
365 $contact->$fieldName = 'NULL';
368 $contact->display_name
= $contact->displayName();
374 * Creates display name.
377 * the constructed display name
379 public function displayName() {
380 $prefix = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id');
381 $suffix = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id');
382 return str_replace(' ', ' ', trim($prefix[$this->prefix_id
] . ' ' . $this->first_name
. ' ' . $this->middle_name
. ' ' . $this->last_name
. ' ' . $suffix[$this->suffix_id
]));
386 * Check if there is data to create the object.
388 * @param array $params
392 public static function dataExists($params) {
393 if ($params['contact_type'] == 'Individual') {