CRM/Core/BAO/Phone.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * Class contains functions for phone.
  36  */
  37 class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone {
  38
  39   /**
  40    * Create phone object - note that the create function calls 'add' but
  41    * has more business logic
  42    *
  43    * @param array $params
  44    *
  45    * @return object
  46    * @throws API_Exception
  47    */
  48   public static function create($params) {
  49     // Ensure mysql phone function exists
  50     CRM_Core_DAO::checkSqlFunctionsExist();
  51
  52     if (is_numeric(CRM_Utils_Array::value('is_primary', $params)) ||
  53       // if id is set & is_primary isn't we can assume no change
  54       empty($params['id'])
  55     ) {
  56       CRM_Core_BAO_Block::handlePrimary($params, get_class());
  57     }
  58     $phone = self::add($params);
  59
  60     return $phone;
  61   }
  62
  63   /**
  64    * Takes an associative array and adds phone.
  65    *
  66    * @param array $params
  67    *   (reference ) an assoc array of name/value pairs.
  68    *
  69    * @return object
  70    *   CRM_Core_BAO_Phone object on success, null otherwise
  71    */
  72   public static function add(&$params) {
  73     // Ensure mysql phone function exists
  74     CRM_Core_DAO::checkSqlFunctionsExist();
  75
  76     $hook = empty($params['id']) ? 'create' : 'edit';
  77     CRM_Utils_Hook::pre($hook, 'Phone', CRM_Utils_Array::value('id', $params), $params);
  78
  79     $phone = new CRM_Core_DAO_Phone();
  80     $phone->copyValues($params);
  81     $phone->save();
  82
  83     CRM_Utils_Hook::post($hook, 'Phone', $phone->id, $phone);
  84     return $phone;
  85   }
  86
  87   /**
  88    * Given the list of params in the params array, fetch the object
  89    * and store the values in the values array
  90    *
  91    * @param array $entityBlock
  92    *
  93    * @return array
  94    *   array of phone objects
  95    */
  96   public static function &getValues($entityBlock) {
  97     $getValues = CRM_Core_BAO_Block::getValues('phone', $entityBlock);
  98     return $getValues;
  99   }
 100
 101   /**
 102    * Get all the phone numbers for a specified contact_id, with the primary being first
 103    *
 104    * @param int $id
 105    *   The contact id.
 106    *
 107    * @param bool $updateBlankLocInfo
 108    * @param null $type
 109    * @param array $filters
 110    *
 111    * @return array
 112    *   the array of phone ids which are potential numbers
 113    */
 114   public static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = []) {
 115     if (!$id) {
 116       return NULL;
 117     }
 118
 119     $cond = NULL;
 120     if ($type) {
 121       $phoneTypeId = array_search($type, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'));
 122       if ($phoneTypeId) {
 123         $cond = " AND civicrm_phone.phone_type_id = $phoneTypeId";
 124       }
 125     }
 126
 127     if (!empty($filters) && is_array($filters)) {
 128       foreach ($filters as $key => $value) {
 129         $cond .= " AND " . $key . " = " . $value;
 130       }
 131     }
 132
 133     $query = "
 134    SELECT phone, civicrm_location_type.name as locationType, civicrm_phone.is_primary as is_primary,
 135      civicrm_phone.id as phone_id, civicrm_phone.location_type_id as locationTypeId,
 136      civicrm_phone.phone_type_id as phoneTypeId
 137      FROM civicrm_contact
 138 LEFT JOIN civicrm_phone ON ( civicrm_contact.id = civicrm_phone.contact_id )
 139 LEFT JOIN civicrm_location_type ON ( civicrm_phone.location_type_id = civicrm_location_type.id )
 140 WHERE     civicrm_contact.id = %1 $cond
 141 ORDER BY civicrm_phone.is_primary DESC,  phone_id ASC ";
 142
 143     $params = [
 144       1 => [
 145         $id,
 146         'Integer',
 147       ],
 148     ];
 149
 150     $numbers = $values = [];
 151     $dao = CRM_Core_DAO::executeQuery($query, $params);
 152     $count = 1;
 153     while ($dao->fetch()) {
 154       $values = [
 155         'locationType' => $dao->locationType,
 156         'is_primary' => $dao->is_primary,
 157         'id' => $dao->phone_id,
 158         'phone' => $dao->phone,
 159         'locationTypeId' => $dao->locationTypeId,
 160         'phoneTypeId' => $dao->phoneTypeId,
 161       ];
 162
 163       if ($updateBlankLocInfo) {
 164         $numbers[$count++] = $values;
 165       }
 166       else {
 167         $numbers[$dao->phone_id] = $values;
 168       }
 169     }
 170     return $numbers;
 171   }
 172
 173   /**
 174    * Get all the phone numbers for a specified location_block id, with the primary phone being first.
 175    *
 176    * This is called from CRM_Core_BAO_Block as a calculated function.
 177    *
 178    * @param array $entityElements
 179    *   The array containing entity_id and.
 180    *   entity_table name
 181    *
 182    * @param null $type
 183    *
 184    * @return array
 185    *   the array of phone ids which are potential numbers
 186    */
 187   public static function allEntityPhones($entityElements, $type = NULL) {
 188     if (empty($entityElements)) {
 189       return NULL;
 190     }
 191
 192     $cond = NULL;
 193     if ($type) {
 194       $phoneTypeId = array_search($type, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'));
 195       if ($phoneTypeId) {
 196         $cond = " AND civicrm_phone.phone_type_id = $phoneTypeId";
 197       }
 198     }
 199
 200     $entityId = $entityElements['entity_id'];
 201     $entityTable = $entityElements['entity_table'];
 202
 203     $sql = " SELECT phone, ltype.name as locationType, ph.is_primary as is_primary,
 204      ph.id as phone_id, ph.location_type_id as locationTypeId
 205 FROM civicrm_loc_block loc, civicrm_phone ph, civicrm_location_type ltype, {$entityTable} ev
 206 WHERE ev.id = %1
 207 AND   loc.id = ev.loc_block_id
 208 AND   ph.id IN (loc.phone_id, loc.phone_2_id)
 209 AND   ltype.id = ph.location_type_id
 210 ORDER BY ph.is_primary DESC, phone_id ASC ";
 211
 212     $params = [
 213       1 => [
 214         $entityId,
 215         'Integer',
 216       ],
 217     ];
 218     $numbers = [];
 219     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 220     while ($dao->fetch()) {
 221       $numbers[$dao->phone_id] = [
 222         'locationType' => $dao->locationType,
 223         'is_primary' => $dao->is_primary,
 224         'id' => $dao->phone_id,
 225         'phone' => $dao->phone,
 226         'locationTypeId' => $dao->locationTypeId,
 227       ];
 228     }
 229     return $numbers;
 230   }
 231
 232   /**
 233    * Set NULL to phone, mapping, uffield
 234    *
 235    * @param $optionId
 236    *   Value of option to be deleted.
 237    */
 238   public static function setOptionToNull($optionId) {
 239     if (!$optionId) {
 240       return;
 241     }
 242     // Ensure mysql phone function exists
 243     CRM_Core_DAO::checkSqlFunctionsExist();
 244
 245     $tables = [
 246       'civicrm_phone',
 247       'civicrm_mapping_field',
 248       'civicrm_uf_field',
 249     ];
 250     $params = [
 251       1 => [
 252         $optionId,
 253         'Integer',
 254       ],
 255     ];
 256
 257     foreach ($tables as $tableName) {
 258       $query = "UPDATE `{$tableName}` SET `phone_type_id` = NULL WHERE `phone_type_id` = %1";
 259       CRM_Core_DAO::executeQuery($query, $params);
 260     }
 261   }
 262
 263   /**
 264    * Call common delete function.
 265    *
 266    * @param int $id
 267    *
 268    * @return bool
 269    */
 270   public static function del($id) {
 271     // Ensure mysql phone function exists
 272     CRM_Core_DAO::checkSqlFunctionsExist();
 273     return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Phone', $id);
 274   }
 275
 276 }