CRM/Member/Form/MembershipType.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  * 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
  87     //setting default fixed_period_start_day & fixed_period_rollover_day
  88     $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
  89     foreach ($periods as $per) {
  90       if (isset($defaults[$per])) {
  91         $date            = $defaults[$per];
  92
  93         $defaults[$per] = array();
  94         if ($date > 31) {
  95           $date                = ($date < 999) ? '0' . $date : $date;
  96           $defaults[$per]['M'] = substr($date, 0, 2);
  97           $defaults[$per]['d'] = substr($date, 2, 3);
  98         }
  99         else {
 100           //special case when only day is rollover and duration is month
 101           $defaults['month_fixed_period_rollover_day']['d'] = $date;
 102         }
 103       }
 104     }
 105
 106     return $defaults;
 107   }
 108
 109   /**
 110    * Build the form object
 111    *
 112    * @return void
 113    */
 114   public function buildQuickForm() {
 115     parent::buildQuickForm();
 116
 117     if ($this->_action & CRM_Core_Action::DELETE) {
 118       return;
 119     }
 120
 121     $this->applyFilter('__ALL__', 'trim');
 122     $this->add('text', 'name', ts('Name'), CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'name'), TRUE);
 123
 124     $this->addRule('name', ts('A membership type with this name already exists. Please select another name.'),
 125       'objectExists', array('CRM_Member_DAO_MembershipType', $this->_id)
 126     );
 127     $this->add('text', 'description', ts('Description'),
 128       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'description')
 129     );
 130     $this->add('text', 'minimum_fee', ts('Minimum Fee'),
 131       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'minimum_fee')
 132     );
 133     $this->addRule('minimum_fee', ts('Please enter a monetary value for the Minimum Fee.'), 'money');
 134
 135     $this->addSelect('duration_unit', array(), TRUE);
 136
 137     //period type
 138     $this->addSelect('period_type', array(), TRUE);
 139
 140     $this->add('text', 'duration_interval', ts('Duration Interval'),
 141       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'duration_interval')
 142     );
 143
 144     $props = array('api' => array('params' => array('contact_type' => 'Organization')));
 145     $this->addEntityRef('member_of_contact_id', ts('Membership Organization'), $props, TRUE);
 146
 147     //start day
 148     $this->add('date', 'fixed_period_start_day', ts('Fixed Period Start Day'),
 149       CRM_Core_SelectValues::date(NULL, 'M d'), FALSE
 150     );
 151
 152     //Auto-renew Option
 153     $paymentProcessor  = CRM_Core_PseudoConstant::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
 154     $isAuthorize       = FALSE;
 155     $options           = array();
 156     if (is_array($paymentProcessor) && !empty($paymentProcessor)) {
 157       $isAuthorize = TRUE;
 158       $options = array(ts('No auto-renew option'), ts('Give option, but not required'), ts('Auto-renew required '));
 159     }
 160
 161     $this->addRadio('auto_renew', ts('Auto-renew Option'), $options);
 162     $this->assign('authorize', $isAuthorize);
 163
 164     //rollover day
 165     $this->add('date', 'fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
 166       CRM_Core_SelectValues::date(NULL, 'M d'), FALSE
 167     );
 168     $this->add('date', 'month_fixed_period_rollover_day', ts('Fixed Period Rollover Day'),
 169       CRM_Core_SelectValues::date(NULL, 'd'), FALSE
 170     );
 171
 172     $this->add('select', 'financial_type_id', ts( 'Financial Type' ),
 173       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(), TRUE, array('class' => 'crm-select2')
 174     );
 175
 176     $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
 177     if (is_array($relTypeInd)) {
 178       asort($relTypeInd);
 179     }
 180     $memberRel = &$this->add('select', 'relationship_type_id', ts('Relationship Type'),
 181       array('' => ts('- select -')) + $relTypeInd);
 182     $memberRel->setMultiple(TRUE);
 183
 184     $this->addSelect('visibility', array('placeholder' => NULL, 'option_url' => NULL));
 185
 186     $this->add('text', 'weight', ts('Order'),
 187       CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'weight')
 188     );
 189     $this->add('checkbox', 'is_active', ts('Enabled?'));
 190
 191     $membershipRecords = FALSE;
 192     if ($this->_action & CRM_Core_Action::UPDATE) {
 193       $membershipType = new CRM_Member_BAO_Membership();
 194       $membershipType->membership_type_id = $this->_id;
 195       if ($membershipType->find(TRUE)) {
 196         $membershipRecords = TRUE;
 197         $memberRel->freeze();
 198       }
 199     }
 200
 201     $this->assign('membershipRecordsExists', $membershipRecords);
 202
 203     $this->add('text', 'max_related', ts('Max related'),
 204         CRM_Core_DAO::getAttribute('CRM_Member_DAO_MembershipType', 'max_related')
 205     );
 206
 207     $this->addFormRule(array('CRM_Member_Form_MembershipType', 'formRule'));
 208
 209     $this->assign('membershipTypeId', $this->_id);
 210   }
 211
 212   /**
 213    * Validation
 214    *
 215    * @param array $params (ref.) an assoc array of name/value pairs
 216    *
 217    * @return mixed true or array of errors
 218    * @static
 219    */
 220   public static function formRule($params) {
 221     $errors = array();
 222
 223     if (!$params['name']) {
 224       $errors['name'] = ts('Please enter a membership type name.');
 225     }
 226
 227     if (($params['minimum_fee'] > 0 ) && !$params['financial_type_id'] ) {
 228       $errors['financial_type_id'] = ts('Please enter the financial Type.');
 229     }
 230
 231     if (empty($params['duration_interval']) and $params['duration_unit'] != 'lifetime') {
 232       $errors['duration_interval'] = ts('Please enter a duration interval.');
 233     }
 234
 235     if (in_array(CRM_Utils_Array::value('auto_renew', $params), array(
 236       1, 2))) {
 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     return empty($errors) ? TRUE : $errors;
 286   }
 287
 288   /**
 289    * Process the form submission
 290    *
 291    *
 292    * @return void
 293    */
 294   public function postProcess() {
 295     if ($this->_action & CRM_Core_Action::DELETE) {
 296       try{
 297       CRM_Member_BAO_MembershipType::del($this->_id);
 298       }
 299       catch(CRM_Core_Exception $e) {
 300         CRM_Core_Error::statusBounce($e->getMessage(), NULL, ts('Membership Type Not Deleted'));
 301       }
 302       CRM_Core_Session::setStatus(ts('Selected membership type has been deleted.'), ts('Record Deleted'), 'success');
 303     }
 304     else {
 305       $buttonName = $this->controller->getButtonName();
 306       $submitted = $this->controller->exportValues($this->_name);
 307
 308       $fields = array(
 309         'name',
 310         'weight',
 311         'is_active',
 312         'member_of_contact_id',
 313         'visibility',
 314         'period_type',
 315         'minimum_fee',
 316         'description',
 317         'auto_renew',
 318         'duration_unit',
 319         'duration_interval',
 320         'financial_type_id',
 321         'fixed_period_start_day',
 322         'fixed_period_rollover_day',
 323         'month_fixed_period_rollover_day',
 324         'max_related'
 325       );
 326
 327       $params = $ids = array();
 328       foreach ($fields as $fld) {
 329         $params[$fld] = CRM_Utils_Array::value($fld, $submitted, 'NULL');
 330       }
 331
 332       //clean money.
 333       if ($params['minimum_fee']) {
 334         $params['minimum_fee'] = CRM_Utils_Rule::cleanMoney($params['minimum_fee']);
 335       }
 336
 337       $hasRelTypeVal = FALSE;
 338       if (!CRM_Utils_System::isNull($submitted['relationship_type_id'])) {
 339         // To insert relation ids and directions with value separator
 340         $relTypeDirs = $submitted['relationship_type_id'];
 341         $relIds = $relDirection = array();
 342         foreach ($relTypeDirs as $key => $value) {
 343           $relationId = explode('_', $value);
 344           if (count($relationId) == 3 &&
 345             is_numeric($relationId[0])
 346           ) {
 347             $relIds[] = $relationId[0];
 348             $relDirection[] = $relationId[1] . '_' . $relationId[2];
 349           }
 350         }
 351         if (!empty($relIds)) {
 352           $hasRelTypeVal = TRUE;
 353           $params['relationship_type_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relIds);
 354           $params['relationship_direction'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $relDirection);
 355         }
 356       }
 357       if (!$hasRelTypeVal) {
 358         $params['relationship_type_id'] = $params['relationship_direction'] = $params['max_related'] = 'NULL';
 359       }
 360
 361       if ($params['duration_unit'] == 'lifetime' &&
 362         empty($params['duration_interval'])
 363       ) {
 364         $params['duration_interval'] = 1;
 365       }
 366
 367       $periods = array('fixed_period_start_day', 'fixed_period_rollover_day');
 368       foreach ($periods as $per) {
 369         if (!empty($params[$per]['M']) && !empty($params[$per]['d'])) {
 370           $mon          = $params[$per]['M'];
 371           $dat          = $params[$per]['d'];
 372           $mon          = ($mon < 10) ? '0' . $mon : $mon;
 373           $dat          = ($dat < 10) ? '0' . $dat : $dat;
 374           $params[$per] = $mon . $dat;
 375         }
 376         else if($per == 'fixed_period_rollover_day' && !empty($params['month_fixed_period_rollover_day'])){
 377           $params['fixed_period_rollover_day'] = $params['month_fixed_period_rollover_day']['d'];
 378           unset($params['month_fixed_period_rollover_day']);
 379         }
 380         else {
 381           $params[$per] = 'NULL';
 382         }
 383       }
 384       $oldWeight = NULL;
 385
 386       if ($this->_id) {
 387         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 388           $this->_id, 'weight', 'id'
 389         );
 390       }
 391       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Member_DAO_MembershipType',
 392         $oldWeight, $params['weight']
 393       );
 394
 395       if ($this->_action & CRM_Core_Action::UPDATE) {
 396         $ids['membershipType'] = $this->_id;
 397       }
 398
 399       $membershipType = CRM_Member_BAO_MembershipType::add($params, $ids);
 400
 401       CRM_Core_Session::setStatus(ts('The membership type \'%1\' has been saved.',
 402           array(1 => $membershipType->name)
 403         ), ts('Saved'), 'success');
 404       $session = CRM_Core_Session::singleton();
 405       if ($buttonName == $this->getButtonName('upload', 'new')) {
 406         $session->replaceUserContext(
 407           CRM_Utils_System::url('civicrm/admin/member/membershipType/add', 'action=add&reset=1')
 408         );
 409       }
 410     }
 411   }
 412
 413   /**
 414    * @param int $previousID
 415    * @param int $priceSetId
 416    * @param int $membershipTypeId
 417    * @param $optionsIds
 418    */
 419   public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
 420     if ($previousID) {
 421       $editedFieldParams = array(
 422         'price_set_id ' => $priceSetId,
 423         'name' => $previousID,
 424       );
 425       $editedResults = array();
 426       CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
 427       if (!empty($editedResults)) {
 428         $editedFieldParams = array(
 429           'price_field_id' => $editedResults['id'],
 430           'membership_type_id' => $membershipTypeId,
 431         );
 432         $editedResults = array();
 433         CRM_Price_BAO_PriceFieldValue::retrieve($editedFieldParams, $editedResults);
 434         $optionsIds['option_id'][1] = CRM_Utils_Array::value('id', $editedResults);
 435       }
 436     }
 437   }
 438 }