4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2013
36 class CRM_Grant_BAO_Query
{
37 static function &getFields() {
39 $fields = CRM_Grant_BAO_Grant
::exportableFields();
44 * build select for CiviGrant
49 static function select(&$query) {
50 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_GRANT
) {
51 if (!empty($query->_returnProperties
['grant_status_id'])) {
52 $query->_select
['grant_status_id'] = 'grant_status.id as grant_status_id';
53 $query->_element
['grant_status'] = 1;
54 $query->_tables
['grant_status'] = $query->_whereTables
['grant_status'] = 1;
55 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
58 if (!empty($query->_returnProperties
['grant_status'])) {
59 $query->_select
['grant_status'] = 'grant_status.label as grant_status';
60 $query->_element
['grant_status'] = 1;
61 $query->_tables
['grant_status'] = $query->_whereTables
['grant_status'] = 1;
62 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
65 if (!empty($query->_returnProperties
['grant_type_id'])) {
66 $query->_select
['grant_type_id'] = 'grant_type.id as grant_type_id';
67 $query->_element
['grant_type'] = 1;
68 $query->_tables
['grant_type'] = $query->_whereTables
['grant_type'] = 1;
69 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
72 if (!empty($query->_returnProperties
['grant_type'])) {
73 $query->_select
['grant_type'] = 'grant_type.label as grant_type';
74 $query->_element
['grant_type'] = 1;
75 $query->_tables
['grant_type'] = $query->_whereTables
['grant_type'] = 1;
76 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
79 if (!empty($query->_returnProperties
['grant_note'])) {
80 $query->_select
['grant_note'] = "civicrm_note.note as grant_note";
81 $query->_element
['grant_note'] = 1;
82 $query->_tables
['grant_note'] = 1;
84 $query->_select
['grant_amount_requested'] = 'civicrm_grant.amount_requested as grant_amount_requested';
85 $query->_select
['grant_amount_granted'] = 'civicrm_grant.amount_granted as grant_amount_granted';
86 $query->_select
['grant_amount_total'] = 'civicrm_grant.amount_total as grant_amount_total';
87 $query->_select
['grant_application_received_date'] = 'civicrm_grant.application_received_date as grant_application_received_date ';
88 $query->_select
['grant_report_received'] = 'civicrm_grant.grant_report_received as grant_report_received';
89 $query->_select
['grant_money_transfer_date'] = 'civicrm_grant.money_transfer_date as grant_money_transfer_date';
90 $query->_element
['grant_type_id'] = 1;
91 $query->_element
['grant_status_id'] = 1;
92 $query->_tables
['civicrm_grant'] = 1;
93 $query->_whereTables
['civicrm_grant'] = 1;
98 * Given a list of conditions in params generate the required
104 static function where(&$query) {
105 foreach ($query->_params
as $id => $values) {
106 if (!is_array($values) ||
count($values) != 5) {
110 if (substr($values[0], 0, 6) == 'grant_') {
111 self
::whereClauseSingle($values, $query);
116 static function whereClauseSingle(&$values, &$query) {
117 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
118 list($name, $op, $value, $grouping, $wildcard) = $values;
120 case 'grant_money_transfer_date_low':
121 case 'grant_money_transfer_date_high':
122 $query->dateQueryBuilder($values, 'civicrm_grant',
123 'grant_money_transfer_date', 'money_transfer_date',
124 'Money Transfer Date'
128 case 'grant_money_transfer_date_notset':
129 $query->_where
[$grouping][] = "civicrm_grant.money_transfer_date IS NULL";
130 $query->_qill
[$grouping][] = ts("Grant Money Transfer Date is NULL");
131 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
134 case 'grant_application_received_date_low':
135 case 'grant_application_received_date_high':
136 $query->dateQueryBuilder($values, 'civicrm_grant',
137 'grant_application_received_date',
138 'application_received_date', 'Application Received Date'
142 case 'grant_application_received_notset':
143 $query->_where
[$grouping][] = "civicrm_grant.application_received_date IS NULL";
144 $query->_qill
[$grouping][] = ts("Grant Application Received Date is NULL");
145 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
148 case 'grant_due_date_low':
149 case 'grant_due_date_high':
150 $query->dateQueryBuilder($values, 'civicrm_grant',
152 'grant_due_date', 'Grant Due Date'
156 case 'grant_due_date_notset':
157 $query->_where
[$grouping][] = "civicrm_grant.grant_due_date IS NULL";
158 $query->_qill
[$grouping][] = ts("Grant Due Date is NULL");
159 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
162 case 'grant_decision_date_low':
163 case 'grant_decision_date_high':
164 $query->dateQueryBuilder($values, 'civicrm_grant',
165 'grant_decision_date',
166 'decision_date', 'Grant Decision Date'
170 case 'grant_decision_date_notset':
171 $query->_where
[$grouping][] = "civicrm_grant.decision_date IS NULL";
172 $query->_qill
[$grouping][] = ts("Grant Decision Date is NULL");
173 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
176 case 'grant_type_id':
178 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
180 $query->_where
[$grouping][] = "civicrm_grant.grant_type_id $op '{$value}'";
182 $grantTypes = CRM_Core_OptionGroup
::values('grant_type');
183 $value = $grantTypes[$value];
184 $query->_qill
[$grouping][] = ts('Grant Type %2 %1', array(1 => $value, 2 => $op));
185 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
189 case 'grant_status_id':
191 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
193 $query->_where
[$grouping][] = "civicrm_grant.status_id $op '{$value}'";
196 $grantStatus = CRM_Core_OptionGroup
::values('grant_status');
197 $value = $grantStatus[$value];
199 $query->_qill
[$grouping][] = ts('Grant Status %2 %1', array(1 => $value, 2 => $op));
200 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
204 case 'grant_report_received':
208 $query->_where
[$grouping][] = "civicrm_grant.grant_report_received $op $value";
210 elseif ($value == 0) {
212 $query->_where
[$grouping][] = "civicrm_grant.grant_report_received IS NULL";
215 $query->_qill
[$grouping][] = "Grant Report Received = $yesNo ";
216 $query->_tables
['civicrm_grant'] = $query->_whereTables
['civicrm_grant'] = 1;
221 case 'grant_amount_low':
222 case 'grant_amount_high':
223 $query->numberRangeBuilder($values,
224 'civicrm_grant', 'grant_amount', 'amount_total', 'Total Amount'
229 static function from($name, $mode, $side) {
232 case 'civicrm_grant':
233 $from = " $side JOIN civicrm_grant ON civicrm_grant.contact_id = contact_a.id ";
237 $from .= " $side JOIN civicrm_option_group option_group_grant_status ON (option_group_grant_status.name = 'grant_status')";
238 $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 ) ";
242 $from .= " $side JOIN civicrm_option_group option_group_grant_type ON (option_group_grant_type.name = 'grant_type')";
243 if ($mode & CRM_Contact_BAO_Query
::MODE_GRANT
) {
244 $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 ) ";
247 $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 ) ";
252 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_grant' AND
253 civicrm_grant.id = civicrm_note.entity_id )";
260 * getter for the qill object
266 return (isset($this->_qill
)) ?
$this->_qill
: "";
269 static function defaultReturnProperties($mode,
270 $includeCustomFields = TRUE
273 if ($mode & CRM_Contact_BAO_Query
::MODE_GRANT
) {
276 'contact_sub_type' => 1,
281 'grant_amount_requested' => 1,
282 'grant_application_received_date' => 1,
283 'grant_report_received' => 1,
284 'grant_money_transfer_date' => 1,
293 * add all the elements shared between grant search and advanaced search
300 static function buildSearchForm(&$form) {
302 $grantType = CRM_Core_OptionGroup
::values('grant_type');
303 $form->add('select', 'grant_type_id', ts('Grant Type'),
304 array('' => ts('- any -')) +
$grantType,
305 FALSE, array('class' => 'crm-select2')
308 $grantStatus = CRM_Core_OptionGroup
::values('grant_status');
309 $form->add('select', 'grant_status_id', ts('Grant Status'),
310 array('' => ts('- any -')) +
$grantStatus,
311 FALSE, array('class' => 'crm-select2')
314 $form->addDate('grant_application_received_date_low', ts('App. Received Date - From'), FALSE, array('formatType' => 'searchDate'));
315 $form->addDate('grant_application_received_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
317 $form->addElement('checkbox', 'grant_application_received_notset', ts(''), NULL);
319 $form->addDate('grant_money_transfer_date_low', ts('Money Sent Date - From'), FALSE, array('formatType' => 'searchDate'));
320 $form->addDate('grant_money_transfer_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
322 $form->addElement('checkbox', 'grant_money_transfer_date_notset', ts(''), NULL);
324 $form->addDate('grant_due_date_low', ts('Report Due Date - From'), FALSE, array('formatType' => 'searchDate'));
325 $form->addDate('grant_due_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
327 $form->addElement('checkbox', 'grant_due_date_notset', ts(''), NULL);
329 $form->addDate('grant_decision_date_low', ts('Grant Decision Date - From'), FALSE, array('formatType' => 'searchDate'));
330 $form->addDate('grant_decision_date_high', ts('To'), FALSE, array('formatType' => 'searchDate'));
332 $form->addElement('checkbox', 'grant_decision_date_notset', ts(''), NULL);
334 $form->addYesNo('grant_report_received', ts('Grant report received?'), TRUE);
336 $form->add('text', 'grant_amount_low', ts('Minimum Amount'), array('size' => 8, 'maxlength' => 8));
337 $form->addRule('grant_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('9.99', ' '))), 'money');
339 $form->add('text', 'grant_amount_high', ts('Maximum Amount'), array('size' => 8, 'maxlength' => 8));
340 $form->addRule('grant_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money
::format('99.99', ' '))), 'money');
342 // add all the custom searchable fields
343 $grant = array('Grant');
344 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $grant);
346 $form->assign('grantGroupTree', $groupDetails);
347 foreach ($groupDetails as $group) {
348 foreach ($group['fields'] as $field) {
349 $fieldId = $field['id'];
350 $elementName = 'custom_' . $fieldId;
351 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
360 $form->assign('validGrant', TRUE);
363 static function searchAction(&$row, $id) {}
365 static function tableNames(&$tables) {}