Support a multiple select for activity types to include & exclude
[civicrm-core.git] / CRM / Activity / Form / ActivityFilter.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
32 */
33
34 /**
35 * This class generates form components for Activity Filter.
36 */
37 class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form {
38 public function buildQuickForm() {
39 // add activity search filter
40 $activityOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
41 asort($activityOptions);
42
43 $this->add('select', 'activity_type_filter_id', ts('Include'), $activityOptions, FALSE, ['class' => 'crm-select2', 'multiple' => TRUE, 'placeholder' => ts('- all activity type(s) -')]);
44 $this->add('select', 'activity_type_exclude_filter_id', ts('Exclude'), $activityOptions, FALSE, ['class' => 'crm-select2', 'multiple' => TRUE, 'placeholder' => ts('- no types excluded -')]);
45 $this->addDatePickerRange('activity_date_time', ts('Date'));
46 $this->addSelect('status_id',
47 array('entity' => 'activity', 'multiple' => 'multiple', 'option_url' => NULL, 'placeholder' => ts('- any -'))
48 );
49
50 $this->assign('suppressForm', TRUE);
51 }
52
53 /**
54 * This virtual function is used to set the default values of
55 * various form elements
56 *
57 * access public
58 *
59 * @return array
60 * reference to the array of default values
61 */
62 public function setDefaultValues() {
63 // CRM-11761 retrieve user's activity filter preferences
64 $defaults = array();
65 if (Civi::settings()->get('preserve_activity_tab_filter') && (CRM_Core_Session::getLoggedInContactID())) {
66 $defaults = Civi::contactSettings()->get('activity_tab_filter');
67 }
68 // set Activity status 'Scheduled' by default only for dashlet
69 elseif (strstr(CRM_Utils_Array::value('q', $_GET), 'dashlet')) {
70 $defaults['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled');
71 }
72 return $defaults;
73 }
74
75 }