3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 * This class generates form components for Membership Type
23 class CRM_Member_Form_MembershipType
extends CRM_Member_Form_MembershipConfig
{
25 use CRM_Core_Form_EntityFormTrait
;
28 * Fields for the entity to be assigned to the template.
30 * Fields may have keys
31 * - name (required to show in tpl from the array)
32 * - description (optional, will appear below the field)
33 * - not-auto-addable - this class will not attempt to add the field using addField.
34 * (this will be automatically set if the field does not have html in it's metadata
35 * or is not a core field on the form's entity).
36 * - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']]
37 * - template - use a field specific template to render this field
39 * - is_freeze (field should be frozen).
43 protected $entityFields = [];
46 * Set entity fields to be assigned to the form.
48 protected function setEntityFields() {
49 $this->entityFields
= [
53 'description' => ts("e.g. 'Student', 'Senior', 'Honor Society'..."),
56 'name' => 'description',
57 'description' => ts("Description of this membership type for internal use. May include eligibility, benefits, terms, etc."),
59 'member_of_contact_id' => [
60 'name' => 'member_of_contact_id',
61 'description' => ts("Members assigned this membership type belong to which organization (e.g. this is for membership in 'Save the Whales - Northwest Chapter'). NOTE: This organization/group/chapter must exist as a CiviCRM Organization type contact."),
64 'name' => 'minimum_fee',
65 'description' => ts('Minimum fee required for this membership type. For free/complimentary memberships - set minimum fee to zero (0). NOTE: When using CiviCRM to process sales taxes this should be the tax exclusive amount.'),
66 'formatter' => 'crmMoney',
68 'financial_type_id' => [
69 'name' => 'financial_type_id',
70 'description' => ts('Select the financial type assigned to fees for this membership type (for example \'Membership Fees\'). This is required for all membership types - including free or complimentary memberships.'),
73 'name' => 'auto_renew',
74 'options' => CRM_Core_SelectValues
::memberAutoRenew(),
75 'place_holder' => ts('You will need to select and configure a supported payment processor (currently Authorize.Net, PayPal Pro, or PayPal Website Standard) in order to offer automatically renewing memberships.'),
77 'duration_interval' => [
78 'name' => 'duration_interval',
82 'name' => 'duration_unit',
83 'description' => ts('Duration of this membership (e.g. 30 days, 2 months, 5 years, 1 lifetime)'),
87 'name' => 'period_type',
88 'description' => ts("Select 'rolling' if membership periods begin at date of signup. Select 'fixed' if membership periods begin on a set calendar date."),
89 'help' => ['id' => 'period-type', 'file' => "CRM/Member/Page/MembershipType.hlp"],
92 'fixed_period_start_day' => [
93 'name' => 'fixed_period_start_day',
94 'description' => ts("Month and day on which a <strong>fixed</strong> period membership or subscription begins. Example: A fixed period membership with Start Day set to Jan 01 means that membership periods would be 1/1/06 - 12/31/06 for anyone signing up during 2006."),
96 'fixed_period_rollover_day' => [
97 'name' => 'fixed_period_rollover_day',
98 'description' => ts('Membership signups on or after this date cover the following calendar year as well. Example: If the rollover day is November 30, membership period for signups during December will cover the following year.'),
100 'relationship_type_id' => [
101 'name' => 'relationship_type_id',
104 'name' => 'max_related',
105 'description' => ts('Maximum number of related memberships (leave blank for unlimited).'),
108 'name' => 'visibility',
109 'description' => ts("Can this membership type be used for self-service signups ('Public'), or is it only for CiviCRM users with 'Edit Contributions' permission ('Admin')."),
115 'name' => 'is_active',
119 if (!CRM_Financial_BAO_PaymentProcessor
::hasPaymentProcessorSupporting(['Recurring'])) {
120 $this->entityFields
['auto_renew']['not-auto-addable'] = TRUE;
121 $this->entityFields
['auto_renew']['documentation_link'] = ['page' => 'user/contributions/payment-processors'];
126 * Deletion message to be assigned to the form.
130 protected $deleteMessage;
133 * Explicitly declare the entity api name.
135 public function getDefaultEntity() {
136 return 'MembershipType';
140 * Set the delete message.
142 * We do this from the constructor in order to do a translation.
144 public function setDeleteMessage() {
145 $this->deleteMessage
= ts('WARNING: Deleting this option will result in the loss of all membership records of this type.') . ts('This may mean the loss of a substantial amount of data, and the action cannot be undone.') . ts('Do you want to continue?');
149 * Explicitly declare the form context.
151 public function getDefaultContext() {
156 * Max number of contacts we will display for membership-organisation
158 const MAX_CONTACTS
= 50;
160 public function preProcess() {
161 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
162 $this->_BAOName
= 'CRM_Member_BAO_MembershipType';
163 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
164 $this->assign('action', $this->_action
);
166 $session = CRM_Core_Session
::singleton();
167 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipType', 'reset=1');
168 $session->pushUserContext($url);
170 $this->setPageTitle(ts('Membership Type'));
174 * Set default values for the form. MobileProvider that in edit/view mode
175 * the default values are retrieved from the database
180 public function setDefaultValues() {
181 $defaults = parent
::setDefaultValues();
183 //finding default weight to be put
184 if (!isset($defaults['weight']) ||
(!$defaults['weight'])) {
185 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Member_DAO_MembershipType');
187 //setting default relationshipType
188 if (isset($defaults['relationship_type_id'])) {
189 //$defaults['relationship_type_id'] = $defaults['relationship_type_id'].'_a_b';
190 // Set values for relation type select box
191 $relTypeIds = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaults['relationship_type_id']);
192 $relDirections = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaults['relationship_direction']);
193 $defaults['relationship_type_id'] = [];
194 foreach ($relTypeIds as $key => $value) {
195 $defaults['relationship_type_id'][] = $value . '_' . $relDirections[$key];
199 //setting default fixed_period_start_day & fixed_period_rollover_day
200 $periods = ['fixed_period_start_day', 'fixed_period_rollover_day'];
201 foreach ($periods as $per) {
202 if (isset($defaults[$per])) {
203 $date = $defaults[$per];
205 $defaults[$per] = [];
207 $date = ($date < 999) ?
'0' . $date : $date;
208 $defaults[$per]['M'] = substr($date, 0, 2);
209 $defaults[$per]['d'] = substr($date, 2, 3);
212 //special case when only day is rollover and duration is month
213 $defaults['month_fixed_period_rollover_day']['d'] = $date;
222 * Build the form object.
225 * @throws \CRM_Core_Exception
226 * @throws \CiviCRM_API3_Exception
228 public function buildQuickForm() {
229 self
::buildQuickEntityForm();
231 if ($this->_action
& CRM_Core_Action
::DELETE
) {
234 // This is a temporary variable as we work towards moving over towards using the EntityField.tpl.
235 // Fields in this array have been tested & in the tpl have been switched over to metadata.
236 // Note this kinda 'works from the top' - ie. once we hit a field that needs some thought we need
237 // to stop & make that one work.
238 $this->assign('tpl_standardised_fields', ['name', 'description', 'member_of_contact_id', 'minimum_fee']);
240 $this->addRule('name', ts('A membership type with this name already exists. Please select another name.'),
241 'objectExists', ['CRM_Member_DAO_MembershipType', $this->_id
]
243 $this->addRule('minimum_fee', ts('Please enter a monetary value for the Minimum Fee.'), 'money');
245 $props = ['api' => ['params' => ['contact_type' => 'Organization']]];
246 $this->addEntityRef('member_of_contact_id', ts('Membership Organization'), $props, TRUE);
249 $this->add('date', 'fixed_period_start_day', ts('Fixed Period Start Day'),
250 CRM_Core_SelectValues
::date(NULL, 'M d'), FALSE
253 // Add Auto-renew options if we have a payment processor that supports recurring contributions
254 $isAuthorize = FALSE;
256 if (CRM_Financial_BAO_PaymentProcessor
::hasPaymentProcessorSupporting(['Recurring'])) {
258 $options = CRM_Core_SelectValues
::memberAutoRenew();
261 $this->addRadio('auto_renew', ts('Auto-renew Option'), $options);
262 $this->assign('authorize', $isAuthorize);
265 $this->add('date', 'fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
266 CRM_Core_SelectValues
::date(NULL, 'M d'), FALSE
268 $this->add('date', 'month_fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
269 CRM_Core_SelectValues
::date(NULL, 'd'), FALSE
271 $this->add('select', 'financial_type_id', ts('Financial Type'),
272 ['' => ts('- select -')] + CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
), TRUE, ['class' => 'crm-select2']
275 $relTypeInd = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
276 if (is_array($relTypeInd)) {
279 $memberRel = $this->add('select', 'relationship_type_id', ts('Relationship Type'),
280 $relTypeInd, FALSE, ['class' => 'crm-select2 huge', 'multiple' => 1]);
282 $this->addField('visibility', ['placeholder' => NULL, 'option_url' => NULL]);
284 $membershipRecords = FALSE;
285 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
286 $result = civicrm_api3("Membership", "get", ["membership_type_id" => $this->_id
, "options" => ["limit" => 1]]);
287 $membershipRecords = ($result["count"] > 0);
288 if ($membershipRecords) {
289 $memberRel->freeze();
293 $this->assign('membershipRecordsExists', $membershipRecords);
295 $this->addFormRule(['CRM_Member_Form_MembershipType', 'formRule']);
297 $this->assign('membershipTypeId', $this->_id
);
299 if (Civi
::settings()->get('deferred_revenue_enabled')) {
300 $deferredFinancialType = CRM_Financial_BAO_FinancialAccount
::getDeferredFinancialType();
301 $this->assign('deferredFinancialType', array_keys($deferredFinancialType));
308 * @param array $params
309 * (ref.) an assoc array of name/value pairs.
312 * mixed true or array of errors
314 public static function formRule($params) {
317 if (!$params['name']) {
318 $errors['name'] = ts('Please enter a membership type name.');
321 if (($params['minimum_fee'] > 0) && !$params['financial_type_id']) {
322 $errors['financial_type_id'] = ts('Please enter the financial Type.');
325 if (empty($params['duration_interval']) and $params['duration_unit'] != 'lifetime') {
326 $errors['duration_interval'] = ts('Please enter a duration interval.');
329 if (in_array(CRM_Utils_Array
::value('auto_renew', $params), [
333 if (($params['duration_interval'] > 1 && $params['duration_unit'] == 'year') ||
334 ($params['duration_interval'] > 12 && $params['duration_unit'] == 'month')
336 $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.');
340 if ($params['period_type'] == 'fixed' &&
341 $params['duration_unit'] == 'day'
343 $errors['period_type'] = ts('Period type should be Rolling when duration unit is Day');
346 if (($params['period_type'] == 'fixed') &&
347 ($params['duration_unit'] == 'year')
349 $periods = ['fixed_period_start_day', 'fixed_period_rollover_day'];
350 foreach ($periods as $period) {
351 $month = $params[$period]['M'];
352 $date = $params[$period]['d'];
353 if (!$month ||
!$date) {
355 case 'fixed_period_start_day':
356 $errors[$period] = ts('Please enter a valid fixed period start day');
359 case 'fixed_period_rollover_day':
360 $errors[$period] = ts('Please enter a valid fixed period rollover day');
367 if ($params['fixed_period_start_day'] && !empty($params['fixed_period_start_day'])) {
368 $params['fixed_period_start_day']['Y'] = date('Y');
369 if (!CRM_Utils_Rule
::qfDate($params['fixed_period_start_day'])) {
370 $errors['fixed_period_start_day'] = ts('Please enter valid Fixed Period Start Day');
374 if ($params['fixed_period_rollover_day'] && !empty($params['fixed_period_rollover_day'])) {
375 $params['fixed_period_rollover_day']['Y'] = date('Y');
376 if (!CRM_Utils_Rule
::qfDate($params['fixed_period_rollover_day'])) {
377 $errors['fixed_period_rollover_day'] = ts('Please enter valid Fixed Period Rollover Day');
381 return empty($errors) ?
TRUE : $errors;
385 * Process the form submission.
389 public function postProcess() {
390 if ($this->_action
& CRM_Core_Action
::DELETE
) {
392 CRM_Member_BAO_MembershipType
::del($this->_id
);
394 catch (CRM_Core_Exception
$e) {
395 CRM_Core_Error
::statusBounce($e->getMessage(), NULL, ts('Membership Type Not Deleted'));
397 CRM_Core_Session
::setStatus(ts('Selected membership type has been deleted.'), ts('Record Deleted'), 'success');
400 $params = $this->exportValues();
402 if ($params['minimum_fee']) {
403 $params['minimum_fee'] = CRM_Utils_Rule
::cleanMoney($params['minimum_fee']);
406 $hasRelTypeVal = FALSE;
407 if (!CRM_Utils_System
::isNull($params['relationship_type_id'])) {
408 // To insert relation ids and directions with value separator
409 $relTypeDirs = $params['relationship_type_id'];
410 $relIds = $relDirection = [];
411 foreach ($relTypeDirs as $key => $value) {
412 $relationId = explode('_', $value);
413 if (count($relationId) == 3 &&
414 is_numeric($relationId[0])
416 $relIds[] = $relationId[0];
417 $relDirection[] = $relationId[1] . '_' . $relationId[2];
420 if (!empty($relIds)) {
421 $hasRelTypeVal = TRUE;
422 $params['relationship_type_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $relIds);
423 $params['relationship_direction'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $relDirection);
426 if (!$hasRelTypeVal) {
427 $params['relationship_type_id'] = $params['relationship_direction'] = $params['max_related'] = 'null';
430 if ($params['duration_unit'] == 'lifetime' &&
431 empty($params['duration_interval'])
433 $params['duration_interval'] = 1;
436 $periods = ['fixed_period_start_day', 'fixed_period_rollover_day'];
437 foreach ($periods as $period) {
438 if (!empty($params[$period]['M']) && !empty($params[$period]['d'])) {
439 $mon = $params[$period]['M'];
440 $dat = $params[$period]['d'];
441 $mon = ($mon < 10) ?
'0' . $mon : $mon;
442 $dat = ($dat < 10) ?
'0' . $dat : $dat;
443 $params[$period] = $mon . $dat;
445 elseif ($period == 'fixed_period_rollover_day' && !empty($params['month_fixed_period_rollover_day'])) {
446 $params['fixed_period_rollover_day'] = $params['month_fixed_period_rollover_day']['d'];
447 unset($params['month_fixed_period_rollover_day']);
450 $params[$period] = 'null';
456 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
457 $this->_id
, 'weight', 'id'
460 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Member_DAO_MembershipType',
461 $oldWeight, $params['weight']
464 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
465 $params['id'] = $this->_id
;
468 $membershipTypeResult = civicrm_api3('MembershipType', 'create', $params);
469 $membershipTypeName = $membershipTypeResult['values'][$membershipTypeResult['id']]['name'];
471 CRM_Core_Session
::setStatus(ts("The membership type '%1' has been saved.",
472 [1 => $membershipTypeName]
473 ), ts('Saved'), 'success');
474 $session = CRM_Core_Session
::singleton();
475 $buttonName = $this->controller
->getButtonName();
476 if ($buttonName == $this->getButtonName('upload', 'new')) {
477 $session->replaceUserContext(
478 CRM_Utils_System
::url('civicrm/admin/member/membershipType/add', 'action=add&reset=1')
485 * @param int $previousID
486 * @param int $priceSetId
487 * @param int $membershipTypeId
490 public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
492 $editedFieldParams = [
493 'price_set_id ' => $priceSetId,
494 'name' => $previousID,
497 CRM_Price_BAO_PriceField
::retrieve($editedFieldParams, $editedResults);
498 if (!empty($editedResults)) {
499 $editedFieldParams = [
500 'price_field_id' => $editedResults['id'],
501 'membership_type_id' => $membershipTypeId,
504 CRM_Price_BAO_PriceFieldValue
::retrieve($editedFieldParams, $editedResults);
505 $optionsIds['option_id'][1] = $editedResults['id'] ??
NULL;