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