CRM/Contribute/Form/ContributionPage/Settings.php

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