CRM/Contact/BAO/SavedSearch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business object for Saved searches
  38  *
  39  */
  40 class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
  41
  42   /**
  43    * class constructor
  44    *
  45    * @return object CRM_Contact_BAO_SavedSearch
  46    */
  47   function __construct() {
  48     parent::__construct();
  49   }
  50
  51   /**
  52    * query the db for all saved searches.
  53    *
  54    * @return array $aSavedSearch - contains the search name as value and and id as key
  55    *
  56    * @access public
  57    */
  58   function getAll() {
  59     $savedSearch = new CRM_Contact_DAO_SavedSearch();
  60     $savedSearch->selectAdd();
  61     $savedSearch->selectAdd('id, name');
  62     $savedSearch->find();
  63     while ($savedSearch->fetch()) {
  64       $aSavedSearch[$savedSearch->id] = $savedSearch->name;
  65     }
  66     return $aSavedSearch;
  67   }
  68
  69   /**
  70    * Takes a bunch of params that are needed to match certain criteria and
  71    * retrieves the relevant objects.
  72    *
  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
  75    *
  76    * @return object CRM_Contact_BAO_SavedSearch
  77    * @access public
  78    * @static
  79    */
  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);
  85       return $savedSearch;
  86     }
  87     return NULL;
  88   }
  89
  90   /**
  91    * given an id, extract the formValues of the saved search
  92    *
  93    * @param int $id the id of the saved search
  94    *
  95    * @return array the values of the posted saved search
  96    * @access public
  97    * @static
  98    */
  99   static function &getFormValues($id) {
 100     $fv = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'form_values');
 101     $result = NULL;
 102     if ($fv) {
 103       // make sure u unserialize - since it's stored in serialized form
 104       $result = unserialize($fv);
 105     }
 106
 107     // check to see if we need to convert the old privacy array
 108     // CRM-9180
 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;
 116           }
 117           unset($result['privacy']['do_not_toggle']);
 118         }
 119
 120         $result['privacy_options'] = array();
 121         foreach ($result['privacy'] as $name => $value) {
 122           if ($value) {
 123             $result['privacy_options'][] = $name;
 124           }
 125         }
 126       }
 127       unset($result['privacy']);
 128     }
 129
 130     return $result;
 131   }
 132
 133   static function getSearchParams($id) {
 134     $fv = self::getFormValues($id);
 135     //check if the saved seach has mapping id
 136     if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $id, 'mapping_id')) {
 137       return CRM_Core_BAO_Mapping::formattedFields($fv);
 138     }
 139     elseif (CRM_Utils_Array::value('customSearchID', $fv)) {
 140       return $fv;
 141     }
 142     else {
 143       return CRM_Contact_BAO_Query::convertFormValues($fv);
 144     }
 145   }
 146
 147   /**
 148    * get the where clause for a saved search
 149    *
 150    * @param int $id saved search id
 151    * @param  array $tables (reference ) add the tables that are needed for the select clause
 152    * @param  array $whereTables (reference ) add the tables that are needed for the where clause
 153    *
 154    * @return string the where clause for this saved search
 155    * @access public
 156    * @static
 157    */
 158   static function whereClause($id, &$tables, &$whereTables) {
 159     $params = self::getSearchParams($id);
 160     if ($params) {
 161       if (CRM_Utils_Array::value('customSearchID', $params)) {
 162         // this has not yet been implemented
 163       } else {
 164       return CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
 165     }
 166     }
 167     return NULL;
 168   }
 169
 170   static function contactIDsSQL($id) {
 171     $params = self::getSearchParams($id);
 172     if ($params &&
 173       CRM_Utils_Array::value('customSearchID', $params)
 174     ) {
 175       return CRM_Contact_BAO_SearchCustom::contactIDSQL(NULL, $id);
 176     }
 177     else {
 178       $tables = $whereTables = array('civicrm_contact' => 1);
 179       $where = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
 180       if (!$where) {
 181         $where = '( 1 )';
 182       }
 183       $from = CRM_Contact_BAO_Query::fromClause($whereTables);
 184       return "
 185 SELECT contact_a.id
 186 $from
 187 WHERE  $where";
 188     }
 189   }
 190
 191   static function fromWhereEmail($id) {
 192     $params = self::getSearchParams($id);
 193
 194     if ($params) {
 195       if (CRM_Utils_Array::value('customSearchID', $params)) {
 196         return CRM_Contact_BAO_SearchCustom::fromWhereEmail(NULL, $id);
 197       }
 198       else {
 199         $tables = $whereTables = array('civicrm_contact' => 1, 'civicrm_email' => 1);
 200         $where  = CRM_Contact_BAO_SavedSearch::whereClause($id, $tables, $whereTables);
 201         $from   = CRM_Contact_BAO_Query::fromClause($whereTables);
 202         return array($from, $where);
 203       }
 204     }
 205     else {
 206       // fix for CRM-7240
 207       $from = "
 208 FROM      civicrm_contact contact_a
 209 LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1)
 210 ";
 211       $where = " ( 1 ) ";
 212       $tables['civicrm_contact'] = $whereTables['civicrm_contact'] = 1;
 213       $tables['civicrm_email'] = $whereTables['civicrm_email'] = 1;
 214       return array($from, $where);
 215     }
 216   }
 217
 218   /**
 219    * given a saved search compute the clause and the tables
 220    * and store it for future use
 221    */
 222   function buildClause() {
 223     $fv = unserialize($this->form_values);
 224
 225     if ($this->mapping_id) {
 226       $params = CRM_Core_BAO_Mapping::formattedFields($fv);
 227     }
 228     else {
 229       $params = CRM_Contact_BAO_Query::convertFormValues($fv);
 230     }
 231
 232     if (!empty($params)) {
 233       $tables = $whereTables = array();
 234       $this->where_clause = CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables);
 235       if (!empty($tables)) {
 236         $this->select_tables = serialize($tables);
 237       }
 238       if (!empty($whereTables)) {
 239         $this->where_tables = serialize($whereTables);
 240       }
 241     }
 242
 243     return;
 244   }
 245
 246   function save() {
 247     // first build the computed fields
 248     $this->buildClause();
 249
 250     parent::save();
 251   }
 252
 253   /**
 254    * given an id, get the name of the saved search
 255    *
 256    * @param int $id the id of the saved search
 257    *
 258    * @return string the name of the saved search
 259    * @access public
 260    * @static
 261    */
 262   static function getName($id, $value = 'name') {
 263     $group = new CRM_Contact_DAO_Group();
 264     $group->saved_search_id = $id;
 265     if ($group->find(TRUE)) {
 266       return $group->$value;
 267     }
 268     return NULL;
 269   }
 270
 271   /**
 272    * Given a label and a set of normalized POST
 273    * formValues, create a smart group with that
 274    */
 275   static function create(&$params) {
 276     $savedSearch = new CRM_Contact_DAO_SavedSearch();
 277     if (isset($params['formValues']) &&
 278       !empty($params['formValues'])
 279     ) {
 280       $savedSearch->form_values = serialize($params['formValues']);
 281     }
 282     else {
 283       $savedSearch->form_values = 'null';
 284     }
 285
 286     $savedSearch->is_active = CRM_Utils_Array::value('is_active', $params, 1);
 287     $savedSearch->mapping_id = CRM_Utils_Array::value('mapping_id', $params, 'null');
 288     $savedSearch->custom_search_id = CRM_Utils_Array::value('custom_search_id', $params, 'null');
 289     $savedSearch->id = CRM_Utils_Array::value('id', $params, NULL);
 290
 291     $savedSearch->save();
 292
 293     return $savedSearch;
 294   }
 295 }
 296