CRM/Contribute/Form/SoftCredit.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class build form elements for select existing or create new soft block.
  36  */
  37 class CRM_Contribute_Form_SoftCredit {
  38
  39   /**
  40    * Function used to build form element for soft credit block.
  41    *
  42    * @param CRM_Core_Form $form
  43    *
  44    * @return \CRM_Core_Form
  45    */
  46   public static function buildQuickForm(&$form) {
  47     if (!empty($form->_honor_block_is_active)) {
  48       $ufJoinDAO = new CRM_Core_DAO_UFJoin();
  49       $ufJoinDAO->module = 'soft_credit';
  50       $ufJoinDAO->entity_id = $form->_id;
  51       if ($ufJoinDAO->find(TRUE)) {
  52         $jsonData = CRM_Contribute_BAO_ContributionPage::formatModuleData($ufJoinDAO->module_data, TRUE, 'soft_credit');
  53         if ($jsonData) {
  54           foreach (['honor_block_title', 'honor_block_text'] as $name) {
  55             $form->assign($name, $jsonData[$name]);
  56           }
  57
  58           $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
  59
  60           // radio button for Honor Type
  61           foreach ($jsonData['soft_credit_types'] as $value) {
  62             $honorTypes[$value] = $form->createElement('radio', NULL, NULL, $softCreditTypes[$value], $value);
  63           }
  64           $form->addGroup($honorTypes, 'soft_credit_type_id', NULL)->setAttribute('allowClear', TRUE);
  65         }
  66       }
  67       return $form;
  68     }
  69
  70     // by default generate 10 blocks
  71     $item_count = $form->_softCreditItemCount;
  72
  73     $showSoftCreditRow = 2;
  74     if ($form->getAction() & CRM_Core_Action::UPDATE) {
  75       $form->_softCreditInfo = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($form->_id, TRUE);
  76     }
  77     elseif (!empty($form->_pledgeID)) {
  78       //Check and select most recent completed contrubtion and use it to retrieve
  79       //soft-credit information to use as default for current pledge payment, CRM-13981
  80       $pledgePayments = CRM_Pledge_BAO_PledgePayment::getPledgePayments($form->_pledgeID);
  81       foreach ($pledgePayments as $id => $record) {
  82         if ($record['contribution_id']) {
  83           $softCredits = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($record['contribution_id'], TRUE);
  84           if ($record['status'] == 'Completed' && count($softCredits) > 0) {
  85             $form->_softCreditInfo = $softCredits;
  86           }
  87         }
  88       }
  89     }
  90
  91     if (property_exists($form, "_softCreditInfo")) {
  92       if (!empty($form->_softCreditInfo['soft_credit'])) {
  93         $showSoftCreditRow = count($form->_softCreditInfo['soft_credit']);
  94         $showSoftCreditRow++;
  95       }
  96     }
  97
  98     for ($rowNumber = 1; $rowNumber <= $item_count; $rowNumber++) {
  99       $form->addEntityRef("soft_credit_contact_id[{$rowNumber}]", ts('Contact'), ['create' => TRUE]);
 100
 101       $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
 102
 103       $form->addSelect("soft_credit_type[{$rowNumber}]", [
 104         'entity' => 'contribution_soft',
 105         'field' => 'soft_credit_type_id',
 106         'label' => ts('Type'),
 107       ]);
 108       if (!empty($form->_softCreditInfo['soft_credit'][$rowNumber]['soft_credit_id'])) {
 109         $form->add('hidden', "soft_credit_id[{$rowNumber}]",
 110           $form->_softCreditInfo['soft_credit'][$rowNumber]['soft_credit_id']);
 111       }
 112     }
 113
 114     self::addPCPFields($form);
 115
 116     $form->assign('showSoftCreditRow', $showSoftCreditRow);
 117     $form->assign('rowCount', $item_count);
 118     $form->addElement('hidden', 'sct_default_id',
 119       CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 120       ['id' => 'sct_default_id']
 121     );
 122   }
 123
 124   /**
 125    * Add PCP fields for the new contribution form and others.
 126    *
 127    * @param CRM_Core_Form &$form
 128    *   The form being built.
 129    * @param string $suffix
 130    *   A suffix to add to field names.
 131    */
 132   public static function addPCPFields(&$form, $suffix = '') {
 133     // CRM-7368 allow user to set or edit PCP link for contributions
 134     $siteHasPCPs = CRM_Contribute_PseudoConstant::pcPage();
 135     if (!CRM_Utils_Array::crmIsEmptyArray($siteHasPCPs)) {
 136       $form->assign('siteHasPCPs', 1);
 137       // Fixme: Not a true entityRef field. Relies on PCP.js.tpl
 138       $form->add('text', "pcp_made_through_id$suffix", ts('Credit to a Personal Campaign Page'), ['class' => 'twenty', 'placeholder' => ts('- select -')]);
 139       // stores the label
 140       $form->add('hidden', "pcp_made_through$suffix");
 141       $form->addElement('checkbox', "pcp_display_in_roll$suffix", ts('Display in Honor Roll?'), NULL);
 142       $form->addElement('text', "pcp_roll_nickname$suffix", ts('Name (for Honor Roll)'));
 143       $form->addElement('textarea', "pcp_personal_note$suffix", ts('Personal Note (for Honor Roll)'));
 144     }
 145   }
 146
 147   /**
 148    * Function used to set defaults for soft credit block.
 149    *
 150    * @param $defaults
 151    * @param $form
 152    */
 153   public static function setDefaultValues(&$defaults, &$form) {
 154     //Used to hide/unhide PCP and/or Soft-credit Panes
 155     $noPCP = $noSoftCredit = TRUE;
 156     if (!empty($form->_softCreditInfo['soft_credit'])) {
 157       $noSoftCredit = FALSE;
 158       foreach ($form->_softCreditInfo['soft_credit'] as $key => $value) {
 159         $defaults["soft_credit_amount[$key]"] = CRM_Utils_Money::format($value['amount'], NULL, '%a');
 160         $defaults["soft_credit_contact_id[$key]"] = $value['contact_id'];
 161         $defaults["soft_credit_type[$key]"] = $value['soft_credit_type'];
 162       }
 163     }
 164     if (!empty($form->_softCreditInfo['pcp_id'])) {
 165       $noPCP = FALSE;
 166       $pcpInfo = $form->_softCreditInfo;
 167       $pcpId = CRM_Utils_Array::value('pcp_id', $pcpInfo);
 168       $pcpTitle = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $pcpId, 'title');
 169       $contributionPageTitle = CRM_PCP_BAO_PCP::getPcpPageTitle($pcpId, 'contribute');
 170       $defaults['pcp_made_through'] = CRM_Utils_Array::value('sort_name', $pcpInfo) . " :: " . $pcpTitle . " :: " . $contributionPageTitle;
 171       $defaults['pcp_made_through_id'] = CRM_Utils_Array::value('pcp_id', $pcpInfo);
 172       $defaults['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $pcpInfo);
 173       $defaults['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $pcpInfo);
 174       $defaults['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $pcpInfo);
 175     }
 176
 177     $form->assign('noSoftCredit', $noSoftCredit);
 178     $form->assign('noPCP', $noPCP);
 179   }
 180
 181   /**
 182    * Global form rule.
 183    *
 184    * @param array $fields
 185    *   The input form values.
 186    *
 187    * @param $errors
 188    * @param $self
 189    *
 190    * @return array
 191    *   Array of errors
 192    */
 193   public static function formRule($fields, $errors, $self) {
 194     $errors = [];
 195
 196     // if honor roll fields are populated but no PCP is selected
 197     if (empty($fields['pcp_made_through_id'])) {
 198       if (!empty($fields['pcp_display_in_roll']) || !empty($fields['pcp_roll_nickname']) ||
 199         CRM_Utils_Array::value('pcp_personal_note', $fields)
 200       ) {
 201         $errors['pcp_made_through_id'] = ts('Please select a Personal Campaign Page, OR uncheck Display in Honor Roll and clear both the Honor Roll Name and the Personal Note field.');
 202       }
 203     }
 204
 205     if (!empty($fields['soft_credit_amount'])) {
 206       $repeat = array_count_values($fields['soft_credit_contact_id']);
 207       foreach ($fields['soft_credit_amount'] as $key => $val) {
 208         if (!empty($fields['soft_credit_contact_id'][$key])) {
 209           if ($repeat[$fields['soft_credit_contact_id'][$key]] > 1) {
 210             $errors["soft_credit_contact_id[$key]"] = ts('You cannot enter multiple soft credits for the same contact.');
 211           }
 212           if ($self->_action == CRM_Core_Action::ADD && $fields['soft_credit_amount'][$key]
 213             && (CRM_Utils_Rule::cleanMoney($fields['soft_credit_amount'][$key]) > CRM_Utils_Rule::cleanMoney($fields['total_amount']))
 214           ) {
 215             $errors["soft_credit_amount[$key]"] = ts('Soft credit amount cannot be more than the total amount.');
 216           }
 217           if (empty($fields['soft_credit_amount'][$key])) {
 218             $errors["soft_credit_amount[$key]"] = ts('Please enter the soft credit amount.');
 219           }
 220         }
 221       }
 222     }
 223
 224     return $errors;
 225   }
 226
 227 }