CRM/Contribute/Form/SoftCredit.php

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