CRM/Member/Form/MembershipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Membership Type
  38  *
  39  */
  40 class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig {
  41
  42   /**
  43    * Max number of contacts we will display for membership-organisation
  44    */
  45   const MAX_CONTACTS = 50;
  46
  47   public function preProcess() {
  48     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
  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);
  56
  57     $this->setPageTitle(ts('Membership Type'));
  58   }
  59
  60   /**
  61    * Set default values for the form. MobileProvider that in edit/view mode
  62    * the default values are retrieved from the database
  63    *
  64    *
  65    * @return void
  66    */
  67   public function setDefaultValues() {
  68     $defaults = parent::setDefaultValues();
  69
  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
  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])) {
  90         $date = $defaults[$per];
  91
  92         $defaults[$per] = array();
  93         if ($date > 31) {
  94           $date = ($date < 999) ? '0' . $date : $date;
  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   /**
 109    * Build the form object.
 110    *
 111    * @return void
 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
 134     $this->addSelect('duration_unit', array(), TRUE);
 135
 136     //period type
 137     $this->addSelect('period_type', array(), TRUE);
 138
 139     $this->add('text', 'duration_interval', ts('Duration Interval'),
 140       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'duration_interval')
 141     );
 142
 143     $props = array('api' => array('params' => array('contact_type' => 'Organization')));
 144     $this->addEntityRef('member_of_contact_id', ts('Membership Organization'), $props, TRUE);
 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
 152     $paymentProcessor = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 153     $isAuthorize = FALSE;
 154     $options = array();
 155     if (is_array($paymentProcessor) && !empty($paymentProcessor)) {
 156       $isAuthorize = TRUE;
 157       $options = CRM_Core_SelectValues::memberAutoRenew();
 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     );
 170     $this->add('select', 'financial_type_id', ts('Financial Type'),
 171       array('' => ts('- select -')) + CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action), TRUE, array('class' => 'crm-select2')
 172     );
 173
 174     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
 175     if (is_array($relTypeInd)) {
 176       asort($relTypeInd);
 177     }
 178     $memberRel = $this->add('select', 'relationship_type_id', ts('Relationship Type'),
 179       $relTypeInd, FALSE, array('class' => 'crm-select2 huge', 'multiple' => 1));
 180
 181     $this->addSelect('visibility', array('placeholder' => NULL, 'option_url' => NULL));
 182
 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) {
 190       $membershipType = new CRM_Member_BAO_Membership();
 191       $membershipType->membership_type_id = $this->_id;
 192       if ($membershipType->find(TRUE)) {
 193         $membershipRecords = TRUE;
 194         $memberRel->freeze();
 195       }
 196     }
 197
 198     $this->assign('membershipRecordsExists', $membershipRecords);
 199
 200     $this->add('text', 'max_related', ts('Max related'),
 201       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'max_related')
 202     );
 203
 204     $this->addFormRule(array('CRM_Member_Form_MembershipType', 'formRule'));
 205
 206     $this->assign('membershipTypeId', $this->_id);
 207   }
 208
 209   /**
 210    * Validation.
 211    *
 212    * @param array $params
 213    *   (ref.) an assoc array of name/value pairs.
 214    *
 215    * @return bool|array
 216    *   mixed true or array of errors
 217    */
 218   public static function formRule($params) {
 219     $errors = array();
 220
 221     if (!$params['name']) {
 222       $errors['name'] = ts('Please enter a membership type name.');
 223     }
 224
 225     if (($params['minimum_fee'] > 0) && !$params['financial_type_id']) {
 226       $errors['financial_type_id'] = ts('Please enter the financial Type.');
 227     }
 228
 229     if (empty($params['duration_interval']) and $params['duration_unit'] != 'lifetime') {
 230       $errors['duration_interval'] = ts('Please enter a duration interval.');
 231     }
 232
 233     if (in_array(CRM_Utils_Array::value('auto_renew', $params), array(
 234       1,
 235       2,
 236     ))) {
 237       if (($params['duration_interval'] > 1 && $params['duration_unit'] == 'year') ||
 238         ($params['duration_interval'] > 12 && $params['duration_unit'] == 'month')
 239       ) {
 240         $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.');
 241       }
 242     }
 243
 244     if ($params['period_type'] == 'fixed' &&
 245       $params['duration_unit'] == 'day'
 246     ) {
 247       $errors['period_type'] = ts('Period type should be Rolling when duration unit is Day');
 248     }
 249
 250     if (($params['period_type'] == 'fixed') &&
 251       ($params['duration_unit'] == 'year')
 252     ) {
 253       $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
 254       foreach ($periods as $period) {
 255         $month = $params[$period]['M'];
 256         $date = $params[$period]['d'];
 257         if (!$month || !$date) {
 258           switch ($period) {
 259             case 'fixed_period_start_day':
 260               $errors[$period] = ts('Please enter a valid fixed period start day');
 261               break;
 262
 263             case 'fixed_period_rollover_day':
 264               $errors[$period] = ts('Please enter a valid fixed period rollover day');
 265               break;
 266           }
 267         }
 268       }
 269     }
 270
 271     if ($params['fixed_period_start_day'] && !empty($params['fixed_period_start_day'])) {
 272       $params['fixed_period_start_day']['Y'] = date('Y');
 273       if (!CRM_Utils_Rule::qfDate($params['fixed_period_start_day'])) {
 274         $errors['fixed_period_start_day'] = ts('Please enter valid Fixed Period Start Day');
 275       }
 276     }
 277
 278     if ($params['fixed_period_rollover_day'] && !empty($params['fixed_period_rollover_day'])) {
 279       $params['fixed_period_rollover_day']['Y'] = date('Y');
 280       if (!CRM_Utils_Rule::qfDate($params['fixed_period_rollover_day'])) {
 281         $errors['fixed_period_rollover_day'] = ts('Please enter valid Fixed Period Rollover Day');
 282       }
 283     }
 284
 285     // CRM-16189
 286     $isError = CRM_Financial_BAO_FinancialAccount::validateFinancialType($params['financial_type_id']);
 287     if ($isError) {
 288       $errors['financial_type_id'] = ts('Deferred revenue account is not configured for selected financial type. Please have an administrator set up the deferred revenue account at Administer > CiviContribute > Financial Accounts, then configure it for financial types at Administer > CiviContribution > Financial Types, Accounts');
 289     }
 290
 291     return empty($errors) ? TRUE : $errors;
 292   }
 293
 294   /**
 295    * Process the form submission.
 296    *
 297    *
 298    * @return void
 299    */
 300   public function postProcess() {
 301     if ($this->_action & CRM_Core_Action::DELETE) {
 302       try {
 303         CRM_Member_BAO_MembershipType::del($this->_id);
 304       }
 305       catch (CRM_Core_Exception $e) {
 306         CRM_Core_Error::statusBounce($e->getMessage(), NULL, ts('Membership Type Not Deleted'));
 307       }
 308       CRM_Core_Session::setStatus(ts('Selected membership type has been deleted.'), ts('Record Deleted'), 'success');
 309     }
 310     else {
 311       $buttonName = $this->controller->getButtonName();
 312       $submitted = $this->controller->exportValues($this->_name);
 313
 314       $fields = array(
 315         'name',
 316         'weight',
 317         'is_active',
 318         'member_of_contact_id',
 319         'visibility',
 320         'period_type',
 321         'minimum_fee',
 322         'description',
 323         'auto_renew',
 324         'duration_unit',
 325         'duration_interval',
 326         'financial_type_id',
 327         'fixed_period_start_day',
 328         'fixed_period_rollover_day',
 329         'month_fixed_period_rollover_day',
 330         'max_related',
 331       );
 332
 333       $params = $ids = array();
 334       foreach ($fields as $fld) {
 335         $params[$fld] = CRM_Utils_Array::value($fld, $submitted, 'NULL');
 336       }
 337
 338       //clean money.
 339       if ($params['minimum_fee']) {
 340         $params['minimum_fee'] = CRM_Utils_Rule::cleanMoney($params['minimum_fee']);
 341       }
 342
 343       $hasRelTypeVal = FALSE;
 344       if (!CRM_Utils_System::isNull($submitted['relationship_type_id'])) {
 345         // To insert relation ids and directions with value separator
 346         $relTypeDirs = $submitted['relationship_type_id'];
 347         $relIds = $relDirection = array();
 348         foreach ($relTypeDirs as $key => $value) {
 349           $relationId = explode('_', $value);
 350           if (count($relationId) == 3 &&
 351             is_numeric($relationId[0])
 352           ) {
 353             $relIds[] = $relationId[0];
 354             $relDirection[] = $relationId[1] . '_' . $relationId[2];
 355           }
 356         }
 357         if (!empty($relIds)) {
 358           $hasRelTypeVal = TRUE;
 359           $params['relationship_type_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relIds);
 360           $params['relationship_direction'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relDirection);
 361         }
 362       }
 363       if (!$hasRelTypeVal) {
 364         $params['relationship_type_id'] = $params['relationship_direction'] = $params['max_related'] = 'NULL';
 365       }
 366
 367       if ($params['duration_unit'] == 'lifetime' &&
 368         empty($params['duration_interval'])
 369       ) {
 370         $params['duration_interval'] = 1;
 371       }
 372
 373       $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
 374       foreach ($periods as $per) {
 375         if (!empty($params[$per]['M']) && !empty($params[$per]['d'])) {
 376           $mon = $params[$per]['M'];
 377           $dat = $params[$per]['d'];
 378           $mon = ($mon < 10) ? '0' . $mon : $mon;
 379           $dat = ($dat < 10) ? '0' . $dat : $dat;
 380           $params[$per] = $mon . $dat;
 381         }
 382         elseif ($per == 'fixed_period_rollover_day' && !empty($params['month_fixed_period_rollover_day'])) {
 383           $params['fixed_period_rollover_day'] = $params['month_fixed_period_rollover_day']['d'];
 384           unset($params['month_fixed_period_rollover_day']);
 385         }
 386         else {
 387           $params[$per] = 'NULL';
 388         }
 389       }
 390       $oldWeight = NULL;
 391
 392       if ($this->_id) {
 393         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 394           $this->_id, 'weight', 'id'
 395         );
 396       }
 397       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Member_DAO_MembershipType',
 398         $oldWeight, $params['weight']
 399       );
 400
 401       if ($this->_action & CRM_Core_Action::UPDATE) {
 402         $ids['membershipType'] = $this->_id;
 403       }
 404
 405       $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
 406
 407       CRM_Core_Session::setStatus(ts('The membership type \'%1\' has been saved.',
 408         array(1 => $membershipType->name)
 409       ), ts('Saved'), 'success');
 410       $session = CRM_Core_Session::singleton();
 411       if ($buttonName == $this->getButtonName('upload', 'new')) {
 412         $session->replaceUserContext(
 413           CRM_Utils_System::url('civicrm/admin/member/membershipType/add', 'action=add&reset=1')
 414         );
 415       }
 416     }
 417   }
 418
 419   /**
 420    * @param int $previousID
 421    * @param int $priceSetId
 422    * @param int $membershipTypeId
 423    * @param $optionsIds
 424    */
 425   public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
 426     if ($previousID) {
 427       $editedFieldParams = array(
 428         'price_set_id ' => $priceSetId,
 429         'name' => $previousID,
 430       );
 431       $editedResults = array();
 432       CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
 433       if (!empty($editedResults)) {
 434         $editedFieldParams = array(
 435           'price_field_id' => $editedResults['id'],
 436           'membership_type_id' => $membershipTypeId,
 437         );
 438         $editedResults = array();
 439         CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
 440         $optionsIds['option_id'][1] = CRM_Utils_Array::value('id', $editedResults);
 441       }
 442     }
 443   }
 444
 445 }