CRM/Member/Form/Task/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality for batch profile update for members
  38  */
  39 class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task {
  40
  41   /**
  42    * The title of the group.
  43    *
  44    * @var string
  45    */
  46   protected $_title;
  47
  48   /**
  49    * Maximum profile fields that will be displayed.
  50    */
  51   protected $_maxFields = 9;
  52
  53   /**
  54    * Variable to store redirect path.
  55    */
  56   protected $_userContext;
  57
  58   /**
  59    * Build all the data structures needed to build the form.
  60    *
  61    * @return void
  62    */
  63   public function preProcess() {
  64     // initialize the task and row fields
  65     parent::preProcess();
  66
  67     //get the contact read only fields to display.
  68     $readOnlyFields = array_merge(array('sort_name' => ts('Name')),
  69       CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  70         'contact_autocomplete_options',
  71         TRUE, NULL, FALSE, 'name', TRUE
  72       )
  73     );
  74     //get the read only field data.
  75     $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
  76     $contactDetails = CRM_Contact_BAO_Contact_Utils::contactDetails($this->_memberIds,
  77       'CiviMember', $returnProperties
  78     );
  79     $this->assign('contactDetails', $contactDetails);
  80     $this->assign('readOnlyFields', $readOnlyFields);
  81   }
  82
  83   /**
  84    * Build the form object.
  85    *
  86    *
  87    * @return void
  88    */
  89   public function buildQuickForm() {
  90     $ufGroupId = $this->get('ufGroupId');
  91
  92     if (!$ufGroupId) {
  93       CRM_Core_Error::fatal('ufGroupId is missing');
  94     }
  95     $this->_title = ts('Update multiple memberships') . ' - ' . CRM_Core_BAO_UFGroup::getTitle($ufGroupId);
  96     CRM_Utils_System::setTitle($this->_title);
  97
  98     $this->addDefaultButtons(ts('Save'));
  99     $this->_fields = array();
 100     $this->_fields = CRM_Core_BAO_UFGroup::getFields($ufGroupId, FALSE, CRM_Core_Action::VIEW);
 101
 102     // remove file type field and then limit fields
 103     $suppressFields = FALSE;
 104     $removehtmlTypes = array('File');
 105     foreach ($this->_fields as $name => $field) {
 106       if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name) &&
 107         in_array($this->_fields[$name]['html_type'], $removehtmlTypes)
 108       ) {
 109         $suppressFields = TRUE;
 110         unset($this->_fields[$name]);
 111       }
 112
 113       //fix to reduce size as we are using this field in grid
 114       if (is_array($field['attributes']) && !empty($this->_fields[$name]['attributes']['size']) && $this->_fields[$name]['attributes']['size'] > 19) {
 115         //shrink class to "form-text-medium"
 116         $this->_fields[$name]['attributes']['size'] = 19;
 117       }
 118     }
 119
 120     $this->_fields = array_slice($this->_fields, 0, $this->_maxFields);
 121
 122     $this->addButtons(array(
 123       array(
 124         'type' => 'submit',
 125         'name' => ts('Update Members(s)'),
 126         'isDefault' => TRUE,
 127       ),
 128       array(
 129         'type' => 'cancel',
 130         'name' => ts('Cancel'),
 131       ),
 132     ));
 133
 134     $this->assign('profileTitle', $this->_title);
 135     $this->assign('componentIds', $this->_memberIds);
 136
 137     //load all campaigns.
 138     if (array_key_exists('member_campaign_id', $this->_fields)) {
 139       $this->_componentCampaigns = array();
 140       CRM_Core_PseudoConstant::populate($this->_componentCampaigns,
 141         'CRM_Member_DAO_Membership',
 142         TRUE, 'campaign_id', 'id',
 143         ' id IN (' . implode(' , ', array_values($this->_memberIds)) . ' ) '
 144       );
 145     }
 146
 147     $customFields = CRM_Core_BAO_CustomField::getFields('Membership');
 148     foreach ($this->_memberIds as $memberId) {
 149       $typeId = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $memberId, 'membership_type_id');
 150       foreach ($this->_fields as $name => $field) {
 151         if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 152           $customValue = CRM_Utils_Array::value($customFieldID, $customFields);
 153           $entityColumnValue = array();
 154           if (!empty($customValue['extends_entity_column_value'])) {
 155             $entityColumnValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 156               $customValue['extends_entity_column_value']
 157             );
 158           }
 159           if ((CRM_Utils_Array::value($typeId, $entityColumnValue)) ||
 160             CRM_Utils_System::isNull($entityColumnValue[$typeId])
 161           ) {
 162             CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $memberId);
 163           }
 164         }
 165         else {
 166           // handle non custom fields
 167           CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $memberId);
 168         }
 169       }
 170     }
 171
 172     $this->assign('fields', $this->_fields);
 173
 174     // don't set the status message when form is submitted.
 175     $buttonName = $this->controller->getButtonName('submit');
 176
 177     if ($suppressFields && $buttonName != '_qf_Batch_next') {
 178       CRM_Core_Session::setStatus(ts("File type field(s) in the selected profile are not supported for Update multiple memberships."), ts('Unsupported Field Type'), 'error');
 179     }
 180
 181     $this->addDefaultButtons(ts('Update Memberships'));
 182   }
 183
 184   /**
 185    * Set default values for the form.
 186    *
 187    *
 188    * @return void
 189    */
 190   public function setDefaultValues() {
 191     if (empty($this->_fields)) {
 192       return;
 193     }
 194
 195     $defaults = array();
 196     foreach ($this->_memberIds as $memberId) {
 197       CRM_Core_BAO_UFGroup::setProfileDefaults(NULL, $this->_fields, $defaults, FALSE, $memberId, 'Membership');
 198     }
 199
 200     return $defaults;
 201   }
 202
 203   /**
 204    * Process the form after the input has been submitted and validated.
 205    *
 206    *
 207    * @return void
 208    */
 209   public function postProcess() {
 210     $params = $this->exportValues();
 211     $dates = array(
 212       'join_date',
 213       'membership_start_date',
 214       'membership_end_date',
 215     );
 216     if (isset($params['field'])) {
 217       $customFields = array();
 218       foreach ($params['field'] as $key => $value) {
 219         $ids['membership'] = $key;
 220         if (!empty($value['membership_source'])) {
 221           $value['source'] = $value['membership_source'];
 222         }
 223
 224         if (!empty($value['membership_type'])) {
 225           $membershipTypeId = $value['membership_type_id'] = $value['membership_type'][1];
 226         }
 227
 228         unset($value['membership_source']);
 229         unset($value['membership_type']);
 230
 231         //Get the membership status
 232         $value['status_id'] = (CRM_Utils_Array::value('membership_status', $value)) ? $value['membership_status'] : CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $key, 'status_id');
 233         unset($value['membership_status']);
 234         foreach ($dates as $val) {
 235           if (isset($value[$val])) {
 236             $value[$val] = CRM_Utils_Date::processDate($value[$val]);
 237           }
 238         }
 239         if (empty($customFields)) {
 240           if (empty($value['membership_type_id'])) {
 241             $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $key, 'membership_type_id');
 242           }
 243
 244           // membership type custom data
 245           $customFields = CRM_Core_BAO_CustomField::getFields('Membership', FALSE, FALSE, $membershipTypeId);
 246
 247           $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
 248             CRM_Core_BAO_CustomField::getFields('Membership',
 249               FALSE, FALSE, NULL, NULL, TRUE
 250             )
 251           );
 252         }
 253         //check for custom data
 254         $value['custom'] = CRM_Core_BAO_CustomField::postProcess($params['field'][$key],
 255           $key,
 256           'Membership',
 257           $membershipTypeId
 258         );
 259
 260         $membership = CRM_Member_BAO_Membership::add($value, $ids);
 261
 262         // add custom field values
 263         if (!empty($value['custom']) &&
 264           is_array($value['custom'])
 265         ) {
 266           CRM_Core_BAO_CustomValueTable::store($value['custom'], 'civicrm_membership', $membership->id);
 267         }
 268       }
 269
 270       CRM_Core_Session::setStatus(ts("Your updates have been saved."), ts('Saved'), 'success');
 271     }
 272     else {
 273       CRM_Core_Session::setStatus(ts("No updates have been saved."), ts('Not Saved'), 'alert');
 274     }
 275   }
 276
 277 }