Commit | Line | Data |
---|---|---|
3efb5b86 CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
3efb5b86 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
3efb5b86 CW |
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. | | |
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 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 | +--------------------------------------------------------------------+ | |
25 | */ | |
26 | ||
27 | /** | |
28 | * Base class for most search forms | |
29 | */ | |
30 | class CRM_Core_Form_Search extends CRM_Core_Form { | |
31 | ||
48473171 CW |
32 | /** |
33 | * Are we forced to run a search | |
34 | * | |
35 | * @var int | |
36 | * @access protected | |
37 | */ | |
38 | protected $_force; | |
39 | ||
40 | /** | |
41 | * name of search button | |
42 | * | |
43 | * @var string | |
44 | * @access protected | |
45 | */ | |
46 | protected $_searchButtonName; | |
47 | ||
48 | /** | |
49 | * name of action button | |
50 | * | |
51 | * @var string | |
52 | * @access protected | |
53 | */ | |
54 | protected $_actionButtonName; | |
55 | ||
56 | /** | |
57 | * form values that we will be using | |
58 | * | |
59 | * @var array | |
60 | * @access public | |
61 | */ | |
62 | public $_formValues; | |
63 | ||
64 | /** | |
65 | * have we already done this search | |
66 | * | |
67 | * @access protected | |
68 | * @var boolean | |
69 | */ | |
70 | protected $_done; | |
71 | ||
72 | /** | |
73 | * what context are we being invoked from | |
74 | * | |
75 | * @access protected | |
76 | * @var string | |
77 | */ | |
78 | protected $_context = NULL; | |
79 | ||
34197a55 CW |
80 | /** |
81 | * Common buildform tasks required by all searches | |
82 | */ | |
3efb5b86 CW |
83 | function buildQuickform() { |
84 | $resources = CRM_Core_Resources::singleton(); | |
85 | ||
86 | if ($resources->ajaxPopupsEnabled) { | |
87 | $resources->addScriptFile('civicrm', 'js/crm.livePage.js'); | |
88 | // Script needed by some popups | |
89 | $this->assign('includeWysiwygEditor', TRUE); | |
90 | } | |
91 | ||
92 | $resources->addScriptFile('civicrm', 'js/crm.searchForm.js'); | |
93 | ||
94 | $this->addButtons(array( | |
95 | array( | |
96 | 'type' => 'refresh', | |
97 | 'name' => ts('Search'), | |
98 | 'isDefault' => TRUE, | |
99 | ), | |
100 | )); | |
8d36b801 | 101 | |
023e90c3 | 102 | $this->addClass('crm-search-form'); |
8d36b801 CW |
103 | } |
104 | ||
105 | /** | |
106 | * Add checkboxes for each row plus a master checkbox | |
107 | */ | |
108 | function addRowSelectors($rows) { | |
109 | $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows')); | |
110 | foreach ($rows as $row) { | |
111 | $this->addElement('checkbox', $row['checkbox'], NULL, NULL, array('class' => 'select-row')); | |
112 | } | |
3efb5b86 | 113 | } |
34197a55 CW |
114 | |
115 | /** | |
116 | * Add actions menu to search results form | |
117 | * @param $tasks | |
118 | */ | |
119 | function addTaskMenu($tasks) { | |
120 | if (is_array($tasks) && !empty($tasks)) { | |
121 | $tasks = array('' => ts('Actions')) + $tasks; | |
122 | $this->add('select', 'task', NULL, $tasks, FALSE, array('class' => 'crm-select2 crm-action-menu huge crm-search-result-actions')); | |
123 | $this->add('submit', $this->_actionButtonName, ts('Go'), array('class' => 'hiddenElement crm-search-go-button')); | |
8d36b801 CW |
124 | |
125 | // Radio to choose "All items" or "Selected items only" | |
126 | $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked')); | |
127 | $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all'); | |
128 | $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']); | |
129 | $this->assign('ts_all_id', $allRowsRadio->_attributes['id']); | |
34197a55 CW |
130 | } |
131 | } | |
3efb5b86 | 132 | } |