3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 Object $block typically a Phone|Email|IM|OpenID object
55 * @param string $blockName name of the above object
56 * @param array $params input parameters to find object
57 * @param array $values output values of the object
59 * @return array of $block objects.
63 static function &getValues($blockName, $params) {
67 $BAOString = 'CRM_Core_BAO_' . $blockName;
68 $block = new $BAOString( );
71 if (!isset($params['entity_table'])) {
72 $block->contact_id
= $params['contact_id'];
73 if (!$block->contact_id
) {
74 CRM_Core_Error
::fatal();
76 $blocks = self
::retrieveBlock($block, $blockName);
79 $blockIds = self
::getBlockIds($blockName, NULL, $params);
81 if (empty($blockIds)) {
86 foreach ($blockIds as $blockId) {
87 $block = new $BAOString( );
88 $block->id
= $blockId['id'];
89 $getBlocks = self
::retrieveBlock($block, $blockName);
90 $blocks[$count++
] = array_pop($getBlocks);
98 * Given the list of params in the params array, fetch the object
99 * and store the values in the values array
101 * @param Object $block typically a Phone|Email|IM|OpenID object
102 * @param string $blockName name of the above object
103 * @param array $values output values of the object
105 * @return array of $block objects.
109 static function retrieveBlock(&$block, $blockName) {
110 // we first get the primary location due to the order by clause
111 $block->orderBy('is_primary desc, id');
116 while ($block->fetch()) {
117 CRM_Core_DAO
::storeValues($block, $blocks[$count]);
118 //unset is_primary after first block. Due to some bug in earlier version
119 //there might be more than one primary blocks, hence unset is_primary other than first
121 unset($blocks[$count]['is_primary']);
130 * check if the current block object has any valid data
132 * @param array $blockFields array of fields that are of interest for this object
133 * @param array $params associated array of submitted fields
135 * @return boolean true if the block has data, otherwise false
139 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 bloack name
152 * @param array $params associated array of submitted fields
154 * @return boolean true if the block exits, otherwise false
158 static function blockExists($blockName, &$params) {
159 // return if no data present
160 if (empty($params[$blockName]) ||
!is_array($params[$blockName])) {
168 * Function to get all block ids for a contact
170 * @param string $blockName block name
171 * @param int $contactId contact id
173 * @return array $contactBlockIds formatted array of block ids
178 static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
179 $allBlocks = array();
181 $name = ucfirst($blockName);
182 if ($blockName == 'im') {
185 elseif ($blockName == 'openid') {
189 $baoString = 'CRM_Core_BAO_' . $name;
191 //@todo a cleverer way to do this would be to use the same fn name on each
192 // BAO rather than constructing the fn
193 // it would also be easier to grep for
194 // e.g $bao = new $baoString;
195 // $bao->getAllBlocks()
196 $baoFunction = 'all' . $name . 's';
197 $allBlocks = $baoString::$baoFunction( $contactId, $updateBlankLocInfo );
199 elseif (!empty($entityElements) && $blockName != 'openid') {
200 $baoFunction = 'allEntity' . $name . 's';
201 $allBlocks = $baoString::$baoFunction( $entityElements );
208 * takes an associative array and creates a block
210 * @param string $blockName block name
211 * @param array $params (reference ) an assoc array of name/value pairs
212 * @param array $requiredFields fields that's are required in a block
214 * @return object CRM_Core_BAO_Block object on success, null otherwise
218 static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
219 if (!self
::blockExists($blockName, $params)) {
223 $name = ucfirst($blockName);
225 $isPrimary = $isBilling = TRUE;
226 $entityElements = $blocks = array();
229 $entityElements = array(
230 'entity_table' => $params['entity_table'],
231 'entity_id' => $params['entity_id'],
235 $contactId = $params['contact_id'];
238 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
240 //get existsing block ids.
241 $blockIds = self
::getBlockIds($blockName, $contactId, $entityElements, $updateBlankLocInfo);
243 if (!$updateBlankLocInfo) {
244 $resetPrimaryId = NULL;
246 foreach ($params[$blockName] as $count => $value) {
247 $blockId = CRM_Utils_Array
::value('id', $value);
249 if (is_array($blockIds)
250 && array_key_exists($blockId, $blockIds)
252 unset($blockIds[$blockId]);
258 //lets allow to update primary w/ more cleanly.
259 if (!$resetPrimaryId && !empty($value['is_primary'])) {
261 if (is_array($blockIds)) {
262 foreach ($blockIds as $blockId => $blockValue) {
263 if (!empty($blockValue['is_primary'])) {
264 $resetPrimaryId = $blockId;
269 if ($resetPrimaryId) {
270 $baoString = 'CRM_Core_BAO_' . $blockName;
271 $block = new $baoString( );
273 $block->selectAdd("id, is_primary");
274 $block->id
= $resetPrimaryId;
275 if ($block->find(TRUE)) {
276 $block->is_primary
= FALSE;
285 foreach ($params[$blockName] as $count => $value) {
286 if (!is_array($value)) {
289 $contactFields = array(
290 'contact_id' => $contactId,
291 'location_type_id' => CRM_Utils_Array
::value('location_type_id', $value),
295 if (empty($value['id']) &&
296 is_array($blockIds) && !empty($blockIds)
298 foreach ($blockIds as $blockId => $blockValue) {
299 if ($updateBlankLocInfo) {
300 if (!empty($blockIds[$count])) {
301 $value['id'] = $blockIds[$count]['id'];
302 unset($blockIds[$count]);
306 if ($blockValue['locationTypeId'] == CRM_Utils_Array
::value('location_type_id', $value)) {
309 if ($blockName == 'phone') {
310 $phoneTypeBlockValue = CRM_Utils_Array
::value('phoneTypeId', $blockValue);
311 if ($phoneTypeBlockValue == CRM_Utils_Array
::value('phone_type_id', $value)) {
315 elseif ($blockName == 'im') {
316 $providerBlockValue = CRM_Utils_Array
::value('providerId', $blockValue);
317 if ($providerBlockValue == $value['provider_id']) {
326 //assigned id as first come first serve basis
327 $value['id'] = $blockValue['id'];
328 if (!$primaryId && !empty($blockValue['is_primary'])) {
329 $value['is_primary'] = $blockValue['is_primary'];
331 unset($blockIds[$blockId]);
339 $dataExits = self
::dataExists(self
::$requiredBlockFields[$blockName], $value);
341 // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
342 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
343 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
344 if (!empty($value['id']) && !$dataExits && $updateBlankLocInfo) {
345 //delete the existing record
346 self
::blockDelete($blockName, array('id' => $value['id']));
349 elseif (!$dataExits) {
353 if ($isPrimary && !empty($value['is_primary'])) {
354 $contactFields['is_primary'] = $value['is_primary'];
358 $contactFields['is_primary'] = 0;
361 if ($isBilling && !empty($value['is_billing'])) {
362 $contactFields['is_billing'] = $value['is_billing'];
366 $contactFields['is_billing'] = 0;
369 $blockFields = array_merge($value, $contactFields);
370 $baoString = 'CRM_Core_BAO_' . $name;
371 $blocks[] = $baoString::add( $blockFields );
374 // we need to delete blocks that were deleted during update
375 if ($updateBlankLocInfo && !empty($blockIds)) {
376 foreach ($blockIds as $deleteBlock) {
377 if (empty($deleteBlock['id'])) {
380 self
::blockDelete($blockName, array('id' => $deleteBlock['id']));
388 * Function to delete block
390 * @param string $blockName block name
391 * @param int $params associates array
396 static function blockDelete($blockName, $params) {
397 $name = ucfirst($blockName);
398 if ($blockName == 'im') {
401 elseif ($blockName == 'openid') {
405 $baoString = 'CRM_Core_DAO_' . $name;
406 $block = new $baoString( );
408 $block->copyValues($params);
410 * CRM-11006 add call to pre and post hook for delete action
412 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
414 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
418 * Handling for is_primary.
419 * $params is_primary could be
420 * # 1 - find other entries with is_primary = 1 & reset them to 0
421 * # 0 - make sure at least one entry is set to 1
422 * - if no other entry is 1 change to 1
423 * - if one other entry exists change that to 1
424 * - if more than one other entry exists change first one to 1
425 * @fixme - perhaps should choose by location_type
426 * # empty - same as 0 as once we have checked first step
427 * we know if it should be 1 or 0
429 * if $params['id'] is set $params['contact_id'] may need to be retrieved
431 * @param array $params
434 public static function handlePrimary(&$params, $class) {
435 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
437 throw new API_Exception("Failed to locate table for class [$class]");
440 // contact_id in params might be empty or the string 'null' so cast to integer
441 $contactId = (int) CRM_Utils_Array
::value('contact_id', $params);
442 // If id is set & we haven't been passed a contact_id, retrieve it
443 if (!empty($params['id']) && !isset($params['contact_id'])) {
444 $entity = new $class();
445 $entity->id
= $params['id'];
447 $contactId = $entity->contact_id
;
449 // If entity is not associated with contact, concept of is_primary not relevant
454 // if params is_primary then set all others to not be primary & exit out
455 if (!empty($params['is_primary'])) {
456 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
457 $sqlParams = array(1 => array($contactId, 'Integer'));
458 // we don't want to create unecessary entries in the log_ tables so exclude the one we are working on
459 if(!empty($params['id'])){
460 $sql .= " AND id <> %2";
461 $sqlParams[2] = array($params['id'], 'Integer');
463 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
467 //Check what other emails exist for the contact
468 $existingEntities = new $class();
469 $existingEntities->contact_id
= $contactId;
470 $existingEntities->orderBy('is_primary DESC');
471 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
472 // ie. if no others is set to be primary then this has to be primary set to 1 so change
473 $params['is_primary'] = 1;
478 * If the only existing email is the one we are editing then we must set
482 if ( $existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value( 'id', $params ) ) {
483 $params['is_primary'] = 1;
487 if ($existingEntities->is_primary
== 1) {
490 // so at this point we are only dealing with ones explicity setting is_primary to 0
491 // since we have reverse sorted by email we can either set the first one to
492 // primary or return if is already is
493 $existingEntities->is_primary
= 1;
494 $existingEntities->save();
499 * Sort location array so primary element is first
500 * @param Array $location
502 static function sortPrimaryFirst(&$locations){
503 uasort($locations, 'self::primaryComparison');
507 * compare 2 locations to see which should go first based on is_primary
508 * (sort function for sortPrimaryFirst)
509 * @param array $location1
510 * @param array_type $location2
513 static function primaryComparison($location1, $location2){
514 $l1 = CRM_Utils_Array
::value('is_primary', $location1);
515 $l2 = CRM_Utils_Array
::value('is_primary', $location2);
519 return ($l1 < $l2) ?
-1 : 1;