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
37 * Class contains functions for phone
39 class CRM_Core_BAO_Phone
extends CRM_Core_DAO_Phone
{
42 * Create phone object - note that the create function calls 'add' but
43 * has more business logic
45 * @param array $params input parameters
48 * @param array $params
51 * @throws API_Exception
53 public static function create($params) {
54 // Ensure mysql phone function exists
55 CRM_Core_DAO
::checkSqlFunctionsExist();
57 if (is_numeric(CRM_Utils_Array
::value('is_primary', $params)) ||
58 // if id is set & is_primary isn't we can assume no change
61 CRM_Core_BAO_Block
::handlePrimary($params, get_class());
63 $phone = self
::add($params);
69 * Takes an associative array and adds phone
71 * @param array $params (reference ) an assoc array of name/value pairs
73 * @return object CRM_Core_BAO_Phone object on success, null otherwise
76 public static function add(&$params) {
77 // Ensure mysql phone function exists
78 CRM_Core_DAO
::checkSqlFunctionsExist();
80 $hook = empty($params['id']) ?
'create' : 'edit';
81 CRM_Utils_Hook
::pre($hook, 'Phone', CRM_Utils_Array
::value('id', $params), $params);
83 $phone = new CRM_Core_DAO_Phone();
84 $phone->copyValues($params);
87 CRM_Utils_Hook
::post($hook, 'Phone', $phone->id
, $phone);
92 * Given the list of params in the params array, fetch the object
93 * and store the values in the values array
95 * @param array entityBlock input parameters to find object
97 * @return array array of phone objects
100 public static function &getValues($entityBlock) {
101 $getValues = CRM_Core_BAO_Block
::getValues('phone', $entityBlock);
106 * Get all the phone numbers for a specified contact_id, with the primary being first
108 * @param int $id the contact id
110 * @param bool $updateBlankLocInfo
112 * @param array $filters
114 * @return array the array of phone ids which are potential numbers
117 public static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array()) {
124 $phoneTypeId = array_search($type, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'));
126 $cond = " AND civicrm_phone.phone_type_id = $phoneTypeId";
130 if (!empty($filters) && is_array($filters)) {
131 foreach ($filters as $key => $value) {
132 $cond .= " AND " . $key . " = " . $value;
137 SELECT phone, civicrm_location_type.name as locationType, civicrm_phone.is_primary as is_primary,
138 civicrm_phone.id as phone_id, civicrm_phone.location_type_id as locationTypeId,
139 civicrm_phone.phone_type_id as phoneTypeId
141 LEFT JOIN civicrm_phone ON ( civicrm_contact.id = civicrm_phone.contact_id )
142 LEFT JOIN civicrm_location_type ON ( civicrm_phone.location_type_id = civicrm_location_type.id )
143 WHERE civicrm_contact.id = %1 $cond
144 ORDER BY civicrm_phone.is_primary DESC, phone_id ASC ";
154 $numbers = $values = array();
155 $dao = CRM_Core_DAO
::executeQuery($query, $params);
157 while ($dao->fetch()) {
159 'locationType' => $dao->locationType
,
160 'is_primary' => $dao->is_primary
,
161 'id' => $dao->phone_id
,
162 'phone' => $dao->phone
,
163 'locationTypeId' => $dao->locationTypeId
,
164 'phoneTypeId' => $dao->phoneTypeId
,
167 if ($updateBlankLocInfo) {
168 $numbers[$count++
] = $values;
171 $numbers[$dao->phone_id
] = $values;
178 * Get all the phone numbers for a specified location_block id, with the primary phone being first
180 * @param array $entityElements the array containing entity_id and
185 * @return array the array of phone ids which are potential numbers
188 public static function allEntityPhones($entityElements, $type = NULL) {
189 if (empty($entityElements)) {
195 $phoneTypeId = array_search($type, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'));
197 $cond = " AND civicrm_phone.phone_type_id = $phoneTypeId";
201 $entityId = $entityElements['entity_id'];
202 $entityTable = $entityElements['entity_table'];
204 $sql = " SELECT phone, ltype.name as locationType, ph.is_primary as is_primary,
205 ph.id as phone_id, ph.location_type_id as locationTypeId
206 FROM civicrm_loc_block loc, civicrm_phone ph, civicrm_location_type ltype, {$entityTable} ev
208 AND loc.id = ev.loc_block_id
209 AND ph.id IN (loc.phone_id, loc.phone_2_id)
210 AND ltype.id = ph.location_type_id
211 ORDER BY ph.is_primary DESC, phone_id ASC ";
220 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
221 while ($dao->fetch()) {
222 $numbers[$dao->phone_id
] = array(
223 'locationType' => $dao->locationType
,
224 'is_primary' => $dao->is_primary
,
225 'id' => $dao->phone_id
,
226 'phone' => $dao->phone
,
227 'locationTypeId' => $dao->locationTypeId
,
234 * Set NULL to phone, mapping, uffield
236 * @param $optionId value of option to be deleted
241 public static function setOptionToNull($optionId) {
245 // Ensure mysql phone function exists
246 CRM_Core_DAO
::checkSqlFunctionsExist();
250 'civicrm_mapping_field',
260 foreach ($tables as $tableName) {
261 $query = "UPDATE `{$tableName}` SET `phone_type_id` = NULL WHERE `phone_type_id` = %1";
262 CRM_Core_DAO
::executeQuery($query, $params);
267 * Call common delete function
269 public static function del($id) {
270 // Ensure mysql phone function exists
271 CRM_Core_DAO
::checkSqlFunctionsExist();
272 return CRM_Contact_BAO_Contact
::deleteObjectWithPrimary('Phone', $id);