3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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 $this->_search
= new $customSearchClass( $formValues );
147 $fnName = $ext->keyToPath
;
148 $customSearchFile = $fnName($customSearchClass, 'search');
149 $className = $ext->keyToClass($customSearchClass, 'search');
150 $this->_search
= new $className($formValues);
156 * This method returns the links that are given for each search row.
157 * currently the links added for each row are
166 static function &links() {
167 if (!(self
::$_links)) {
168 self
::$_links = array(
169 CRM_Core_Action
::VIEW
=> array(
170 'name' => ts('View'),
171 'url' => 'civicrm/contact/view',
172 'qs' => 'reset=1&cid=%%id%%',
173 'title' => ts('View Contact Details'),
175 CRM_Core_Action
::UPDATE
=> array(
176 'name' => ts('Edit'),
177 'url' => 'civicrm/contact/add',
178 'qs' => 'reset=1&action=update&cid=%%id%%',
179 'title' => ts('Edit Contact Details'),
183 $config = CRM_Core_Config
::singleton();
184 if ($config->mapAPIKey
&& $config->mapProvider
) {
185 self
::$_links[CRM_Core_Action
::MAP
] = array(
187 'url' => 'civicrm/contact/map',
188 'qs' => 'reset=1&cid=%%id%%&searchType=custom',
189 'title' => ts('Map Contact'),
193 return self
::$_links;
198 * getter for array of the parameters required for creating pager.
203 function getPagerParams($action, &$params) {
204 $params['status'] = ts('Contact %%StatusMessage%%');
205 $params['csvString'] = NULL;
206 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
208 $params['buttonTop'] = 'PagerTopButton';
209 $params['buttonBottom'] = 'PagerBottomButton';
214 * returns the column headers as an array of tuples:
215 * (name, sortName (key to the sort array))
217 * @param string $action the action being performed
218 * @param enum $output what should the result set include (web/email/csv)
220 * @return array the column headers that need to be displayed
223 function &getColumnHeaders($action = NULL, $output = NULL) {
224 $columns = $this->_search
->columns();
225 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
226 return array_keys($columns);
230 foreach ($columns as $name => $key) {
235 'direction' => CRM_Utils_Sort
::ASCENDING
,
239 $headers[] = array();
247 * Returns total number of rows for the query.
251 * @return int Total number of rows
254 function getTotalCount($action) {
255 return $this->_search
->count();
259 * returns all the rows in the given offset and rowCount
261 * @param enum $action the action being performed
262 * @param int $offset the row number to start from
263 * @param int $rowCount the number of rows to return
264 * @param string $sort the sql string that describes the sort order
265 * @param enum $output what should the result set include (web/email/csv)
267 * @return int the total number of rows for this action
269 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
271 $includeContactIDs = FALSE;
272 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
273 $output == CRM_Core_Selector_Controller
::SCREEN
275 $this->_formValues
['radio_ts'] == 'ts_sel'
277 $includeContactIDs = TRUE;
280 $sql = $this->_search
->all($offset, $rowCount, $sort, $includeContactIDs);
281 // contact query object used for creating $sql
282 $contactQueryObj = NULL;
283 if (method_exists($this->_search
, 'getQueryObj') &&
284 is_a($this->_search
->getQueryObj(), 'CRM_Contact_BAO_Query')) {
285 $contactQueryObj = $this->_search
->getQueryObj();
288 $dao = CRM_Core_DAO
::executeQuery($sql, CRM_Core_DAO
::$_nullArray);
290 $columns = $this->_search
->columns();
291 $columnNames = array_values($columns);
292 $links = self
::links();
294 $permissions = array(CRM_Core_Permission
::getPermission());
295 if (CRM_Core_Permission
::check('delete contacts')) {
296 $permissions[] = CRM_Core_Permission
::DELETE
;
298 $mask = CRM_Core_Action
::mask($permissions);
301 if (method_exists($this->_customSearchClass
,
307 if (is_a($this->_search
, 'CRM_Contact_Form_Search_Custom_Basic')) {
310 // process the result of the query
312 while ($dao->fetch()) {
316 // if contact query object present
317 // process pseudo constants
318 if ($contactQueryObj) {
319 $contactQueryObj->convertToPseudoNames($dao);
322 // the columns we are interested in
323 foreach ($columnNames as $property) {
324 $row[$property] = $dao->$property;
325 if (!empty($dao->$property)) {
330 $contactID = isset($dao->contact_id
) ?
$dao->contact_id
: NULL;
332 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $contactID;
333 $row['action'] = CRM_Core_Action
::formLink($links,
335 array('id' => $contactID),
338 'contact.custom.actions',
342 $row['contact_id'] = $contactID;
345 $this->_search
->alterRow($row);
349 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
350 $dao->contact_sub_type
: $dao->contact_type
, FALSE, $contactID
357 $this->buildPrevNextCache($sort);
363 * Given the current formValues, gets the query in local
367 reference) $formValues submitted formValues
369 * @return array $qill which contains an array of strings
372 public function getQILL() {
376 public function getSummary() {
377 return $this->_search
->summary();
381 * name of export file.
383 * @param string $output type of output
385 * @return string name of the file
387 function getExportFileName($output = 'csv') {
388 return ts('CiviCRM Custom Search');
391 function alphabetQuery() {
395 function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
397 $sql = $this->_search
->contactIDs($params);
399 return CRM_Core_DAO
::executeQuery($sql, $params);
402 function addActions(&$rows) {
403 $links = self
::links();
405 $permissions = array(CRM_Core_Permission
::getPermission());
406 if (CRM_Core_Permission
::check('delete contacts')) {
407 $permissions[] = CRM_Core_Permission
::DELETE
;
409 $mask = CRM_Core_Action
::mask($permissions);
411 foreach ($rows as $id => & $row) {
412 $row['action'] = CRM_Core_Action
::formLink($links,
414 array('id' => $row['contact_id']),
417 'contact.custom.actions',
424 function removeActions(&$rows) {
425 foreach ($rows as $rid => & $rValue) {
426 unset($rValue['action']);