CRM/Contribute/Form/ContributionPage/Custom.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  */
  33
  34 /**
  35  * form to process actions on the group aspect of Custom Data
  36  */
  37 class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_ContributionPage {
  38
  39   /**
  40    * Build the form object.
  41    *
  42    * @return void
  43    */
  44   public function buildQuickForm() {
  45
  46     // Register 'contact_1' model
  47     $entities = array();
  48     $entities[] = array('entity_name' => 'contact_1', 'entity_type' => 'IndividualModel');
  49     $allowCoreTypes = array_merge(array('Contact', 'Individual'), CRM_Contact_BAO_ContactType::subTypes('Individual'));
  50     $allowSubTypes = array();
  51
  52     // Register 'contribution_1'
  53     $financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'financial_type_id');
  54     $allowCoreTypes[] = 'Contribution';
  55     //CRM-15427
  56     $allowSubTypes['ContributionType'] = array($financialTypeId);
  57     $entities[] = array(
  58       'entity_name' => 'contribution_1',
  59       'entity_type' => 'ContributionModel',
  60       'entity_sub_type' => '*',
  61     );
  62
  63     // If applicable, register 'membership_1'
  64     $member = CRM_Member_BAO_Membership::getMembershipBlock($this->_id);
  65     if ($member && $member['is_active']) {
  66       //CRM-15427
  67       $entities[] = array(
  68         'entity_name' => 'membership_1',
  69         'entity_type' => 'MembershipModel',
  70         'entity_sub_type' => '*',
  71       );
  72       $allowCoreTypes[] = 'Membership';
  73       $allowSubTypes['MembershipType'] = explode(',', $member['membership_types']);
  74     }
  75     //CRM-15427
  76     $this->addProfileSelector('custom_pre_id', ts('Include Profile') . '<br />' . ts('(top of page)'), $allowCoreTypes, $allowSubTypes, $entities, TRUE);
  77     $this->addProfileSelector('custom_post_id', ts('Include Profile') . '<br />' . ts('(bottom of page)'), $allowCoreTypes, $allowSubTypes, $entities, TRUE);
  78
  79     $this->addFormRule(array('CRM_Contribute_Form_ContributionPage_Custom', 'formRule'), $this->_id);
  80
  81     parent::buildQuickForm();
  82   }
  83
  84   /**
  85    * Set default values for the form. Note that in edit/view mode
  86    * the default values are retrieved from the database
  87    *
  88    *
  89    * @return void
  90    */
  91   public function setDefaultValues() {
  92     $defaults = parent::setDefaultValues();
  93
  94     if ($this->_id) {
  95       $title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title');
  96       CRM_Utils_System::setTitle(ts('Include Profiles') . " ($title)");
  97     }
  98
  99     $ufJoinParams = array(
 100       'module' => 'CiviContribute',
 101       'entity_table' => 'civicrm_contribution_page',
 102       'entity_id' => $this->_id,
 103     );
 104     list($defaults['custom_pre_id'],
 105       $second) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
 106     $defaults['custom_post_id'] = $second ? array_shift($second) : '';
 107
 108     return $defaults;
 109   }
 110
 111   /**
 112    * Process the form.
 113    *
 114    * @return void
 115    */
 116   public function postProcess() {
 117     // get the submitted form values.
 118     $params = $this->controller->exportValues($this->_name);
 119
 120     if ($this->_action & CRM_Core_Action::UPDATE) {
 121       $params['id'] = $this->_id;
 122     }
 123
 124     $transaction = new CRM_Core_Transaction();
 125
 126     // also update uf join table
 127     $ufJoinParams = array(
 128       'is_active' => 1,
 129       'module' => 'CiviContribute',
 130       'entity_table' => 'civicrm_contribution_page',
 131       'entity_id' => $this->_id,
 132     );
 133
 134     // first delete all past entries
 135     CRM_Core_BAO_UFJoin::deleteAll($ufJoinParams);
 136
 137     if (!empty($params['custom_pre_id'])) {
 138       $ufJoinParams['weight'] = 1;
 139       $ufJoinParams['uf_group_id'] = $params['custom_pre_id'];
 140       CRM_Core_BAO_UFJoin::create($ufJoinParams);
 141     }
 142
 143     unset($ufJoinParams['id']);
 144
 145     if (!empty($params['custom_post_id'])) {
 146       $ufJoinParams['weight'] = 2;
 147       $ufJoinParams['uf_group_id'] = $params['custom_post_id'];
 148       CRM_Core_BAO_UFJoin::create($ufJoinParams);
 149     }
 150
 151     $transaction->commit();
 152     parent::endPostProcess();
 153   }
 154
 155   /**
 156    * Return a descriptive name for the page, used in wizard header
 157    *
 158    * @return string
 159    */
 160   public function getTitle() {
 161     return ts('Include Profiles');
 162   }
 163
 164   /**
 165    * Global form rule.
 166    *
 167    * @param array $fields
 168    *   The input form values.
 169    *
 170    * @param $files
 171    * @param int $contributionPageId
 172    *
 173    * @return bool|array
 174    *   true if no errors, else array of errors
 175    */
 176   public static function formRule($fields, $files, $contributionPageId) {
 177     $errors = array();
 178     $preProfileType = $postProfileType = NULL;
 179     // for membership profile make sure Membership section is enabled
 180     // get membership section for this contribution page
 181     $dao = new CRM_Member_DAO_MembershipBlock();
 182     $dao->entity_table = 'civicrm_contribution_page';
 183     $dao->entity_id = $contributionPageId;
 184
 185     $membershipEnable = FALSE;
 186
 187     if ($dao->find(TRUE) && $dao->is_active) {
 188       $membershipEnable = TRUE;
 189     }
 190
 191     if ($fields['custom_pre_id']) {
 192       $preProfileType = CRM_Core_BAO_UFField::getProfileType($fields['custom_pre_id']);
 193     }
 194
 195     if ($fields['custom_post_id']) {
 196       $postProfileType = CRM_Core_BAO_UFField::getProfileType($fields['custom_post_id']);
 197     }
 198
 199     $errorMsg = ts('You must enable the Membership Block for this Contribution Page if you want to include a Profile with Membership fields.');
 200
 201     if (($preProfileType == 'Membership') && !$membershipEnable) {
 202       $errors['custom_pre_id'] = $errorMsg;
 203     }
 204
 205     if (($postProfileType == 'Membership') && !$membershipEnable) {
 206       $errors['custom_post_id'] = $errorMsg;
 207     }
 208
 209     $behalf = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $contributionPageId, 'is_for_organization');
 210     if ($fields['custom_pre_id']) {
 211       $errorMsg = ts('You should move the membership related fields in the "On Behalf" profile for this Contribution Page');
 212       if ($preProfileType == 'Membership' && $behalf) {
 213         $errors['custom_pre_id'] = isset($errors['custom_pre_id']) ? $errors['custom_pre_id'] . $errorMsg : $errorMsg;
 214       }
 215     }
 216
 217     if ($fields['custom_post_id']) {
 218       $errorMsg = ts('You should move the membership related fields in the "On Behalf" profile for this Contribution Page');
 219       if ($postProfileType == 'Membership' && $behalf) {
 220         $errors['custom_post_id'] = isset($errors['custom_post_id']) ? $errors['custom_post_id'] . $errorMsg : $errorMsg;
 221       }
 222     }
 223     return empty($errors) ? TRUE : $errors;
 224   }
 225
 226 }