3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This file is for activity search.
21 class CRM_Activity_Form_Search
extends CRM_Core_Form_Search
{
24 * The params that are sent to the query.
28 protected $_queryParams;
31 * Are we restricting ourselves to a single contact.
35 protected $_single = FALSE;
38 * Are we restricting ourselves to a single contact.
45 * Prefix for the controller.
48 protected $_prefix = 'activity_';
51 * The saved search ID retrieved from the GET vars.
60 public function getDefaultEntity() {
65 * Processing needed for buildForm and later.
67 * @throws \CRM_Core_Exception
68 * @throws \CiviCRM_API3_Exception
70 public function preProcess() {
71 $this->set('searchFormName', 'Search');
73 // set the button names
74 $this->_actionButtonName
= $this->getButtonName('next', 'action');
77 $this->sortNameOnly
= TRUE;
81 if (empty($this->_formValues
)) {
82 if (isset($this->_ssID
)) {
83 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
87 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
88 $selector = new CRM_Activity_Selector_Search($this->_queryParams
,
96 if ($this->_context
== 'user') {
97 $prefix = $this->_prefix
;
100 $this->assign("{$prefix}limit", $this->_limit
);
101 $this->assign("{$prefix}single", $this->_single
);
103 $controller = new CRM_Core_Selector_Controller($selector,
104 $this->get(CRM_Utils_Pager
::PAGE_ID
),
106 CRM_Core_Action
::VIEW
,
108 CRM_Core_Selector_Controller
::TRANSFER
,
111 $controller->setEmbedded(TRUE);
112 $controller->moveFromSessionToTemplate();
114 $this->assign('summary', $this->get('summary'));
118 * Build the form object.
120 * @throws \CRM_Core_Exception
121 * @throws \CiviCRM_API3_Exception
123 public function buildQuickForm() {
124 parent
::buildQuickForm();
125 $this->addSortNameField();
127 CRM_Activity_BAO_Query
::buildSearchForm($this);
129 $rows = $this->get('rows');
130 if (is_array($rows)) {
131 if (!$this->_single
) {
132 $this->addRowSelectors($rows);
135 $this->addTaskMenu(CRM_Activity_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
141 * The post processing of the form gets done here.
143 * Key things done during post processing are
144 * - check for reset or next request. if present, skip post procesing.
145 * - now check if user requested running a saved search, if so, then
146 * the form values associated with the saved search are used for searching.
147 * - if user has done a submit with new values the regular post submissing is
150 * The processing consists of using a Selector / Controller framework for getting the
153 * @throws \CRM_Core_Exception
155 public function postProcess() {
161 $this->setFormValues();
162 if (!empty($_POST)) {
168 'priority_id' => 'activity_priority_id',
171 CRM_Contact_BAO_Query
::processSpecialFormValue($this->_formValues
, $specialParams, $changeNames);
173 $this->fixFormValues();
175 if (isset($this->_ssID
) && empty($_POST)) {
176 // if we are editing / running a saved search and the form has not been posted
177 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
180 // We don't show test records in summaries or dashboards
181 if (empty($this->_formValues
['activity_test']) && $this->_force
) {
182 $this->_formValues
["activity_test"] = 0;
185 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
187 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
189 $this->set('queryParams', $this->_queryParams
);
191 $buttonName = $this->controller
->getButtonName();
192 if ($buttonName == $this->_actionButtonName
) {
193 // check actionName and if next, then do not repeat a search, since we are going to the next page
194 // hack, make sure we reset the task values
195 $stateMachine = $this->controller
->getStateMachine();
196 $formName = $stateMachine->getTaskFormName();
197 $this->controller
->resetPage($formName);
201 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
203 $selector = new CRM_Activity_Selector_Search($this->_queryParams
,
210 $selector->setKey($this->controller
->_key
);
213 if ($this->_context
=== 'basic' ||
$this->_context
=== 'user') {
214 $prefix = $this->_prefix
;
217 $controller = new CRM_Core_Selector_Controller($selector,
218 $this->get(CRM_Utils_Pager
::PAGE_ID
),
220 CRM_Core_Action
::VIEW
,
222 CRM_Core_Selector_Controller
::SESSION
,
225 $controller->setEmbedded(TRUE);
226 $query = &$selector->getQuery();
228 if ($this->_context
=== 'user') {
229 $query->setSkipPermission(TRUE);
235 * Probably more hackery than anything else.
237 * @throws \CRM_Core_Exception
239 public function fixFormValues() {
240 if (!$this->_force
) {
244 $status = CRM_Utils_Request
::retrieve('status', 'String', $this);
246 $this->_formValues
['activity_status_id'] = $status;
247 $this->_defaults
['activity_status_id'] = $status;
250 $survey = CRM_Utils_Request
::retrieve('survey', 'Positive');
253 $this->_formValues
['activity_survey_id'] = $this->_defaults
['activity_survey_id'] = $survey;
254 $sid = $this->_formValues
['activity_survey_id'] ??
NULL;
255 $activity_type_id = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $sid, 'activity_type_id');
257 // since checkbox are replaced by multiple select option
258 $this->_formValues
['activity_type_id'] = $activity_type_id;
259 $this->_defaults
['activity_type_id'] = $activity_type_id;
261 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
264 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
266 $this->_formValues
['contact_id'] = $cid;
268 $activity_role = CRM_Utils_Request
::retrieve('activity_role', 'Positive', $this);
270 if ($activity_role) {
271 $this->_formValues
['activity_role'] = $activity_role;
274 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'sort_name');
276 // also assign individual mode to the template
277 $this->_single
= TRUE;
281 // Enable search activity by custom value
282 // @todo this is not good security practice. Instead define entity fields in metadata &
283 // use getEntity Defaults
284 $requestParams = CRM_Utils_Request
::exportValues();
285 foreach (array_keys($requestParams) as $key) {
286 if (substr($key, 0, 7) != 'custom_') {
289 elseif (empty($requestParams[$key])) {
292 $customValue = CRM_Utils_Request
::retrieve($key, 'String', $this);
294 $this->_formValues
[$key] = $customValue;
295 $this->_defaults
[$key] = $customValue;
299 if (!empty($this->_defaults
)) {
300 $this->setDefaults($this->_defaults
);
305 * Return a descriptive name for the page, used in wizard header
309 public function getTitle() {
310 return ts('Find Activities');
314 * Get metadata for the entity fields.
318 * @throws \CiviCRM_API3_Exception
320 protected function getEntityMetadata() {
321 return CRM_Activity_BAO_Query
::getSearchFieldMetadata();
325 * Set the metadata for the form.
327 protected function setSearchMetadata() {
328 $this->addSearchFieldMetadata(['Activity' => $this->getEntityMetadata()]);