CRM/Member/Form/MembershipBlock.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * form to process actions on Membership
  38  */
  39 class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPage {
  40
  41   /**
  42    * Store membership price set id
  43    */
  44   protected $_memPriceSetId = NULL;
  45
  46   /**
  47    * Set default values for the form. Note that in edit/view mode
  48    * the default values are retrieved from the database
  49    *
  50    *
  51    * @return void
  52    */
  53   public function setDefaultValues() {
  54     //parent::setDefaultValues();
  55     $defaults = array();
  56     if (isset($this->_id)) {
  57       $defaults = CRM_Member_BAO_Membership::getMembershipBlock($this->_id);
  58     }
  59     $defaults['member_is_active'] = $defaults['is_active'];
  60
  61     // Set Display Minimum Fee default to true if we are adding a new membership block
  62     if (!isset($defaults['id'])) {
  63       $defaults['display_min_fee'] = 1;
  64     }
  65     else {
  66       $this->assign('membershipBlockId', $defaults['id']);
  67     }
  68     if ($this->_id &&
  69       ($priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, 3, 1))
  70     ) {
  71       $defaults['member_price_set_id'] = $priceSetId;
  72       $this->_memPriceSetId = $priceSetId;
  73     }
  74     else {
  75       // for membership_types
  76       // if ( isset( $defaults['membership_types'] ) ) {
  77       $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, 3);
  78       $this->assign('isQuick', 1);
  79       $this->_memPriceSetId = $priceSetId;
  80       $pFIDs = array();
  81       if ($priceSetId) {
  82         CRM_Core_DAO::commonRetrieveAll('CRM_Price_DAO_PriceField', 'price_set_id', $priceSetId, $pFIDs, $return = array('html_type', 'name', 'label'));
  83         foreach ($pFIDs as $pid => $pValue) {
  84           if ($pValue['html_type'] == 'Radio' && $pValue['name'] == 'membership_amount') {
  85             $defaults['mem_price_field_id'] = $pValue['id'];
  86             $defaults['membership_type_label'] = $pValue['label'];
  87           }
  88         }
  89
  90         if (!empty($defaults['mem_price_field_id'])) {
  91           $options = array();
  92           $priceFieldOptions = CRM_Price_BAO_PriceFieldValue::getValues($defaults['mem_price_field_id'], $options, 'id', 1);
  93           foreach ($options as $k => $v) {
  94             $newMembershipType[$v['membership_type_id']] = 1;
  95             if (!empty($defaults['auto_renew'])) {
  96               $defaults["auto_renew_" . $v['membership_type_id']] = $defaults['auto_renew'][$v['membership_type_id']];
  97             }
  98           }
  99           $defaults['membership_type'] = $newMembershipType;
 100         }
 101       }
 102     }
 103
 104     return $defaults;
 105   }
 106
 107   /**
 108    * Build the form object
 109    *
 110    * @return void
 111    */
 112   public function buildQuickForm() {
 113     $membershipTypes = CRM_Member_BAO_MembershipType::getMembershipTypes();
 114
 115     if (!empty($membershipTypes)) {
 116       $this->addElement('checkbox', 'member_is_active', ts('Membership Section Enabled?'));
 117
 118       $this->addElement('text', 'new_title', ts('Title - New Membership'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipBlock', 'new_title'));
 119
 120       $this->addWysiwyg('new_text', ts('Introductory Message - New Memberships'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipBlock', 'new_text'));
 121
 122       $this->addElement('text', 'renewal_title', ts('Title - Renewals'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipBlock', 'renewal_title'));
 123
 124       $this->addWysiwyg('renewal_text', ts('Introductory Message - Renewals'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipBlock', 'renewal_text'));
 125
 126       $this->addElement('checkbox', 'is_required', ts('Require Membership Signup'));
 127       $this->addElement('checkbox', 'display_min_fee', ts('Display Membership Fee'));
 128       $this->addElement('checkbox', 'is_separate_payment', ts('Separate Membership Payment'));
 129       $this->addElement('text', 'membership_type_label', ts('Membership Types Label'), array('placeholder' => ts('Membership')));
 130
 131       $paymentProcessor = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 132       $paymentProcessorIds = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
 133         $this->_id, 'payment_processor'
 134       );
 135       $paymentProcessorId = explode(CRM_Core_DAO::VALUE_SEPARATOR, $paymentProcessorIds);
 136       $isRecur = TRUE;
 137       foreach ($paymentProcessorId as $dontCare => $id) {
 138         if (!array_key_exists($id, $paymentProcessor)) {
 139           $isRecur = FALSE;
 140           continue;
 141         }
 142       }
 143
 144       $membership = $membershipDefault = $params = array();
 145       foreach ($membershipTypes as $k => $v) {
 146         $membership[] = $this->createElement('advcheckbox', $k, NULL, $v);
 147         $membershipDefault[] = $this->createElement('radio', NULL, NULL, NULL, $k);
 148         $membershipRequired[$k] = NULL;
 149         if ($isRecur) {
 150           $autoRenew        = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $k, 'auto_renew');
 151           $membershipRequired[$k] = $autoRenew;
 152           $autoRenewOptions = array();
 153           if ($autoRenew) {
 154             $autoRenewOptions = array(ts('Not offered'), ts('Give option'), ts('Required'));
 155             $this->addElement('select', "auto_renew_$k", ts('Auto-renew'), $autoRenewOptions);
 156             //CRM-15573
 157             if ($autoRenew == 2) {
 158               $this->freeze("auto_renew_$k");
 159               $params['id'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipBlock', $this->_id, 'id', 'entity_id');
 160             }
 161             $this->_renewOption[$k] = $autoRenew;
 162           }
 163         }
 164       }
 165
 166       //CRM-15573
 167       if (!empty($params['id'])) {
 168         $params['membership_types'] = serialize($membershipRequired);
 169         CRM_Member_BAO_MembershipBlock::create($params);
 170       }
 171       $this->add('hidden', "mem_price_field_id", '', array('id' => "mem_price_field_id"));
 172       $this->assign('is_recur', $isRecur);
 173       if (isset($this->_renewOption)) {
 174         $this->assign('auto_renew', $this->_renewOption);
 175       }
 176       $this->addGroup($membership, 'membership_type', ts('Membership Types'));
 177       $this->addGroup($membershipDefault, 'membership_type_default', ts('Membership Types Default'))->setAttribute('allowClear', TRUE);
 178
 179       $this->addFormRule(array('CRM_Member_Form_MembershipBlock', 'formRule'), $this->_id);
 180     }
 181     $price = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviMember');
 182     if (CRM_Utils_System::isNull($price)) {
 183       $this->assign('price', FALSE);
 184     }
 185     else {
 186       $this->assign('price', TRUE);
 187     }
 188     $this->add('select', 'member_price_set_id', ts('Membership Price Set'), (array('' => ts('- none -')) + $price));
 189
 190     $session = CRM_Core_Session::singleton();
 191     $single = $session->get('singleForm');
 192     if ($single) {
 193       $this->addButtons(array(
 194           array(
 195             'type' => 'next',
 196             'name' => ts('Save'),
 197             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 198             'isDefault' => TRUE,
 199           ),
 200           array(
 201             'type' => 'cancel',
 202             'name' => ts('Cancel'),
 203           ),
 204         )
 205       );
 206     }
 207     else {
 208       parent::buildQuickForm();
 209     }
 210   }
 211
 212   /**
 213    * Validation
 214    *
 215    * @param array $params
 216    *   (ref.) an assoc array of name/value pairs.
 217    *
 218    * @param $files
 219    * @param int $contributionPageId
 220    *
 221    * @return mixed true or array of errors
 222    * @static
 223    */
 224   public static function formRule($params, $files, $contributionPageId = NULL) {
 225     $errors = array();
 226
 227     if (!empty($params['member_price_set_id'])) {
 228       //check if this price set has membership type both auto-renew and non-auto-renew memberships.
 229       $bothTypes = CRM_Price_BAO_PriceSet::checkMembershipPriceSet($params['member_price_set_id']);
 230
 231       //check for supporting payment processors
 232       //if both auto-renew and non-auto-renew memberships
 233       if ($bothTypes) {
 234         $paymentProcessorIds = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
 235             $contributionPageId, 'payment_processor'
 236             );
 237
 238         $paymentProcessorId = explode(CRM_Core_DAO::VALUE_SEPARATOR, $paymentProcessorIds);
 239
 240         if (!empty($paymentProcessorId)) {
 241           $paymentProcessorType = CRM_Core_PseudoConstant::paymentProcessorType(FALSE, NULL, 'name');
 242           foreach ($paymentProcessorId as $pid) {
 243             if ($pid) {
 244               $paymentProcessorTypeId = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessor',
 245                 $pid, 'payment_processor_type_id'
 246                 );
 247             }
 248             if (!($paymentProcessorTypeId == CRM_Utils_Array::key('PayPal', $paymentProcessorType) ||
 249               ($paymentProcessorTypeId == CRM_Utils_Array::key('AuthNet', $paymentProcessorType)))) {
 250               $errors['member_price_set_id'] = ts('The membership price set associated with this online contribution allows a user to select BOTH an auto-renew AND a non-auto-renew membership. This requires submitting multiple processor transactions, and is not supported for one or more of the payment processors enabled under the Amounts tab.');
 251             }
 252
 253           }
 254         }
 255       }
 256     }
 257     if (!empty($params['member_is_active'])) {
 258
 259       // don't allow price set w/ membership signup, CRM-5095
 260       if ($contributionPageId && ($setID = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $contributionPageId, NULL, 1))) {
 261
 262         $extends = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'extends');
 263         if ($extends != CRM_Core_Component::getComponentID('CiviMember')) {
 264           $errors['member_is_active'] = ts('You cannot enable both Membership Signup and a Contribution Price Set on the same online contribution page.');
 265           return $errors;
 266         }
 267       }
 268
 269       if ($contributionPageId && !empty($params['member_price_set_id']) &&
 270         CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $contributionPageId, 'amount_block_is_active')) {
 271         $errors['member_price_set_id'] = ts('You cannot use Membership Price Sets with the Contribution Amounts section. However, a membership price set may include additional fields for non-membership options that requires an additional fee (e.g. magazine subscription) or an additional voluntary contribution.');
 272       }
 273
 274       if (!empty($params['member_price_set_id'])) {
 275         return $errors;
 276       }
 277
 278       if (!isset($params['membership_type']) ||
 279         (!is_array($params['membership_type']))
 280       ) {
 281         $errors['membership_type'] = ts('Please select at least one Membership Type to include in the Membership section of this page.');
 282       }
 283       else {
 284         $membershipType = array_values($params['membership_type']);
 285         if (array_sum($membershipType) == 0) {
 286           $errors['membership_type'] = ts('Please select at least one Membership Type to include in the Membership section of this page.');
 287         }
 288         elseif (array_sum($membershipType) > CRM_Price_Form_Field::NUM_OPTION) {
 289           // for CRM-13079
 290           $errors['membership_type'] = ts('You cannot select more than %1 choices. For more complex functionality, please use a Price Set.', array(1 => CRM_Price_Form_Field::NUM_OPTION));
 291         }
 292       }
 293
 294       //for CRM-1302
 295       //if Membership status is not present, then display an error message
 296       $dao = new CRM_Member_BAO_MembershipStatus();
 297       if (!$dao->find()) {
 298         $errors['_qf_default'] = ts('Add status rules, before configuring membership');
 299       }
 300
 301       //give error if default is selected for an unchecked membership type
 302       if (!empty($params['membership_type_default']) && !$params['membership_type'][$params['membership_type_default']]) {
 303         $errors['membership_type_default'] = ts('Can\'t set default option for an unchecked membership type.');
 304       }
 305
 306       if ($contributionPageId) {
 307         $amountBlock = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $contributionPageId, 'amount_block_is_active');
 308
 309         if (!$amountBlock && !empty($params['is_separate_payment'])) {
 310           $errors['is_separate_payment'] = ts('Please enable the contribution amount section to use this option.');
 311         }
 312       }
 313
 314     }
 315
 316     return empty($errors) ? TRUE : $errors;
 317   }
 318
 319   /**
 320    * Process the form
 321    *
 322    * @return void
 323    */
 324   public function postProcess() {
 325     // get the submitted form values.
 326     $params = $this->controller->exportValues($this->_name);
 327     $deletePriceSet = 0;
 328     if ($params['membership_type']) {
 329       // we do this in case the user has hit the forward/back button
 330       $dao               = new CRM_Member_DAO_MembershipBlock();
 331       $dao->entity_table = 'civicrm_contribution_page';
 332       $dao->entity_id    = $this->_id;
 333       $dao->find(TRUE);
 334       $membershipID = $dao->id;
 335       if ($membershipID) {
 336         $params['id'] = $membershipID;
 337       }
 338
 339       $membershipTypes = array();
 340       if (is_array($params['membership_type'])) {
 341         foreach ($params['membership_type'] as $k => $v) {
 342           if ($v) {
 343             $membershipTypes[$k] = CRM_Utils_Array::value("auto_renew_$k", $params);
 344           }
 345         }
 346       }
 347
 348       // check for price set.
 349       $priceSetID = CRM_Utils_Array::value('member_price_set_id', $params);
 350       if (!empty($params['member_is_active']) && is_array($membershipTypes) && !$priceSetID) {
 351         $usedPriceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, 2);
 352         if (empty($params['mem_price_field_id']) && !$usedPriceSetId) {
 353           $pageTitle = strtolower(CRM_Utils_String::munge($this->_values['title'], '_', 245));
 354           $setParams['title'] = $this->_values['title'];
 355           if (!CRM_Core_DAO::getFieldValue('CRM_Price_BAO_PriceSet', $pageTitle, 'id', 'name')) {
 356             $setParams['name'] = $pageTitle;
 357           }
 358           elseif (!CRM_Core_DAO::getFieldValue('CRM_Price_BAO_PriceSet', $pageTitle . '_' . $this->_id, 'id', 'name')) {
 359             $setParams['name'] = $pageTitle . '_' . $this->_id;
 360           }
 361           else {
 362             $timeSec = explode(".", microtime(TRUE));
 363             $setParams['name'] = $pageTitle . '_' . date('is', $timeSec[0]) . $timeSec[1];
 364           }
 365           $setParams['is_quick_config'] = 1;
 366           $setParams['extends'] = CRM_Core_Component::getComponentID('CiviMember');
 367           $setParams['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $this->_values);
 368           $priceSet = CRM_Price_BAO_PriceSet::create($setParams);
 369           $priceSetID = $priceSet->id;
 370           $fieldParams['price_set_id'] = $priceSet->id;
 371         }
 372         elseif ($usedPriceSetId) {
 373           $setParams['extends'] = CRM_Core_Component::getComponentID('CiviMember');
 374           $setParams['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $this->_values);
 375           $setParams['id'] = $usedPriceSetId;
 376           $priceSet = CRM_Price_BAO_PriceSet::create($setParams);
 377           $priceSetID = $priceSet->id;
 378           $fieldParams['price_set_id'] = $priceSet->id;
 379         }
 380         else {
 381           $fieldParams['id'] = CRM_Utils_Array::value('mem_price_field_id', $params);
 382           $priceSetID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array::value('mem_price_field_id', $params), 'price_set_id');
 383         }
 384         $editedFieldParams = array(
 385           'price_set_id' => $priceSetID,
 386           'name' => 'membership_amount',
 387         );
 388         $editedResults = array();
 389         CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
 390         if (empty($editedResults['id'])) {
 391           $fieldParams['name'] = strtolower(CRM_Utils_String::munge('Membership Amount', '_', 245));
 392           if (empty($params['mem_price_field_id'])) {
 393             CRM_Utils_Weight::updateOtherWeights('CRM_Price_DAO_PriceField', 0, 1, array('price_set_id' => $priceSetID));
 394           }
 395           $fieldParams['weight'] = 1;
 396         }
 397         else {
 398           $fieldParams['id'] = CRM_Utils_Array::value('id', $editedResults);
 399         }
 400
 401         $fieldParams['label'] = !empty($params['membership_type_label']) ? $params['membership_type_label'] : ts('Membership');
 402         $fieldParams['is_active'] = 1;
 403         $fieldParams['html_type'] = 'Radio';
 404         $fieldParams['is_required'] = !empty($params['is_required']) ? 1 : 0;
 405         $fieldParams['is_display_amounts'] = !empty($params['display_min_fee']) ? 1 : 0;
 406         $rowCount = 1;
 407         $options = array();
 408         if (!empty($fieldParams['id'])) {
 409           CRM_Core_PseudoConstant::populate($options, 'CRM_Price_DAO_PriceFieldValue', TRUE, 'membership_type_id', NULL, " price_field_id = {$fieldParams['id']} ");
 410         }
 411
 412         foreach ($membershipTypes as $memType => $memAutoRenew) {
 413           if ($priceFieldID = CRM_Utils_Array::key($memType, $options)) {
 414             $fieldParams['option_id'][$rowCount] = $priceFieldID;
 415             unset($options[$priceFieldID]);
 416           }
 417           $membetype = CRM_Member_BAO_MembershipType::getMembershipTypeDetails($memType);
 418           $fieldParams['option_label'][$rowCount]       = CRM_Utils_Array::value('name', $membetype);
 419           $fieldParams['option_amount'][$rowCount]      = CRM_Utils_Array::value('minimum_fee', $membetype, 0);
 420           $fieldParams['option_weight'][$rowCount]      = CRM_Utils_Array::value('weight', $membetype);
 421           $fieldParams['option_description'][$rowCount] = CRM_Utils_Array::value('description', $membetype);
 422           $fieldParams['default_option']                = CRM_Utils_Array::value('membership_type_default', $params);
 423           $fieldParams['option_financial_type_id'][$rowCount] = CRM_Utils_Array::value('financial_type_id', $membetype);
 424
 425           $fieldParams['membership_type_id'][$rowCount] = $memType;
 426           // [$rowCount] = $membetype[''];
 427           $rowCount++;
 428         }
 429         foreach ($options as $priceFieldID => $memType) {
 430           CRM_Price_BAO_PriceFieldValue::setIsActive($priceFieldID, '0');
 431         }
 432         $priceField = CRM_Price_BAO_PriceField::create($fieldParams);
 433       }
 434       elseif (!$priceSetID) {
 435         $deletePriceSet = 1;
 436       }
 437
 438       $params['is_required'] = CRM_Utils_Array::value('is_required', $params, FALSE);
 439       $params['is_active'] = CRM_Utils_Array::value('member_is_active', $params, FALSE);
 440
 441       if ($priceSetID) {
 442         $params['membership_types'] = 'null';
 443         $params['membership_type_default'] = CRM_Utils_Array::value('membership_type_default', $params, 'null');
 444         $params['membership_types']        = serialize($membershipTypes);
 445         $params['display_min_fee']         = CRM_Utils_Array::value('display_min_fee', $params, FALSE);
 446         $params['is_separate_payment']     = CRM_Utils_Array::value('is_separate_payment', $params, FALSE);
 447       }
 448       $params['entity_table'] = 'civicrm_contribution_page';
 449       $params['entity_id'] = $this->_id;
 450
 451       $dao = new CRM_Member_DAO_MembershipBlock();
 452       $dao->copyValues($params);
 453       $dao->save();
 454
 455       if ($priceSetID && $params['is_active']) {
 456         CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $this->_id, $priceSetID);
 457       }
 458
 459       if ($deletePriceSet || !CRM_Utils_Array::value('member_is_active', $params, FALSE)) {
 460
 461         if ($this->_memPriceSetId) {
 462           $pFIDs = array();
 463           $conditionParams = array(
 464             'price_set_id' => $this->_memPriceSetId,
 465             'html_type' => 'radio',
 466             'name' => 'contribution_amount',
 467           );
 468
 469           CRM_Core_DAO::commonRetrieve('CRM_Price_DAO_PriceField', $conditionParams, $pFIDs);
 470           if (empty($pFIDs['id'])) {
 471             CRM_Price_BAO_PriceSet::removeFrom('civicrm_contribution_page', $this->_id);
 472             CRM_Price_BAO_PriceSet::setIsQuickConfig($this->_memPriceSetId, '0');
 473           }
 474           else {
 475
 476             CRM_Price_BAO_PriceField::setIsActive($params['mem_price_field_id'], '0');
 477           }
 478         }
 479       }
 480     }
 481     parent::endPostProcess();
 482   }
 483
 484   /**
 485    * Return a descriptive name for the page, used in wizard header
 486    *
 487    * @return string
 488    */
 489   public function getTitle() {
 490     return ts('Memberships');
 491   }
 492 }