3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
35 * Business object for Saved searches.
37 class CRM_Contact_BAO_SavedSearch
extends CRM_Contact_DAO_SavedSearch
{
42 public function __construct() {
43 parent
::__construct();
47 * Query the db for all saved searches.
50 * contains the search name as value and and id as key
52 public function getAll() {
53 $savedSearch = new CRM_Contact_DAO_SavedSearch();
54 $savedSearch->selectAdd();
55 $savedSearch->selectAdd('id, name');
57 while ($savedSearch->fetch()) {
58 $aSavedSearch[$savedSearch->id
] = $savedSearch->name
;
64 * Retrieve DB object based on input parameters.
66 * It also stores all the retrieved values in the default array.
68 * @param array $params
69 * (reference ) an assoc array of name/value pairs.
70 * @param array $defaults
71 * (reference ) an assoc array to hold the flattened values.
73 * @return CRM_Contact_BAO_SavedSearch
75 public static function retrieve(&$params, &$defaults) {
76 $savedSearch = new CRM_Contact_DAO_SavedSearch();
77 $savedSearch->copyValues($params);
78 if ($savedSearch->find(TRUE)) {
79 CRM_Core_DAO
::storeValues($savedSearch, $defaults);
86 * Given an id, extract the formValues of the saved search.
89 * The id of the saved search.
92 * the values of the posted saved search used as default values in various Search Form
94 public static function getFormValues($id) {
95 $fv = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'form_values');
98 // make sure u unserialize - since it's stored in serialized form
99 $result = unserialize($fv);
102 $specialFields = array('contact_type', 'group', 'contact_tags', 'member_membership_type_id', 'member_status_id');
103 foreach ($result as $element => $value) {
104 if (CRM_Contact_BAO_Query
::isAlreadyProcessedForQueryFormat($value)) {
105 $id = CRM_Utils_Array
::value(0, $value);
106 $value = CRM_Utils_Array
::value(2, $value);
107 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
109 $value = CRM_Utils_Array
::value($op, $value);
110 if (in_array($op, array('BETWEEN', '>=', '<='))) {
111 self
::decodeRelativeFields($result, $id, $op, $value);
112 unset($result[$element]);
116 if (strpos($id, '_date_low') !== FALSE ||
strpos($id, '_date_high') !== FALSE) {
117 $entityName = strstr($id, '_date', TRUE);
118 if (!empty($result['relative_dates']) && array_key_exists($entityName, $result['relative_dates'])) {
120 $result["{$entityName}_date_relative"] = $result['relative_dates'][$entityName];
123 $result[$id] = $value;
124 $result["{$entityName}_date_relative"] = 0;
128 $result[$id] = $value;
130 unset($result[$element]);
133 if (!empty($value) && is_array($value)) {
134 if (in_array($element, $specialFields)) {
135 // Remove the element to minimise support for legacy formats. It is stored in $value
136 // so will be re-set with the right name.
137 unset($result[$element]);
138 $element = str_replace('member_membership_type_id', 'membership_type_id', $element);
139 $element = str_replace('member_status_id', 'membership_status_id', $element);
140 CRM_Contact_BAO_Query
::legacyConvertFormValues($element, $value);
141 $result[$element] = $value;
143 // As per the OK (Operator as Key) value format, value array may contain key
144 // as an operator so to ensure the default is always set actual value
145 elseif (in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
146 $result[$element] = CRM_Utils_Array
::value(key($value), $value);
147 if (is_string($result[$element])) {
148 $result[$element] = str_replace("%", '', $result[$element]);
152 if (substr($element, 0, 7) == 'custom_' &&
153 (substr($element, -5, 5) == '_from' ||
substr($element, -3, 3) == '_to')
155 // Ensure the _relative field is set if from or to are set to ensure custom date
156 // fields with 'from' or 'to' values are displayed when the are set in the smart group
157 // being loaded. (CRM-17116)
158 if (!isset($result[CRM_Contact_BAO_Query
::getCustomFieldName($element) . '_relative'])) {
159 $result[CRM_Contact_BAO_Query
::getCustomFieldName($element) . '_relative'] = 0;
162 // check to see if we need to convert the old privacy array
164 if (!empty($result['privacy'])) {
165 if (is_array($result['privacy'])) {
166 $result['privacy_operator'] = 'AND';
167 $result['privacy_toggle'] = 1;
168 if (isset($result['privacy']['do_not_toggle'])) {
169 if ($result['privacy']['do_not_toggle']) {
170 $result['privacy_toggle'] = 2;
172 unset($result['privacy']['do_not_toggle']);
175 $result['privacy_options'] = array();
176 foreach ($result['privacy'] as $name => $val) {
178 $result['privacy_options'][] = $name;
182 unset($result['privacy']);
190 * Get search parameters.
196 public static function getSearchParams($id) {
197 $fv = self
::getFormValues($id);
198 //check if the saved search has mapping id
199 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'mapping_id')) {
200 return CRM_Core_BAO_Mapping
::formattedFields($fv);
202 elseif (!empty($fv['customSearchID'])) {
206 return CRM_Contact_BAO_Query
::convertFormValues($fv);
211 * Get the where clause for a saved search.
215 * @param array $tables
216 * (reference ) add the tables that are needed for the select clause.
217 * @param array $whereTables
218 * (reference ) add the tables that are needed for the where clause.
221 * the where clause for this saved search
223 public static function whereClause($id, &$tables, &$whereTables) {
224 $params = self
::getSearchParams($id);
226 if (!empty($params['customSearchID'])) {
227 // this has not yet been implemented
230 return CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
237 * Contact IDS Sql (whatever that means!).
243 public static function contactIDsSQL($id) {
244 $params = self
::getSearchParams($id);
245 if ($params && !empty($params['customSearchID'])) {
246 return CRM_Contact_BAO_SearchCustom
::contactIDSQL(NULL, $id);
249 $tables = $whereTables = array('civicrm_contact' => 1);
250 $where = CRM_Contact_BAO_SavedSearch
::whereClause($id, $tables, $whereTables);
254 $from = CRM_Contact_BAO_Query
::fromClause($whereTables);
263 * Get from where email (whatever that means!).
269 public static function fromWhereEmail($id) {
270 $params = self
::getSearchParams($id);
273 if (!empty($params['customSearchID'])) {
274 return CRM_Contact_BAO_SearchCustom
::fromWhereEmail(NULL, $id);
277 $tables = $whereTables = array('civicrm_contact' => 1, 'civicrm_email' => 1);
278 $where = CRM_Contact_BAO_SavedSearch
::whereClause($id, $tables, $whereTables);
279 $from = CRM_Contact_BAO_Query
::fromClause($whereTables);
280 return array($from, $where);
286 FROM civicrm_contact contact_a
287 LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1)
290 $tables['civicrm_contact'] = $whereTables['civicrm_contact'] = 1;
291 $tables['civicrm_email'] = $whereTables['civicrm_email'] = 1;
292 return array($from, $where);
297 * Given a saved search compute the clause and the tables and store it for future use.
299 public function buildClause() {
300 $fv = unserialize($this->form_values
);
302 if ($this->mapping_id
) {
303 $params = CRM_Core_BAO_Mapping
::formattedFields($fv);
306 $params = CRM_Contact_BAO_Query
::convertFormValues($fv);
309 if (!empty($params)) {
310 $tables = $whereTables = array();
311 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
312 if (!empty($tables)) {
313 $this->select_tables
= serialize($tables);
315 if (!empty($whereTables)) {
316 $this->where_tables
= serialize($whereTables);
326 public function save($hook = TRUE) {
327 // first build the computed fields
328 $this->buildClause();
334 * Given an id, get the name of the saved search.
337 * The id of the saved search.
339 * @param string $value
342 * the name of the saved search
344 public static function getName($id, $value = 'name') {
345 $group = new CRM_Contact_DAO_Group();
346 $group->saved_search_id
= $id;
347 if ($group->find(TRUE)) {
348 return $group->$value;
354 * Create a smart group from normalised values.
356 * @param array $params
358 * @return \CRM_Contact_DAO_SavedSearch
360 public static function create(&$params) {
361 $savedSearch = new CRM_Contact_DAO_SavedSearch();
362 if (isset($params['formValues']) &&
363 !empty($params['formValues'])
365 $savedSearch->form_values
= serialize($params['formValues']);
368 $savedSearch->form_values
= NULL;
371 $savedSearch->is_active
= CRM_Utils_Array
::value('is_active', $params, 1);
372 $savedSearch->mapping_id
= CRM_Utils_Array
::value('mapping_id', $params, 'null');
373 $savedSearch->custom_search_id
= CRM_Utils_Array
::value('custom_search_id', $params, 'null');
374 $savedSearch->id
= CRM_Utils_Array
::value('id', $params, NULL);
376 $savedSearch->save();
384 * @param string $fieldName
385 * @param array $fieldDef
386 * @param int $counter
388 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
389 if ($fieldName == 'form_values') {
390 // A dummy value for form_values.
391 $this->{$fieldName} = serialize(
392 array('sort_name' => "SortName{$counter}"));
395 parent
::assignTestValues($fieldName, $fieldDef, $counter);
400 * Store relative dates in separate array format
402 * @param array $queryParams
403 * @param array $formValues
405 public static function saveRelativeDates(&$queryParams, $formValues) {
406 $relativeDates = array('relative_dates' => array());
407 foreach ($formValues as $id => $value) {
408 if (preg_match('/_date_relative$/', $id) && !empty($value)) {
409 $entityName = strstr($id, '_date', TRUE);
410 $relativeDates['relative_dates'][$entityName] = $value;
413 // merge with original queryParams if relative date value(s) found
414 if (count($relativeDates['relative_dates'])) {
415 $queryParams = array_merge($queryParams, $relativeDates);
420 * Store search variables in $queryParams which were skipped while processing query params,
421 * precisely at CRM_Contact_BAO_Query::fixWhereValues(...). But these variable are required in
422 * building smart group criteria otherwise it will cause issues like CRM-18585,CRM-19571
424 * @param array $queryParams
425 * @param array $formValues
427 public static function saveSkippedElement(&$queryParams, $formValues) {
428 // these are elements which are skipped in a smart group criteria
429 $specialElements = array(
432 'display_relationship_type',
434 foreach ($specialElements as $element) {
435 if (!empty($formValues[$element])) {
436 $queryParams[] = array($element, '=', $formValues[$element], 0, 0);
442 * Decode relative custom fields (converted by CRM_Contact_BAO_Query->convertCustomRelativeFields(...))
443 * into desired formValues
445 * @param array $formValues
446 * @param string $fieldName
448 * @param array|string|int $value
450 public static function decodeRelativeFields(&$formValues, $fieldName, $op, $value) {
451 // check if its a custom date field, if yes then 'searchDate' format the value
452 $isCustomDateField = CRM_Contact_BAO_Query
::isCustomDateField($fieldName);
454 // select date range as default
455 if ($isCustomDateField) {
456 $formValues[$fieldName . '_relative'] = 0;
460 if ($isCustomDateField) {
461 list($formValues[$fieldName . '_from'], $formValues[$fieldName . '_from_time']) = CRM_Utils_Date
::setDateDefaults($value[0], 'searchDate');
462 list($formValues[$fieldName . '_to'], $formValues[$fieldName . '_to_time']) = CRM_Utils_Date
::setDateDefaults($value[1], 'searchDate');
465 list($formValues[$fieldName . '_from'], $formValues[$fieldName . '_to']) = $value;
470 if ($isCustomDateField) {
471 list($formValues[$fieldName . '_from'], $formValues[$fieldName . '_from_time']) = CRM_Utils_Date
::setDateDefaults($value, 'searchDate');
474 $formValues[$fieldName . '_from'] = $value;
479 if ($isCustomDateField) {
480 list($formValues[$fieldName . '_to'], $formValues[$fieldName . '_to_time']) = CRM_Utils_Date
::setDateDefaults($value, 'searchDate');
483 $formValues[$fieldName . '_to'] = $value;