3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 class CRM_Grant_BAO_Query
{
39 public static function &getFields() {
41 $fields = CRM_Grant_BAO_Grant
::exportableFields();
46 * Build select for CiviGrant.
52 public static function select(&$query) {
53 if (!empty($query->_returnProperties
['grant_status_id'])) {
54 $query->_select
['grant_status_id'] = 'grant_status.id as grant_status_id';
55 $query->_element
['grant_status'] = 1;
56 $query->_tables
['grant_status'] = $query->_whereTables
['grant_status'] = 1;
57 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
60 if (!empty($query->_returnProperties
['grant_status'])) {
61 $query->_select
['grant_status'] = 'grant_status.label as grant_status';
62 $query->_element
['grant_status'] = 1;
63 $query->_tables
['grant_status'] = $query->_whereTables
['grant_status'] = 1;
64 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
67 if (!empty($query->_returnProperties
['grant_type_id'])) {
68 $query->_select
['grant_type_id'] = 'grant_type.id as grant_type_id';
69 $query->_element
['grant_type'] = 1;
70 $query->_tables
['grant_type'] = $query->_whereTables
['grant_type'] = 1;
71 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
74 if (!empty($query->_returnProperties
['grant_type'])) {
75 $query->_select
['grant_type'] = 'grant_type.label as grant_type';
76 $query->_element
['grant_type'] = 1;
77 $query->_tables
['grant_type'] = $query->_whereTables
['grant_type'] = 1;
78 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
81 if (!empty($query->_returnProperties
['grant_note'])) {
82 $query->_select
['grant_note'] = "civicrm_note.note as grant_note";
83 $query->_element
['grant_note'] = 1;
84 $query->_tables
['grant_note'] = 1;
87 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_GRANT
) {
88 $query->_select
['grant_amount_requested'] = 'civicrm_grant.amount_requested as grant_amount_requested';
89 $query->_select
['grant_amount_granted'] = 'civicrm_grant.amount_granted as grant_amount_granted';
90 $query->_select
['grant_amount_total'] = 'civicrm_grant.amount_total as grant_amount_total';
91 $query->_select
['grant_application_received_date'] = 'civicrm_grant.application_received_date as grant_application_received_date ';
92 $query->_select
['grant_report_received'] = 'civicrm_grant.grant_report_received as grant_report_received';
93 $query->_select
['grant_money_transfer_date'] = 'civicrm_grant.money_transfer_date as grant_money_transfer_date';
94 $query->_element
['grant_type_id'] = 1;
95 $query->_element
['grant_status_id'] = 1;
96 $query->_tables
['civicrm_grant'] = 1;
97 $query->_whereTables
['civicrm_grant'] = 1;
102 * Given a list of conditions in params generate the required.
109 public static function where(&$query) {
110 foreach ($query->_params
as $id => $values) {
111 if (!is_array($values) ||
count($values) != 5) {
115 if (substr($values[0], 0, 6) == 'grant_') {
116 self
::whereClauseSingle($values, $query);
125 public static function whereClauseSingle(&$values, &$query) {
126 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
127 list($name, $op, $value, $grouping, $wildcard) = $values;
128 $val = $names = array();
130 case 'grant_money_transfer_date_low':
131 case 'grant_money_transfer_date_high':
132 $query->dateQueryBuilder($values, 'civicrm_grant',
133 'grant_money_transfer_date', 'money_transfer_date',
134 'Money Transfer Date'
138 case 'grant_money_transfer_date_notset':
139 $query->_where
[$grouping][] = "civicrm_grant.money_transfer_date IS NULL";
140 $query->_qill
[$grouping][] = ts("Grant Money Transfer Date is NULL");
141 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
144 case 'grant_application_received_date_low':
145 case 'grant_application_received_date_high':
146 $query->dateQueryBuilder($values, 'civicrm_grant',
147 'grant_application_received_date',
148 'application_received_date', 'Application Received Date'
152 case 'grant_application_received_notset':
153 $query->_where
[$grouping][] = "civicrm_grant.application_received_date IS NULL";
154 $query->_qill
[$grouping][] = ts("Grant Application Received Date is NULL");
155 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
158 case 'grant_due_date_low':
159 case 'grant_due_date_high':
160 $query->dateQueryBuilder($values, 'civicrm_grant',
162 'grant_due_date', 'Grant Due Date'
166 case 'grant_due_date_notset':
167 $query->_where
[$grouping][] = "civicrm_grant.grant_due_date IS NULL";
168 $query->_qill
[$grouping][] = ts("Grant Due Date is NULL");
169 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
172 case 'grant_decision_date_low':
173 case 'grant_decision_date_high':
174 $query->dateQueryBuilder($values, 'civicrm_grant',
175 'grant_decision_date',
176 'decision_date', 'Grant Decision Date'
180 case 'grant_decision_date_notset':
181 $query->_where
[$grouping][] = "civicrm_grant.decision_date IS NULL";
182 $query->_qill
[$grouping][] = ts("Grant Decision Date is NULL");
183 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
186 case 'grant_type_id':
188 case 'grant_status_id':
191 if (strstr($name, 'type')) {
192 $name = 'grant_type_id';
193 $label = 'Grant Type(s)';
197 $label = 'Grant Status(s)';
200 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_grant.$name", $op, $value, "Integer");
202 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Grant_DAO_Grant', $name, $value, $op);
203 $query->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillop, 3 => $qillVal));
204 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
208 case 'grant_report_received':
212 $query->_where
[$grouping][] = "civicrm_grant.grant_report_received $op $value";
214 elseif ($value == 0) {
216 $query->_where
[$grouping][] = "civicrm_grant.grant_report_received IS NULL";
219 $query->_qill
[$grouping][] = "Grant Report Received = $yesNo ";
220 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
225 case 'grant_amount_low':
226 case 'grant_amount_high':
227 $query->numberRangeBuilder($values,
228 'civicrm_grant', 'grant_amount', 'amount_total', 'Total Amount'
234 * @param string $name
238 * @return null|string
240 public static function from($name, $mode, $side) {
243 case 'civicrm_grant':
244 $from = " $side JOIN civicrm_grant ON civicrm_grant.contact_id = contact_a.id ";
248 $from .= " $side JOIN civicrm_option_group option_group_grant_status ON (option_group_grant_status.name = 'grant_status')";
249 $from .= " $side JOIN civicrm_option_value grant_status ON (civicrm_grant.status_id = grant_status.value AND option_group_grant_status.id = grant_status.option_group_id ) ";
253 $from .= " $side JOIN civicrm_option_group option_group_grant_type ON (option_group_grant_type.name = 'grant_type')";
254 if ($mode & CRM_Contact_BAO_Query
::MODE_GRANT
) {
255 $from .= " INNER JOIN civicrm_option_value grant_type ON (civicrm_grant.grant_type_id = grant_type.value AND option_group_grant_type.id = grant_type.option_group_id ) ";
258 $from .= " $side JOIN civicrm_option_value grant_type ON (civicrm_grant.grant_type_id = grant_type.value AND option_group_grant_type.id = grant_type.option_group_id ) ";
263 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_grant' AND
264 civicrm_grant.id = civicrm_note.entity_id )";
271 * Getter for the qill object.
275 public function qill() {
276 return (isset($this->_qill
)) ?
$this->_qill
: "";
281 * @param bool $includeCustomFields
285 public static function defaultReturnProperties(
287 $includeCustomFields = TRUE
290 if ($mode & CRM_Contact_BAO_Query
::MODE_GRANT
) {
293 'contact_sub_type' => 1,
298 'grant_amount_requested' => 1,
299 'grant_application_received_date' => 1,
300 'grant_report_received' => 1,
301 'grant_money_transfer_date' => 1,
310 * Add all the elements shared between grant search and advanaced search.
313 * @param CRM_Core_Form $form
317 public static function buildSearchForm(&$form) {
319 $grantType = CRM_Core_OptionGroup
::values('grant_type');
320 $form->add('select', 'grant_type_id', ts('Grant Type'), $grantType, FALSE,
321 array('id' => 'grant_type_id', 'multiple' => 'multiple', 'class' => 'crm-select2')
324 $grantStatus = CRM_Core_OptionGroup
::values('grant_status');
325 $form->add('select', 'grant_status_id', ts('Grant Status'), $grantStatus, FALSE,
326 array('id' => 'grant_status_id', 'multiple' => 'multiple', 'class' => 'crm-select2')
329 $form->addDate('grant_application_received_date_low', ts('App. Received Date - From'), FALSE, array('formatType' => 'searchDate'));
330 $form->addDate('grant_application_received_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
332 $form->addElement('checkbox', 'grant_application_received_notset', '', NULL);
334 $form->addDate('grant_money_transfer_date_low', ts('Money Sent Date - From'), FALSE, array('formatType' => 'searchDate'));
335 $form->addDate('grant_money_transfer_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
337 $form->addElement('checkbox', 'grant_money_transfer_date_notset', '', NULL);
339 $form->addDate('grant_due_date_low', ts('Report Due Date - From'), FALSE, array('formatType' => 'searchDate'));
340 $form->addDate('grant_due_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
342 $form->addElement('checkbox', 'grant_due_date_notset', '', NULL);
344 $form->addDate('grant_decision_date_low', ts('Grant Decision Date - From'), FALSE, array('formatType' => 'searchDate'));
345 $form->addDate('grant_decision_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
347 $form->addElement('checkbox', 'grant_decision_date_notset', '', NULL);
349 $form->addYesNo('grant_report_received', ts('Grant report received?'), TRUE);
351 $form->add('text', 'grant_amount_low', ts('Minimum Amount'), array('size' => 8, 'maxlength' => 8));
352 $form->addRule('grant_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('9.99', ' '))), 'money');
354 $form->add('text', 'grant_amount_high', ts('Maximum Amount'), array('size' => 8, 'maxlength' => 8));
355 $form->addRule('grant_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('99.99', ' '))), 'money');
357 // add all the custom searchable fields
358 $grant = array('Grant');
359 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $grant);
361 $form->assign('grantGroupTree', $groupDetails);
362 foreach ($groupDetails as $group) {
363 foreach ($group['fields'] as $field) {
364 $fieldId = $field['id'];
365 $elementName = 'custom_' . $fieldId;
366 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
375 $form->assign('validGrant', TRUE);
382 public static function searchAction(&$row, $id) {
388 public static function tableNames(&$tables) {