3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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_Grant_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
49 static $_links = NULL;
52 * We use desc to remind us what that column is, name is used in the tpl
56 static $_columnHeaders;
59 * Properties of contact we're interested in displaying
62 static $_properties = array(
72 'grant_amount_requested',
73 'grant_amount_granted',
74 'grant_application_received_date',
75 'grant_report_received',
76 'grant_money_transfer_date',
80 * Are we restricting ourselves to a single contact.
84 protected $_single = FALSE;
87 * Are we restricting ourselves to a single contact.
91 protected $_limit = NULL;
94 * What context are we being invoked from.
98 protected $_context = NULL;
101 * QueryParams is the array returned by exportValues called on.
102 * the HTML_QuickForm_Controller for that page.
106 public $_queryParams;
109 * Represent the type of selector.
116 * The additional clause that we restrict the search with.
120 protected $_grantClause = NULL;
132 * @param array $queryParams
133 * Array of parameters for query.
134 * @param \const|int $action - action of search basic or advanced.
135 * @param string $grantClause
136 * If the caller wants to further restrict the search.
137 * @param bool $single
138 * Are we dealing only with one contact?.
140 * How many participations do we want returned.
142 * @param string $context
144 * @return \CRM_Grant_Selector_Search
146 public function __construct(
148 $action = CRM_Core_Action
::NONE
,
154 // submitted form values
155 $this->_queryParams
= &$queryParams;
157 $this->_single
= $single;
158 $this->_limit
= $limit;
159 $this->_context
= $context;
161 $this->_grantClause
= $grantClause;
164 $this->_action
= $action;
166 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
, NULL, NULL, FALSE, FALSE,
167 CRM_Contact_BAO_Query
::MODE_GRANT
169 $this->_query
->_distinctComponentClause
= " civicrm_grant.id";
170 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_grant.id ";
174 * This method returns the links that are given for each search row.
175 * currently the links added for each row are
180 * @param string|null $key
184 public static function &links($key = NULL) {
185 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
186 $extraParams = ($key) ?
"&key={$key}" : NULL;
188 if (!(self
::$_links)) {
189 self
::$_links = array(
190 CRM_Core_Action
::VIEW
=> array(
191 'name' => ts('View'),
192 'url' => 'civicrm/contact/view/grant',
193 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=grant' . $extraParams,
194 'title' => ts('View Grant'),
196 CRM_Core_Action
::UPDATE
=> array(
197 'name' => ts('Edit'),
198 'url' => 'civicrm/contact/view/grant',
199 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
200 'title' => ts('Edit Grant'),
206 CRM_Core_Action
::DELETE
=> array(
207 'name' => ts('Delete'),
208 'url' => 'civicrm/contact/view/grant',
209 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=grant' . $extraParams,
210 'title' => ts('Delete Grant'),
213 self
::$_links = self
::$_links +
$delLink;
216 return self
::$_links;
220 * Getter for array of the parameters required for creating pager.
223 * @param array $params
225 public function getPagerParams($action, &$params) {
226 $params['status'] = ts('Grant') . ' %%StatusMessage%%';
227 $params['csvString'] = NULL;
229 $params['rowCount'] = $this->_limit
;
232 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
235 $params['buttonTop'] = 'PagerTopButton';
236 $params['buttonBottom'] = 'PagerBottomButton';
240 * Returns total number of rows for the query.
245 * Total number of rows
247 public function getTotalCount($action) {
248 return $this->_query
->searchQuery(0, 0, NULL,
257 * Returns all the rows in the given offset and rowCount *
259 * @param string $action
260 * The action being performed.
262 * The row number to start from.
263 * @param int $rowCount
264 * The number of rows to return.
265 * @param string $sort
266 * The sql string that describes the sort order.
267 * @param string $output
268 * What should the result set include (web/email/csv).
271 * the total number of rows for this action
273 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
274 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
281 // process the result of the query
284 //CRM-4418 check for view, edit, delete
285 $permissions = array(CRM_Core_Permission
::VIEW
);
286 if (CRM_Core_Permission
::check('edit grants')) {
287 $permissions[] = CRM_Core_Permission
::EDIT
;
289 if (CRM_Core_Permission
::check('delete in CiviGrant')) {
290 $permissions[] = CRM_Core_Permission
::DELETE
;
292 $mask = CRM_Core_Action
::mask($permissions);
294 while ($result->fetch()) {
296 // the columns we are interested in
297 foreach (self
::$_properties as $property) {
298 if (isset($result->$property)) {
299 $row[$property] = $result->$property;
303 if ($this->_context
== 'search') {
304 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->grant_id
;
307 $row['action'] = CRM_Core_Action
::formLink(self
::links($this->_key
),
310 'id' => $result->grant_id
,
311 'cid' => $result->contact_id
,
312 'cxt' => $this->_context
,
316 'grant.selector.row',
321 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
333 public function getQILL() {
334 return $this->_query
->qill();
338 * Returns the column headers as an array of tuples:
339 * (name, sortName (key to the sort array))
341 * @param string $action
342 * The action being performed.
343 * @param string $output
344 * What should the result set include (web/email/csv).
347 * the column headers that need to be displayed
349 public function &getColumnHeaders($action = NULL, $output = NULL) {
350 if (!isset(self
::$_columnHeaders)) {
351 self
::$_columnHeaders = array(
353 'name' => ts('Status'),
354 'sort' => 'grant_status',
355 'direction' => CRM_Utils_Sort
::DONTCARE
,
358 'name' => ts('Type'),
359 'sort' => 'grant_type_id',
360 'direction' => CRM_Utils_Sort
::DONTCARE
,
363 'name' => ts('Requested'),
364 'sort' => 'grant_amount_total',
365 'direction' => CRM_Utils_Sort
::DONTCARE
,
368 'name' => ts('Granted'),
369 'sort' => 'grant_amount_granted',
370 'direction' => CRM_Utils_Sort
::DONTCARE
,
373 'name' => ts('Application Received'),
374 'sort' => 'grant_application_received_date',
375 'direction' => CRM_Utils_Sort
::DONTCARE
,
378 'name' => ts('Report Received'),
379 'sort' => 'grant_report_received',
380 'direction' => CRM_Utils_Sort
::DONTCARE
,
383 'name' => ts('Money Transferred'),
384 'sort' => 'money_transfer_date',
385 'direction' => CRM_Utils_Sort
::DONTCARE
,
387 array('desc' => ts('Actions')),
390 if (!$this->_single
) {
392 array('desc' => ts('Contact Type')),
394 'name' => ts('Name'),
395 'sort' => 'sort_name',
396 'direction' => CRM_Utils_Sort
::ASCENDING
,
399 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
402 return self
::$_columnHeaders;
408 public function &getQuery() {
409 return $this->_query
;
413 * Name of export file.
415 * @param string $output
421 public function getExportFileName($output = 'csv') {
422 return ts('CiviCRM Grant Search');