422 lines
13 KiB
PHP
422 lines
13 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class contains functions for individual contact type.
|
||
|
|
*/
|
||
|
|
class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class constructor.
|
||
|
|
*/
|
||
|
|
public function __construct() {
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function is used to format the individual contact values.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* (reference ) an assoc array of name/value pairs.
|
||
|
|
* @param CRM $contact
|
||
|
|
* Contact object.
|
||
|
|
*
|
||
|
|
* @return CRM_Contact_BAO_Contact
|
||
|
|
*/
|
||
|
|
public static function format(&$params, &$contact) {
|
||
|
|
if (!self::dataExists($params)) {
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
// "null" value for example is passed by dedupe merge in order to empty.
|
||
|
|
// Display name computation shouldn't consider such values.
|
||
|
|
foreach (array('first_name', 'middle_name', 'last_name', 'nick_name', 'formal_title', 'birth_date', 'deceased_date') as $displayField) {
|
||
|
|
if (CRM_Utils_Array::value($displayField, $params) == "null") {
|
||
|
|
$params[$displayField] = '';
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$sortName = $displayName = '';
|
||
|
|
$firstName = CRM_Utils_Array::value('first_name', $params, '');
|
||
|
|
$middleName = CRM_Utils_Array::value('middle_name', $params, '');
|
||
|
|
$lastName = CRM_Utils_Array::value('last_name', $params, '');
|
||
|
|
$nickName = CRM_Utils_Array::value('nick_name', $params, '');
|
||
|
|
$prefix_id = CRM_Utils_Array::value('prefix_id', $params, '');
|
||
|
|
$suffix_id = CRM_Utils_Array::value('suffix_id', $params, '');
|
||
|
|
$formalTitle = CRM_Utils_Array::value('formal_title', $params, '');
|
||
|
|
|
||
|
|
// get prefix and suffix names
|
||
|
|
$prefix = $suffix = NULL;
|
||
|
|
if ($prefix_id) {
|
||
|
|
$params['individual_prefix'] = $prefix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'prefix_id', $prefix_id);
|
||
|
|
}
|
||
|
|
if ($suffix_id) {
|
||
|
|
$params['individual_suffix'] = $suffix = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'suffix_id', $suffix_id);
|
||
|
|
}
|
||
|
|
|
||
|
|
$params['is_deceased'] = CRM_Utils_Array::value('is_deceased', $params, FALSE);
|
||
|
|
|
||
|
|
$individual = NULL;
|
||
|
|
if ($contact->id) {
|
||
|
|
$individual = new CRM_Contact_BAO_Contact();
|
||
|
|
$individual->id = $contact->id;
|
||
|
|
if ($individual->find(TRUE)) {
|
||
|
|
|
||
|
|
//lets allow to update single name field though preserveDBName
|
||
|
|
//but if db having null value and params contain value, CRM-4330.
|
||
|
|
$useDBNames = array();
|
||
|
|
|
||
|
|
foreach (array('last', 'middle', 'first', 'nick') as $name) {
|
||
|
|
$dbName = "{$name}_name";
|
||
|
|
$value = $individual->$dbName;
|
||
|
|
|
||
|
|
// the db has name values
|
||
|
|
if ($value && !empty($params['preserveDBName'])) {
|
||
|
|
$useDBNames[] = $name;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach (array('prefix', 'suffix') as $name) {
|
||
|
|
$dbName = "{$name}_id";
|
||
|
|
$value = $individual->$dbName;
|
||
|
|
if ($value && !empty($params['preserveDBName'])) {
|
||
|
|
$useDBNames[] = $name;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($individual->formal_title && !empty($params['preserveDBName'])) {
|
||
|
|
$useDBNames[] = 'formal_title';
|
||
|
|
}
|
||
|
|
|
||
|
|
// CRM-4430
|
||
|
|
//1. preserve db name if want
|
||
|
|
//2. lets get value from param if exists.
|
||
|
|
//3. if not in params, lets get from db.
|
||
|
|
|
||
|
|
foreach (array('last', 'middle', 'first', 'nick') as $name) {
|
||
|
|
$phpName = "{$name}Name";
|
||
|
|
$dbName = "{$name}_name";
|
||
|
|
$value = $individual->$dbName;
|
||
|
|
if (in_array($name, $useDBNames)) {
|
||
|
|
$params[$dbName] = $value;
|
||
|
|
$contact->$dbName = $value;
|
||
|
|
$$phpName = $value;
|
||
|
|
}
|
||
|
|
elseif (array_key_exists($dbName, $params)) {
|
||
|
|
$$phpName = $params[$dbName];
|
||
|
|
}
|
||
|
|
elseif ($value) {
|
||
|
|
$$phpName = $value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach (array('prefix', 'suffix') as $name) {
|
||
|
|
$dbName = "{$name}_id";
|
||
|
|
|
||
|
|
$value = $individual->$dbName;
|
||
|
|
if (in_array($name, $useDBNames)) {
|
||
|
|
$params[$dbName] = $value;
|
||
|
|
$contact->$dbName = $value;
|
||
|
|
if ($value) {
|
||
|
|
$$name = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', $dbName, $value);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$$name = NULL;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
elseif (array_key_exists($dbName, $params)) {
|
||
|
|
// CRM-5278
|
||
|
|
if (!empty($params[$dbName])) {
|
||
|
|
$$name = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', $dbName, $params[$dbName]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
elseif ($value) {
|
||
|
|
$$name = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', $dbName, $value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (in_array('formal_title', $useDBNames)) {
|
||
|
|
$params['formal_title'] = $individual->formal_title;
|
||
|
|
$contact->formal_title = $individual->formal_title;
|
||
|
|
$formalTitle = $individual->formal_title;
|
||
|
|
}
|
||
|
|
elseif (array_key_exists('formal_title', $params)) {
|
||
|
|
$formalTitle = $params['formal_title'];
|
||
|
|
}
|
||
|
|
elseif ($individual->formal_title) {
|
||
|
|
$formalTitle = $individual->formal_title;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//first trim before further processing.
|
||
|
|
foreach (array('lastName', 'firstName', 'middleName') as $fld) {
|
||
|
|
$$fld = trim($$fld);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($lastName || $firstName || $middleName) {
|
||
|
|
// make sure we have values for all the name fields.
|
||
|
|
$formatted = $params;
|
||
|
|
$nameParams = array(
|
||
|
|
'first_name' => $firstName,
|
||
|
|
'middle_name' => $middleName,
|
||
|
|
'last_name' => $lastName,
|
||
|
|
'nick_name' => $nickName,
|
||
|
|
'individual_suffix' => $suffix,
|
||
|
|
'individual_prefix' => $prefix,
|
||
|
|
'prefix_id' => $prefix_id,
|
||
|
|
'suffix_id' => $suffix_id,
|
||
|
|
'formal_title' => $formalTitle,
|
||
|
|
);
|
||
|
|
// make sure we have all the name fields.
|
||
|
|
foreach ($nameParams as $name => $value) {
|
||
|
|
if (empty($formatted[$name]) && $value) {
|
||
|
|
$formatted[$name] = $value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$tokens = array();
|
||
|
|
CRM_Utils_Hook::tokens($tokens);
|
||
|
|
$tokenFields = array();
|
||
|
|
foreach ($tokens as $catTokens) {
|
||
|
|
foreach ($catTokens as $token => $label) {
|
||
|
|
$tokenFields[] = $token;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//build the sort name.
|
||
|
|
$format = Civi::settings()->get('sort_name_format');
|
||
|
|
$sortName = CRM_Utils_Address::format($formatted, $format,
|
||
|
|
FALSE, FALSE, TRUE, $tokenFields
|
||
|
|
);
|
||
|
|
$sortName = trim($sortName);
|
||
|
|
|
||
|
|
//build the display name.
|
||
|
|
$format = Civi::settings()->get('display_name_format');
|
||
|
|
$displayName = CRM_Utils_Address::format($formatted, $format,
|
||
|
|
FALSE, FALSE, TRUE, $tokenFields
|
||
|
|
);
|
||
|
|
$displayName = trim($displayName);
|
||
|
|
}
|
||
|
|
|
||
|
|
//start further check for email.
|
||
|
|
if (empty($sortName) || empty($displayName)) {
|
||
|
|
$email = NULL;
|
||
|
|
if (!empty($params['email']) &&
|
||
|
|
is_array($params['email'])
|
||
|
|
) {
|
||
|
|
foreach ($params['email'] as $emailBlock) {
|
||
|
|
if (isset($emailBlock['is_primary'])) {
|
||
|
|
$email = $emailBlock['email'];
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$uniqId = CRM_Utils_Array::value('user_unique_id', $params);
|
||
|
|
if (!$email && $contact->id) {
|
||
|
|
$email = CRM_Contact_BAO_Contact::getPrimaryEmail($contact->id);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//now set the names.
|
||
|
|
$names = array('displayName' => 'display_name', 'sortName' => 'sort_name');
|
||
|
|
foreach ($names as $value => $name) {
|
||
|
|
if (empty($$value)) {
|
||
|
|
if ($email) {
|
||
|
|
$$value = $email;
|
||
|
|
}
|
||
|
|
elseif ($uniqId) {
|
||
|
|
$$value = $uniqId;
|
||
|
|
}
|
||
|
|
elseif (!empty($params[$name])) {
|
||
|
|
$$value = $params[$name];
|
||
|
|
}
|
||
|
|
// If we have nothing else going on set sort_name to display_name.
|
||
|
|
elseif ($displayName) {
|
||
|
|
$$value = $displayName;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//finally if we could not pass anything lets keep db.
|
||
|
|
if (!empty($$value)) {
|
||
|
|
$contact->$name = $$value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$format = CRM_Utils_Date::getDateFormat('birth');
|
||
|
|
if ($date = CRM_Utils_Array::value('birth_date', $params)) {
|
||
|
|
if (in_array($format, array(
|
||
|
|
'dd-mm',
|
||
|
|
'mm/dd',
|
||
|
|
))) {
|
||
|
|
$separator = '/';
|
||
|
|
if ($format == 'dd-mm') {
|
||
|
|
$separator = '-';
|
||
|
|
}
|
||
|
|
$date = $date . $separator . '1902';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'yy-mm',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'M yy',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'yy',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01-01';
|
||
|
|
}
|
||
|
|
$contact->birth_date = CRM_Utils_Date::processDate($date);
|
||
|
|
}
|
||
|
|
elseif ($contact->birth_date) {
|
||
|
|
$contact->birth_date = CRM_Utils_Date::isoToMysql($contact->birth_date);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($date = CRM_Utils_Array::value('deceased_date', $params)) {
|
||
|
|
if (in_array($format, array(
|
||
|
|
'dd-mm',
|
||
|
|
'mm/dd',
|
||
|
|
))) {
|
||
|
|
$separator = '/';
|
||
|
|
if ($format == 'dd-mm') {
|
||
|
|
$separator = '-';
|
||
|
|
}
|
||
|
|
$date = $date . $separator . '1902';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'yy-mm',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'M yy',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01';
|
||
|
|
}
|
||
|
|
elseif (in_array($format, array(
|
||
|
|
'yy',
|
||
|
|
))) {
|
||
|
|
$date = $date . '-01-01';
|
||
|
|
}
|
||
|
|
|
||
|
|
$contact->deceased_date = CRM_Utils_Date::processDate($date);
|
||
|
|
}
|
||
|
|
elseif ($contact->deceased_date) {
|
||
|
|
$contact->deceased_date = CRM_Utils_Date::isoToMysql($contact->deceased_date);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($middle_name = CRM_Utils_Array::value('middle_name', $params)) {
|
||
|
|
$contact->middle_name = $middle_name;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $contact;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Regenerates display_name for contacts with given prefixes/suffixes.
|
||
|
|
*
|
||
|
|
* @param array $ids
|
||
|
|
* The array with the prefix/suffix id governing which contacts to regenerate.
|
||
|
|
* @param int $action
|
||
|
|
* The action describing whether prefix/suffix was UPDATED or DELETED.
|
||
|
|
*/
|
||
|
|
public static function updateDisplayNames(&$ids, $action) {
|
||
|
|
// get the proper field name (prefix_id or suffix_id) and its value
|
||
|
|
$fieldName = '';
|
||
|
|
foreach ($ids as $key => $value) {
|
||
|
|
switch ($key) {
|
||
|
|
case 'individualPrefix':
|
||
|
|
$fieldName = 'prefix_id';
|
||
|
|
$fieldValue = $value;
|
||
|
|
break 2;
|
||
|
|
|
||
|
|
case 'individualSuffix':
|
||
|
|
$fieldName = 'suffix_id';
|
||
|
|
$fieldValue = $value;
|
||
|
|
break 2;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ($fieldName == '') {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
// query for the affected individuals
|
||
|
|
$fieldValue = CRM_Utils_Type::escape($fieldValue, 'Integer');
|
||
|
|
$contact = new CRM_Contact_BAO_Contact();
|
||
|
|
$contact->$fieldName = $fieldValue;
|
||
|
|
$contact->find();
|
||
|
|
|
||
|
|
// iterate through the affected individuals and rebuild their display_names
|
||
|
|
while ($contact->fetch()) {
|
||
|
|
$contact = new CRM_Contact_BAO_Contact();
|
||
|
|
$contact->id = $contact->contact_id;
|
||
|
|
if ($action == CRM_Core_Action::DELETE) {
|
||
|
|
$contact->$fieldName = 'NULL';
|
||
|
|
$contact->save();
|
||
|
|
}
|
||
|
|
$contact->display_name = $contact->displayName();
|
||
|
|
$contact->save();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates display name.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
* the constructed display name
|
||
|
|
*/
|
||
|
|
public function displayName() {
|
||
|
|
$prefix = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
|
||
|
|
$suffix = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id');
|
||
|
|
return str_replace(' ', ' ', trim($prefix[$this->prefix_id] . ' ' . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name . ' ' . $suffix[$this->suffix_id]));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if there is data to create the object.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function dataExists($params) {
|
||
|
|
if ($params['contact_type'] == 'Individual') {
|
||
|
|
return TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
return FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|