3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id: Selector.php 11510 2007-09-18 09:21:34Z lobo $
37 * This class is used to retrieve and display a range of
38 * contacts that match the given criteria (specifically for
39 * results of advanced search options.
42 class CRM_Contact_Selector_Custom
extends CRM_Contact_Selector
{
45 * This defines two actions- View and Edit.
50 static $_links = NULL;
53 * we use desc to remind us what that column is, name is used in the tpl
58 static $_columnHeaders;
61 * Properties of contact we're interested in displaying
65 static $_properties = array('contact_id', 'contact_type', 'display_name');
68 * formValues is the array returned by exportValues called on
69 * the HTML_QuickForm_Controller for that page.
77 * params is the array in a value used by the search query creator
85 * represent the type of selector
95 * the public visible fields to be shown to the user
103 * The object that implements the search interface
107 protected $_customSearchClass;
112 * @param array $formValues array of form values imported
113 * @param array $params array of parameters for query
114 * @param int $action - action of search basic or advanced.
116 * @return CRM_Contact_Selector
119 function __construct(
123 $returnProperties = NULL,
124 $action = CRM_Core_Action
::NONE
,
125 $includeContactIds = FALSE,
126 $searchChildGroups = TRUE,
127 $searchContext = 'search',
130 $this->_customSearchClass
= $customSearchClass;
131 $this->_formValues
= $formValues;
132 $this->_includeContactIds
= $includeContactIds;
134 $ext = CRM_Extension_System
::singleton()->getMapper();
136 if (!$ext->isExtensionKey($customSearchClass)) {
137 if ($ext->isExtensionClass($customSearchClass)) {
138 $customSearchFile = $ext->classToPath($customSearchClass);
139 require_once ($customSearchFile);
142 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $customSearchClass) . '.php');
144 eval('$this->_search = new ' . $customSearchClass . '( $formValues );');
147 $customSearchFile = $ext->keyToPath($customSearchClass, 'search');
148 require_once ($customSearchFile);
149 eval('$this->_search = new ' . $ext->keyToClass($customSearchClass, 'search') . '( $formValues );');
155 * This method returns the links that are given for each search row.
156 * currently the links added for each row are
165 static function &links() {
166 if (!(self
::$_links)) {
167 self
::$_links = array(
168 CRM_Core_Action
::VIEW
=> array(
169 'name' => ts('View'),
170 'url' => 'civicrm/contact/view',
171 'qs' => 'reset=1&cid=%%id%%',
172 'title' => ts('View Contact Details'),
174 CRM_Core_Action
::UPDATE
=> array(
175 'name' => ts('Edit'),
176 'url' => 'civicrm/contact/add',
177 'qs' => 'reset=1&action=update&cid=%%id%%',
178 'title' => ts('Edit Contact Details'),
182 $config = CRM_Core_Config
::singleton();
183 if ($config->mapAPIKey
&& $config->mapProvider
) {
184 self
::$_links[CRM_Core_Action
::MAP
] = array(
186 'url' => 'civicrm/contact/map',
187 'qs' => 'reset=1&cid=%%id%%&searchType=custom',
188 'title' => ts('Map Contact'),
192 return self
::$_links;
197 * getter for array of the parameters required for creating pager.
202 function getPagerParams($action, &$params) {
203 $params['status'] = ts('Contact %%StatusMessage%%');
204 $params['csvString'] = NULL;
205 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
207 $params['buttonTop'] = 'PagerTopButton';
208 $params['buttonBottom'] = 'PagerBottomButton';
213 * returns the column headers as an array of tuples:
214 * (name, sortName (key to the sort array))
216 * @param string $action the action being performed
217 * @param enum $output what should the result set include (web/email/csv)
219 * @return array the column headers that need to be displayed
222 function &getColumnHeaders($action = NULL, $output = NULL) {
223 $columns = $this->_search
->columns();
224 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
225 return array_keys($columns);
229 foreach ($columns as $name => $key) {
234 'direction' => CRM_Utils_Sort
::ASCENDING
,
238 $headers[] = array();
246 * Returns total number of rows for the query.
250 * @return int Total number of rows
253 function getTotalCount($action) {
254 return $this->_search
->count();
258 * returns all the rows in the given offset and rowCount
260 * @param enum $action the action being performed
261 * @param int $offset the row number to start from
262 * @param int $rowCount the number of rows to return
263 * @param string $sort the sql string that describes the sort order
264 * @param enum $output what should the result set include (web/email/csv)
266 * @return int the total number of rows for this action
268 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
270 $includeContactIDs = FALSE;
271 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
272 $output == CRM_Core_Selector_Controller
::SCREEN
274 $this->_formValues
['radio_ts'] == 'ts_sel'
276 $includeContactIDs = TRUE;
279 $sql = $this->_search
->all($offset, $rowCount, $sort, $includeContactIDs);
281 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
283 $columns = $this->_search
->columns();
284 $columnNames = array_values($columns);
285 $links = self
::links();
287 $permissions = array(CRM_Core_Permission
::getPermission());
288 if (CRM_Core_Permission
::check('delete contacts')) {
289 $permissions[] = CRM_Core_Permission
::DELETE
;
291 $mask = CRM_Core_Action
::mask($permissions);
294 if (method_exists($this->_customSearchClass
,
300 if (is_a($this->_search
, 'CRM_Contact_Form_Search_Custom_Basic')) {
303 // process the result of the query
305 while ($dao->fetch()) {
309 // the columns we are interested in
310 foreach ($columnNames as $property) {
311 $row[$property] = $dao->$property;
312 if (!empty($dao->$property)) {
317 $contactID = isset($dao->contact_id
) ?
$dao->contact_id
: NULL;
319 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $contactID;
320 $row['action'] = CRM_Core_Action
::formLink($links,
322 array('id' => $contactID)
324 $row['contact_id'] = $contactID;
327 $this->_search
->alterRow($row);
331 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
332 $dao->contact_sub_type
: $dao->contact_type
, FALSE, $contactID
339 $this->buildPrevNextCache($sort);
345 * Given the current formValues, gets the query in local
349 reference) $formValues submitted formValues
351 * @return array $qill which contains an array of strings
354 public function getQILL() {
358 public function getSummary() {
359 return $this->_search
->summary();
363 * name of export file.
365 * @param string $output type of output
367 * @return string name of the file
369 function getExportFileName($output = 'csv') {
370 return ts('CiviCRM Custom Search');
373 function alphabetQuery() {
377 function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
379 $sql = $this->_search
->contactIDs($params);
381 return CRM_Core_DAO
::executeQuery($sql, $params);
384 function addActions(&$rows) {
385 $links = self
::links();
387 $permissions = array(CRM_Core_Permission
::getPermission());
388 if (CRM_Core_Permission
::check('delete contacts')) {
389 $permissions[] = CRM_Core_Permission
::DELETE
;
391 $mask = CRM_Core_Action
::mask($permissions);
393 foreach ($rows as $id => & $row) {
394 $row['action'] = CRM_Core_Action
::formLink($links,
396 array('id' => $row['contact_id'])
401 function removeActions(&$rows) {
402 foreach ($rows as $rid => & $rValue) {
403 unset($rValue['action']);