CRM/Core/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * Base class for most search forms
  30  */
  31 class CRM_Core_Form_Search extends CRM_Core_Form {
  32
  33   /**
  34    * Are we forced to run a search
  35    *
  36    * @var int
  37    */
  38   protected $_force;
  39
  40   /**
  41    * Name of search button
  42    *
  43    * @var string
  44    */
  45   protected $_searchButtonName;
  46
  47   /**
  48    * Name of action button
  49    *
  50    * @var string
  51    */
  52   protected $_actionButtonName;
  53
  54   /**
  55    * Form values that we will be using
  56    *
  57    * @var array
  58    */
  59   public $_formValues;
  60
  61   /**
  62    * Have we already done this search
  63    *
  64    * @var boolean
  65    */
  66   protected $_done;
  67
  68   /**
  69    * What context are we being invoked from
  70    *
  71    * @var string
  72    */
  73   protected $_context = NULL;
  74
  75   /**
  76    * The list of tasks or actions that a searcher can perform on a result set.
  77    *
  78    * @var array
  79    */
  80   protected $_taskList = array();
  81
  82   /**
  83    * Builds the list of tasks or actions that a searcher can perform on a result set.
  84    *
  85    * To modify the task list, child classes should alter $this->_taskList,
  86    * preferably by extending this method.
  87    *
  88    * @return array
  89    */
  90   protected function buildTaskList() {
  91     return $this->_taskList;
  92   }
  93
  94   /**
  95    * Common buildform tasks required by all searches
  96    */
  97   public function buildQuickform() {
  98     CRM_Core_Resources::singleton()
  99       ->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header')
 100       ->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
 101
 102     $this->addButtons(array(
 103       array(
 104         'type' => 'refresh',
 105         'name' => ts('Search'),
 106         'isDefault' => TRUE,
 107       ),
 108     ));
 109
 110     $this->addClass('crm-search-form');
 111
 112     // for backwards compatibility we pass an argument to addTaskMenu even though
 113     // it could just as well access $this->_taskList internally
 114     $tasks = $this->buildTaskList();
 115     $this->addTaskMenu($tasks);
 116   }
 117
 118   /**
 119    * Add checkboxes for each row plus a master checkbox
 120    */
 121   public function addRowSelectors($rows) {
 122     $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows'));
 123     if (!empty($rows)) {
 124       foreach ($rows as $row) {
 125         if (CRM_Utils_Array::value('checkbox', $row)) {
 126           $this->addElement('checkbox', $row['checkbox'], NULL, NULL, array('class' => 'select-row'));
 127         }
 128       }
 129     }
 130   }
 131
 132   /**
 133    * Add actions menu to search results form
 134    * @param $tasks
 135    */
 136   public function addTaskMenu($tasks) {
 137     if (is_array($tasks) && !empty($tasks)) {
 138       $tasks = array('' => ts('Actions')) + $tasks;
 139       $this->add('select', 'task', NULL, $tasks, FALSE, array('class' => 'crm-select2 crm-action-menu huge crm-search-result-actions'));
 140       $this->add('submit', $this->_actionButtonName, ts('Go'), array('class' => 'hiddenElement crm-search-go-button'));
 141
 142       // Radio to choose "All items" or "Selected items only"
 143       $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
 144       $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
 145       $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']);
 146       $this->assign('ts_all_id', $allRowsRadio->_attributes['id']);
 147     }
 148   }
 149
 150 }