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) {
227 if (!self
::blockExists($blockName, $params)) {
231 // Set up required information / defaults
232 $entityElements = $blocks = array();
233 $resetPrimary = $primarySet = $billingSet = FALSE;
236 $baoString = 'CRM_Core_BAO_' . ucfirst($blockName);
237 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
240 $entityElements = array(
241 'entity_table' => $params['entity_table'],
242 'entity_id' => $params['entity_id'],
246 $contactId = $params['contact_id'];
249 // Get current and submitted values
250 $existingValues = self
::getBlockIds($blockName, $contactId, $entityElements, $updateBlankLocInfo);
251 $submittedValues = $params[$blockName];
253 // For each submitted value
254 foreach ($submittedValues as $count => $submittedValue) {
256 // Set the contact ID
257 $submittedValue['contact_id'] = $contactId;
259 // If this is a primary value, and we haven't unset a primary value yet, and there are values on the contact
260 // Then unset any primary value currently on the Contact
261 if (!empty($submittedValue['is_primary']) && !$resetPrimary && is_array($existingValues)) {
262 foreach ($existingValues as $existingValueId => $existingValue) {
263 if (!empty($existingValue['is_primary'])) {
265 // @todo Can we refactor this?
266 $block = new $baoString();
268 $block->selectAdd("id, is_primary");
269 $block->id
= $existingValue['id'];
270 if ($block->find(TRUE)) {
271 $block->is_primary
= FALSE;
276 // Stop looping since we found a match
277 $resetPrimary = TRUE;
283 // If there is already an ID passed in
284 if (!empty($submittedValue['id'])) {
285 // If the ID already exists on the contact
286 // Then we don't want to match on it later, so unset it
287 if (array_key_exists($submittedValue['id'], $existingValues)) {
288 unset($existingValues[$existingValueId]);
290 // Otherwise it is a new value, so ignore the passed in ID
292 unset($submittedValue['id']);
296 // Otherwise, if there was no ID passed in
297 // Loop through the current values, and find the first match on location type
299 foreach ($existingValues as $existingValueId => $existingValue) {
300 if ($existingValue['locationTypeId'] == $submittedValue['location_type_id']) {
302 // Also require a match on 'type id' for phone and IM blocks
305 if ($blockName == 'phone') {
306 if (CRM_Utils_Array
::value('phoneTypeId', $existingValue) == CRM_Utils_Array
::value('phone_type_id', $submittedValue)) {
310 elseif ($blockName == 'im') {
311 if (CRM_Utils_Array
::value('providerId', $existingValue) == CRM_Utils_Array
::value('provider_id', $submittedValue)) {
319 // If we found a match
322 $submittedValue['id'] = $existingValue['id'];
323 // If the submitted value is not primary, but the matched value is
324 // Then set the submitted value to be primary
325 if (empty($submittedValue['is_primary']) && !empty($existingValue['is_primary'])) {
326 $submittedValue['is_primary'] = 1;
328 // Remove the original value from the array so we don't match on it again
329 unset($existingValues[$existingValueId]);
336 // Check if data exists in the submitted value
337 $dataExists = self
::dataExists(self
::$requiredBlockFields[$blockName], $submittedValue);
342 // "There can be only one" primary / billing block
343 if (!$primarySet && !empty($submittedValue['is_primary'])) {
344 $submittedValue['is_primary'] = 1;
348 $contactFields['is_primary'] = 0;
351 if (!$billingSet && !empty($submittedValue['is_billing'])) {
352 $submittedValue['is_billing'] = 1;
356 $contactFields['is_billing'] = 0;
359 // Add the value to the list of blocks
360 $blocks[] = $baoString::add($submittedValue);
363 // Otherwise, if there is no data, and there is an ID, and we are deleting 'blanked' values
365 elseif (!empty($submittedValue['id']) && $updateBlankLocInfo) {
366 self
::blockDelete($blockName, array('id' => $submittedValue['id']));
369 // Otherwise we ignore it
381 * @param string $blockName
388 public static function blockDelete($blockName, $params) {
389 $name = ucfirst($blockName);
390 if ($blockName == 'im') {
393 elseif ($blockName == 'openid') {
397 $baoString = 'CRM_Core_DAO_' . $name;
398 $block = new $baoString();
400 $block->copyValues($params);
402 // CRM-11006 add call to pre and post hook for delete action
403 CRM_Utils_Hook
::pre('delete', $name, $block->id
, CRM_Core_DAO
::$_nullArray);
405 CRM_Utils_Hook
::post('delete', $name, $block->id
, $block);
409 * Handling for is_primary.
410 * $params is_primary could be
411 * # 1 - find other entries with is_primary = 1 & reset them to 0
412 * # 0 - make sure at least one entry is set to 1
413 * - if no other entry is 1 change to 1
414 * - if one other entry exists change that to 1
415 * - if more than one other entry exists change first one to 1
416 * @fixme - perhaps should choose by location_type
417 * # empty - same as 0 as once we have checked first step
418 * we know if it should be 1 or 0
420 * if $params['id'] is set $params['contact_id'] may need to be retrieved
422 * @param array $params
425 * @throws API_Exception
427 public static function handlePrimary(&$params, $class) {
428 $table = CRM_Core_DAO_AllCoreTables
::getTableForClass($class);
430 throw new API_Exception("Failed to locate table for class [$class]");
433 // contact_id in params might be empty or the string 'null' so cast to integer
434 $contactId = (int) CRM_Utils_Array
::value('contact_id', $params);
435 // If id is set & we haven't been passed a contact_id, retrieve it
436 if (!empty($params['id']) && !isset($params['contact_id'])) {
437 $entity = new $class();
438 $entity->id
= $params['id'];
440 $contactId = $entity->contact_id
;
442 // If entity is not associated with contact, concept of is_primary not relevant
447 // if params is_primary then set all others to not be primary & exit out
448 if (!empty($params['is_primary'])) {
449 $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
450 $sqlParams = array(1 => array($contactId, 'Integer'));
451 // we don't want to create unecessary entries in the log_ tables so exclude the one we are working on
452 if (!empty($params['id'])) {
453 $sql .= " AND id <> %2";
454 $sqlParams[2] = array($params['id'], 'Integer');
456 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
460 //Check what other emails exist for the contact
461 $existingEntities = new $class();
462 $existingEntities->contact_id
= $contactId;
463 $existingEntities->orderBy('is_primary DESC');
464 if (!$existingEntities->find(TRUE) ||
(!empty($params['id']) && $existingEntities->id
== $params['id'])) {
465 // ie. if no others is set to be primary then this has to be primary set to 1 so change
466 $params['is_primary'] = 1;
471 * If the only existing email is the one we are editing then we must set
475 if ($existingEntities->N
== 1 && $existingEntities->id
== CRM_Utils_Array
::value('id', $params)) {
476 $params['is_primary'] = 1;
480 if ($existingEntities->is_primary
== 1) {
483 // so at this point we are only dealing with ones explicity setting is_primary to 0
484 // since we have reverse sorted by email we can either set the first one to
485 // primary or return if is already is
486 $existingEntities->is_primary
= 1;
487 $existingEntities->save();
492 * Sort location array so primary element is first.
494 * @param array $locations
496 public static function sortPrimaryFirst(&$locations) {
497 uasort($locations, 'self::primaryComparison');
501 * compare 2 locations to see which should go first based on is_primary
502 * (sort function for sortPrimaryFirst)
503 * @param array $location1
504 * @param array $location2
507 public static function primaryComparison($location1, $location2) {
508 $l1 = CRM_Utils_Array
::value('is_primary', $location1);
509 $l2 = CRM_Utils_Array
::value('is_primary', $location2);
513 return ($l1 < $l2) ?
-1 : 1;