3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class provides the functionality to save a search.
37 * Saved Searches are used for saving frequently used queries
39 class CRM_Contact_Form_Task_SaveSearch
extends CRM_Contact_Form_Task
{
42 * Saved search id if any.
49 * Build all the data structures needed to build the form.
51 public function preProcess() {
54 // get the submitted values of the search form
55 // we'll need to get fv from either search or adv search in the future
56 if ($this->_action
== CRM_Core_Action
::ADVANCED
) {
57 $values = $this->controller
->exportValues('Advanced');
59 elseif ($this->_action
== CRM_Core_Action
::PROFILE
) {
60 $values = $this->controller
->exportValues('Builder');
62 elseif ($this->_action
== CRM_Core_Action
::COPY
) {
63 $values = $this->controller
->exportValues('Custom');
66 $values = $this->controller
->exportValues('Basic');
70 $modeValue = CRM_Contact_Form_Search
::getModeValue($values['component_mode']);
71 $className = $modeValue['taskClassName'];
72 $taskList = $className::taskTitles();
73 $this->_task
= CRM_Utils_Array
::value('task', $values);
74 $this->assign('taskName', CRM_Utils_Array
::value($this->_task
, $taskList));
78 * Build the form object.
81 * - displaying the QILL (query in local language)
82 * - displaying elements for saving the search
84 public function buildQuickForm() {
85 // @todo sync this more with CRM_Group_Form_Edit.
86 $query = new CRM_Contact_BAO_Query($this->get('queryParams'));
87 $this->assign('qill', $query->qill());
89 // Values from the search form
90 $formValues = $this->controller
->exportValues();
92 // the name and description are actually stored with the group and not the saved search
93 $this->add('text', 'title', ts('Name'),
94 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'title'), TRUE
97 $this->addElement('textarea', 'description', ts('Description'),
98 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'description')
101 $groupTypes = CRM_Core_OptionGroup
::values('group_type', TRUE);
102 unset($groupTypes['Access Control']);
103 if (!CRM_Core_Permission
::access('CiviMail')) {
104 $isWorkFlowEnabled = CRM_Mailing_Info
::workflowEnabled();
105 if ($isWorkFlowEnabled &&
106 !CRM_Core_Permission
::check('create mailings') &&
107 !CRM_Core_Permission
::check('schedule mailings') &&
108 !CRM_Core_Permission
::check('approve mailings')
110 unset($groupTypes['Mailing List']);
114 if (!empty($groupTypes)) {
115 $this->addCheckBox('group_type',
118 NULL, NULL, NULL, NULL, ' '
123 CRM_Group_Form_Edit
::buildParentGroups($this);
124 CRM_Group_Form_Edit
::buildGroupOrganizations($this);
126 // get the group id for the saved search
128 if (isset($this->_id
)) {
129 $groupID = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
134 $this->addDefaultButtons(ts('Update Smart Group'));
137 $this->addDefaultButtons(ts('Save Smart Group'));
138 $this->assign('partiallySelected', $formValues['radio_ts'] != 'ts_all');
140 $this->addRule('title', ts('Name already exists in Database.'),
141 'objectExists', ['CRM_Contact_DAO_Group', $groupID, 'title']
146 * Process the form after the input has been submitted and validated.
148 public function postProcess() {
149 // saved search form values
150 // get form values of all the forms in this controller
151 $formValues = $this->controller
->exportValues();
153 $isAdvanced = $this->get('isAdvanced');
154 $isSearchBuilder = $this->get('isSearchBuilder');
156 // add mapping record only for search builder saved search
158 if ($isAdvanced == '2' && $isSearchBuilder == '1') {
159 //save the mapping for search builder
162 //save record in mapping table
164 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
166 $mapping = CRM_Core_BAO_Mapping
::add($mappingParams);
167 $mappingId = $mapping->id
;
170 //get the mapping id from saved search
172 $savedSearch = new CRM_Contact_BAO_SavedSearch();
173 $savedSearch->id
= $this->_id
;
174 $savedSearch->find(TRUE);
175 $mappingId = $savedSearch->mapping_id
;
178 //save mapping fields
179 CRM_Core_BAO_Mapping
::saveMappingFields($formValues, $mappingId);
183 $savedSearch = new CRM_Contact_BAO_SavedSearch();
184 $savedSearch->id
= $this->_id
;
185 $queryParams = $this->get('queryParams');
187 // Use the query parameters rather than the form values - these have already been assessed / converted
188 // with the extra knowledge that the form has.
189 // Note that we want to move towards a standardised way of saving the query that is not
190 // an exact match for the form requirements & task the form layer with converting backwards and forwards.
191 // Ideally per CRM-17075 we will use entity reference fields heavily in the form layer & convert to the
192 // sql operator syntax at the query layer.
193 if (!$isSearchBuilder) {
194 CRM_Contact_BAO_SavedSearch
::saveRelativeDates($queryParams, $formValues);
195 CRM_Contact_BAO_SavedSearch
::saveSkippedElement($queryParams, $formValues);
196 $savedSearch->form_values
= serialize($queryParams);
199 // We want search builder to be able to convert back & forth at the form layer
200 // to a standardised style - but it can't yet!
201 $savedSearch->form_values
= serialize($formValues);
204 $savedSearch->mapping_id
= $mappingId;
205 $savedSearch->search_custom_id
= $this->get('customSearchID');
206 $savedSearch->save();
207 $this->set('ssID', $savedSearch->id
);
208 CRM_Core_Session
::setStatus(ts("Your smart group has been saved as '%1'.", [1 => $formValues['title']]), ts('Group Saved'), 'success');
210 // also create a group that is associated with this saved search only if new saved search
212 $params['title'] = $formValues['title'];
213 $params['description'] = $formValues['description'];
214 if (isset($formValues['group_type']) && is_array($formValues['group_type']) && count($formValues['group_type'])) {
215 $params['group_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
216 array_keys($formValues['group_type'])) . CRM_Core_DAO
::VALUE_SEPARATOR
;
219 $params['group_type'] = '';
221 $params['visibility'] = 'User and User Admin Only';
222 $params['saved_search_id'] = $savedSearch->id
;
223 $params['is_active'] = 1;
226 $params['parents'] = $formValues['parents'];
229 $params['id'] = CRM_Contact_BAO_SavedSearch
::getName($this->_id
, 'id');
232 $group = CRM_Contact_BAO_Group
::create($params);
234 // Update mapping with the name and description of the group.
235 if ($mappingId && $group) {
238 'name' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $group->id
, 'name', 'id'),
239 'description' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $group->id
, 'description', 'id'),
240 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
242 CRM_Core_BAO_Mapping
::add($mappingParams);
246 $this->_id
= $savedSearch->id
;
249 if (!empty($formValues['parents'])) {
250 CRM_Contact_BAO_GroupNestingCache
::update();
259 public function setDefaultValues() {
261 if (empty($defaults['parents'])) {
262 $defaults['parents'] = CRM_Core_BAO_Domain
::getGroupId();