3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
34 * add static functions to include some common functionality
35 * used across location sub object BAO classes
38 class CRM_Core_BAO_Block
{
41 * Fields that are required for a valid block.
43 static $requiredBlockFields = array(
44 'email' => array('email'),
45 'phone' => array('phone'),
46 'im' => array('name'),
47 'openid' => array('openid'),
51 * Given the list of params in the params array, fetch the object
52 * and store the values in the values array
54 * @param string $blockName
55 * Name of the above object.
56 * @param array $params
57 * Input parameters to find object.
60 * Array of $block objects.
62 public static function &getValues($blockName, $params) {
66 $BAOString = 'CRM_Core_BAO_' . $blockName;
67 $block = new $BAOString();
70 if (!isset($params['entity_table'])) {
71 $block->contact_id
= $params['contact_id'];
72 if (!$block->contact_id
) {
73 CRM_Core_Error
::fatal();
75 $blocks = self
::retrieveBlock($block, $blockName);
78 $blockIds = self
::getBlockIds($blockName, NULL, $params);
80 if (empty($blockIds)) {
85 foreach ($blockIds as $blockId) {
86 $block = new $BAOString();
87 $block->id
= $blockId['id'];
88 $getBlocks = self
::retrieveBlock($block, $blockName);
89 $blocks[$count++
] = array_pop($getBlocks);
97 * Given the list of params in the params array, fetch the object
98 * and store the values in the values array
100 * @param Object $block
101 * Typically a Phone|Email|IM|OpenID object.
102 * @param string $blockName
103 * Name of the above object.
106 * Array of $block objects.
108 public static function retrieveBlock(&$block, $blockName) {
109 // we first get the primary location due to the order by clause
110 $block->orderBy('is_primary desc, id');
115 while ($block->fetch()) {
116 CRM_Core_DAO
::storeValues($block, $blocks[$count]);
117 //unset is_primary after first block. Due to some bug in earlier version
118 //there might be more than one primary blocks, hence unset is_primary other than first
120 unset($blocks[$count]['is_primary']);
129 * Check if the current block object has any valid data.
131 * @param array $blockFields
132 * Array of fields that are of interest for this object.
133 * @param array $params
134 * Associated array of submitted fields.
137 * true if the block has data, otherwise false
139 public static function dataExists($blockFields, &$params) {
140 foreach ($blockFields as $field) {
141 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value($field, $params))) {
149 * Check if the current block exits.
151 * @param string $blockName
153 * @param array $params
154 * Associated array of submitted fields.
157 * true if the block exits, otherwise false
159 public static function blockExists($blockName, &$params) {
160 // return if no data present
161 if (empty($params[$blockName]) ||
!is_array($params[$blockName])) {
169 * Get all block ids for a contact.
171 * @param string $blockName
173 * @param int $contactId
176 * @param null $entityElements
177 * @param bool $updateBlankLocInfo
180 * formatted array of block ids
183 public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
184 $allBlocks = array();
186 $name = ucfirst($blockName);
187 if ($blockName == 'im') {
190 elseif ($blockName == 'openid') {
194 $baoString = 'CRM_Core_BAO_' . $name;
196 //@todo a cleverer way to do this would be to use the same fn name on each
197 // BAO rather than constructing the fn
198 // it would also be easier to grep for
199 // e.g $bao = new $baoString;
200 // $bao->getAllBlocks()
201 $baoFunction = 'all' . $name . 's';
202 $allBlocks = $baoString::$baoFunction($contactId, $updateBlankLocInfo);
204 elseif (!empty($entityElements) && $blockName != 'openid') {
205 $baoFunction = 'allEntity' . $name . 's';
206 $allBlocks = $baoString::$baoFunction($entityElements);
213 * Takes an associative array and creates a block.
215 * @param string $blockName
217 * @param array $params
218 * (reference ) an assoc array of name/value pairs.
219 * @param null $entity
220 * @param int $contactId
223 * CRM_Core_BAO_Block object on success, null otherwise
225 public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
226 if (!self
::blockExists($blockName, $params)) {
230 $name = ucfirst($blockName);
232 $isPrimary = $isBilling = TRUE;
233 $entityElements = $blocks = array();
236 $entityElements = array(
237 'entity_table' => $params['entity_table'],
238 'entity_id' => $params['entity_id'],
242 $contactId = $params['contact_id'];
245 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
247 //get existsing block ids.
248 $blockIds = self
::getBlockIds($blockName, $contactId, $entityElements, $updateBlankLocInfo);
250 if (!$updateBlankLocInfo) {
251 $resetPrimaryId = NULL;
253 foreach ($params[$blockName] as $count => $value) {
254 $blockId = CRM_Utils_Array
::value('id', $value);
256 if (is_array($blockIds)
257 && array_key_exists($blockId, $blockIds)
259 unset($blockIds[$blockId]);
265 //lets allow to update primary w/ more cleanly.
266 if (!$resetPrimaryId && !empty($value['is_primary'])) {
268 if (is_array($blockIds)) {
269 foreach ($blockIds as $blockId => $blockValue) {
270 if (!empty($blockValue['is_primary'])) {
271 $resetPrimaryId = $blockId;
276 if ($resetPrimaryId) {
277 $baoString = 'CRM_Core_BAO_' . $blockName;
278 $block = new $baoString();
280 $block->selectAdd("id, is_primary");
281 $block->id
= $resetPrimaryId;
282 if ($block->find(TRUE)) {
283 $block->is_primary
= FALSE;
292 foreach ($params[$blockName] as $count => $value) {
293 if (!is_array($value)) {
296 $contactFields = array(
297 'contact_id' => $contactId,
298 'location_type_id' => CRM_Utils_Array
::value('location_type_id', $value),
302 if (empty($value['id']) &&
303 is_array($blockIds) && !empty($blockIds)
305 foreach ($blockIds as $blockId => $blockValue) {
306 if ($updateBlankLocInfo) {
307 if (!empty($blockIds[$count])) {
308 $value['id'] = $blockIds[$count]['id'];
309 unset($blockIds[$count]);
313 if ($blockValue['locationTypeId'] == CRM_Utils_Array
::value('location_type_id', $value)) {
316 if ($blockName == 'phone') {
317 $phoneTypeBlockValue = CRM_Utils_Array
::value('phoneTypeId', $blockValue);
318 if ($phoneTypeBlockValue == CRM_Utils_Array
::value('phone_type_id', $value)) {
322 elseif ($blockName == 'im') {
323 $providerBlockValue = CRM_Utils_Array
::value('providerId', $blockValue);
324 if ($providerBlockValue == $value['provider_id']) {
333 //assigned id as first come first serve basis
334 $value['id'] = $blockValue['id'];
335 if (!$primaryId && !empty($blockValue['is_primary'])) {
336 $value['is_primary'] = $blockValue['is_primary'];
338 unset($blockIds[$blockId]);
346 $dataExits = self
::dataExists(self
::$requiredBlockFields[$blockName], $value);
348 // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
349 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
350 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
351 if (!empty($value['id']) && !$dataExits && $updateBlankLocInfo) {
352 //delete the existing record
353 self
::blockDelete($blockName, array('id' => $value['id']));
356 elseif (!$dataExits) {
360 if ($isPrimary && !empty($value['is_primary'])) {
361 $contactFields['is_primary'] = $value['is_primary'];
365 $contactFields['is_primary'] = 0;
368 if ($isBilling && !empty($value['is_billing'])) {
369 $contactFields['is_billing'] = $value['is_billing'];
373 $contactFields['is_billing'] = 0;
376 $blockFields = array_merge($value, $contactFields);
377 $baoString = 'CRM_Core_BAO_' . $name;
378 $blocks[] = $baoString::add($blockFields);
381 // we need to delete blocks that were deleted during update
382 if ($updateBlankLocInfo && !empty($blockIds)) {
383 foreach ($blockIds as $deleteBlock) {
384 if (empty($deleteBlock['id'])) {
387 self
::blockDelete($blockName, array('id' => $deleteBlock['id']));
397 * @param string $blockName
404 public static function blockDelete($blockName, $params) {
405 $name = ucfirst($blockName);
406 if ($blockName == 'im') {
409 elseif ($blockName == 'openid') {
413 $baoString = 'CRM_Core_DAO_' . $name;
414 $block = new $baoString();
416 $block->copyValues($params);
418 // CRM-11006 add call to pre and post hook for delete action
419 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
421 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
425 * Handling for is_primary.
426 * $params is_primary could be
427 * # 1 - find other entries with is_primary = 1 & reset them to 0
428 * # 0 - make sure at least one entry is set to 1
429 * - if no other entry is 1 change to 1
430 * - if one other entry exists change that to 1
431 * - if more than one other entry exists change first one to 1
432 * @fixme - perhaps should choose by location_type
433 * # empty - same as 0 as once we have checked first step
434 * we know if it should be 1 or 0
436 * if $params['id'] is set $params['contact_id'] may need to be retrieved
438 * @param array $params
441 * @throws API_Exception
443 public static function handlePrimary(&$params, $class) {
444 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
446 throw new API_Exception("Failed to locate table for class [$class]");
449 // contact_id in params might be empty or the string 'null' so cast to integer
450 $contactId = (int) CRM_Utils_Array
::value('contact_id', $params);
451 // If id is set & we haven't been passed a contact_id, retrieve it
452 if (!empty($params['id']) && !isset($params['contact_id'])) {
453 $entity = new $class();
454 $entity->id
= $params['id'];
456 $contactId = $entity->contact_id
;
458 // If entity is not associated with contact, concept of is_primary not relevant
463 // if params is_primary then set all others to not be primary & exit out
464 if (!empty($params['is_primary'])) {
465 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
466 $sqlParams = array(1 => array($contactId, 'Integer'));
467 // we don't want to create unecessary entries in the log_ tables so exclude the one we are working on
468 if (!empty($params['id'])) {
469 $sql .= " AND id <> %2";
470 $sqlParams[2] = array($params['id'], 'Integer');
472 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
476 //Check what other emails exist for the contact
477 $existingEntities = new $class();
478 $existingEntities->contact_id
= $contactId;
479 $existingEntities->orderBy('is_primary DESC');
480 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
481 // ie. if no others is set to be primary then this has to be primary set to 1 so change
482 $params['is_primary'] = 1;
487 * If the only existing email is the one we are editing then we must set
491 if ($existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value('id', $params)) {
492 $params['is_primary'] = 1;
496 if ($existingEntities->is_primary
== 1) {
499 // so at this point we are only dealing with ones explicity setting is_primary to 0
500 // since we have reverse sorted by email we can either set the first one to
501 // primary or return if is already is
502 $existingEntities->is_primary
= 1;
503 $existingEntities->save();
508 * Sort location array so primary element is first.
510 * @param array $locations
512 public static function sortPrimaryFirst(&$locations) {
513 uasort($locations, 'self::primaryComparison');
517 * compare 2 locations to see which should go first based on is_primary
518 * (sort function for sortPrimaryFirst)
519 * @param array $location1
520 * @param array $location2
523 public static function primaryComparison($location1, $location2) {
524 $l1 = CRM_Utils_Array
::value('is_primary', $location1);
525 $l2 = CRM_Utils_Array
::value('is_primary', $location2);
529 return ($l1 < $l2) ?
-1 : 1;