Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class contain function for IM handling | |
38 | */ | |
39 | class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { | |
40 | ||
41 | /** | |
42 | * takes an associative array and adds im | |
43 | * | |
44 | * @param array $params (reference ) an assoc array of name/value pairs | |
45 | * | |
46 | * @return object CRM_Core_BAO_IM object on success, null otherwise | |
47 | * @access public | |
48 | * @static | |
49 | */ | |
50 | static function add(&$params) { | |
51 | $hook = empty($params['id']) ? 'create' : 'edit'; | |
52 | CRM_Utils_Hook::pre($hook, 'IM', CRM_Utils_Array::value('id', $params), $params); | |
53 | ||
54 | $im = new CRM_Core_DAO_IM(); | |
55 | $im->copyValues($params); | |
56 | $im->save(); | |
57 | ||
58 | CRM_Utils_Hook::post($hook, 'IM', $im->id, $im); | |
59 | return $im; | |
60 | } | |
61 | ||
62 | /** | |
63 | * Given the list of params in the params array, fetch the object | |
64 | * and store the values in the values array | |
65 | * | |
66 | * @param array entityBlock input parameters to find object | |
67 | * | |
68 | * @return boolean | |
69 | * @access public | |
70 | * @static | |
71 | */ | |
72 | static function &getValues($entityBlock) { | |
73 | return CRM_Core_BAO_Block::getValues('im', $entityBlock); | |
74 | } | |
75 | ||
76 | /** | |
77 | * Get all the ims for a specified contact_id, with the primary im being first | |
78 | * | |
79 | * @param int $id the contact id | |
80 | * | |
81 | * @return array the array of im details | |
82 | * @access public | |
83 | * @static | |
84 | */ | |
85 | static function allIMs($id, $updateBlankLocInfo = FALSE) { | |
86 | if (!$id) { | |
87 | return NULL; | |
88 | } | |
89 | ||
90 | $query = " | |
91 | SELECT civicrm_im.name as im, civicrm_location_type.name as locationType, civicrm_im.is_primary as is_primary, | |
92 | civicrm_im.id as im_id, civicrm_im.location_type_id as locationTypeId, | |
93 | civicrm_im.provider_id as providerId | |
94 | FROM civicrm_contact | |
95 | LEFT JOIN civicrm_im ON ( civicrm_im.contact_id = civicrm_contact.id ) | |
96 | LEFT JOIN civicrm_location_type ON ( civicrm_im.location_type_id = civicrm_location_type.id ) | |
97 | WHERE | |
98 | civicrm_contact.id = %1 | |
99 | ORDER BY | |
100 | civicrm_im.is_primary DESC, im_id ASC "; | |
101 | $params = array(1 => array($id, 'Integer')); | |
102 | ||
103 | $ims = $values = array(); | |
104 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
105 | $count = 1; | |
106 | while ($dao->fetch()) { | |
107 | $values = array( | |
108 | 'locationType' => $dao->locationType, | |
109 | 'is_primary' => $dao->is_primary, | |
110 | 'id' => $dao->im_id, | |
111 | 'name' => $dao->im, | |
112 | 'locationTypeId' => $dao->locationTypeId, | |
113 | 'providerId' => $dao->providerId, | |
114 | ); | |
115 | ||
116 | if ($updateBlankLocInfo) { | |
117 | $ims[$count++] = $values; | |
118 | } | |
119 | else { | |
120 | $ims[$dao->im_id] = $values; | |
121 | } | |
122 | } | |
123 | return $ims; | |
124 | } | |
125 | ||
126 | /** | |
127 | * Get all the ims for a specified location_block id, with the primary im being first | |
128 | * | |
129 | * @param array $entityElements the array containing entity_id and | |
130 | * entity_table name | |
131 | * | |
132 | * @return array the array of im details | |
133 | * @access public | |
134 | * @static | |
135 | */ | |
136 | static function allEntityIMs(&$entityElements) { | |
137 | if (empty($entityElements)) { | |
138 | return NULL; | |
139 | } | |
140 | ||
141 | ||
142 | $entityId = $entityElements['entity_id']; | |
143 | $entityTable = $entityElements['entity_table']; | |
144 | ||
145 | ||
146 | $sql = "SELECT cim.name as im, ltype.name as locationType, cim.is_primary as is_primary, cim.id as im_id, cim.location_type_id as locationTypeId | |
147 | FROM civicrm_loc_block loc, civicrm_im cim, civicrm_location_type ltype, {$entityTable} ev | |
148 | WHERE ev.id = %1 | |
149 | AND loc.id = ev.loc_block_id | |
150 | AND cim.id IN (loc.im_id, loc.im_2_id) | |
151 | AND ltype.id = cim.location_type_id | |
152 | ORDER BY cim.is_primary DESC, im_id ASC "; | |
153 | ||
154 | $params = array(1 => array($entityId, 'Integer')); | |
155 | ||
156 | $ims = array(); | |
157 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
158 | while ($dao->fetch()) { | |
159 | $ims[$dao->im_id] = array( | |
160 | 'locationType' => $dao->locationType, | |
161 | 'is_primary' => $dao->is_primary, | |
162 | 'id' => $dao->im_id, | |
163 | 'name' => $dao->im, | |
164 | 'locationTypeId' => $dao->locationTypeId, | |
165 | ); | |
166 | } | |
167 | return $ims; | |
168 | } | |
12445e1c CW |
169 | |
170 | /** | |
171 | * Call common delete function | |
172 | */ | |
173 | static function del($id) { | |
a65e2e55 | 174 | return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('IM', $id); |
12445e1c | 175 | } |
6a488035 TO |
176 | } |
177 |