CRM/Contribute/Form/ContributionPage/Settings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ContributionPage {
  36
  37   /**
  38    * Function to set variables up before form is built
  39    *
  40    * @return void
  41    * @access public
  42    */
  43   public function preProcess() {
  44     parent::preProcess();
  45   }
  46
  47   /**
  48    * This function sets the default values for the form. Note that in edit/view mode
  49    * the default values are retrieved from the database
  50    *
  51    * @access public
  52    *
  53    * @return void
  54    */
  55   function setDefaultValues() {
  56     $defaults = parent::setDefaultValues();
  57
  58     if ($this->_id) {
  59       $title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
  60         $this->_id,
  61         'title'
  62       );
  63       CRM_Utils_System::setTitle(ts('Title and Settings (%1)',
  64           array(1 => $title)
  65         ));
  66
  67       $ufJoinParams = array(
  68         'module' => 'OnBehalf',
  69         'entity_table' => 'civicrm_contribution_page',
  70         'entity_id' => $this->_id,
  71       );
  72       $onBehalfIDs = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
  73       if ($onBehalfIDs) {
  74         // get the first one only
  75         $defaults['onbehalf_profile_id'] = $onBehalfIDs[0];
  76       }
  77
  78       $ufJoinDAO = new CRM_Core_DAO_UFJoin();
  79       $ufJoinDAO->module = 'soft_credit';
  80       $ufJoinDAO->entity_id = $this->_id;
  81       if ($ufJoinDAO->find(TRUE)) {
  82         $defaults['honoree_profile'] = $ufJoinDAO->uf_group_id;
  83         $jsonData = json_decode($ufJoinDAO->module_data);
  84         if ($jsonData) {
  85           foreach ($jsonData->soft_credit as $index => $value){
  86             $defaults[$index] = $value;
  87           }
  88         }
  89       }
  90     }
  91     else {
  92       CRM_Utils_System::setTitle(ts('Title and Settings'));
  93     }
  94
  95     if (!CRM_Utils_Array::value('soft_credit_types', $defaults)) {
  96       $defaults['soft_credit_types'] = array(1, 2);
  97     }
  98
  99     return $defaults;
 100   }
 101
 102   /**
 103    * Function to actually build the form
 104    *
 105    * @return void
 106    * @access public
 107    */
 108   public function buildQuickForm() {
 109
 110     $this->_first = TRUE;
 111     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage');
 112
 113     // financial Type
 114     $financialType = CRM_Financial_BAO_FinancialType::getIncomeFinancialType();
 115     $this->add('select', 'financial_type_id',
 116       ts('Financial Type'),
 117       $financialType,
 118       TRUE
 119     );
 120
 121     // name
 122     $this->add('text', 'title', ts('Title'), $attributes['title'], TRUE);
 123
 124     //CRM-7362 --add campaigns.
 125     CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
 126
 127     $this->addWysiwyg('intro_text', ts('Introductory Message'), $attributes['intro_text']);
 128
 129     $this->addWysiwyg('footer_text', ts('Footer Message'), $attributes['footer_text']);
 130
 131     // is on behalf of an organization ?
 132     $this->addElement('checkbox', 'is_organization', ts('Allow individuals to contribute and / or signup for membership on behalf of an organization?'), NULL, array('onclick' => "showHideByValue('is_organization',true,'for_org_text','table-row','radio',false);showHideByValue('is_organization',true,'for_org_option','table-row','radio',false);"));
 133
 134     $required = array('Contact', 'Organization');
 135     $optional = array('Contribution', 'Membership');
 136
 137     $profiles = CRM_Core_BAO_UFGroup::getValidProfiles($required, $optional);
 138     //Check profiles for Organization subtypes
 139     $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
 140     foreach ($contactSubType as $type) {
 141       $required = array('Contact', $type);
 142       $subTypeProfiles = CRM_Core_BAO_UFGroup::getValidProfiles($required, $optional);
 143       foreach ($subTypeProfiles as $profileId => $profileName) {
 144         $profiles[$profileId] = $profileName;
 145       }
 146     }
 147
 148     $requiredProfileFields = array('organization_name', 'email');
 149
 150     if (!empty($profiles)) {
 151       foreach ($profiles as $id => $dontCare) {
 152         $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($id, $requiredProfileFields);
 153         if (!$validProfile) {
 154           unset($profiles[$id]);
 155         }
 156       }
 157     }
 158
 159     if (empty($profiles)) {
 160       $invalidProfiles = TRUE;
 161       $this->assign('invalidProfiles', $invalidProfiles);
 162     }
 163
 164     $this->add('select', 'onbehalf_profile_id', ts('Organization Profile'),
 165       array(
 166         '' => ts('- select -')) + $profiles
 167     );
 168
 169     $options   = array();
 170     $options[] = $this->createElement('radio', NULL, NULL, ts('Optional'), 1);
 171     $options[] = $this->createElement('radio', NULL, NULL, ts('Required'), 2);
 172     $this->addGroup($options, 'is_for_organization', ts(''));
 173     $this->add('textarea', 'for_organization', ts('On behalf of Label'), $attributes['for_organization']);
 174
 175     // collect goal amount
 176     $this->add('text', 'goal_amount', ts('Goal Amount'), array('size' => 8, 'maxlength' => 12));
 177     $this->addRule('goal_amount', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
 178
 179     // is confirmation page enabled?
 180     $this->addElement('checkbox', 'is_confirm_enabled', ts('Use a confirmation page?'));
 181
 182     // is this page shareable through social media ?
 183     $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
 184
 185     // is this page active ?
 186     $this->addElement('checkbox', 'is_active', ts('Is this Online Contribution Page Active?'));
 187
 188     // should the honor be enabled
 189     $this->addElement('checkbox', 'honor_block_is_active', ts('Honoree Section Enabled'), NULL, array('onclick' => "showHonor()"));
 190
 191     $this->add('text', 'honor_block_title', ts('Honoree Section Title'), array('maxlength' => 255, 'size' => 45));
 192
 193     $this->add('textarea', 'honor_block_text', ts('Honoree Introductory Message'), array('rows' => 2, 'cols' => 50));
 194
 195     $softCreditTypes = &$this->add('select', 'soft_credit_types',
 196       ts('Honor Types'),
 197       CRM_Core_OptionGroup::values("soft_credit_type", FALSE),
 198       FALSE,
 199       array(
 200         'id' => 'soft_credit_types',
 201         'multiple' => 'multiple',
 202         'title' => '- ' . ts('select') . ' -',
 203       )
 204     );
 205
 206     $entities = array(
 207       array('entity_name' => 'contact_1',
 208         'entity_type' => 'IndividualModel'
 209       ),
 210       array('entity_name' => 'organization_1',
 211         'entity_type' => 'OrganizationModel'
 212       ),
 213       array('entity_name' => 'household_1',
 214         'entity_type' => 'HouseholdModel'
 215       ),
 216     );
 217     $allowCoreTypes = array_merge(array('Contact', 'Individual', 'Organization', 'Household'), CRM_Contact_BAO_ContactType::subTypes('Individual'));
 218     $allowSubTypes = array();
 219
 220     $this->addProfileSelector('honoree_profile', ts('Honoree Profile'), $allowCoreTypes, $allowSubTypes, $entities);
 221
 222     if (CRM_Utils_Array::value('honor_block_is_active', $this->_submitValues)) {
 223       $this->addRule('soft_credit_types', ts('At least one value must be selected if Honor Section is active'), 'required');
 224       $this->addRule('honoree_profile', ts('Please select a profile used for honoree'), 'required');
 225     }
 226
 227     // add optional start and end dates
 228     $this->addDateTime('start_date', ts('Start Date'));
 229     $this->addDateTime('end_date', ts('End Date'));
 230
 231     $this->addFormRule(array('CRM_Contribute_Form_ContributionPage_Settings', 'formRule'), $this);
 232
 233     parent::buildQuickForm();
 234   }
 235
 236   /**
 237    * global validation rules for the form
 238    *
 239    * @param array $values posted values of the form
 240    *
 241    * @return array list of errors to be posted back to the form
 242    * @static
 243    * @access public
 244    */
 245   static function formRule($values, $files, $self) {
 246     $errors = array();
 247     $contributionPageId = $self->_id;
 248     //CRM-4286
 249     if (strstr($values['title'], '/')) {
 250       $errors['title'] = ts("Please do not use '/' in Title");
 251     }
 252
 253     if (CRM_Utils_Array::value('is_organization', $values) &&
 254       !CRM_Utils_Array::value('onbehalf_profile_id', $values)
 255     ) {
 256       $errors['onbehalf_profile_id'] = ts('Please select a profile to collect organization information on this contribution page.');
 257     }
 258
 259     //CRM-11494
 260     $start = CRM_Utils_Date::processDate($values['start_date']);
 261     $end = CRM_Utils_Date::processDate($values['end_date']);
 262     if (($end < $start) && ($end != 0)) {
 263       $errors['end_date'] = ts('End date should be after Start date.');
 264     }
 265
 266     if (CRM_Utils_Array::value('payment_processor', $self->_values)
 267       && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($values['financial_type_id'])) {
 268       $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
 269     }
 270
 271     //dont allow on behalf of save when
 272     //pre or post profile consists of membership fields
 273     if ($contributionPageId && CRM_Utils_Array::value('is_organization', $values)) {
 274       $ufJoinParams = array(
 275         'module' => 'CiviContribute',
 276         'entity_table' => 'civicrm_contribution_page',
 277         'entity_id' => $contributionPageId,
 278       );
 279
 280       list($contributionProfiles['custom_pre_id'],
 281         $contributionProfiles['custom_post_id']
 282       ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
 283
 284       $conProfileType = NULL;
 285       if ($contributionProfiles['custom_pre_id']) {
 286         $preProfileType = CRM_Core_BAO_UFField::getProfileType($contributionProfiles['custom_pre_id']);
 287         if ($preProfileType == 'Membership') {
 288           $conProfileType = "'Includes Profile (top of page)'";
 289         }
 290       }
 291
 292       if ($contributionProfiles['custom_post_id']) {
 293         $postProfileType = CRM_Core_BAO_UFField::getProfileType($contributionProfiles['custom_post_id']);
 294         if ($postProfileType == 'Membership') {
 295           $conProfileType  = empty($conProfileType) ? "'Includes Profile (bottom of page)'" : "{$conProfileType} and 'Includes Profile (bottom of page)'";
 296         }
 297       }
 298       if (!empty($conProfileType)) {
 299         $errors['is_organization'] = ts("You should move the membership related fields configured in %1 to the 'On Behalf' profile for this Contribution Page", array(1 => $conProfileType));
 300       }
 301     }
 302     return $errors;
 303   }
 304
 305   /**
 306    * Process the form
 307    *
 308    * @return void
 309    * @access public
 310    */
 311   public function postProcess() {
 312     // get the submitted form values.
 313     $params = $this->controller->exportValues($this->_name);
 314
 315     // we do this in case the user has hit the forward/back button
 316     if ($this->_id) {
 317       $params['id'] = $this->_id;
 318     }
 319     else {
 320       $session = CRM_Core_Session::singleton();
 321       $params['created_id'] = $session->get('userID');
 322       $params['created_date'] = date('YmdHis');
 323       $config = CRM_Core_Config::singleton();
 324       $params['currency'] = $config->defaultCurrency;
 325     }
 326
 327     $params['is_confirm_enabled'] = CRM_Utils_Array::value('is_confirm_enabled', $params, FALSE);
 328     $params['is_share'] = CRM_Utils_Array::value('is_share', $params, FALSE);
 329     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 330     $params['is_credit_card_only'] = CRM_Utils_Array::value('is_credit_card_only', $params, FALSE);
 331     $params['honor_block_is_active'] = CRM_Utils_Array::value('honor_block_is_active', $params, FALSE);
 332     $params['is_for_organization'] = CRM_Utils_Array::value('is_organization', $params) ? CRM_Utils_Array::value('is_for_organization', $params, FALSE) : 0;
 333
 334     $params['start_date'] = CRM_Utils_Date::processDate($params['start_date'], $params['start_date_time'], TRUE);
 335     $params['end_date'] = CRM_Utils_Date::processDate($params['end_date'], $params['end_date_time'], TRUE);
 336
 337     $params['goal_amount'] = CRM_Utils_Rule::cleanMoney($params['goal_amount']);
 338
 339     if (!$params['honor_block_is_active']) {
 340       $params['honor_block_title'] = NULL;
 341       $params['honor_block_text'] = NULL;
 342     }
 343     else {
 344       $sctJSON = json_encode(array(
 345         'soft_credit' => array(
 346           'soft_credit_types' => $params['soft_credit_types'],
 347           'honor_block_title' => $params['honor_block_title'],
 348           'honor_block_text' => $params['honor_block_text']
 349           )
 350         )
 351       );
 352     }
 353
 354     $dao = CRM_Contribute_BAO_ContributionPage::create($params);
 355
 356     $ufJoinParams = array(
 357       'onbehalf_profile_id' =>
 358         array(
 359           'is_active' => 1,
 360           'module' => 'OnBehalf',
 361           'entity_table' => 'civicrm_contribution_page',
 362           'entity_id' => $dao->id,
 363         ),
 364       'honor_block_is_active' =>
 365         array(
 366           'module' => 'soft_credit',
 367           'entity_table' => 'civicrm_contribution_page',
 368           'entity_id' => $dao->id,
 369         )
 370     );
 371
 372
 373     foreach ($ufJoinParams as $index => $ufJoinParam) {
 374       if (CRM_Utils_Array::value($index, $params)) {
 375           $ufJoinParam['weight'] = 1;
 376           if ($index == 'honor_block_is_active') {
 377             $ufJoinParam['is_active'] = 1;
 378             $ufJoinParam['uf_group_id'] = $params['honoree_profile'];
 379             $ufJoinParam['module_data'] = $sctJSON;
 380           }
 381           else {
 382             // first delete all past entries
 383             CRM_Core_BAO_UFJoin::deleteAll($ufJoinParam);
 384             $ufJoinParam['uf_group_id'] = $params[$index];
 385           }
 386             CRM_Core_BAO_UFJoin::create($ufJoinParam);
 387         }
 388       elseif ($index == 'honor_block_is_active') {
 389         //On subsequent honor_block_is_active uncheck, disable(don't delete)
 390         //that particular honoree profile entry in UFjoin table, CRM-13981
 391         $ufId = CRM_Core_BAO_UFJoin::findJoinEntryId($ufJoinParam);
 392         if ($ufId) {
 393           $ufJoinParam['uf_group_id'] = CRM_Core_BAO_UFJoin::findUFGroupId($ufJoinParam);
 394           $ufJoinParam['is_active'] = 0;
 395           CRM_Core_BAO_UFJoin::create($ufJoinParam);
 396         }
 397       }
 398     }
 399
 400     $this->set('id', $dao->id);
 401     if ($this->_action & CRM_Core_Action::ADD) {
 402       $url = 'civicrm/admin/contribute/amount';
 403       $urlParams = "action=update&reset=1&id={$dao->id}";
 404       // special case for 'Save and Done' consistency.
 405       if ($this->controller->getButtonName('submit') == '_qf_Amount_upload_done') {
 406         $url = 'civicrm/admin/contribute';
 407         $urlParams = 'reset=1';
 408         CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
 409             array(1 => $this->getTitle())
 410           ), ts('Saved'), 'success');
 411       }
 412
 413       CRM_Utils_System::redirect(CRM_Utils_System::url($url, $urlParams));
 414     }
 415     parent::endPostProcess();
 416   }
 417
 418   /**
 419    * Return a descriptive name for the page, used in wizard header
 420    *
 421    * @return string
 422    * @access public
 423    */
 424   public function getTitle() {
 425     return ts('Title and Settings');
 426   }
 427 }
 428