Merge branch '4.7.21-rc' into master
[civicrm-core.git] / CRM / Member / Form / MembershipType.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
7e9e8871 4 | CiviCRM version 4.7 |
6a488035 5 +--------------------------------------------------------------------+
0f03f337 6 | Copyright CiviCRM LLC (c) 2004-2017 |
6a488035
TO
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
0f03f337 31 * @copyright CiviCRM LLC (c) 2004-2017
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * This class generates form components for Membership Type
38 *
39 */
fb3082b2 40class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig {
6a488035
TO
41
42 /**
100fef9d 43 * Max number of contacts we will display for membership-organisation
6a488035 44 */
7da04cde 45 const MAX_CONTACTS = 50;
6a488035 46
00be9182 47 public function preProcess() {
481a74f4 48 $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
6a488035
TO
49 $this->_BAOName = 'CRM_Member_BAO_MembershipType';
50 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
51 $this->assign('action', $this->_action);
52
53 $session = CRM_Core_Session::singleton();
54 $url = CRM_Utils_System::url('civicrm/admin/member/membershipType', 'reset=1');
55 $session->pushUserContext($url);
e2046b33
CW
56
57 $this->setPageTitle(ts('Membership Type'));
6a488035
TO
58 }
59
60 /**
c490a46a 61 * Set default values for the form. MobileProvider that in edit/view mode
6a488035
TO
62 * the default values are retrieved from the database
63 *
6a488035 64 *
355ba699 65 * @return void
6a488035
TO
66 */
67 public function setDefaultValues() {
68 $defaults = parent::setDefaultValues();
69
6a488035
TO
70 //finding default weight to be put
71 if (!isset($defaults['weight']) || (!$defaults['weight'])) {
72 $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Member_DAO_MembershipType');
73 }
74 //setting default relationshipType
75 if (isset($defaults['relationship_type_id'])) {
76 //$defaults['relationship_type_id'] = $defaults['relationship_type_id'].'_a_b';
77 // Set values for relation type select box
78 $relTypeIds = explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['relationship_type_id']);
79 $relDirections = explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['relationship_direction']);
80 $defaults['relationship_type_id'] = array();
81 foreach ($relTypeIds as $key => $value) {
82 $defaults['relationship_type_id'][] = $value . '_' . $relDirections[$key];
83 }
84 }
85
6a488035
TO
86 //setting default fixed_period_start_day & fixed_period_rollover_day
87 $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
88 foreach ($periods as $per) {
89 if (isset($defaults[$per])) {
353ffa53 90 $date = $defaults[$per];
6a488035
TO
91
92 $defaults[$per] = array();
93 if ($date > 31) {
353ffa53 94 $date = ($date < 999) ? '0' . $date : $date;
6a488035
TO
95 $defaults[$per]['M'] = substr($date, 0, 2);
96 $defaults[$per]['d'] = substr($date, 2, 3);
97 }
98 else {
99 //special case when only day is rollover and duration is month
100 $defaults['month_fixed_period_rollover_day']['d'] = $date;
101 }
102 }
103 }
104
105 return $defaults;
106 }
107
108 /**
fe482240 109 * Build the form object.
6a488035 110 *
355ba699 111 * @return void
6a488035
TO
112 */
113 public function buildQuickForm() {
114 parent::buildQuickForm();
115
116 if ($this->_action & CRM_Core_Action::DELETE) {
117 return;
118 }
119
120 $this->applyFilter('__ALL__', 'trim');
121 $this->add('text', 'name', ts('Name'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'name'), TRUE);
122
123 $this->addRule('name', ts('A membership type with this name already exists. Please select another name.'),
124 'objectExists', array('CRM_Member_DAO_MembershipType', $this->_id)
125 );
126 $this->add('text', 'description', ts('Description'),
127 CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'description')
128 );
129 $this->add('text', 'minimum_fee', ts('Minimum Fee'),
130 CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'minimum_fee')
131 );
132 $this->addRule('minimum_fee', ts('Please enter a monetary value for the Minimum Fee.'), 'money');
133
2267460c 134 $this->addSelect('duration_unit', array(), TRUE);
6a488035
TO
135
136 //period type
ab5e0c41 137 $this->addSelect('period_type', array(), TRUE);
6a488035
TO
138
139 $this->add('text', 'duration_interval', ts('Duration Interval'),
140 CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'duration_interval')
141 );
142
fc791e90
CW
143 $props = array('api' => array('params' => array('contact_type' => 'Organization')));
144 $this->addEntityRef('member_of_contact_id', ts('Membership Organization'), $props, TRUE);
6a488035
TO
145
146 //start day
147 $this->add('date', 'fixed_period_start_day', ts('Fixed Period Start Day'),
148 CRM_Core_SelectValues::date(NULL, 'M d'), FALSE
149 );
150
151 //Auto-renew Option
353ffa53
TO
152 $paymentProcessor = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
153 $isAuthorize = FALSE;
154 $options = array();
6a488035
TO
155 if (is_array($paymentProcessor) && !empty($paymentProcessor)) {
156 $isAuthorize = TRUE;
dbd82592 157 $options = CRM_Core_SelectValues::memberAutoRenew();
6a488035
TO
158 }
159
160 $this->addRadio('auto_renew', ts('Auto-renew Option'), $options);
161 $this->assign('authorize', $isAuthorize);
162
163 //rollover day
164 $this->add('date', 'fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
165 CRM_Core_SelectValues::date(NULL, 'M d'), FALSE
166 );
167 $this->add('date', 'month_fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
168 CRM_Core_SelectValues::date(NULL, 'd'), FALSE
169 );
481a74f4 170 $this->add('select', 'financial_type_id', ts('Financial Type'),
573fd305 171 array('' => ts('- select -')) + CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action), TRUE, array('class' => 'crm-select2')
6a488035
TO
172 );
173
174 $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
175 if (is_array($relTypeInd)) {
176 asort($relTypeInd);
177 }
baccd59e
CW
178 $memberRel = $this->add('select', 'relationship_type_id', ts('Relationship Type'),
179 $relTypeInd, FALSE, array('class' => 'crm-select2 huge', 'multiple' => 1));
6a488035 180
764b1cdc 181 $this->addSelect('visibility', array('placeholder' => NULL, 'option_url' => NULL));
b3872345 182
6a488035
TO
183 $this->add('text', 'weight', ts('Order'),
184 CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'weight')
185 );
186 $this->add('checkbox', 'is_active', ts('Enabled?'));
187
188 $membershipRecords = FALSE;
189 if ($this->_action & CRM_Core_Action::UPDATE) {
ff60ec7a 190 $result = civicrm_api3("Membership", "get", array("membership_type_id" => $this->_id, "options" => array("limit" => 1)));
88d349ca 191 $membershipRecords = ($result["count"] > 0);
ff60ec7a 192 if ($membershipRecords) {
6a488035
TO
193 $memberRel->freeze();
194 }
195 }
196
197 $this->assign('membershipRecordsExists', $membershipRecords);
198
199 $this->add('text', 'max_related', ts('Max related'),
353ffa53 200 CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'max_related')
6a488035
TO
201 );
202
203 $this->addFormRule(array('CRM_Member_Form_MembershipType', 'formRule'));
204
205 $this->assign('membershipTypeId', $this->_id);
cebff547
PN
206
207 if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
208 $deferredFinancialType = CRM_Financial_BAO_FinancialAccount::getDeferredFinancialType();
209 $this->assign('deferredFinancialType', array_keys($deferredFinancialType));
210 }
6a488035
TO
211 }
212
213 /**
fe482240 214 * Validation.
6a488035 215 *
b2363ea8
TO
216 * @param array $params
217 * (ref.) an assoc array of name/value pairs.
6a488035 218 *
72b3a70c
CW
219 * @return bool|array
220 * mixed true or array of errors
6a488035 221 */
00be9182 222 public static function formRule($params) {
6a488035
TO
223 $errors = array();
224
225 if (!$params['name']) {
226 $errors['name'] = ts('Please enter a membership type name.');
227 }
228
481a74f4 229 if (($params['minimum_fee'] > 0) && !$params['financial_type_id']) {
6c68db9f 230 $errors['financial_type_id'] = ts('Please enter the financial Type.');
6a488035
TO
231 }
232
6a488035
TO
233 if (empty($params['duration_interval']) and $params['duration_unit'] != 'lifetime') {
234 $errors['duration_interval'] = ts('Please enter a duration interval.');
235 }
236
237 if (in_array(CRM_Utils_Array::value('auto_renew', $params), array(
353ffa53 238 1,
af9b09df 239 2,
353ffa53 240 ))) {
6a488035
TO
241 if (($params['duration_interval'] > 1 && $params['duration_unit'] == 'year') ||
242 ($params['duration_interval'] > 12 && $params['duration_unit'] == 'month')
243 ) {
244 $errors['duration_unit'] = ts('Automatic renewals are not supported by the currently available payment processors when the membership duration is greater than 1 year / 12 months.');
245 }
246 }
247
6a488035
TO
248 if ($params['period_type'] == 'fixed' &&
249 $params['duration_unit'] == 'day'
250 ) {
251 $errors['period_type'] = ts('Period type should be Rolling when duration unit is Day');
252 }
253
254 if (($params['period_type'] == 'fixed') &&
255 ($params['duration_unit'] == 'year')
256 ) {
257 $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
258 foreach ($periods as $period) {
259 $month = $params[$period]['M'];
260 $date = $params[$period]['d'];
261 if (!$month || !$date) {
262 switch ($period) {
263 case 'fixed_period_start_day':
264 $errors[$period] = ts('Please enter a valid fixed period start day');
265 break;
266
267 case 'fixed_period_rollover_day':
268 $errors[$period] = ts('Please enter a valid fixed period rollover day');
269 break;
270 }
271 }
272 }
273 }
274
275 if ($params['fixed_period_start_day'] && !empty($params['fixed_period_start_day'])) {
276 $params['fixed_period_start_day']['Y'] = date('Y');
277 if (!CRM_Utils_Rule::qfDate($params['fixed_period_start_day'])) {
278 $errors['fixed_period_start_day'] = ts('Please enter valid Fixed Period Start Day');
279 }
280 }
281
282 if ($params['fixed_period_rollover_day'] && !empty($params['fixed_period_rollover_day'])) {
283 $params['fixed_period_rollover_day']['Y'] = date('Y');
284 if (!CRM_Utils_Rule::qfDate($params['fixed_period_rollover_day'])) {
285 $errors['fixed_period_rollover_day'] = ts('Please enter valid Fixed Period Rollover Day');
286 }
287 }
288
289 return empty($errors) ? TRUE : $errors;
290 }
291
292 /**
fe482240 293 * Process the form submission.
6a488035 294 *
6a488035 295 *
355ba699 296 * @return void
6a488035
TO
297 */
298 public function postProcess() {
299 if ($this->_action & CRM_Core_Action::DELETE) {
92e4c2a5 300 try {
353ffa53 301 CRM_Member_BAO_MembershipType::del($this->_id);
dcc4f6a7 302 }
353ffa53 303 catch (CRM_Core_Exception $e) {
dcc4f6a7 304 CRM_Core_Error::statusBounce($e->getMessage(), NULL, ts('Membership Type Not Deleted'));
305 }
6a488035
TO
306 CRM_Core_Session::setStatus(ts('Selected membership type has been deleted.'), ts('Record Deleted'), 'success');
307 }
308 else {
309 $buttonName = $this->controller->getButtonName();
310 $submitted = $this->controller->exportValues($this->_name);
311
312 $fields = array(
313 'name',
314 'weight',
315 'is_active',
316 'member_of_contact_id',
317 'visibility',
318 'period_type',
319 'minimum_fee',
320 'description',
321 'auto_renew',
322 'duration_unit',
323 'duration_interval',
324 'financial_type_id',
325 'fixed_period_start_day',
326 'fixed_period_rollover_day',
327 'month_fixed_period_rollover_day',
21dfd5f5 328 'max_related',
6a488035
TO
329 );
330
331 $params = $ids = array();
332 foreach ($fields as $fld) {
333 $params[$fld] = CRM_Utils_Array::value($fld, $submitted, 'NULL');
334 }
335
336 //clean money.
337 if ($params['minimum_fee']) {
338 $params['minimum_fee'] = CRM_Utils_Rule::cleanMoney($params['minimum_fee']);
339 }
340
341 $hasRelTypeVal = FALSE;
342 if (!CRM_Utils_System::isNull($submitted['relationship_type_id'])) {
343 // To insert relation ids and directions with value separator
344 $relTypeDirs = $submitted['relationship_type_id'];
345 $relIds = $relDirection = array();
346 foreach ($relTypeDirs as $key => $value) {
347 $relationId = explode('_', $value);
348 if (count($relationId) == 3 &&
349 is_numeric($relationId[0])
350 ) {
351 $relIds[] = $relationId[0];
352 $relDirection[] = $relationId[1] . '_' . $relationId[2];
353 }
354 }
355 if (!empty($relIds)) {
356 $hasRelTypeVal = TRUE;
357 $params['relationship_type_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relIds);
358 $params['relationship_direction'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relDirection);
359 }
360 }
361 if (!$hasRelTypeVal) {
362 $params['relationship_type_id'] = $params['relationship_direction'] = $params['max_related'] = 'NULL';
363 }
364
365 if ($params['duration_unit'] == 'lifetime' &&
366 empty($params['duration_interval'])
367 ) {
368 $params['duration_interval'] = 1;
369 }
370
371 $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
372 foreach ($periods as $per) {
8cc574cf 373 if (!empty($params[$per]['M']) && !empty($params[$per]['d'])) {
353ffa53
TO
374 $mon = $params[$per]['M'];
375 $dat = $params[$per]['d'];
376 $mon = ($mon < 10) ? '0' . $mon : $mon;
377 $dat = ($dat < 10) ? '0' . $dat : $dat;
6a488035
TO
378 $params[$per] = $mon . $dat;
379 }
353ffa53 380 elseif ($per == 'fixed_period_rollover_day' && !empty($params['month_fixed_period_rollover_day'])) {
6a488035
TO
381 $params['fixed_period_rollover_day'] = $params['month_fixed_period_rollover_day']['d'];
382 unset($params['month_fixed_period_rollover_day']);
383 }
384 else {
385 $params[$per] = 'NULL';
386 }
387 }
388 $oldWeight = NULL;
389
390 if ($this->_id) {
391 $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
392 $this->_id, 'weight', 'id'
393 );
394 }
395 $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Member_DAO_MembershipType',
396 $oldWeight, $params['weight']
397 );
398
399 if ($this->_action & CRM_Core_Action::UPDATE) {
400 $ids['membershipType'] = $this->_id;
401 }
402
403 $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
404
405 CRM_Core_Session::setStatus(ts('The membership type \'%1\' has been saved.',
353ffa53
TO
406 array(1 => $membershipType->name)
407 ), ts('Saved'), 'success');
6a488035
TO
408 $session = CRM_Core_Session::singleton();
409 if ($buttonName == $this->getButtonName('upload', 'new')) {
60970bf5
DL
410 $session->replaceUserContext(
411 CRM_Utils_System::url('civicrm/admin/member/membershipType/add', 'action=add&reset=1')
6a488035
TO
412 );
413 }
414 }
415 }
416
bb3a214a 417 /**
100fef9d
CW
418 * @param int $previousID
419 * @param int $priceSetId
420 * @param int $membershipTypeId
bb3a214a
EM
421 * @param $optionsIds
422 */
6975b8a7 423 public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
6a488035
TO
424 if ($previousID) {
425 $editedFieldParams = array(
426 'price_set_id ' => $priceSetId,
427 'name' => $previousID,
428 );
429 $editedResults = array();
9da8dc8c 430 CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
6a488035
TO
431 if (!empty($editedResults)) {
432 $editedFieldParams = array(
433 'price_field_id' => $editedResults['id'],
434 'membership_type_id' => $membershipTypeId,
435 );
436 $editedResults = array();
9da8dc8c 437 CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
6a488035
TO
438 $optionsIds['option_id'][1] = CRM_Utils_Array::value('id', $editedResults);
439 }
440 }
441 }
96025800 442
6a488035 443}