CRM/Contact/Form/Task/PickProfile.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 provides the functionality for batch profile update
  38  */
  39 class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task {
  40
  41   /**
  42    * The title of the group
  43    *
  44    * @var string
  45    */
  46   protected $_title;
  47
  48   /**
  49    * Maximum contacts that should be allowed to update
  50    *
  51    */
  52   protected $_maxContacts = 100;
  53
  54   /**
  55    * Maximum profile fields that will be displayed
  56    *
  57    */
  58   protected $_maxFields = 9;
  59
  60   /**
  61    * Variable to store redirect path
  62    *
  63    */
  64   protected $_userContext;
  65
  66   /**
  67    * Build all the data structures needed to build the form
  68    *
  69    * @return void
  70    */
  71   public function preProcess() {
  72     /*
  73      * initialize the task and row fields
  74      */
  75     parent::preProcess();
  76
  77     $session = CRM_Core_Session::singleton();
  78     $this->_userContext = $session->readUserContext();
  79
  80     $validate = FALSE;
  81     //validations
  82     if (count($this->_contactIds) > $this->_maxContacts) {
  83       CRM_Core_Session::setStatus(ts("The maximum number of contacts you can select for Batch Update is %1. You have selected %2. Please select fewer contacts from your search results and try again.", array(1 => $this->_maxContacts, 2 => count($this->_contactIds))), ts('Maximum Exceeded'), 'error');
  84       $validate = TRUE;
  85     }
  86
  87     if (CRM_Contact_BAO_Contact_Utils::checkContactType($this->_contactIds)) {
  88       CRM_Core_Session::setStatus(ts("Batch update requires that all selected contacts be the same basic type (e.g. all Individuals OR all Organizations...). Please modify your selection and try again."), ts('Contact Type Mismatch'), 'error');
  89       $validate = TRUE;
  90     }
  91
  92     // than redirect
  93     if ($validate) {
  94       CRM_Utils_System::redirect($this->_userContext);
  95     }
  96   }
  97
  98   /**
  99    * Build the form object
 100    *
 101    *
 102    * @return void
 103    */
 104   public function buildQuickForm() {
 105     CRM_Utils_System::setTitle(ts('Batch Profile Update for Contact'));
 106
 107     foreach ($this->_contactIds as $id) {
 108       $this->_contactTypes = CRM_Contact_BAO_Contact::getContactTypes($id);
 109     }
 110
 111     //add Contact type profiles
 112     $this->_contactTypes[] = 'Contact';
 113
 114     $profiles = CRM_Core_BAO_UFGroup::getProfiles($this->_contactTypes);
 115
 116     if (empty($profiles)) {
 117       $types = implode(' ' . ts('or') . ' ', $this->_contactTypes);
 118       CRM_Core_Session::setStatus(ts("The contact type selected for Batch Update does not have a corresponding profile. Please set up a profile for %1s and try again.", array(1 => $types)), ts('No Profile Available'), 'error');
 119       CRM_Utils_System::redirect($this->_userContext);
 120     }
 121     $ufGroupElement = $this->add('select', 'uf_group_id', ts('Select Profile'), array('' => ts('- select profile -')) + $profiles, TRUE, array('class' => 'crm-select2 huge'));
 122
 123     $this->addDefaultButtons(ts('Continue >>'));
 124   }
 125
 126   /**
 127    * Add local and global form rules
 128    *
 129    *
 130    * @return void
 131    */
 132   public function addRules() {
 133     $this->addFormRule(array('CRM_Contact_Form_Task_PickProfile', 'formRule'));
 134   }
 135
 136   /**
 137    * Global validation rules for the form
 138    *
 139    * @param array $fields posted values of the form
 140    *
 141    * @return array list of errors to be posted back to the form
 142    * @static
 143    */
 144   public static function formRule($fields) {
 145     if (CRM_Core_BAO_UFField::checkProfileType($fields['uf_group_id'])) {
 146       $errorMsg['uf_group_id'] = "You cannot select mix profile for batch update.";
 147     }
 148
 149     if (!empty($errorMsg)) {
 150       return $errorMsg;
 151     }
 152
 153     return TRUE;
 154   }
 155
 156   /**
 157    * Process the form after the input has been submitted and validated
 158    *
 159    *
 160    * @return void
 161    */
 162   public function postProcess() {
 163     $params = $this->exportValues();
 164
 165     $this->set('ufGroupId', $params['uf_group_id']);
 166
 167     // also reset the batch page so it gets new values from the db
 168     $this->controller->resetPage('Batch');
 169   }
 170 }
 171