3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 name of the above object
55 * @param array $params input parameters to find object
57 * @internal param Object $block typically a Phone|Email|IM|OpenID object
58 * @internal param array $values output values of the object
60 * @return array of $block objects.
64 static function &getValues($blockName, $params) {
68 $BAOString = 'CRM_Core_BAO_' . $blockName;
69 $block = new $BAOString( );
72 if (!isset($params['entity_table'])) {
73 $block->contact_id
= $params['contact_id'];
74 if (!$block->contact_id
) {
75 CRM_Core_Error
::fatal();
77 $blocks = self
::retrieveBlock($block, $blockName);
80 $blockIds = self
::getBlockIds($blockName, NULL, $params);
82 if (empty($blockIds)) {
87 foreach ($blockIds as $blockId) {
88 $block = new $BAOString( );
89 $block->id
= $blockId['id'];
90 $getBlocks = self
::retrieveBlock($block, $blockName);
91 $blocks[$count++
] = array_pop($getBlocks);
99 * Given the list of params in the params array, fetch the object
100 * and store the values in the values array
102 * @param Object $block typically a Phone|Email|IM|OpenID object
103 * @param string $blockName name of the above object
105 * @internal param array $values output values of the object
107 * @return array of $block objects.
111 static function retrieveBlock(&$block, $blockName) {
112 // we first get the primary location due to the order by clause
113 $block->orderBy('is_primary desc, id');
118 while ($block->fetch()) {
119 CRM_Core_DAO
::storeValues($block, $blocks[$count]);
120 //unset is_primary after first block. Due to some bug in earlier version
121 //there might be more than one primary blocks, hence unset is_primary other than first
123 unset($blocks[$count]['is_primary']);
132 * check if the current block object has any valid data
134 * @param array $blockFields array of fields that are of interest for this object
135 * @param array $params associated array of submitted fields
137 * @return boolean true if the block has data, otherwise false
141 static function dataExists($blockFields, &$params) {
142 foreach ($blockFields as $field) {
143 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value($field, $params))) {
151 * check if the current block exits
153 * @param string $blockName bloack name
154 * @param array $params associated array of submitted fields
156 * @return boolean true if the block exits, otherwise false
160 static function blockExists($blockName, &$params) {
161 // return if no data present
162 if (empty($params[$blockName]) ||
!is_array($params[$blockName])) {
170 * Function to get all block ids for a contact
172 * @param string $blockName block name
173 * @param int $contactId contact id
175 * @param null $entityElements
176 * @param bool $updateBlankLocInfo
178 * @return array $contactBlockIds formatted array of block ids
183 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 block name
216 * @param array $params (reference ) an assoc array of name/value pairs
217 * @param null $entity
218 * @param null $contactId
220 * @internal param array $requiredFields fields that's are required in a block
222 * @return object CRM_Core_BAO_Block object on success, null otherwise
226 static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
227 if (!self
::blockExists($blockName, $params)) {
231 $name = ucfirst($blockName);
233 $isPrimary = $isBilling = TRUE;
234 $entityElements = $blocks = array();
237 $entityElements = array(
238 'entity_table' => $params['entity_table'],
239 'entity_id' => $params['entity_id'],
243 $contactId = $params['contact_id'];
246 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
248 //get existsing block ids.
249 $blockIds = self
::getBlockIds($blockName, $contactId, $entityElements, $updateBlankLocInfo);
251 if (!$updateBlankLocInfo) {
252 $resetPrimaryId = NULL;
254 foreach ($params[$blockName] as $count => $value) {
255 $blockId = CRM_Utils_Array
::value('id', $value);
257 if (is_array($blockIds)
258 && array_key_exists($blockId, $blockIds)
260 unset($blockIds[$blockId]);
266 //lets allow to update primary w/ more cleanly.
267 if (!$resetPrimaryId && !empty($value['is_primary'])) {
269 if (is_array($blockIds)) {
270 foreach ($blockIds as $blockId => $blockValue) {
271 if (!empty($blockValue['is_primary'])) {
272 $resetPrimaryId = $blockId;
277 if ($resetPrimaryId) {
278 $baoString = 'CRM_Core_BAO_' . $blockName;
279 $block = new $baoString( );
281 $block->selectAdd("id, is_primary");
282 $block->id
= $resetPrimaryId;
283 if ($block->find(TRUE)) {
284 $block->is_primary
= FALSE;
293 foreach ($params[$blockName] as $count => $value) {
294 if (!is_array($value)) {
297 $contactFields = array(
298 'contact_id' => $contactId,
299 'location_type_id' => CRM_Utils_Array
::value('location_type_id', $value),
303 if (empty($value['id']) &&
304 is_array($blockIds) && !empty($blockIds)
306 foreach ($blockIds as $blockId => $blockValue) {
307 if ($updateBlankLocInfo) {
308 if (!empty($blockIds[$count])) {
309 $value['id'] = $blockIds[$count]['id'];
310 unset($blockIds[$count]);
314 if ($blockValue['locationTypeId'] == CRM_Utils_Array
::value('location_type_id', $value)) {
317 if ($blockName == 'phone') {
318 $phoneTypeBlockValue = CRM_Utils_Array
::value('phoneTypeId', $blockValue);
319 if ($phoneTypeBlockValue == CRM_Utils_Array
::value('phone_type_id', $value)) {
323 elseif ($blockName == 'im') {
324 $providerBlockValue = CRM_Utils_Array
::value('providerId', $blockValue);
325 if ($providerBlockValue == $value['provider_id']) {
334 //assigned id as first come first serve basis
335 $value['id'] = $blockValue['id'];
336 if (!$primaryId && !empty($blockValue['is_primary'])) {
337 $value['is_primary'] = $blockValue['is_primary'];
339 unset($blockIds[$blockId]);
347 $dataExits = self
::dataExists(self
::$requiredBlockFields[$blockName], $value);
349 // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
350 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
351 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
352 if (!empty($value['id']) && !$dataExits && $updateBlankLocInfo) {
353 //delete the existing record
354 self
::blockDelete($blockName, array('id' => $value['id']));
357 elseif (!$dataExits) {
361 if ($isPrimary && !empty($value['is_primary'])) {
362 $contactFields['is_primary'] = $value['is_primary'];
366 $contactFields['is_primary'] = 0;
369 if ($isBilling && !empty($value['is_billing'])) {
370 $contactFields['is_billing'] = $value['is_billing'];
374 $contactFields['is_billing'] = 0;
377 $blockFields = array_merge($value, $contactFields);
378 $baoString = 'CRM_Core_BAO_' . $name;
379 $blocks[] = $baoString::add( $blockFields );
382 // we need to delete blocks that were deleted during update
383 if ($updateBlankLocInfo && !empty($blockIds)) {
384 foreach ($blockIds as $deleteBlock) {
385 if (empty($deleteBlock['id'])) {
388 self
::blockDelete($blockName, array('id' => $deleteBlock['id']));
396 * Function to delete block
398 * @param string $blockName block name
399 * @param int $params associates array
404 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
420 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
422 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
426 * Handling for is_primary.
427 * $params is_primary could be
428 * # 1 - find other entries with is_primary = 1 & reset them to 0
429 * # 0 - make sure at least one entry is set to 1
430 * - if no other entry is 1 change to 1
431 * - if one other entry exists change that to 1
432 * - if more than one other entry exists change first one to 1
433 * @fixme - perhaps should choose by location_type
434 * # empty - same as 0 as once we have checked first step
435 * we know if it should be 1 or 0
437 * if $params['id'] is set $params['contact_id'] may need to be retrieved
439 * @param array $params
442 * @throws API_Exception
445 public static function handlePrimary(&$params, $class) {
446 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
448 throw new API_Exception("Failed to locate table for class [$class]");
451 // contact_id in params might be empty or the string 'null' so cast to integer
452 $contactId = (int) CRM_Utils_Array
::value('contact_id', $params);
453 // If id is set & we haven't been passed a contact_id, retrieve it
454 if (!empty($params['id']) && !isset($params['contact_id'])) {
455 $entity = new $class();
456 $entity->id
= $params['id'];
458 $contactId = $entity->contact_id
;
460 // If entity is not associated with contact, concept of is_primary not relevant
465 // if params is_primary then set all others to not be primary & exit out
466 if (!empty($params['is_primary'])) {
467 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
468 $sqlParams = array(1 => array($contactId, 'Integer'));
469 // we don't want to create unecessary entries in the log_ tables so exclude the one we are working on
470 if(!empty($params['id'])){
471 $sql .= " AND id <> %2";
472 $sqlParams[2] = array($params['id'], 'Integer');
474 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
478 //Check what other emails exist for the contact
479 $existingEntities = new $class();
480 $existingEntities->contact_id
= $contactId;
481 $existingEntities->orderBy('is_primary DESC');
482 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
483 // ie. if no others is set to be primary then this has to be primary set to 1 so change
484 $params['is_primary'] = 1;
489 * If the only existing email is the one we are editing then we must set
493 if ( $existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value( 'id', $params ) ) {
494 $params['is_primary'] = 1;
498 if ($existingEntities->is_primary
== 1) {
501 // so at this point we are only dealing with ones explicity setting is_primary to 0
502 // since we have reverse sorted by email we can either set the first one to
503 // primary or return if is already is
504 $existingEntities->is_primary
= 1;
505 $existingEntities->save();
510 * Sort location array so primary element is first
514 * @internal param Array $location
516 static function sortPrimaryFirst(&$locations){
517 uasort($locations, 'self::primaryComparison');
521 * compare 2 locations to see which should go first based on is_primary
522 * (sort function for sortPrimaryFirst)
523 * @param array $location1
524 * @param array_type $location2
527 static function primaryComparison($location1, $location2){
528 $l1 = CRM_Utils_Array
::value('is_primary', $location1);
529 $l2 = CRM_Utils_Array
::value('is_primary', $location2);
533 return ($l1 < $l2) ?
-1 : 1;