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
37 * This class handle creation of location block elements
39 class CRM_Core_BAO_Location
extends CRM_Core_DAO
{
42 * Location block element array
44 static $blocks = array('phone', 'email', 'im', 'openid', 'address');
47 * Function to create various elements of location block
49 * @param array $params (reference ) an assoc array of name/value pairs
50 * @param boolean $fixAddress true if you need to fix (format) address values
51 * before inserting in db
55 * @return array $location
59 static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
61 if (!self
::dataExists($params)) {
65 // create location blocks.
66 foreach (self
::$blocks as $block) {
67 if ($block != 'address') {
68 $location[$block] = CRM_Core_BAO_Block
::create( $block, $params, $entity );
71 $location[$block] = CRM_Core_BAO_Address
::create($params, $fixAddress, $entity);
76 // this is a special case for adding values in location block table
77 $entityElements = array(
78 'entity_table' => $params['entity_table'],
79 'entity_id' => $params['entity_id'],
82 $location['id'] = self
::createLocBlock($location, $entityElements);
85 // when we come from a form which displays all the location elements (like the edit form or the inline block
86 // elements, we can skip the below check. The below check adds quite a feq queries to an already overloaded
88 if (!CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE)) {
89 // make sure contact should have only one primary block, CRM-5051
90 self
::checkPrimaryBlocks(CRM_Utils_Array
::value('contact_id', $params));
98 * Creates the entry in the civicrm_loc_block
101 static function createLocBlock(&$location, &$entityElements) {
102 $locId = self
::findExisting($entityElements);
106 $locBlock['id'] = $locId;
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;
116 foreach ($locBlock as $key => $block) {
117 if (empty($locBlock[$key])) {
118 $locBlock[$key] = 'null';
123 if (count($locBlock) == $countNull) {
124 // implies nothing is set.
128 $locBlockInfo = self
::addLocBlock($locBlock);
129 return $locBlockInfo->id
;
133 * takes an entity array and finds the existing location block
137 static function findExisting($entityElements) {
138 $eid = $entityElements['entity_id'];
139 $etable = $entityElements['entity_table'];
141 SELECT e.loc_block_id as locId
145 $params = array(1 => array($eid, 'Integer'));
146 $dao = CRM_Core_DAO
::executeQuery($query, $params);
147 while ($dao->fetch()) {
148 $locBlockId = $dao->locId
;
154 * takes an associative array and adds location block
156 * @param array $params (reference ) an assoc array of name/value pairs
158 * @return object CRM_Core_BAO_locBlock object on success, null otherwise
162 static function addLocBlock(&$params) {
163 $locBlock = new CRM_Core_DAO_LocBlock();
165 $locBlock->copyValues($params);
167 return $locBlock->save();
171 * This function deletes the Location Block
173 * @param int $locBlockId id of the Location Block
179 public static function deleteLocBlock($locBlockId) {
184 $locBlock = new CRM_Core_DAO_LocBlock();
185 $locBlock->id
= $locBlockId;
187 $locBlock->find(TRUE);
189 //resolve conflict of having same ids for multiple blocks
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
,
201 foreach ($store as $daoName => $id) {
203 $daoName = 'CRM_Core_DAO_' . substr($daoName, 0, -2);
204 $dao = new $daoName();
214 * Check if there is data to create the object
216 * @param array $params (reference ) an assoc array of name/value pairs
222 static function dataExists(&$params) {
223 // return if no data present
225 foreach (self
::$blocks as $block) {
226 if (array_key_exists($block, $params)) {
236 * Given the list of params in the params array, fetch the object
237 * and store the values in the values array
239 * @param $entityBlock
240 * @param bool $microformat
242 * @internal param array $params input parameters to find object
243 * @internal param array $values output values of the object
245 * @return array array of objects(CRM_Core_BAO_Location)
249 static function &getValues($entityBlock, $microformat = FALSE) {
250 if (empty($entityBlock)) {
256 'openid' => 'OpenID',
259 //get all the blocks for this contact
260 foreach (self
::$blocks as $block) {
261 if (array_key_exists($block, $name_map)) {
262 $name = $name_map[$block];
265 $name = ucfirst($block);
267 $baoString = 'CRM_Core_BAO_' . $name;
268 $blocks[$block] = $baoString::getValues( $entityBlock, $microformat );
274 * Delete all the block associated with the location
276 * @param int $contactId contact id
277 * @param int $locationTypeId id of the location to delete
283 static function deleteLocationBlocks($contactId, $locationTypeId) {
284 // ensure that contactId has a value
285 if (empty($contactId) ||
286 !CRM_Utils_Rule
::positiveInteger($contactId)
288 CRM_Core_Error
::fatal();
291 if (empty($locationTypeId) ||
292 !CRM_Utils_Rule
::positiveInteger($locationTypeId)
294 // so we only delete the blocks which DO NOT have a location type Id
296 $locationTypeId = 'null';
299 static $blocks = array('Address', 'Phone', 'IM', 'OpenID', 'Email');
301 $params = array('contact_id' => $contactId, 'location_type_id' => $locationTypeId);
302 foreach ($blocks as $name) {
303 CRM_Core_BAO_Block
::blockDelete($name, $params);
307 /* Function to copy or update location block.
309 * @param int $locBlockId location block id.
310 * @param int $updateLocBlockId update location block id
311 * @return int newly created/updated location block id.
315 * @param null $updateLocBlockId
319 static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) {
320 //get the location info.
321 $defaults = $updateValues = array();
322 $locBlock = array('id' => $locBlockId);
323 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_LocBlock', $locBlock, $defaults);
325 if ($updateLocBlockId) {
326 //get the location info for update.
327 $copyLocationParams = array('id' => $updateLocBlockId);
328 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_LocBlock', $copyLocationParams, $updateValues);
329 foreach ($updateValues as $key => $value) {
331 $copyLocationParams[$key] = 'null';
336 //copy all location blocks (email, phone, address, etc)
337 foreach ($defaults as $key => $value) {
339 $tbl = explode("_", $key);
340 $name = ucfirst($tbl[0]);
341 $updateParams = NULL;
342 if ($updateId = CRM_Utils_Array
::value($key, $updateValues)) {
343 $updateParams = array('id' => $updateId);
346 $copy = CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_' . $name, array('id' => $value), $updateParams);
347 $copyLocationParams[$key] = $copy->id
;
351 $copyLocation = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_LocBlock',
352 array('id' => $locBlock['id']),
355 return $copyLocation->id
;
359 * If contact has data for any location block, make sure
360 * contact should have only one primary block, CRM-5051
362 * @param int $contactId - contact id
367 static function checkPrimaryBlocks($contactId) {
372 // get the loc block ids.
373 $primaryLocBlockIds = CRM_Contact_BAO_Contact
::getLocBlockIds($contactId, array('is_primary' => 1));
374 $nonPrimaryBlockIds = CRM_Contact_BAO_Contact
::getLocBlockIds($contactId, array('is_primary' => 0));
377 'Email', 'IM', 'Phone', 'Address', 'OpenID') as $block) {
378 $name = strtolower($block);
379 if (array_key_exists($name, $primaryLocBlockIds) &&
380 !CRM_Utils_System
::isNull($primaryLocBlockIds[$name])
382 if (count($primaryLocBlockIds[$name]) > 1) {
383 // keep only single block as primary.
384 $primaryId = array_pop($primaryLocBlockIds[$name]);
385 $resetIds = "(" . implode(',', $primaryLocBlockIds[$name]) . ")";
386 // reset all primary except one.
387 CRM_Core_DAO
::executeQuery("UPDATE civicrm_$name SET is_primary = 0 WHERE id IN $resetIds");
390 elseif (array_key_exists($name, $nonPrimaryBlockIds) &&
391 !CRM_Utils_System
::isNull($nonPrimaryBlockIds[$name])
393 // data exists and no primary block - make one primary.
394 CRM_Core_DAO
::setFieldValue("CRM_Core_DAO_" . $block,
395 array_pop($nonPrimaryBlockIds[$name]), 'is_primary', 1