crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Member/Form/MembershipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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
 171     $this->add('select', 'financial_type_id', ts('Financial Type'),
 172       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(), TRUE, array('class' => 'crm-select2')
 173     );
 174
 175     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
 176     if (is_array($relTypeInd)) {
 177       asort($relTypeInd);
 178     }
 179     $memberRel = $this->add('select', 'relationship_type_id', ts('Relationship Type'),
 180       $relTypeInd, FALSE, array('class' => 'crm-select2 huge', 'multiple' => 1));
 181
 182     $this->addSelect('visibility', array('placeholder' => NULL, 'option_url' => NULL));
 183
 184     $this->add('text', 'weight', ts('Order'),
 185       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'weight')
 186     );
 187     $this->add('checkbox', 'is_active', ts('Enabled?'));
 188
 189     $membershipRecords = FALSE;
 190     if ($this->_action & CRM_Core_Action::UPDATE) {
 191       $membershipType = new CRM_Member_BAO_Membership();
 192       $membershipType->membership_type_id = $this->_id;
 193       if ($membershipType->find(TRUE)) {
 194         $membershipRecords = TRUE;
 195         $memberRel->freeze();
 196       }
 197     }
 198
 199     $this->assign('membershipRecordsExists', $membershipRecords);
 200
 201     $this->add('text', 'max_related', ts('Max related'),
 202       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'max_related')
 203     );
 204
 205     $this->addFormRule(array('CRM_Member_Form_MembershipType', 'formRule'));
 206
 207     $this->assign('membershipTypeId', $this->_id);
 208   }
 209
 210   /**
 211    * Validation.
 212    *
 213    * @param array $params
 214    *   (ref.) an assoc array of name/value pairs.
 215    *
 216    * @return bool|array
 217    *   mixed true or array of errors
 218    */
 219   public static function formRule($params) {
 220     $errors = array();
 221
 222     if (!$params['name']) {
 223       $errors['name'] = ts('Please enter a membership type name.');
 224     }
 225
 226     if (($params['minimum_fee'] > 0) && !$params['financial_type_id']) {
 227       $errors['financial_type_id'] = ts('Please enter the financial Type.');
 228     }
 229
 230     if (empty($params['duration_interval']) and $params['duration_unit'] != 'lifetime') {
 231       $errors['duration_interval'] = ts('Please enter a duration interval.');
 232     }
 233
 234     if (in_array(CRM_Utils_Array::value('auto_renew', $params), array(
 235       1,
 236       2,
 237     ))) {
 238       if (($params['duration_interval'] > 1 && $params['duration_unit'] == 'year') ||
 239         ($params['duration_interval'] > 12 && $params['duration_unit'] == 'month')
 240       ) {
 241         $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.');
 242       }
 243     }
 244
 245     if ($params['period_type'] == 'fixed' &&
 246       $params['duration_unit'] == 'day'
 247     ) {
 248       $errors['period_type'] = ts('Period type should be Rolling when duration unit is Day');
 249     }
 250
 251     if (($params['period_type'] == 'fixed') &&
 252       ($params['duration_unit'] == 'year')
 253     ) {
 254       $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
 255       foreach ($periods as $period) {
 256         $month = $params[$period]['M'];
 257         $date = $params[$period]['d'];
 258         if (!$month || !$date) {
 259           switch ($period) {
 260             case 'fixed_period_start_day':
 261               $errors[$period] = ts('Please enter a valid fixed period start day');
 262               break;
 263
 264             case 'fixed_period_rollover_day':
 265               $errors[$period] = ts('Please enter a valid fixed period rollover day');
 266               break;
 267           }
 268         }
 269       }
 270     }
 271
 272     if ($params['fixed_period_start_day'] && !empty($params['fixed_period_start_day'])) {
 273       $params['fixed_period_start_day']['Y'] = date('Y');
 274       if (!CRM_Utils_Rule::qfDate($params['fixed_period_start_day'])) {
 275         $errors['fixed_period_start_day'] = ts('Please enter valid Fixed Period Start Day');
 276       }
 277     }
 278
 279     if ($params['fixed_period_rollover_day'] && !empty($params['fixed_period_rollover_day'])) {
 280       $params['fixed_period_rollover_day']['Y'] = date('Y');
 281       if (!CRM_Utils_Rule::qfDate($params['fixed_period_rollover_day'])) {
 282         $errors['fixed_period_rollover_day'] = ts('Please enter valid Fixed Period Rollover Day');
 283       }
 284     }
 285
 286     return empty($errors) ? TRUE : $errors;
 287   }
 288
 289   /**
 290    * Process the form submission.
 291    *
 292    *
 293    * @return void
 294    */
 295   public function postProcess() {
 296     if ($this->_action & CRM_Core_Action::DELETE) {
 297       try {
 298         CRM_Member_BAO_MembershipType::del($this->_id);
 299       }
 300       catch (CRM_Core_Exception $e) {
 301         CRM_Core_Error::statusBounce($e->getMessage(), NULL, ts('Membership Type Not Deleted'));
 302       }
 303       CRM_Core_Session::setStatus(ts('Selected membership type has been deleted.'), ts('Record Deleted'), 'success');
 304     }
 305     else {
 306       $buttonName = $this->controller->getButtonName();
 307       $submitted = $this->controller->exportValues($this->_name);
 308
 309       $fields = array(
 310         'name',
 311         'weight',
 312         'is_active',
 313         'member_of_contact_id',
 314         'visibility',
 315         'period_type',
 316         'minimum_fee',
 317         'description',
 318         'auto_renew',
 319         'duration_unit',
 320         'duration_interval',
 321         'financial_type_id',
 322         'fixed_period_start_day',
 323         'fixed_period_rollover_day',
 324         'month_fixed_period_rollover_day',
 325         'max_related',
 326       );
 327
 328       $params = $ids = array();
 329       foreach ($fields as $fld) {
 330         $params[$fld] = CRM_Utils_Array::value($fld, $submitted, 'NULL');
 331       }
 332
 333       //clean money.
 334       if ($params['minimum_fee']) {
 335         $params['minimum_fee'] = CRM_Utils_Rule::cleanMoney($params['minimum_fee']);
 336       }
 337
 338       $hasRelTypeVal = FALSE;
 339       if (!CRM_Utils_System::isNull($submitted['relationship_type_id'])) {
 340         // To insert relation ids and directions with value separator
 341         $relTypeDirs = $submitted['relationship_type_id'];
 342         $relIds = $relDirection = array();
 343         foreach ($relTypeDirs as $key => $value) {
 344           $relationId = explode('_', $value);
 345           if (count($relationId) == 3 &&
 346             is_numeric($relationId[0])
 347           ) {
 348             $relIds[] = $relationId[0];
 349             $relDirection[] = $relationId[1] . '_' . $relationId[2];
 350           }
 351         }
 352         if (!empty($relIds)) {
 353           $hasRelTypeVal = TRUE;
 354           $params['relationship_type_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relIds);
 355           $params['relationship_direction'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relDirection);
 356         }
 357       }
 358       if (!$hasRelTypeVal) {
 359         $params['relationship_type_id'] = $params['relationship_direction'] = $params['max_related'] = 'NULL';
 360       }
 361
 362       if ($params['duration_unit'] == 'lifetime' &&
 363         empty($params['duration_interval'])
 364       ) {
 365         $params['duration_interval'] = 1;
 366       }
 367
 368       $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
 369       foreach ($periods as $per) {
 370         if (!empty($params[$per]['M']) && !empty($params[$per]['d'])) {
 371           $mon = $params[$per]['M'];
 372           $dat = $params[$per]['d'];
 373           $mon = ($mon < 10) ? '0' . $mon : $mon;
 374           $dat = ($dat < 10) ? '0' . $dat : $dat;
 375           $params[$per] = $mon . $dat;
 376         }
 377         elseif ($per == 'fixed_period_rollover_day' && !empty($params['month_fixed_period_rollover_day'])) {
 378           $params['fixed_period_rollover_day'] = $params['month_fixed_period_rollover_day']['d'];
 379           unset($params['month_fixed_period_rollover_day']);
 380         }
 381         else {
 382           $params[$per] = 'NULL';
 383         }
 384       }
 385       $oldWeight = NULL;
 386
 387       if ($this->_id) {
 388         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 389           $this->_id, 'weight', 'id'
 390         );
 391       }
 392       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Member_DAO_MembershipType',
 393         $oldWeight, $params['weight']
 394       );
 395
 396       if ($this->_action & CRM_Core_Action::UPDATE) {
 397         $ids['membershipType'] = $this->_id;
 398       }
 399
 400       $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
 401
 402       CRM_Core_Session::setStatus(ts('The membership type \'%1\' has been saved.',
 403         array(1 => $membershipType->name)
 404       ), ts('Saved'), 'success');
 405       $session = CRM_Core_Session::singleton();
 406       if ($buttonName == $this->getButtonName('upload', 'new')) {
 407         $session->replaceUserContext(
 408           CRM_Utils_System::url('civicrm/admin/member/membershipType/add', 'action=add&reset=1')
 409         );
 410       }
 411     }
 412   }
 413
 414   /**
 415    * @param int $previousID
 416    * @param int $priceSetId
 417    * @param int $membershipTypeId
 418    * @param $optionsIds
 419    */
 420   public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
 421     if ($previousID) {
 422       $editedFieldParams = array(
 423         'price_set_id ' => $priceSetId,
 424         'name' => $previousID,
 425       );
 426       $editedResults = array();
 427       CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
 428       if (!empty($editedResults)) {
 429         $editedFieldParams = array(
 430           'price_field_id' => $editedResults['id'],
 431           'membership_type_id' => $membershipTypeId,
 432         );
 433         $editedResults = array();
 434         CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
 435         $optionsIds['option_id'][1] = CRM_Utils_Array::value('id', $editedResults);
 436       }
 437     }
 438   }
 439
 440 }