CRM/Core/BAO/Block.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  * add static functions to include some common functionality
  35  * used across location sub object BAO classes
  36  *
  37  */
  38 class CRM_Core_BAO_Block {
  39
  40   /**
  41    * Fields that are required for a valid block.
  42    */
  43   static $requiredBlockFields = array(
  44     'email' => array('email'),
  45     'phone' => array('phone'),
  46     'im' => array('name'),
  47     'openid' => array('openid'),
  48   );
  49
  50   /**
  51    * Given the list of params in the params array, fetch the object
  52    * and store the values in the values array
  53    *
  54    * @param string $blockName
  55    *   Name of the above object.
  56    * @param array $params
  57    *   Input parameters to find object.
  58    *
  59    * @return array
  60    *   Array of $block objects.
  61    */
  62   public static function &getValues($blockName, $params) {
  63     if (empty($params)) {
  64       return NULL;
  65     }
  66     $BAOString = 'CRM_Core_BAO_' . $blockName;
  67     $block = new $BAOString();
  68
  69     $blocks = array();
  70     if (!isset($params['entity_table'])) {
  71       $block->contact_id = $params['contact_id'];
  72       if (!$block->contact_id) {
  73         CRM_Core_Error::fatal();
  74       }
  75       $blocks = self::retrieveBlock($block, $blockName);
  76     }
  77     else {
  78       $blockIds = self::getBlockIds($blockName, NULL, $params);
  79
  80       if (empty($blockIds)) {
  81         return $blocks;
  82       }
  83
  84       $count = 1;
  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);
  90       }
  91     }
  92
  93     return $blocks;
  94   }
  95
  96   /**
  97    * Given the list of params in the params array, fetch the object
  98    * and store the values in the values array
  99    *
 100    * @param Object $block
 101    *   Typically a Phone|Email|IM|OpenID object.
 102    * @param string $blockName
 103    *   Name of the above object.
 104    *
 105    * @return array
 106    *   Array of $block objects.
 107    */
 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');
 111     $block->find();
 112
 113     $count = 1;
 114     $blocks = array();
 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
 119       if ($count > 1) {
 120         unset($blocks[$count]['is_primary']);
 121       }
 122       $count++;
 123     }
 124
 125     return $blocks;
 126   }
 127
 128   /**
 129    * Check if the current block object has any valid data.
 130    *
 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.
 135    *
 136    * @return bool
 137    *   true if the block has data, otherwise false
 138    */
 139   public static function dataExists($blockFields, &$params) {
 140     foreach ($blockFields as $field) {
 141       if (CRM_Utils_System::isNull(CRM_Utils_Array::value($field, $params))) {
 142         return FALSE;
 143       }
 144     }
 145     return TRUE;
 146   }
 147
 148   /**
 149    * Check if the current block exits.
 150    *
 151    * @param string $blockName
 152    *   Bloack name.
 153    * @param array $params
 154    *   Associated array of submitted fields.
 155    *
 156    * @return bool
 157    *   true if the block exits, otherwise false
 158    */
 159   public static function blockExists($blockName, &$params) {
 160     // return if no data present
 161     if (empty($params[$blockName]) || !is_array($params[$blockName])) {
 162       return FALSE;
 163     }
 164
 165     return TRUE;
 166   }
 167
 168   /**
 169    * Get all block ids for a contact.
 170    *
 171    * @param string $blockName
 172    *   Block name.
 173    * @param int $contactId
 174    *   Contact id.
 175    *
 176    * @param null $entityElements
 177    * @param bool $updateBlankLocInfo
 178    *
 179    * @return array
 180    *   formatted array of block ids
 181    *
 182    */
 183   public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
 184     $allBlocks = array();
 185
 186     $name = ucfirst($blockName);
 187     if ($blockName == 'im') {
 188       $name = 'IM';
 189     }
 190     elseif ($blockName == 'openid') {
 191       $name = 'OpenID';
 192     }
 193
 194     $baoString = 'CRM_Core_BAO_' . $name;
 195     if ($contactId) {
 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);
 203     }
 204     elseif (!empty($entityElements) && $blockName != 'openid') {
 205       $baoFunction = 'allEntity' . $name . 's';
 206       $allBlocks = $baoString::$baoFunction($entityElements);
 207     }
 208
 209     return $allBlocks;
 210   }
 211
 212   /**
 213    * Takes an associative array and creates a block.
 214    *
 215    * @param string $blockName
 216    *   Block name.
 217    * @param array $params
 218    *   (reference ) an assoc array of name/value pairs.
 219    * @param null $entity
 220    * @param int $contactId
 221    *
 222    * @return object
 223    *   CRM_Core_BAO_Block object on success, null otherwise
 224    */
 225   public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
 226     if (!self::blockExists($blockName, $params)) {
 227       return NULL;
 228     }
 229
 230     $name = ucfirst($blockName);
 231     $isPrimary = $isBilling = TRUE;
 232     $entityElements = $blocks = array();
 233
 234     if ($entity) {
 235       $entityElements = array(
 236         'entity_table' => $params['entity_table'],
 237         'entity_id' => $params['entity_id'],
 238       );
 239     }
 240     else {
 241       $contactId = $params['contact_id'];
 242     }
 243
 244     $updateBlankLocInfo = CRM_Utils_Array::value('updateBlankLocInfo', $params, FALSE);
 245
 246     //get existing block ids.
 247     $blockIds = self::getBlockIds($blockName, $contactId, $entityElements);
 248
 249     foreach ($params[$blockName] as $count => $value) {
 250       if (!is_array($value)) {
 251         continue;
 252       }
 253       // if in some case (eg. email used in Online Conribution Page) id is not set
 254       // lets try to add using the previous method to avoid any false creation of existing data.
 255       foreach ($blockIds as $blockId => $blockValue) {
 256         if (empty($value['id']) && $blockValue['locationTypeId'] == CRM_Utils_Array::value('location_type_id', $value)) {
 257           //assigned id as first come first serve basis
 258           $value['id'] = $blockValue['id'];
 259           break;
 260         }
 261       }
 262       $dataExists = self::dataExists(self::$requiredBlockFields[$blockName], $value);
 263       // Note there could be cases when block info already exist ($value[id] is set) for a contact/entity
 264       // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
 265       // $updateBlankLocInfo will help take appropriate decision. CRM-5969
 266       if (!empty($value['id']) && !$dataExists && $updateBlankLocInfo) {
 267         //delete the existing record
 268         self::blockDelete($blockName, array('id' => $value['id']));
 269         continue;
 270       }
 271       elseif (!$dataExists) {
 272         continue;
 273       }
 274
 275       $contactFields = array(
 276         'contact_id' => $contactId,
 277         'location_type_id' => CRM_Utils_Array::value('location_type_id', $value),
 278       );
 279
 280       if ($isPrimary && !empty($value['is_primary'])) {
 281         $contactFields['is_primary'] = $value['is_primary'];
 282         $isPrimary = FALSE;
 283       }
 284       else {
 285         $contactFields['is_primary'] = 0;
 286       }
 287
 288       if ($isBilling && !empty($value['is_billing'])) {
 289         $contactFields['is_billing'] = $value['is_billing'];
 290         $isBilling = FALSE;
 291       }
 292       else {
 293         $contactFields['is_billing'] = 0;
 294       }
 295
 296       $blockFields = array_merge($value, $contactFields);
 297       $baoString = 'CRM_Core_BAO_' . $name;
 298       $blocks[] = $baoString::add($blockFields);
 299     }
 300
 301     return $blocks;
 302   }
 303
 304   /**
 305    * Delete block.
 306    *
 307    * @param string $blockName
 308    *   Block name.
 309    * @param int $params
 310    *   Associates array.
 311    *
 312    * @return void
 313    */
 314   public static function blockDelete($blockName, $params) {
 315     $name = ucfirst($blockName);
 316     if ($blockName == 'im') {
 317       $name = 'IM';
 318     }
 319     elseif ($blockName == 'openid') {
 320       $name = 'OpenID';
 321     }
 322
 323     $baoString = 'CRM_Core_DAO_' . $name;
 324     $block = new $baoString();
 325
 326     $block->copyValues($params);
 327
 328     // CRM-11006 add call to pre and post hook for delete action
 329     CRM_Utils_Hook::pre('delete', $name, $block->id, CRM_Core_DAO::$_nullArray);
 330     $block->delete();
 331     CRM_Utils_Hook::post('delete', $name, $block->id, $block);
 332   }
 333
 334   /**
 335    * Handling for is_primary.
 336    * $params is_primary could be
 337    *  #  1 - find other entries with is_primary = 1 &  reset them to 0
 338    *  #  0 - make sure at least one entry is set to 1
 339    *            - if no other entry is 1 change to 1
 340    *            - if one other entry exists change that to 1
 341    *            - if more than one other entry exists change first one to 1
 342    * @fixme - perhaps should choose by location_type
 343    *  #  empty - same as 0 as once we have checked first step
 344    *             we know if it should be 1 or 0
 345    *
 346    *  if $params['id'] is set $params['contact_id'] may need to be retrieved
 347    *
 348    * @param array $params
 349    * @param $class
 350    *
 351    * @throws API_Exception
 352    */
 353   public static function handlePrimary(&$params, $class) {
 354     $table = CRM_Core_DAO_AllCoreTables::getTableForClass($class);
 355     if (!$table) {
 356       throw new API_Exception("Failed to locate table for class [$class]");
 357     }
 358
 359     // contact_id in params might be empty or the string 'null' so cast to integer
 360     $contactId = (int) CRM_Utils_Array::value('contact_id', $params);
 361     // If id is set & we haven't been passed a contact_id, retrieve it
 362     if (!empty($params['id']) && !isset($params['contact_id'])) {
 363       $entity = new $class();
 364       $entity->id = $params['id'];
 365       $entity->find(TRUE);
 366       $contactId = $entity->contact_id;
 367     }
 368     // If entity is not associated with contact, concept of is_primary not relevant
 369     if (!$contactId) {
 370       return;
 371     }
 372
 373     // if params is_primary then set all others to not be primary & exit out
 374     if (!empty($params['is_primary'])) {
 375       $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1";
 376       $sqlParams = array(1 => array($contactId, 'Integer'));
 377       // we don't want to create unnecessary entries in the log_ tables so exclude the one we are working on
 378       if (!empty($params['id'])) {
 379         $sql .= " AND id <> %2";
 380         $sqlParams[2] = array($params['id'], 'Integer');
 381       }
 382       CRM_Core_DAO::executeQuery($sql, $sqlParams);
 383       return;
 384     }
 385
 386     //Check what other emails exist for the contact
 387     $existingEntities = new $class();
 388     $existingEntities->contact_id = $contactId;
 389     $existingEntities->orderBy('is_primary DESC');
 390     if (!$existingEntities->find(TRUE) || (!empty($params['id']) && $existingEntities->id == $params['id'])) {
 391       // ie. if  no others is set to be primary then this has to be primary set to 1 so change
 392       $params['is_primary'] = 1;
 393       return;
 394     }
 395     else {
 396       /*
 397        * If the only existing email is the one we are editing then we must set
 398        * is_primary to 1
 399        * CRM-10451
 400        */
 401       if ($existingEntities->N == 1 && $existingEntities->id == CRM_Utils_Array::value('id', $params)) {
 402         $params['is_primary'] = 1;
 403         return;
 404       }
 405
 406       if ($existingEntities->is_primary == 1) {
 407         return;
 408       }
 409       // so at this point we are only dealing with ones explicity setting is_primary to 0
 410       // since we have reverse sorted by email we can either set the first one to
 411       // primary or return if is already is
 412       $existingEntities->is_primary = 1;
 413       $existingEntities->save();
 414     }
 415   }
 416
 417   /**
 418    * Sort location array so primary element is first.
 419    *
 420    * @param array $locations
 421    */
 422   public static function sortPrimaryFirst(&$locations) {
 423     uasort($locations, 'self::primaryComparison');
 424   }
 425
 426   /**
 427    * compare 2 locations to see which should go first based on is_primary
 428    * (sort function for sortPrimaryFirst)
 429    * @param array $location1
 430    * @param array $location2
 431    * @return int
 432    */
 433   public static function primaryComparison($location1, $location2) {
 434     $l1 = CRM_Utils_Array::value('is_primary', $location1);
 435     $l2 = CRM_Utils_Array::value('is_primary', $location2);
 436     if ($l1 == $l2) {
 437       return 0;
 438     }
 439     return ($l1 < $l2) ? -1 : 1;
 440   }
 441
 442 }