CRM/Core/BAO/Location.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2014                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  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.   |
  13   |                                                                    |
  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.        |
  18   |                                                                    |
  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   +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class handle creation of location block elements
  38  */
  39 class CRM_Core_BAO_Location extends CRM_Core_DAO {
  40
  41   /**
  42    * Location block element array
  43    */
  44   static $blocks = array('phone', 'email', 'im', 'openid', 'address');
  45
  46   /**
  47    * Create various elements of location block
  48    *
  49    * @param array $params
  50    *   (reference ) an assoc array of name/value pairs.
  51    * @param bool $fixAddress
  52    *   True if you need to fix (format) address values.
  53    *                               before inserting in db
  54    *
  55    * @param null $entity
  56    *
  57    * @return array
  58    * @static
  59    */
  60   public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
  61     $location = array();
  62     if (!self::dataExists($params)) {
  63       return $location;
  64     }
  65
  66     // create location blocks.
  67     foreach (self::$blocks as $block) {
  68       if ($block != 'address') {
  69         $location[$block] = CRM_Core_BAO_Block::create($block, $params, $entity);
  70       }
  71       else {
  72         $location[$block] = CRM_Core_BAO_Address::create($params, $fixAddress, $entity);
  73       }
  74     }
  75
  76     if ($entity) {
  77       // this is a special case for adding values in location block table
  78       $entityElements = array(
  79         'entity_table' => $params['entity_table'],
  80         'entity_id' => $params['entity_id'],
  81       );
  82
  83       $location['id'] = self::createLocBlock($location, $entityElements);
  84     }
  85     else {
  86       // when we come from a form which displays all the location elements (like the edit form or the inline block
  87       // elements, we can skip the below check. The below check adds quite a feq queries to an already overloaded
  88       // form
  89       if (!CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE)) {
  90         // make sure contact should have only one primary block, CRM-5051
  91         self::checkPrimaryBlocks(CRM_Utils_Array::value('contact_id', $params));
  92       }
  93     }
  94
  95     return $location;
  96   }
  97
  98   /**
  99    * Creates the entry in the civicrm_loc_block
 100    */
 101   public static function createLocBlock(&$location, &$entityElements) {
 102     $locId = self::findExisting($entityElements);
 103     $locBlock = array();
 104
 105     if ($locId) {
 106       $locBlock['id'] = $locId;
 107     }
 108
 109     foreach (array(
 110       'phone', 'email', 'im', 'address') as $loc) {
 111       $locBlock["{$loc}_id"] = !empty($location["$loc"][0]) ? $location["$loc"][0]->id : NULL;
 112       $locBlock["{$loc}_2_id"] = !empty($location["$loc"][1]) ? $location["$loc"][1]->id : NULL;
 113     }
 114
 115     $countNull = 0;
 116     foreach ($locBlock as $key => $block) {
 117       if (empty($locBlock[$key])) {
 118         $locBlock[$key] = 'null';
 119         $countNull++;
 120       }
 121     }
 122
 123     if (count($locBlock) == $countNull) {
 124       // implies nothing is set.
 125       return NULL;
 126     }
 127
 128     $locBlockInfo = self::addLocBlock($locBlock);
 129     return $locBlockInfo->id;
 130   }
 131
 132   /**
 133    * Takes an entity array and finds the existing location block
 134    * @static
 135    */
 136   public static function findExisting($entityElements) {
 137     $eid    = $entityElements['entity_id'];
 138     $etable = $entityElements['entity_table'];
 139     $query  = "
 140 SELECT e.loc_block_id as locId
 141 FROM {$etable} e
 142 WHERE e.id = %1";
 143
 144     $params = array(1 => array($eid, 'Integer'));
 145     $dao = CRM_Core_DAO::executeQuery($query, $params);
 146     while ($dao->fetch()) {
 147       $locBlockId = $dao->locId;
 148     }
 149     return $locBlockId;
 150   }
 151
 152   /**
 153    * Takes an associative array and adds location block
 154    *
 155    * @param array $params
 156    *   (reference ) an assoc array of name/value pairs.
 157    *
 158    * @return object
 159    *   CRM_Core_BAO_locBlock object on success, null otherwise
 160    * @static
 161    */
 162   public static function addLocBlock(&$params) {
 163     $locBlock = new CRM_Core_DAO_LocBlock();
 164
 165     $locBlock->copyValues($params);
 166
 167     return $locBlock->save();
 168   }
 169
 170   /**
 171    * Delete the Location Block
 172    *
 173    * @param int $locBlockId
 174    *   Id of the Location Block.
 175    *
 176    * @return void
 177    * @static
 178    */
 179   public static function deleteLocBlock($locBlockId) {
 180     if (!$locBlockId) {
 181       return;
 182     }
 183
 184     $locBlock = new CRM_Core_DAO_LocBlock();
 185     $locBlock->id = $locBlockId;
 186
 187     $locBlock->find(TRUE);
 188
 189     //resolve conflict of having same ids for multiple blocks
 190     $store = array(
 191       'IM_1' => $locBlock->im_id,
 192       'IM_2' => $locBlock->im_2_id,
 193       'Email_1' => $locBlock->email_id,
 194       'Email_2' => $locBlock->email_2_id,
 195       'Phone_1' => $locBlock->phone_id,
 196       'Phone_2' => $locBlock->phone_2_id,
 197       'Address_1' => $locBlock->address_id,
 198       'Address_2' => $locBlock->address_2_id,
 199     );
 200     $locBlock->delete();
 201     foreach ($store as $daoName => $id) {
 202       if ($id) {
 203         $daoName = 'CRM_Core_DAO_' . substr($daoName, 0, -2);
 204         $dao = new $daoName();
 205         $dao->id = $id;
 206         $dao->find(TRUE);
 207         $dao->delete();
 208         $dao->free();
 209       }
 210     }
 211   }
 212
 213   /**
 214    * Check if there is data to create the object
 215    *
 216    * @param array $params
 217    *   (reference ) an assoc array of name/value pairs.
 218    *
 219    * @return boolean
 220    * @static
 221    */
 222   public static function dataExists(&$params) {
 223     // return if no data present
 224     $dataExists = FALSE;
 225     foreach (self::$blocks as $block) {
 226       if (array_key_exists($block, $params)) {
 227         $dataExists = TRUE;
 228         break;
 229       }
 230     }
 231
 232     return $dataExists;
 233   }
 234
 235   /**
 236    * @param $entityBlock
 237    * @param bool $microformat
 238    *
 239    * @return array
 240    *   array of objects(CRM_Core_BAO_Location)
 241    * @static
 242    */
 243   public static function &getValues($entityBlock, $microformat = FALSE) {
 244     if (empty($entityBlock)) {
 245       return NULL;
 246     }
 247     $blocks = array();
 248     $name_map = array(
 249       'im' => 'IM',
 250       'openid' => 'OpenID',
 251     );
 252     $blocks = array();
 253     //get all the blocks for this contact
 254     foreach (self::$blocks as $block) {
 255       if (array_key_exists($block, $name_map)) {
 256         $name = $name_map[$block];
 257       }
 258       else {
 259         $name = ucfirst($block);
 260       }
 261       $baoString = 'CRM_Core_BAO_' . $name;
 262       $blocks[$block] = $baoString::getValues($entityBlock, $microformat);
 263     }
 264     return $blocks;
 265   }
 266
 267   /**
 268    * Delete all the block associated with the location
 269    *
 270    * @param int $contactId
 271    *   Contact id.
 272    * @param int $locationTypeId
 273    *   Id of the location to delete.
 274    *
 275    * @return void
 276    * @static
 277    */
 278   public static function deleteLocationBlocks($contactId, $locationTypeId) {
 279     // ensure that contactId has a value
 280     if (empty($contactId) ||
 281       !CRM_Utils_Rule::positiveInteger($contactId)
 282     ) {
 283       CRM_Core_Error::fatal();
 284     }
 285
 286     if (empty($locationTypeId) ||
 287       !CRM_Utils_Rule::positiveInteger($locationTypeId)
 288     ) {
 289       // so we only delete the blocks which DO NOT have a location type Id
 290       // CRM-3581
 291       $locationTypeId = 'null';
 292     }
 293
 294     static $blocks = array('Address', 'Phone', 'IM', 'OpenID', 'Email');
 295
 296     $params = array('contact_id' => $contactId, 'location_type_id' => $locationTypeId);
 297     foreach ($blocks as $name) {
 298       CRM_Core_BAO_Block::blockDelete($name, $params);
 299     }
 300   }
 301
 302   /**
 303    * Copy or update location block.
 304    *
 305    * @param int $locBlockId
 306    *   Location block id.
 307    * @param int $updateLocBlockId
 308    *   Update location block id.
 309    *
 310    * @return int
 311    *   newly created/updated location block id.
 312    */
 313   public static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) {
 314     //get the location info.
 315     $defaults = $updateValues = array();
 316     $locBlock = array('id' => $locBlockId);
 317     CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_LocBlock', $locBlock, $defaults);
 318
 319     if ($updateLocBlockId) {
 320       //get the location info for update.
 321       $copyLocationParams = array('id' => $updateLocBlockId);
 322       CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_LocBlock', $copyLocationParams, $updateValues);
 323       foreach ($updateValues as $key => $value) {
 324         if ($key != 'id') {
 325           $copyLocationParams[$key] = 'null';
 326         }
 327       }
 328     }
 329
 330     //copy all location blocks (email, phone, address, etc)
 331     foreach ($defaults as $key => $value) {
 332       if ($key != 'id') {
 333         $tbl          = explode("_", $key);
 334         $name         = ucfirst($tbl[0]);
 335         $updateParams = NULL;
 336         if ($updateId = CRM_Utils_Array::value($key, $updateValues)) {
 337           $updateParams = array('id' => $updateId);
 338         }
 339
 340         $copy = CRM_Core_DAO::copyGeneric('CRM_Core_DAO_' . $name, array('id' => $value), $updateParams);
 341         $copyLocationParams[$key] = $copy->id;
 342       }
 343     }
 344
 345     $copyLocation = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_LocBlock',
 346       array('id' => $locBlock['id']),
 347       $copyLocationParams
 348     );
 349     return $copyLocation->id;
 350   }
 351
 352   /**
 353    * If contact has data for any location block, make sure
 354    * contact should have only one primary block, CRM-5051
 355    *
 356    * @param int $contactId
 357    *   Contact id.
 358    *
 359    * @static
 360    */
 361   public static function checkPrimaryBlocks($contactId) {
 362     if (!$contactId) {
 363       return;
 364     }
 365
 366     // get the loc block ids.
 367     $primaryLocBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($contactId, array('is_primary' => 1));
 368     $nonPrimaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($contactId, array('is_primary' => 0));
 369
 370     foreach (array(
 371       'Email', 'IM', 'Phone', 'Address', 'OpenID') as $block) {
 372       $name = strtolower($block);
 373       if (array_key_exists($name, $primaryLocBlockIds) &&
 374         !CRM_Utils_System::isNull($primaryLocBlockIds[$name])
 375       ) {
 376         if (count($primaryLocBlockIds[$name]) > 1) {
 377           // keep only single block as primary.
 378           $primaryId = array_pop($primaryLocBlockIds[$name]);
 379           $resetIds = "(" . implode(',', $primaryLocBlockIds[$name]) . ")";
 380           // reset all primary except one.
 381           CRM_Core_DAO::executeQuery("UPDATE civicrm_$name SET is_primary = 0 WHERE id IN $resetIds");
 382         }
 383       }
 384       elseif (array_key_exists($name, $nonPrimaryBlockIds) &&
 385         !CRM_Utils_System::isNull($nonPrimaryBlockIds[$name])
 386       ) {
 387         // data exists and no primary block - make one primary.
 388         CRM_Core_DAO::setFieldValue("CRM_Core_DAO_" . $block,
 389           array_pop($nonPrimaryBlockIds[$name]), 'is_primary', 1
 390         );
 391       }
 392     }
 393   }
 394
 395   /**
 396    * @param mixed $values
 397    * @param string $valueType
 398    * @param bool $flatten
 399    *
 400    * @return array
 401    */
 402   public static function getChainSelectValues($values, $valueType, $flatten = FALSE) {
 403     if (!$values) {
 404       return array();
 405     }
 406     $values = array_filter((array) $values);
 407     $elements = array();
 408     $list = &$elements;
 409     $method = $valueType == 'country' ? 'stateProvinceForCountry' : 'countyForState';
 410     foreach ($values as $val) {
 411       $result = CRM_Core_PseudoConstant::$method($val);
 412
 413       // Format for quickform
 414       if ($flatten) {
 415         // Option-groups for multiple categories
 416         if ($result && count($values) > 1) {
 417           $elements["crm_optgroup_$val"] = CRM_Core_PseudoConstant::$valueType($val, FALSE);
 418         }
 419         $elements += $result;
 420       }
 421
 422       // Format for js
 423       else {
 424        // Option-groups for multiple categories
 425         if ($result && count($values) > 1) {
 426           $elements[] = array(
 427             'value' => CRM_Core_PseudoConstant::$valueType($val, FALSE),
 428             'children' => array(),
 429           );
 430           $list = & $elements[count($elements) - 1]['children'];
 431         }
 432         foreach ($result as $id => $name) {
 433           $list[] = array(
 434             'value' => $name,
 435             'key' => $id,
 436           );
 437         }
 438       }
 439     }
 440     return $elements;
 441   }
 442 }