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. |
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 along with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2014
40 * This file is for activity search
42 class CRM_Activity_Form_Search
extends CRM_Core_Form_Search
{
45 * the params that are sent to the query
50 protected $_queryParams;
53 * are we restricting ourselves to a single contact
58 protected $_single = FALSE;
61 * are we restricting ourselves to a single contact
66 protected $_limit = NULL;
69 * prefix for the controller
72 protected $_prefix = "activity_";
77 * the saved search ID retrieved from the GET vars
85 * processing needed for buildForm and later
90 function preProcess() {
91 $this->set('searchFormName', 'Search');
94 * set the button names
96 $this->_searchButtonName
= $this->getButtonName('refresh');
97 $this->_actionButtonName
= $this->getButtonName('next', 'action');
100 $this->defaults
= array();
103 * we allow the controller to set force/reset externally, useful when we are being
104 * driven by the wizard framework
106 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
107 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
108 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
109 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
111 $this->assign("context", $this->_context
);
113 // get user submitted values
114 // get it from controller only if form has been submitted, else preProcess has set this
115 if (!empty($_POST) && !$this->controller
->isModal()) {
116 $this->_formValues
= $this->controller
->exportValues($this->_name
);
119 $this->_formValues
= $this->get('formValues');
122 if (empty($this->_formValues
)) {
123 if (isset($this->_ssID
)) {
124 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
129 $this->postProcess();
130 $this->set('force', 0);
134 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
135 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
136 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
140 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
141 $selector = new CRM_Activity_Selector_Search($this->_queryParams
,
149 if ($this->_context
== 'user') {
150 $prefix = $this->_prefix
;
153 $this->assign("{$prefix}limit", $this->_limit
);
154 $this->assign("{$prefix}single", $this->_single
);
156 $controller = new CRM_Core_Selector_Controller($selector,
157 $this->get(CRM_Utils_Pager
::PAGE_ID
),
159 CRM_Core_Action
::VIEW
,
161 CRM_Core_Selector_Controller
::TRANSFER
,
164 $controller->setEmbedded(TRUE);
165 $controller->moveFromSessionToTemplate();
167 $this->assign('summary', $this->get('summary'));
177 function buildQuickForm() {
178 parent
::buildQuickForm();
179 $this->addElement('text', 'sort_name', ts('Name or Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
181 CRM_Activity_BAO_Query
::buildSearchForm($this);
183 $rows = $this->get('rows');
184 if (is_array($rows)) {
185 if (!$this->_single
) {
186 $this->addRowSelectors($rows);
189 $permission = CRM_Core_Permission
::getPermission();
191 $this->addTaskMenu(CRM_Activity_Task
::permissionedTaskTitles($permission));
197 * The post processing of the form gets done here.
199 * Key things done during post processing are
200 * - check for reset or next request. if present, skip post procesing.
201 * - now check if user requested running a saved search, if so, then
202 * the form values associated with the saved search are used for searching.
203 * - if user has done a submit with new values the regular post submissing is
205 * The processing consists of using a Selector / Controller framework for getting the
213 function postProcess() {
220 if (!empty($_POST)) {
221 $this->_formValues
= $this->controller
->exportValues($this->_name
);
224 $this->fixFormValues();
226 if (isset($this->_ssID
) && empty($_POST)) {
227 // if we are editing / running a saved search and the form has not been posted
228 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
231 // We don't show test records in summaries or dashboards
232 if (empty($this->_formValues
['activity_test']) && $this->_force
) {
233 $this->_formValues
["activity_test"] = 0;
236 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
238 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
240 $this->set('formValues', $this->_formValues
);
241 $this->set('queryParams', $this->_queryParams
);
243 $buttonName = $this->controller
->getButtonName();
244 if ($buttonName == $this->_actionButtonName
) {
245 // check actionName and if next, then do not repeat a search, since we are going to the next page
246 // hack, make sure we reset the task values
247 $stateMachine = $this->controller
->getStateMachine();
248 $formName = $stateMachine->getTaskFormName();
249 $this->controller
->resetPage($formName);
254 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
255 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
256 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
260 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
262 $selector = new CRM_Activity_Selector_Search($this->_queryParams
,
269 $selector->setKey($this->controller
->_key
);
272 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
273 $prefix = $this->_prefix
;
276 $controller = new CRM_Core_Selector_Controller($selector,
277 $this->get(CRM_Utils_Pager
::PAGE_ID
),
279 CRM_Core_Action
::VIEW
,
281 CRM_Core_Selector_Controller
::SESSION
,
284 $controller->setEmbedded(TRUE);
285 $query = &$selector->getQuery();
287 if ($this->_context
== 'user') {
288 $query->setSkipPermission(TRUE);
293 function fixFormValues() {
294 if (!$this->_force
) {
298 $status = CRM_Utils_Request
::retrieve('status', 'String', $this);
300 $this->_formValues
['activity_status'] = $status;
301 $this->_defaults
['activity_status'] = $status;
304 $survey = CRM_Utils_Request
::retrieve('survey', 'Positive', CRM_Core_DAO
::$_nullObject);
307 $this->_formValues
['activity_survey_id'] = $this->_defaults
['activity_survey_id'] = $survey;
308 $sid = CRM_Utils_Array
::value('activity_survey_id', $this->_formValues
);
309 $activity_type_id = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $sid, 'activity_type_id');
311 $this->_formValues
['activity_type_id'][$activity_type_id] = 1;
312 $this->_defaults
['activity_type_id'][$activity_type_id] = 1;
314 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
317 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
319 $this->_formValues
['contact_id'] = $cid;
321 $activity_role = CRM_Utils_Request
::retrieve('activity_role', 'Positive', $this);
323 if ($activity_role) {
324 $this->_formValues
['activity_role'] = $activity_role;
327 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'sort_name');
329 // also assign individual mode to the template
330 $this->_single
= TRUE;
334 // Added for membership search
336 $signupType = CRM_Utils_Request
::retrieve('signupType', 'Positive',
337 CRM_Core_DAO
::$_nullObject
341 //$this->_formValues['activity_type_id'] = array();
342 $this->_formValues
['activity_role'] = 1;
343 $this->_defaults
['activity_role'] = 1;
344 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
346 $renew = CRM_Utils_Array
::key('Membership Renewal', $activityTypes);
347 $signup = CRM_Utils_Array
::key('Membership Signup', $activityTypes);
349 switch ($signupType) {
350 case 3: // signups and renewals
351 $this->_formValues
['activity_type_id'][$renew] = 1;
352 $this->_defaults
['activity_type_id'][$renew] = 1;
353 case 1: // signups only
354 $this->_formValues
['activity_type_id'][$signup] = 1;
355 $this->_defaults
['activity_type_id'][$signup] = 1;
358 case 2: // renewals only
359 $this->_formValues
['activity_type_id'][$renew] = 1;
360 $this->_defaults
['activity_type_id'][$renew] = 1;
365 $dateLow = CRM_Utils_Request
::retrieve('dateLow', 'String',
366 CRM_Core_DAO
::$_nullObject
370 $dateLow = date('m/d/Y', strtotime($dateLow));
371 $this->_formValues
['activity_date_relative'] = 0;
372 $this->_defaults
['activity_date_relative'] = 0;
373 $this->_formValues
['activity_date_low'] = $dateLow;
374 $this->_defaults
['activity_date_low'] = $dateLow;
377 $dateHigh = CRM_Utils_Request
::retrieve('dateHigh', 'String',
378 CRM_Core_DAO
::$_nullObject
382 // Activity date time assumes midnight at the beginning of the date
383 // This sets it to almost midnight at the end of the date
384 /* if ($dateHigh <= 99999999) {
385 $dateHigh = 1000000 * $dateHigh + 235959;
387 $dateHigh = date('m/d/Y', strtotime($dateHigh));
388 $this->_formValues
['activity_date_relative'] = 0;
389 $this->_defaults
['activity_date_relative'] = 0;
390 $this->_formValues
['activity_date_high'] = $dateHigh;
391 $this->_defaults
['activity_date_high'] = $dateHigh;
394 if (!empty($this->_defaults
)) {
395 $this->setDefaults($this->_defaults
);
402 function getFormValues() {
407 * Return a descriptive name for the page, used in wizard header
412 public function getTitle() {
413 return ts('Find Activities');