CRM/Contribute/Form/ContributionPage.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Contribution Page form.
  20  */
  21 class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form {
  22
  23   /**
  24    * The page id saved to the session for an update.
  25    *
  26    * @var int
  27    */
  28   protected $_id;
  29
  30   /**
  31    * The pledgeBlock id saved to the session for an update.
  32    *
  33    * @var int
  34    */
  35   protected $_pledgeBlockID;
  36
  37   /**
  38    * Are we in single form mode or wizard mode?
  39    *
  40    * @var bool
  41    */
  42   protected $_single;
  43
  44   /**
  45    * Is this the first page?
  46    *
  47    * @var bool
  48    */
  49   protected $_first = FALSE;
  50
  51   /**
  52    * Is this the last page?
  53    *
  54    * @var bool
  55    */
  56   protected $_last = FALSE;
  57
  58   /**
  59    * Store price set id.
  60    *
  61    * @var int
  62    */
  63   protected $_priceSetID = NULL;
  64
  65   protected $_values;
  66
  67   /**
  68    * Explicitly declare the entity api name.
  69    */
  70   public function getDefaultEntity() {
  71     return 'Contribution';
  72   }
  73
  74   /**
  75    * Explicitly declare the form context.
  76    */
  77   public function getDefaultContext() {
  78     return 'create';
  79   }
  80
  81   /**
  82    * Set variables up before form is built.
  83    */
  84   public function preProcess() {
  85     // current contribution page id
  86     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive',
  87       $this, FALSE, NULL, 'REQUEST'
  88     );
  89     $this->assign('contributionPageID', $this->_id);
  90
  91     // get the requested action
  92     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
  93       // default to 'browse'
  94       $this, FALSE, 'browse'
  95     );
  96
  97     // setting title and 3rd level breadcrumb for html page if contrib page exists
  98     if ($this->_id) {
  99       $title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title');
 100
 101       if ($this->_action == CRM_Core_Action::UPDATE) {
 102         $this->_single = TRUE;
 103       }
 104     }
 105
 106     // CRM-16776 - show edit/copy/create buttons on Profiles Tab if user has required permission.
 107     if (CRM_Core_Permission::check('administer CiviCRM')) {
 108       $this->assign('perm', TRUE);
 109     }
 110     // set up tabs
 111     CRM_Contribute_Form_ContributionPage_TabHeader::build($this);
 112
 113     if ($this->_action == CRM_Core_Action::UPDATE) {
 114       $this->setTitle(ts('Configure Page - %1', [1 => $title]));
 115     }
 116     elseif ($this->_action == CRM_Core_Action::VIEW) {
 117       $this->setTitle(ts('Preview Page - %1', [1 => $title]));
 118     }
 119     elseif ($this->_action == CRM_Core_Action::DELETE) {
 120       $this->setTitle(ts('Delete Page - %1', [1 => $title]));
 121     }
 122
 123     //cache values.
 124     $this->_values = $this->get('values');
 125     if (!is_array($this->_values)) {
 126       $this->_values = [];
 127       if (isset($this->_id) && $this->_id) {
 128         $params = ['id' => $this->_id];
 129         CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $this->_values);
 130         CRM_Contribute_BAO_ContributionPage::setValues($this->_id, $this->_values);
 131       }
 132       $this->set('values', $this->_values);
 133     }
 134
 135     // Check permission to edit contribution page
 136     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() && $this->_action & CRM_Core_Action::UPDATE) {
 137       $financialTypeID = CRM_Contribute_PseudoConstant::financialType($this->_values['financial_type_id']);
 138       if (!CRM_Core_Permission::check('edit contributions of type ' . $financialTypeID)) {
 139         CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 140       }
 141     }
 142
 143     // Preload libraries required by the "Profiles" tab
 144     $schemas = ['IndividualModel', 'OrganizationModel', 'ContributionModel'];
 145     if (CRM_Core_Component::isEnabled('CiviMember')) {
 146       $schemas[] = 'MembershipModel';
 147     }
 148     CRM_UF_Page_ProfileEditor::registerProfileScripts();
 149     CRM_UF_Page_ProfileEditor::registerSchemas($schemas);
 150   }
 151
 152   /**
 153    * Build the form object.
 154    */
 155   public function buildQuickForm() {
 156     $this->applyFilter('__ALL__', 'trim');
 157
 158     $session = CRM_Core_Session::singleton();
 159     $this->_cancelURL = $_POST['cancelURL'] ?? NULL;
 160
 161     if (!$this->_cancelURL) {
 162       $this->_cancelURL = CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1');
 163     }
 164
 165     if ($this->_cancelURL) {
 166       $this->addElement('hidden', 'cancelURL', $this->_cancelURL);
 167     }
 168
 169     if ($this->_single) {
 170       $buttons = [
 171         [
 172           'type' => 'next',
 173           'name' => ts('Save'),
 174           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 175           'isDefault' => TRUE,
 176         ],
 177         [
 178           'type' => 'upload',
 179           'name' => ts('Save and Done'),
 180           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 181           'subName' => 'done',
 182         ],
 183       ];
 184       if (!$this->_last) {
 185         $buttons[] = [
 186           'type' => 'submit',
 187           'name' => ts('Save and Next'),
 188           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 189           'subName' => 'savenext',
 190         ];
 191       }
 192       $buttons[] = [
 193         'type' => 'cancel',
 194         'name' => ts('Cancel'),
 195       ];
 196       $this->addButtons($buttons);
 197     }
 198     else {
 199       $buttons = [];
 200       if (!$this->_first) {
 201         $buttons[] = [
 202           'type' => 'back',
 203           'name' => ts('Previous'),
 204           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 205         ];
 206       }
 207       $buttons[] = [
 208         'type' => 'next',
 209         'name' => ts('Continue'),
 210         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 211         'isDefault' => TRUE,
 212       ];
 213       $buttons[] = [
 214         'type' => 'cancel',
 215         'name' => ts('Cancel'),
 216       ];
 217
 218       $this->addButtons($buttons);
 219     }
 220
 221     $session->replaceUserContext($this->_cancelURL);
 222
 223     // don't show option for contribution amounts section if membership price set
 224     // this flag is sent to template
 225
 226     $membershipBlock = new CRM_Member_DAO_MembershipBlock();
 227     $membershipBlock->entity_table = 'civicrm_contribution_page';
 228     $membershipBlock->entity_id = $this->_id;
 229     $membershipBlock->is_active = 1;
 230     $hasMembershipBlk = FALSE;
 231     if ($membershipBlock->find(TRUE) &&
 232       ($setID = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, NULL, 1))
 233     ) {
 234       $extends = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'extends');
 235       if ($extends && $extends == CRM_Core_Component::getComponentID('CiviMember')) {
 236         $hasMembershipBlk = TRUE;
 237       }
 238     }
 239     // set value in DOM that membership price set exists
 240     CRM_Core_Resources::singleton()->addSetting(['memberPriceset' => $hasMembershipBlk]);
 241   }
 242
 243   /**
 244    * Set default values for the form. Note that in edit/view mode
 245    * the default values are retrieved from the database
 246    *
 247    *
 248    * @return array
 249    *   defaults
 250    */
 251   public function setDefaultValues() {
 252     //some child classes calling setdefaults directly w/o preprocess.
 253     $this->_values = $this->get('values');
 254     if (!is_array($this->_values)) {
 255       $this->_values = [];
 256       if (isset($this->_id) && $this->_id) {
 257         $params = ['id' => $this->_id];
 258         CRM_Core_DAO::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $this->_values);
 259       }
 260       $this->set('values', $this->_values);
 261     }
 262     $defaults = $this->_values;
 263
 264     $config = CRM_Core_Config::singleton();
 265     if (isset($this->_id)) {
 266
 267       //set defaults for pledgeBlock values.
 268       $pledgeBlockParams = [
 269         'entity_id' => $this->_id,
 270         'entity_table' => 'civicrm_contribution_page',
 271       ];
 272       $pledgeBlockDefaults = [];
 273       CRM_Pledge_BAO_PledgeBlock::retrieve($pledgeBlockParams, $pledgeBlockDefaults);
 274       if ($this->_pledgeBlockID = CRM_Utils_Array::value('id', $pledgeBlockDefaults)) {
 275         $defaults['is_pledge_active'] = TRUE;
 276       }
 277       $pledgeBlock = [
 278         'is_pledge_interval',
 279         'max_reminders',
 280         'initial_reminder_day',
 281         'additional_reminder_day',
 282         'pledge_start_date',
 283         'is_pledge_start_date_visible',
 284         'is_pledge_start_date_editable',
 285       ];
 286       foreach ($pledgeBlock as $key) {
 287         $defaults[$key] = $pledgeBlockDefaults[$key] ?? NULL;
 288         if ($key == 'pledge_start_date' && !empty($pledgeBlockDefaults[$key])) {
 289           $defaultPledgeDate = (array) json_decode($pledgeBlockDefaults['pledge_start_date']);
 290           $pledgeDateFields = [
 291             'pledge_calendar_date' => 'calendar_date',
 292             'pledge_calendar_month' => 'calendar_month',
 293           ];
 294           $defaults['pledge_default_toggle'] = key($defaultPledgeDate);
 295           foreach ($pledgeDateFields as $key => $value) {
 296             if (array_key_exists($value, $defaultPledgeDate)) {
 297               $defaults[$key] = reset($defaultPledgeDate);
 298               $this->assign($key, reset($defaultPledgeDate));
 299             }
 300           }
 301         }
 302       }
 303       if (!empty($pledgeBlockDefaults['pledge_frequency_unit'])) {
 304         $defaults['pledge_frequency_unit'] = array_fill_keys(explode(CRM_Core_DAO::VALUE_SEPARATOR,
 305           $pledgeBlockDefaults['pledge_frequency_unit']
 306         ), '1');
 307       }
 308
 309       // fix the display of the monetary value, CRM-4038
 310       if (isset($defaults['goal_amount'])) {
 311         $defaults['goal_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['goal_amount']);
 312       }
 313
 314       // get price set of type contributions
 315       //this is the value for stored in db if price set extends contribution
 316       $usedFor = 2;
 317       $this->_priceSetID = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id, $usedFor, 1);
 318       if ($this->_priceSetID) {
 319         $defaults['price_set_id'] = $this->_priceSetID;
 320       }
 321     }
 322     else {
 323       $defaults['is_active'] = 1;
 324       // set current date as start date
 325       // @todo look to change to $defaults['start_date'] = date('Ymd His');
 326       // main settings form overrides this to implement above but this is left here
 327       // 'in case' another extending form uses start_date - for now
 328       $defaults['start_date'] = date('Y-m-d H:i:s');
 329     }
 330
 331     if (!empty($defaults['recur_frequency_unit'])) {
 332       $defaults['recur_frequency_unit'] = array_fill_keys(explode(CRM_Core_DAO::VALUE_SEPARATOR,
 333         $defaults['recur_frequency_unit']
 334       ), '1');
 335     }
 336     else {
 337       // CRM-10860
 338       $defaults['recur_frequency_unit'] = ['month' => 1];
 339     }
 340
 341     // confirm page starts out enabled
 342     if (!isset($defaults['is_confirm_enabled'])) {
 343       $defaults['is_confirm_enabled'] = 1;
 344     }
 345
 346     return $defaults;
 347   }
 348
 349   /**
 350    * Process the form.
 351    */
 352   public function postProcess() {
 353     $pageId = $this->get('id');
 354     //page is newly created.
 355     if ($pageId && !$this->_id) {
 356       $session = CRM_Core_Session::singleton();
 357       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1'));
 358     }
 359   }
 360
 361   public function endPostProcess() {
 362     // make submit buttons keep the current working tab opened, or save and next tab
 363     if ($this->_action & CRM_Core_Action::UPDATE) {
 364       $className = CRM_Utils_String::getClassName($this->_name);
 365
 366       //retrieve list of pages from StateMachine and find next page
 367       //this is quite painful because StateMachine is full of protected variables
 368       //so we have to retrieve all pages, find current page, and then retrieve next
 369       $stateMachine = new CRM_Contribute_StateMachine_ContributionPage($this);
 370       $states = $stateMachine->getStates();
 371       $statesList = array_keys($states);
 372       $currKey = array_search($className, $statesList);
 373       $nextPage = (array_key_exists($currKey + 1, $statesList)) ? $statesList[$currKey + 1] : '';
 374
 375       //unfortunately, some classes don't map to subpage names, so we alter the exceptions
 376
 377       switch ($className) {
 378         case 'Contribute':
 379           $attributes = $this->getVar('_attributes');
 380           $subPage = CRM_Utils_Request::retrieveComponent($attributes);
 381           if ($subPage == 'friend') {
 382             $nextPage = 'custom';
 383           }
 384           else {
 385             $nextPage = 'settings';
 386           }
 387           break;
 388
 389         case 'MembershipBlock':
 390           $subPage = 'membership';
 391           $nextPage = 'thankyou';
 392           break;
 393
 394         case 'Widget':
 395           $subPage = 'widget';
 396           $nextPage = 'pcp';
 397           break;
 398
 399         default:
 400           $subPage = strtolower($className);
 401           $nextPage = strtolower($nextPage);
 402
 403           if ($subPage == 'amount') {
 404             $nextPage = 'membership';
 405           }
 406           elseif ($subPage == 'thankyou') {
 407             $nextPage = 'friend';
 408           }
 409           break;
 410       }
 411
 412       CRM_Core_Session::setStatus(ts("'%1' information has been saved.",
 413         [1 => CRM_Utils_Array::value('title', CRM_Utils_Array::value($subPage, $this->get('tabHeader')), $className)]
 414       ), $this->getTitle(), 'success');
 415
 416       $this->postProcessHook();
 417
 418       if ($this->controller->getButtonName('submit') == "_qf_{$className}_next") {
 419         CRM_Utils_System::redirect(CRM_Utils_System::url("civicrm/admin/contribute/{$subPage}",
 420           "action=update&reset=1&id={$this->_id}"
 421         ));
 422       }
 423       elseif ($this->controller->getButtonName('submit') == "_qf_{$className}_submit_savenext") {
 424         if ($nextPage) {
 425           CRM_Utils_System::redirect(CRM_Utils_System::url("civicrm/admin/contribute/{$nextPage}",
 426             "action=update&reset=1&id={$this->_id}"
 427           ));
 428         }
 429         else {
 430           CRM_Utils_System::redirect(CRM_Utils_System::url("civicrm/admin/contribute",
 431             "reset=1"
 432           ));
 433         }
 434       }
 435       else {
 436         CRM_Utils_System::redirect(CRM_Utils_System::url("civicrm/admin/contribute", 'reset=1'));
 437       }
 438     }
 439   }
 440
 441   /**
 442    * Use the form name to create the tpl file name.
 443    *
 444    * @return string
 445    */
 446
 447   /**
 448    * @return string
 449    */
 450   public function getTemplateFileName() {
 451     if ($this->controller->getPrint() || $this->getVar('_id') <= 0 ||
 452       ($this->_action & CRM_Core_Action::DELETE) ||
 453       (CRM_Utils_String::getClassName($this->_name) == 'AddProduct')
 454     ) {
 455       return parent::getTemplateFileName();
 456     }
 457     else {
 458       // hack lets suppress the form rendering for now
 459       self::$_template->assign('isForm', FALSE);
 460       return 'CRM/Contribute/Form/ContributionPage/Tab.tpl';
 461     }
 462   }
 463
 464 }