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 * Business object for Saved searches
40 class CRM_Contact_BAO_SavedSearch
extends CRM_Contact_DAO_SavedSearch
{
45 * @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch
47 function __construct() {
48 parent
::__construct();
52 * query the db for all saved searches.
54 * @return array $aSavedSearch - contains the search name as value and and id as key
59 $savedSearch = new CRM_Contact_DAO_SavedSearch();
60 $savedSearch->selectAdd();
61 $savedSearch->selectAdd('id, name');
63 while ($savedSearch->fetch()) {
64 $aSavedSearch[$savedSearch->id
] = $savedSearch->name
;
70 * Takes a bunch of params that are needed to match certain criteria and
71 * retrieves the relevant objects.
73 * @param array $params (reference ) an assoc array of name/value pairs
74 * @param array $defaults (reference ) an assoc array to hold the flattened values
76 * @return object CRM_Contact_BAO_SavedSearch
80 static function retrieve(&$params, &$defaults) {
81 $savedSearch = new CRM_Contact_DAO_SavedSearch();
82 $savedSearch->copyValues($params);
83 if ($savedSearch->find(TRUE)) {
84 CRM_Core_DAO
::storeValues($savedSearch, $defaults);
91 * given an id, extract the formValues of the saved search
93 * @param int $id the id of the saved search
95 * @return array the values of the posted saved search
99 static function &getFormValues($id) {
100 $fv = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'form_values');
103 // make sure u unserialize - since it's stored in serialized form
104 $result = unserialize($fv);
107 // check to see if we need to convert the old privacy array
109 if (isset($result['privacy'])) {
110 if (is_array($result['privacy'])) {
111 $result['privacy_operator'] = 'AND';
112 $result['privacy_toggle'] = 1;
113 if (isset($result['privacy']['do_not_toggle'])) {
114 if ($result['privacy']['do_not_toggle']) {
115 $result['privacy_toggle'] = 2;
117 unset($result['privacy']['do_not_toggle']);
120 $result['privacy_options'] = array();
121 foreach ($result['privacy'] as $name => $value) {
123 $result['privacy_options'][] = $name;
127 unset($result['privacy']);
138 static function getSearchParams($id) {
139 $fv = self
::getFormValues($id);
140 //check if the saved search has mapping id
141 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'mapping_id')) {
142 return CRM_Core_BAO_Mapping
::formattedFields($fv);
144 elseif (!empty($fv['customSearchID'])) {
148 return CRM_Contact_BAO_Query
::convertFormValues($fv);
153 * get the where clause for a saved search
155 * @param int $id saved search id
156 * @param array $tables (reference ) add the tables that are needed for the select clause
157 * @param array $whereTables (reference ) add the tables that are needed for the where clause
159 * @return string the where clause for this saved search
163 static function whereClause($id, &$tables, &$whereTables) {
164 $params = self
::getSearchParams($id);
166 if (!empty($params['customSearchID'])) {
167 // this has not yet been implemented
169 return CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
180 static function contactIDsSQL($id) {
181 $params = self
::getSearchParams($id);
182 if ($params && !empty($params['customSearchID'])) {
183 return CRM_Contact_BAO_SearchCustom
::contactIDSQL(NULL, $id);
186 $tables = $whereTables = array('civicrm_contact' => 1);
187 $where = CRM_Contact_BAO_SavedSearch
::whereClause($id, $tables, $whereTables);
191 $from = CRM_Contact_BAO_Query
::fromClause($whereTables);
204 static function fromWhereEmail($id) {
205 $params = self
::getSearchParams($id);
208 if (!empty($params['customSearchID'])) {
209 return CRM_Contact_BAO_SearchCustom
::fromWhereEmail(NULL, $id);
212 $tables = $whereTables = array('civicrm_contact' => 1, 'civicrm_email' => 1);
213 $where = CRM_Contact_BAO_SavedSearch
::whereClause($id, $tables, $whereTables);
214 $from = CRM_Contact_BAO_Query
::fromClause($whereTables);
215 return array($from, $where);
221 FROM civicrm_contact contact_a
222 LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1)
225 $tables['civicrm_contact'] = $whereTables['civicrm_contact'] = 1;
226 $tables['civicrm_email'] = $whereTables['civicrm_email'] = 1;
227 return array($from, $where);
232 * given a saved search compute the clause and the tables
233 * and store it for future use
235 function buildClause() {
236 $fv = unserialize($this->form_values
);
238 if ($this->mapping_id
) {
239 $params = CRM_Core_BAO_Mapping
::formattedFields($fv);
242 $params = CRM_Contact_BAO_Query
::convertFormValues($fv);
245 if (!empty($params)) {
246 $tables = $whereTables = array();
247 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
248 if (!empty($tables)) {
249 $this->select_tables
= serialize($tables);
251 if (!empty($whereTables)) {
252 $this->where_tables
= serialize($whereTables);
260 // first build the computed fields
261 $this->buildClause();
267 * given an id, get the name of the saved search
269 * @param int $id the id of the saved search
271 * @param string $value
273 * @return string the name of the saved search
277 static function getName($id, $value = 'name') {
278 $group = new CRM_Contact_DAO_Group();
279 $group->saved_search_id
= $id;
280 if ($group->find(TRUE)) {
281 return $group->$value;
287 * Given a label and a set of normalized POST
288 * formValues, create a smart group with that
290 static function create(&$params) {
291 $savedSearch = new CRM_Contact_DAO_SavedSearch();
292 if (isset($params['formValues']) &&
293 !empty($params['formValues'])
295 $savedSearch->form_values
= serialize($params['formValues']);
298 $savedSearch->form_values
= 'null';
301 $savedSearch->is_active
= CRM_Utils_Array
::value('is_active', $params, 1);
302 $savedSearch->mapping_id
= CRM_Utils_Array
::value('mapping_id', $params, 'null');
303 $savedSearch->custom_search_id
= CRM_Utils_Array
::value('custom_search_id', $params, 'null');
304 $savedSearch->id
= CRM_Utils_Array
::value('id', $params, NULL);
306 $savedSearch->save();