CRM/Contribute/Form/SoftCredit.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class build form elements for select exitsing or create new soft block
  38  */
  39 class CRM_Contribute_Form_SoftCredit {
  40
  41   /**
  42    * Function used to build form element for soft credit block
  43    *
  44    * @param object   $form form object
  45    * @access public
  46    *
  47    * @return void
  48    */
  49   static function buildQuickForm(&$form) {
  50     $prefix = 'soft_credit_';
  51     // by default generate 5 blocks
  52     $item_count = 6;
  53
  54     $showSoftCreditRow = 2;
  55     $showCreateNew = TRUE;
  56     if ($form->_action & CRM_Core_Action::UPDATE) {
  57       $form->_softCreditInfo = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($form->_id, TRUE);
  58       if (!empty($form->_softCreditInfo['soft_credit'])) {
  59         $showSoftCreditRow = count($form->_softCreditInfo['soft_credit']);
  60         $showSoftCreditRow++;
  61         $showCreateNew = FALSE;
  62       }
  63     }
  64
  65     for ($rowNumber = 1; $rowNumber <= $item_count; $rowNumber++) {
  66       CRM_Contact_Form_NewContact::buildQuickForm($form, $rowNumber, NULL, FALSE, $prefix);
  67
  68       $form->addMoney("{$prefix}amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
  69
  70       $form->add('select', "{$prefix}type[{$rowNumber}]",
  71         ts( 'Soft Credit Type' ),
  72         array(
  73           '' => ts('- select -')) +
  74           CRM_Core_OptionGroup::values("{$prefix}type", FALSE)
  75       );
  76       if (!empty($form->_softCreditInfo['soft_credit'][$rowNumber]['soft_credit_id'])) {
  77         $form->add('hidden', "{$prefix}id[{$rowNumber}]",
  78           $form->_softCreditInfo['soft_credit'][$rowNumber]['soft_credit_id']);
  79       }
  80     }
  81
  82     // CRM-7368 allow user to set or edit PCP link for contributions
  83     $siteHasPCPs = CRM_Contribute_PseudoConstant::pcPage();
  84     if (!CRM_Utils_Array::crmIsEmptyArray($siteHasPCPs)) {
  85       $form->assign('siteHasPCPs', 1);
  86       $pcpDataUrl = CRM_Utils_System::url('civicrm/ajax/rest',
  87         'className=CRM_Contact_Page_AJAX&fnName=getPCPList&json=1&context=contact&reset=1',
  88         FALSE, NULL, FALSE
  89       );
  90       $form->assign('pcpDataUrl', $pcpDataUrl);
  91       $form->addElement('text', 'pcp_made_through', ts('Credit to a Personal Campaign Page'));
  92       $form->addElement('hidden', 'pcp_made_through_id', '', array('id' => 'pcp_made_through_id'));
  93       $form->addElement('checkbox', 'pcp_display_in_roll', ts('Display in Honor Roll?'), NULL);
  94       $form->addElement('text', 'pcp_roll_nickname', ts('Name (for Honor Roll)'));
  95       $form->addElement('textarea', 'pcp_personal_note', ts('Personal Note (for Honor Roll)'));
  96     }
  97     $form->assign('showSoftCreditRow', $showSoftCreditRow);
  98     $form->assign('rowCount', $item_count);
  99     $form->assign('showCreateNew', $showCreateNew);
 100     $form->addElement('hidden', 'sct_default_id',
 101       CRM_Core_OptionGroup::getDefaultValue("{$prefix}type"),
 102       array('id' => 'sct_default_id')
 103     );
 104
 105     // Tell tpl to hide soft credit field if contribution is linked directly to a PCP Page
 106     if (CRM_Utils_Array::value('pcp_made_through_id', $form->_values)) {
 107       $form->assign('pcpLinked', 1);
 108     }
 109   }
 110
 111   /**
 112    * Function used to set defaults for soft credit block
 113    */
 114   static function setDefaultValues(&$defaults, &$form) {
 115     if (!empty($form->_softCreditInfo['soft_credit'])) {
 116       foreach ($form->_softCreditInfo['soft_credit'] as $key => $value) {
 117         $defaults["soft_credit_amount[$key]"] = CRM_Utils_Money::format($value['amount'], NULL, '%a');
 118         $defaults["soft_credit_contact_select_id[$key]"] = $value['contact_id'];
 119         $defaults["soft_credit_type[$key]"] = $value['soft_credit_type'];
 120       }
 121     }
 122
 123     elseif (CRM_Utils_Array::value('pcp_id', $form->_softCreditInfo)) {
 124       $pcpInfo = $form->_softCreditInfo;
 125       $pcpId = CRM_Utils_Array::value('pcp_id', $pcpInfo);
 126       $pcpTitle = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $pcpId, 'title');
 127       $contributionPageTitle = CRM_PCP_BAO_PCP::getPcpPageTitle($pcpId, 'contribute');
 128       $defaults['pcp_made_through'] = CRM_Utils_Array::value('sort_name', $pcpInfo) . " :: " . $pcpTitle . " :: " . $contributionPageTitle;
 129       $defaults['pcp_made_through_id'] = CRM_Utils_Array::value('pcp_id', $pcpInfo);
 130       $defaults['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $pcpInfo);
 131       $defaults['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $pcpInfo);
 132       $defaults['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $pcpInfo);
 133     }
 134   }
 135
 136   /**
 137    * global form rule
 138    *
 139    * @param array $fields  the input form values
 140    *
 141    * @return true if no errors, else array of errors
 142    * @access public
 143    * @static
 144    */
 145   static function formRule($fields) {
 146     $errors = array();
 147
 148     // if honor roll fields are populated but no PCP is selected
 149     if (!CRM_Utils_Array::value('pcp_made_through_id', $fields)) {
 150       if (CRM_Utils_Array::value('pcp_display_in_roll', $fields) ||
 151         CRM_Utils_Array::value('pcp_roll_nickname', $fields) ||
 152         CRM_Utils_Array::value('pcp_personal_note', $fields)
 153       ) {
 154         $errors['pcp_made_through'] = 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.');
 155       }
 156     }
 157
 158     if (!empty($fields['soft_credit_amount'])) {
 159       $repeat = array_count_values($fields['soft_credit_contact_select_id']);
 160       foreach ($fields['soft_credit_amount'] as $key => $val) {
 161         if (!empty($fields['soft_credit_contact_select_id'][$key])) {
 162           if ($repeat[$fields['soft_credit_contact_select_id'][$key]] > 1) {
 163             $errors["soft_credit_contact_select_id[$key]"] = ts('You cannot enter multiple soft credits for the same contact.');
 164           }
 165           if ($fields['soft_credit_amount'][$key]
 166             && (CRM_Utils_Rule::cleanMoney($fields['soft_credit_amount'][$key]) > CRM_Utils_Rule::cleanMoney($fields['total_amount']))) {
 167             $errors["soft_credit_amount[$key]"] = ts('Soft credit amount cannot be more than the total amount.');
 168           }
 169           if (empty($fields['soft_credit_amount'][$key])) {
 170             $errors["soft_credit_amount[$key]"] = ts('Please enter the soft credit amount.');
 171           }
 172         }
 173       }
 174     }
 175     return $errors;
 176   }
 177 }
 178