3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 +--------------------------------------------------------------------+
29 * Base class for most search forms
31 class CRM_Core_Form_Search
extends CRM_Core_Form
{
34 * Are we forced to run a search
41 * Name of search button
45 protected $_searchButtonName;
48 * Name of action button
52 protected $_actionButtonName;
55 * Form values that we will be using
62 * Have we already done this search
69 * What context are we being invoked from
73 protected $_context = NULL;
76 * The list of tasks or actions that a searcher can perform on a result set.
80 protected $_taskList = array();
83 * Declare entity reference fields as they will need to be converted.
85 * The entity reference format looks like '2,3' whereas the Query object expects array(2, 3)
86 * or array('IN' => array(2, 3). The latter is the one we are moving towards standardising on.
90 protected $entityReferenceFields = array();
93 * Builds the list of tasks or actions that a searcher can perform on a result set.
95 * To modify the task list, child classes should alter $this->_taskList,
96 * preferably by extending this method.
100 protected function buildTaskList() {
101 return $this->_taskList
;
105 * Common buildForm tasks required by all searches.
107 public function buildQuickform() {
108 CRM_Core_Resources
::singleton()
109 ->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header')
110 ->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
112 $this->addButtons(array(
115 'name' => ts('Search'),
120 $this->addClass('crm-search-form');
122 // for backwards compatibility we pass an argument to addTaskMenu even though
123 // it could just as well access $this->_taskList internally
124 $tasks = $this->buildTaskList();
125 $this->addTaskMenu($tasks);
129 * Add checkboxes for each row plus a master checkbox.
133 public function addRowSelectors($rows) {
134 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
136 foreach ($rows as $row) {
137 if (CRM_Utils_Array
::value('checkbox', $row)) {
138 $this->addElement('checkbox', $row['checkbox'], NULL, NULL, array('class' => 'select-row'));
145 * Add actions menu to search results form.
147 * @param array $tasks
149 public function addTaskMenu($tasks) {
150 if (is_array($tasks) && !empty($tasks)) {
151 $tasks = array('' => ts('Actions')) +
$tasks;
152 $this->add('select', 'task', NULL, $tasks, FALSE, array('class' => 'crm-select2 crm-action-menu fa-check-circle-o huge crm-search-result-actions'));
153 $this->add('submit', $this->_actionButtonName
, ts('Go'), array('class' => 'hiddenElement crm-search-go-button'));
155 // Radio to choose "All items" or "Selected items only"
156 $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
157 $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
158 $this->assign('ts_sel_id', $selectedRowsRadio->_attributes
['id']);
159 $this->assign('ts_all_id', $allRowsRadio->_attributes
['id']);
164 * Add the sort-name field to the form.
166 * There is a setting to determine whether email is included in the search & we look this up to determine
167 * which text to choose.
169 * Note that for translation purposes the full string works better than using 'prefix' hence we use override-able functions
170 * to define the string.
172 protected function addSortNameField() {
176 civicrm_api3('setting', 'getvalue', array('name' => 'includeEmailInName', 'group' => 'Search Preferences')) ?
$this->getSortNameLabelWithEmail() : $this->getSortNameLabelWithOutEmail(),
177 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
182 * Get the label for the sortName field if email searching is on.
184 * (email searching is a setting under search preferences).
188 protected function getSortNameLabelWithEmail() {
189 return ts('Name or Email');
193 * Get the label for the sortName field if email searching is off.
195 * (email searching is a setting under search preferences).
199 protected function getSortNameLabelWithOutEmail() {
204 * Explicitly declare the form context for addField().
206 public function getDefaultContext() {