CRM/Pledge/BAO/Query.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  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.   |
  14  |                                                                    |
  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.        |
  19  |                                                                    |
  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  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36 class CRM_Pledge_BAO_Query {
  37   /**
  38    * @return array
  39    */
  40   static function &getFields() {
  41     $fields = CRM_Pledge_BAO_Pledge::exportableFields();
  42     return $fields;
  43   }
  44
  45   /**
  46    * build select for Pledge
  47    *
  48    * @param $query
  49    *
  50    * @return void
  51    * @access public
  52    */
  53   static function select(&$query) {
  54     if (($query->_mode & CRM_Contact_BAO_Query::MODE_PLEDGE) || !empty($query->_returnProperties['pledge_id'])) {
  55       $query->_select['pledge_id'] = 'civicrm_pledge.id as pledge_id';
  56       $query->_element['pledge_id'] = 1;
  57       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
  58     }
  59
  60     //add pledge select
  61     if (!empty($query->_returnProperties['pledge_amount'])) {
  62       $query->_select['pledge_amount'] = 'civicrm_pledge.amount as pledge_amount';
  63       $query->_element['pledge_amount'] = 1;
  64       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
  65     }
  66
  67     if (!empty($query->_returnProperties['pledge_create_date'])) {
  68       $query->_select['pledge_create_date'] = 'civicrm_pledge.create_date as pledge_create_date';
  69       $query->_element['pledge_create_date'] = 1;
  70       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
  71     }
  72
  73     if (!empty($query->_returnProperties['pledge_status_id'])) {
  74       $query->_select['pledge_status_id'] = 'pledge_status.value as pledge_status_id';
  75       $query->_element['pledge_status'] = 1;
  76       $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1;
  77       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
  78     }
  79
  80     if (!empty($query->_returnProperties['pledge_status'])) {
  81       $query->_select['pledge_status'] = 'pledge_status.label as pledge_status';
  82       $query->_element['pledge_status'] = 1;
  83       $query->_tables['pledge_status'] = $query->_whereTables['pledge_status'] = 1;
  84       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
  85     }
  86
  87     if (!empty($query->_returnProperties['pledge_total_paid'])) {
  88       $query->_select['pledge_total_paid'] = ' (SELECT sum(civicrm_pledge_payment.actual_amount) FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id = 1 ) as pledge_total_paid';
  89       $query->_element['pledge_total_paid'] = 1;
  90     }
  91
  92     if (!empty($query->_returnProperties['pledge_next_pay_date'])) {
  93       $query->_select['pledge_next_pay_date'] = " (SELECT civicrm_pledge_payment.scheduled_date FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id IN ( 2, 6 ) ORDER BY civicrm_pledge_payment.scheduled_date ASC LIMIT 0, 1) as pledge_next_pay_date";
  94       $query->_element['pledge_next_pay_date'] = 1;
  95     }
  96
  97     if (!empty($query->_returnProperties['pledge_next_pay_amount'])) {
  98       $query->_select['pledge_next_pay_amount'] = " (SELECT civicrm_pledge_payment.scheduled_amount FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id = 2 ORDER BY civicrm_pledge_payment.scheduled_date ASC LIMIT 0, 1) as pledge_next_pay_amount";
  99       $query->_element['pledge_next_pay_amount'] = 1;
 100
 101       $query->_select['pledge_outstanding_amount'] = " (SELECT sum(civicrm_pledge_payment.scheduled_amount) FROM civicrm_pledge_payment WHERE civicrm_pledge_payment.pledge_id = civicrm_pledge.id AND civicrm_pledge_payment.status_id = 6 ) as pledge_outstanding_amount";
 102       $query->_element['pledge_outstanding_amount'] = 1;
 103     }
 104
 105     if (!empty($query->_returnProperties['pledge_financial_type'])) {
 106       $query->_select['pledge_financial_type']  = "(SELECT civicrm_financial_type.name FROM civicrm_financial_type WHERE civicrm_financial_type.id = civicrm_pledge.financial_type_id) as pledge_financial_type";
 107       $query->_element['pledge_financial_type'] = 1;
 108       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 109     }
 110
 111     if (!empty($query->_returnProperties['pledge_contribution_page_id'])) {
 112       $query->_select['pledge_contribution_page_id'] = 'civicrm_pledge.contribution_page_id as pledge_contribution_page_id';
 113       $query->_element['pledge_contribution_page_id'] = 1;
 114       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 115     }
 116
 117     if (!empty($query->_returnProperties['pledge_payment_id'])) {
 118       $query->_select['pledge_payment_id'] = 'civicrm_pledge_payment.id as pledge_payment_id';
 119       $query->_element['pledge_payment_id'] = 1;
 120       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 121     }
 122
 123     if (!empty($query->_returnProperties['pledge_payment_scheduled_amount'])) {
 124       $query->_select['pledge_payment_scheduled_amount'] = 'civicrm_pledge_payment.scheduled_amount as pledge_payment_scheduled_amount';
 125       $query->_element['pledge_payment_scheduled_amount'] = 1;
 126       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 127     }
 128
 129     if (!empty($query->_returnProperties['pledge_payment_scheduled_date'])) {
 130       $query->_select['pledge_payment_scheduled_date'] = 'civicrm_pledge_payment.scheduled_date as pledge_payment_scheduled_date';
 131       $query->_element['pledge_payment_scheduled_date'] = 1;
 132       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 133     }
 134
 135     if (!empty($query->_returnProperties['pledge_payment_paid_amount'])) {
 136       $query->_select['pledge_payment_paid_amount'] = 'civicrm_pledge_payment.actual_amount as pledge_payment_paid_amount';
 137       $query->_element['pledge_payment_paid_amount'] = 1;
 138       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 139     }
 140
 141     if (!empty($query->_returnProperties['pledge_payment_paid_date'])) {
 142       $query->_select['pledge_payment_paid_date'] = 'payment_contribution.receive_date as pledge_payment_paid_date';
 143       $query->_element['pledge_payment_paid_date'] = 1;
 144       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 145       $query->_tables['payment_contribution'] = $query->_whereTables['payment_contribution'] = 1;
 146     }
 147
 148     if (!empty($query->_returnProperties['pledge_payment_reminder_date'])) {
 149       $query->_select['pledge_payment_reminder_date'] = 'civicrm_pledge_payment.reminder_date as pledge_payment_reminder_date';
 150       $query->_element['pledge_payment_reminder_date'] = 1;
 151       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 152     }
 153
 154     if (!empty($query->_returnProperties['pledge_payment_reminder_count'])) {
 155       $query->_select['pledge_payment_reminder_count'] = 'civicrm_pledge_payment.reminder_count as pledge_payment_reminder_count';
 156       $query->_element['pledge_payment_reminder_count'] = 1;
 157       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 158     }
 159
 160     if (!empty($query->_returnProperties['pledge_payment_status_id'])) {
 161       $query->_select['pledge_payment_status_id'] = 'payment_status.name as pledge_payment_status_id';
 162       $query->_element['pledge_payment_status_id'] = 1;
 163       $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1;
 164       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 165     }
 166
 167     if (!empty($query->_returnProperties['pledge_payment_status'])) {
 168       $query->_select['pledge_payment_status'] = 'payment_status.label as pledge_payment_status';
 169       $query->_element['pledge_payment_status'] = 1;
 170       $query->_tables['payment_status'] = $query->_whereTables['payment_status'] = 1;
 171       $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 172     }
 173
 174     if (!empty($query->_returnProperties['pledge_frequency_interval'])) {
 175       $query->_select['pledge_frequency_interval'] = 'civicrm_pledge.frequency_interval as pledge_frequency_interval';
 176       $query->_element['pledge_frequency_interval'] = 1;
 177       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 178     }
 179
 180     if (!empty($query->_returnProperties['pledge_frequency_unit'])) {
 181       $query->_select['pledge_frequency_unit'] = 'civicrm_pledge.frequency_unit as pledge_frequency_unit';
 182       $query->_element['pledge_frequency_unit'] = 1;
 183       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 184     }
 185
 186     if (!empty($query->_returnProperties['pledge_is_test'])) {
 187       $query->_select['pledge_is_test'] = 'civicrm_pledge.is_test as pledge_is_test';
 188       $query->_element['pledge_is_test'] = 1;
 189       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 190     }
 191     if (!empty($query->_returnProperties['pledge_campaign_id'])) {
 192       $query->_select['pledge_campaign_id'] = 'civicrm_pledge.campaign_id as pledge_campaign_id';
 193       $query->_element['pledge_campaign_id'] = 1;
 194       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 195     }
 196
 197     if (!empty($query->_returnProperties['pledge_currency'])) {
 198       $query->_select['pledge_currency'] = 'civicrm_pledge.currency as pledge_currency';
 199       $query->_element['pledge_currency'] = 1;
 200       $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 201     }
 202   }
 203
 204   /**
 205    * @param $query
 206    */
 207   static function where(&$query) {
 208     $grouping = NULL;
 209     foreach (array_keys($query->_params) as $id) {
 210       if (empty($query->_params[$id][0])) {
 211         continue;
 212       }
 213       if (substr($query->_params[$id][0], 0, 7) == 'pledge_') {
 214         if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
 215           $query->_useDistinct = TRUE;
 216         }
 217         $grouping = $query->_params[$id][3];
 218         self::whereClauseSingle($query->_params[$id], $query);
 219       }
 220     }
 221   }
 222
 223   /**
 224    * @param $values
 225    * @param $query
 226    */
 227   static function whereClauseSingle(&$values, &$query) {
 228     list($name, $op, $value, $grouping, $wildcard) = $values;
 229
 230     switch ($name) {
 231       case 'pledge_create_date_low':
 232       case 'pledge_create_date_high':
 233         // process to / from date
 234         $query->dateQueryBuilder($values,
 235           'civicrm_pledge', 'pledge_create_date', 'create_date', 'Pledge Made'
 236         );
 237       case 'pledge_start_date_low':
 238       case 'pledge_start_date_high':
 239         // process to / from date
 240         $query->dateQueryBuilder($values,
 241           'civicrm_pledge', 'pledge_start_date', 'start_date', 'Pledge Start Date'
 242         );
 243         return;
 244
 245       case 'pledge_end_date_low':
 246       case 'pledge_end_date_high':
 247         // process to / from date
 248         $query->dateQueryBuilder($values,
 249           'civicrm_pledge', 'pledge_end_date', 'end_date', 'Pledge End Date'
 250         );
 251         return;
 252
 253       case 'pledge_payment_date_low':
 254       case 'pledge_payment_date_high':
 255         // process to / from date
 256         $query->dateQueryBuilder($values,
 257           'civicrm_pledge_payment', 'pledge_payment_date', 'scheduled_date', 'Payment Scheduled'
 258         );
 259         return;
 260
 261       case 'pledge_amount':
 262       case 'pledge_amount_low':
 263       case 'pledge_amount_high':
 264         // process min/max amount
 265         $query->numberRangeBuilder($values,
 266           'civicrm_pledge', 'pledge_amount', 'amount', 'Pledge Amount'
 267         );
 268         return;
 269
 270       case 'pledge_status_id':
 271         if (is_array($value)) {
 272           foreach ($value as $k => $v) {
 273             if ($v) {
 274               $val[$k] = $k;
 275             }
 276           }
 277
 278           $status = implode(',', $val);
 279
 280           if (count($val) > 1) {
 281             $op = 'IN';
 282             $status = "({$status})";
 283           }
 284         }
 285         else {
 286           $op = '=';
 287           $status = $value;
 288         }
 289
 290         $statusValues = CRM_Core_OptionGroup::values('contribution_status');
 291
 292         $names = array();
 293         if (isset($val) && is_array($val)) {
 294           foreach ($val as $id => $dontCare) {
 295             $names[] = $statusValues[$id];
 296           }
 297         }
 298         else {
 299           $names[] = $statusValues[$value];
 300         }
 301
 302         $query->_qill[$grouping][] = ts('Pledge Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
 303         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.status_id',
 304           $op,
 305           $status,
 306           'Integer'
 307         );
 308         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 309         return;
 310
 311       case 'pledge_payment_status_id':
 312         if (is_array($value)) {
 313           foreach ($value as $k => $v) {
 314             if ($v) {
 315               $val[$k] = $k;
 316             }
 317           }
 318
 319           $status = implode(',', $val);
 320
 321           if (count($val) > 1) {
 322             $op = 'IN';
 323             $status = "({$status})";
 324           }
 325         }
 326         else {
 327           $op = '=';
 328           $status = $value;
 329         }
 330
 331         $statusValues = CRM_Core_OptionGroup::values('contribution_status');
 332
 333         $names = array();
 334         if (is_array($val)) {
 335           foreach ($val as $id => $dontCare) {
 336             $names[] = $statusValues[$id];
 337           }
 338         }
 339         else {
 340           $names[] = $statusValues[$value];
 341         }
 342
 343         $query->_qill[$grouping][] = ts('Pledge Payment Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
 344         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge_payment.status_id',
 345           $op,
 346           $status,
 347           'Integer'
 348         );
 349         $query->_tables['civicrm_pledge_payment'] = $query->_whereTables['civicrm_pledge_payment'] = 1;
 350         return;
 351
 352       case 'pledge_test':
 353       case 'pledge_is_test':
 354         // We dont want to include all tests for sql OR CRM-7827
 355         if (!$value || $query->getOperator() != 'OR') {
 356           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.is_test',
 357             $op,
 358             $value,
 359             'Boolean'
 360           );
 361           if ($value) {
 362             $query->_qill[$grouping][] = ts('Pledge is a Test');
 363           }
 364           $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 365         }
 366         return;
 367
 368       case 'pledge_financial_type_id':
 369         $type = CRM_Contribute_PseudoConstant::financialType($value);
 370         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.financial_type_id',
 371           $op,
 372           $value,
 373           'Integer'
 374         );
 375             $query->_qill[$grouping][] = ts( 'Financial Type - %1', array( 1 => $type ) );
 376         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 377         return;
 378
 379       case 'pledge_contribution_page_id':
 380         $page = CRM_Contribute_PseudoConstant::contributionPage($value);
 381         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_pledge.contribution_page_id',
 382           $op,
 383           $value,
 384           'Integer'
 385         );
 386         $query->_qill[$grouping][] = ts('Financial Page - %1', array(1 => $page));
 387         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 388         return;
 389
 390       case 'pledge_id':
 391         $query->_where[$grouping][] = "civicrm_pledge.id $op $value";
 392         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 393         return;
 394
 395       case 'pledge_frequency_interval':
 396         $query->_where[$grouping][] = "civicrm_pledge.frequency_interval $op $value";
 397         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 398         return;
 399
 400       case 'pledge_frequency_unit':
 401         $query->_where[$grouping][] = "civicrm_pledge.frequency_unit $op $value";
 402         $query->_tables['civicrm_pledge'] = $query->_whereTables['civicrm_pledge'] = 1;
 403         return;
 404
 405       case 'pledge_campaign_id':
 406         $campParams = array(
 407           'op' => $op,
 408           'campaign' => $value,
 409           'grouping' => $grouping,
 410           'tableName' => 'civicrm_pledge',
 411         );
 412         CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query);
 413         return;
 414     }
 415   }
 416
 417   /**
 418    * @param $name
 419    * @param $mode
 420    * @param $side
 421    *
 422    * @return null|string
 423    */
 424   static function from($name, $mode, $side) {
 425     $from = NULL;
 426
 427     switch ($name) {
 428       case 'civicrm_pledge':
 429         $from = " $side JOIN civicrm_pledge  ON civicrm_pledge.contact_id = contact_a.id ";
 430         break;
 431
 432       case 'pledge_status':
 433         $from .= " $side JOIN civicrm_option_group option_group_pledge_status ON (option_group_pledge_status.name = 'contribution_status')";
 434         $from .= " $side JOIN civicrm_option_value pledge_status ON (civicrm_pledge.status_id = pledge_status.value AND option_group_pledge_status.id = pledge_status.option_group_id ) ";
 435         break;
 436
 437       case 'pledge_financial_type':
 438             $from .= " $side JOIN civicrm_financial_type ON civicrm_pledge.financial_type_id = civicrm_financial_type.id ";
 439         break;
 440
 441       case 'civicrm_pledge_payment':
 442         $from .= " $side JOIN civicrm_pledge_payment  ON civicrm_pledge_payment.pledge_id = civicrm_pledge.id ";
 443         break;
 444
 445       case 'payment_contribution':
 446         $from .= " $side JOIN civicrm_contribution payment_contribution ON civicrm_pledge_payment.contribution_id  = payment_contribution.id ";
 447         break;
 448
 449       case 'payment_status':
 450         $from .= " $side JOIN civicrm_option_group option_group_payment_status ON (option_group_payment_status.name = 'contribution_status')";
 451         $from .= " $side JOIN civicrm_option_value payment_status ON (civicrm_pledge_payment.status_id = payment_status.value AND option_group_payment_status.id = payment_status.option_group_id ) ";
 452         break;
 453     }
 454
 455     return $from;
 456   }
 457
 458   /**
 459    * getter for the qill object
 460    *
 461    * @return string
 462    * @access public
 463    */
 464   function qill() {
 465     return (isset($this->_qill)) ? $this->_qill : "";
 466   }
 467
 468   /**
 469    * Ideally this function should include fields that are displayed in the selector
 470    */
 471   static function defaultReturnProperties($mode,
 472     $includeCustomFields = TRUE
 473   ) {
 474     $properties = NULL;
 475
 476     if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) {
 477       $properties = array(
 478         'contact_type' => 1,
 479         'contact_sub_type' => 1,
 480         'sort_name' => 1,
 481         'display_name' => 1,
 482         'pledge_id' => 1,
 483         'pledge_amount' => 1,
 484         'pledge_total_paid' => 1,
 485         'pledge_create_date' => 1,
 486         'pledge_next_pay_date' => 1,
 487         'pledge_next_pay_amount' => 1,
 488         'pledge_status' => 1,
 489         'pledge_status_id' => 1,
 490         'pledge_is_test' => 1,
 491         'pledge_contribution_page_id' => 1,
 492         'pledge_financial_type' => 1,
 493         'pledge_frequency_interval' => 1,
 494         'pledge_frequency_unit' => 1,
 495         'pledge_currency' => 1,
 496         'pledge_campaign_id' => 1,
 497       );
 498     }
 499     return $properties;
 500   }
 501
 502   /**
 503    * This includes any extra fields that might need for export etc
 504    */
 505   static function extraReturnProperties($mode) {
 506     $properties = NULL;
 507
 508     if ($mode & CRM_Contact_BAO_Query::MODE_PLEDGE) {
 509       $properties = array(
 510         'pledge_balance_amount' => 1,
 511         'pledge_payment_id' => 1,
 512         'pledge_payment_scheduled_amount' => 1,
 513         'pledge_payment_scheduled_date' => 1,
 514         'pledge_payment_paid_amount' => 1,
 515         'pledge_payment_paid_date' => 1,
 516         'pledge_payment_reminder_date' => 1,
 517         'pledge_payment_reminder_count' => 1,
 518         'pledge_payment_status_id' => 1,
 519         'pledge_payment_status' => 1,
 520       );
 521
 522       // also get all the custom pledge properties
 523       $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Pledge');
 524       if (!empty($fields)) {
 525         foreach ($fields as $name => $dontCare) {
 526           $properties[$name] = 1;
 527         }
 528       }
 529     }
 530     return $properties;
 531   }
 532
 533   /**
 534    * @param $form
 535    */
 536   static function buildSearchForm(&$form) {
 537     // pledge related dates
 538     CRM_Core_Form_Date::buildDateRange($form, 'pledge_start_date', 1, '_low', '_high', ts('From'), FALSE);
 539     CRM_Core_Form_Date::buildDateRange($form, 'pledge_end_date', 1, '_low', '_high', ts('From'), FALSE);
 540     CRM_Core_Form_Date::buildDateRange($form, 'pledge_create_date', 1, '_low', '_high', ts('From'), FALSE);
 541
 542     // pledge payment related dates
 543     CRM_Core_Form_Date::buildDateRange($form, 'pledge_payment_date', 1, '_low', '_high', ts('From'), FALSE);
 544
 545     $form->addYesNo('pledge_test', ts('Pledge is a Test?'), TRUE);
 546     $form->add('text', 'pledge_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
 547     $form->addRule('pledge_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money');
 548
 549     $form->add('text', 'pledge_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
 550     $form->addRule('pledge_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
 551
 552     $statusValues = CRM_Contribute_PseudoConstant::contributionStatus();
 553
 554     // Remove status values that are only used for recurring contributions for now (Failed and In Progress).
 555     unset($statusValues['4']);
 556
 557     foreach ($statusValues as $key => $val) {
 558       $status[] = $form->createElement('advcheckbox', $key, NULL, $val);
 559     }
 560
 561     $form->addGroup($status, 'pledge_status_id', ts('Pledge Status'));
 562
 563     //unset in progress for payment
 564     unset($statusValues['5']);
 565
 566     foreach ($statusValues as $key => $val) {
 567       $paymentStatus[] = $form->createElement('advcheckbox', $key, NULL, $val);
 568     }
 569
 570     $form->addGroup($paymentStatus, 'pledge_payment_status_id', ts('Pledge Payment Status'));
 571
 572     $form->add('select', 'pledge_financial_type_id',
 573       ts( 'Financial Type' ),
 574       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(),
 575       FALSE, array('class' => 'crm-select2')
 576     );
 577
 578     $form->add('select', 'pledge_contribution_page_id',
 579       ts('Contribution Page'),
 580       array('' => ts('- any -')) + CRM_Contribute_PseudoConstant::contributionPage(),
 581       FALSE, array('class' => 'crm-select2')
 582     );
 583
 584     //add fields for pledge frequency
 585     $form->add('text', 'pledge_frequency_interval', ts('Every'), array('size' => 8, 'maxlength' => 8));
 586     $form->addRule('pledge_frequency_interval', ts('Please enter valid Pledge Frequency Interval'), 'integer');
 587     $frequencies = CRM_Core_OptionGroup::values('recur_frequency_units');
 588     foreach ($frequencies as $val => $label) {
 589       $freqUnitsDisplay["'{$val}'"] = ts('%1(s)', array(1 => $label));
 590     }
 591
 592     $form->add('select', 'pledge_frequency_unit',
 593       ts('Pledge Frequency'),
 594       array('' => ts('- any -')) + $freqUnitsDisplay
 595     );
 596
 597     // add all the custom  searchable fields
 598     $pledge = array('Pledge');
 599     $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $pledge);
 600     if ($groupDetails) {
 601       $form->assign('pledgeGroupTree', $groupDetails);
 602       foreach ($groupDetails as $group) {
 603         foreach ($group['fields'] as $field) {
 604           $fieldId = $field['id'];
 605           $elementName = 'custom_' . $fieldId;
 606           CRM_Core_BAO_CustomField::addQuickFormElement($form,
 607             $elementName,
 608             $fieldId,
 609             FALSE, FALSE, TRUE
 610           );
 611         }
 612       }
 613     }
 614
 615     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'pledge_campaign_id');
 616
 617     $form->assign('validCiviPledge', TRUE);
 618     $form->setDefaults(array('pledge_test' => 0));
 619   }
 620
 621   /**
 622    * @param $row
 623    * @param $id
 624    */
 625   static function searchAction(&$row, $id) {}
 626
 627   /**
 628    * @param $tables
 629    */
 630   static function tableNames(&$tables) {
 631     //add status table
 632     if (!empty($tables['pledge_status']) || !empty($tables['civicrm_pledge_payment'])) {
 633       $tables = array_merge(array('civicrm_pledge' => 1), $tables);
 634     }
 635   }
 636 }
 637