CRM/Contribute/Form/ContributionPage/Settings.php

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