3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Contribution Page form.
21 class CRM_Contribute_Form_ContributionPage
extends CRM_Core_Form
{
24 * The page id saved to the session for an update.
31 * The pledgeBlock id saved to the session for an update.
35 protected $_pledgeBlockID;
38 * Are we in single form mode or wizard mode?
45 * Is this the first page?
49 protected $_first = FALSE;
52 * Is this the last page?
56 protected $_last = FALSE;
63 protected $_priceSetID = NULL;
68 * Explicitly declare the entity api name.
70 public function getDefaultEntity() {
71 return 'Contribution';
75 * Explicitly declare the form context.
77 public function getDefaultContext() {
82 * Set variables up before form is built.
84 public function preProcess() {
85 // current contribution page id
86 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive',
87 $this, FALSE, NULL, 'REQUEST'
89 $this->assign('contributionPageID', $this->_id
);
91 // get the requested action
92 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
93 // default to 'browse'
94 $this, FALSE, 'browse'
97 // setting title and 3rd level breadcrumb for html page if contrib page exists
99 $title = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id
, 'title');
101 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
102 $this->_single
= TRUE;
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);
111 CRM_Contribute_Form_ContributionPage_TabHeader
::build($this);
113 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
114 $this->setTitle(ts('Configure Page - %1', [1 => $title]));
116 elseif ($this->_action
== CRM_Core_Action
::VIEW
) {
117 $this->setTitle(ts('Preview Page - %1', [1 => $title]));
119 elseif ($this->_action
== CRM_Core_Action
::DELETE
) {
120 $this->setTitle(ts('Delete Page - %1', [1 => $title]));
124 $this->_values
= $this->get('values');
125 if (!is_array($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
);
132 $this->set('values', $this->_values
);
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.'));
143 // Preload libraries required by the "Profiles" tab
144 $schemas = ['IndividualModel', 'OrganizationModel', 'ContributionModel'];
145 if (in_array('CiviMember', CRM_Core_Config
::singleton()->enableComponents
)) {
146 $schemas[] = 'MembershipModel';
148 CRM_UF_Page_ProfileEditor
::registerProfileScripts();
149 CRM_UF_Page_ProfileEditor
::registerSchemas($schemas);
153 * Build the form object.
155 public function buildQuickForm() {
156 $this->applyFilter('__ALL__', 'trim');
158 $session = CRM_Core_Session
::singleton();
159 $this->_cancelURL
= $_POST['cancelURL'] ??
NULL;
161 if (!$this->_cancelURL
) {
162 $this->_cancelURL
= CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1');
165 if ($this->_cancelURL
) {
166 $this->addElement('hidden', 'cancelURL', $this->_cancelURL
);
169 if ($this->_single
) {
173 'name' => ts('Save'),
174 'spacing' => ' ',
179 'name' => ts('Save and Done'),
180 'spacing' => ' ',
187 'name' => ts('Save and Next'),
188 'spacing' => ' ',
189 'subName' => 'savenext',
194 'name' => ts('Cancel'),
196 $this->addButtons($buttons);
200 if (!$this->_first
) {
203 'name' => ts('Previous'),
204 'spacing' => ' ',
209 'name' => ts('Continue'),
210 'spacing' => ' ',
215 'name' => ts('Cancel'),
218 $this->addButtons($buttons);
221 $session->replaceUserContext($this->_cancelURL
);
222 // views are implemented as frozen form
223 if ($this->_action
& CRM_Core_Action
::VIEW
) {
225 $this->addElement('button', 'done', ts('Done'), ['onclick' => "location.href='civicrm/admin/custom/group?reset=1&action=browse'"]);
228 // don't show option for contribution amounts section if membership price set
229 // this flag is sent to template
231 $membershipBlock = new CRM_Member_DAO_MembershipBlock();
232 $membershipBlock->entity_table
= 'civicrm_contribution_page';
233 $membershipBlock->entity_id
= $this->_id
;
234 $membershipBlock->is_active
= 1;
235 $hasMembershipBlk = FALSE;
236 if ($membershipBlock->find(TRUE) &&
237 ($setID = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
, NULL, 1))
239 $extends = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'extends');
240 if ($extends && $extends == CRM_Core_Component
::getComponentID('CiviMember')) {
241 $hasMembershipBlk = TRUE;
244 // set value in DOM that membership price set exists
245 CRM_Core_Resources
::singleton()->addSetting(['memberPriceset' => $hasMembershipBlk]);
249 * Set default values for the form. Note that in edit/view mode
250 * the default values are retrieved from the database
256 public function setDefaultValues() {
257 //some child classes calling setdefaults directly w/o preprocess.
258 $this->_values
= $this->get('values');
259 if (!is_array($this->_values
)) {
261 if (isset($this->_id
) && $this->_id
) {
262 $params = ['id' => $this->_id
];
263 CRM_Core_DAO
::commonRetrieve('CRM_Contribute_DAO_ContributionPage', $params, $this->_values
);
265 $this->set('values', $this->_values
);
267 $defaults = $this->_values
;
269 $config = CRM_Core_Config
::singleton();
270 if (isset($this->_id
)) {
272 //set defaults for pledgeBlock values.
273 $pledgeBlockParams = [
274 'entity_id' => $this->_id
,
275 'entity_table' => ts('civicrm_contribution_page'),
277 $pledgeBlockDefaults = [];
278 CRM_Pledge_BAO_PledgeBlock
::retrieve($pledgeBlockParams, $pledgeBlockDefaults);
279 if ($this->_pledgeBlockID
= CRM_Utils_Array
::value('id', $pledgeBlockDefaults)) {
280 $defaults['is_pledge_active'] = TRUE;
283 'is_pledge_interval',
285 'initial_reminder_day',
286 'additional_reminder_day',
288 'is_pledge_start_date_visible',
289 'is_pledge_start_date_editable',
291 foreach ($pledgeBlock as $key) {
292 $defaults[$key] = $pledgeBlockDefaults[$key] ??
NULL;
293 if ($key == 'pledge_start_date' && !empty($pledgeBlockDefaults[$key])) {
294 $defaultPledgeDate = (array) json_decode($pledgeBlockDefaults['pledge_start_date']);
295 $pledgeDateFields = [
296 'pledge_calendar_date' => 'calendar_date',
297 'pledge_calendar_month' => 'calendar_month',
299 $defaults['pledge_default_toggle'] = key($defaultPledgeDate);
300 foreach ($pledgeDateFields as $key => $value) {
301 if (array_key_exists($value, $defaultPledgeDate)) {
302 $defaults[$key] = reset($defaultPledgeDate);
303 $this->assign($key, reset($defaultPledgeDate));
308 if (!empty($pledgeBlockDefaults['pledge_frequency_unit'])) {
309 $defaults['pledge_frequency_unit'] = array_fill_keys(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
310 $pledgeBlockDefaults['pledge_frequency_unit']
314 // fix the display of the monetary value, CRM-4038
315 if (isset($defaults['goal_amount'])) {
316 $defaults['goal_amount'] = CRM_Utils_Money
::format($defaults['goal_amount'], NULL, '%a');
319 // get price set of type contributions
320 //this is the value for stored in db if price set extends contribution
322 $this->_priceSetID
= CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
, $usedFor, 1);
323 if ($this->_priceSetID
) {
324 $defaults['price_set_id'] = $this->_priceSetID
;
328 $defaults['is_active'] = 1;
329 // set current date as start date
330 // @todo look to change to $defaults['start_date'] = date('Ymd His');
331 // main settings form overrides this to implement above but this is left here
332 // 'in case' another extending form uses start_date - for now
333 $defaults['start_date'] = date('Y-m-d H:i:s');
336 if (!empty($defaults['recur_frequency_unit'])) {
337 $defaults['recur_frequency_unit'] = array_fill_keys(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
338 $defaults['recur_frequency_unit']
343 $defaults['recur_frequency_unit'] = ['month' => 1];
346 // confirm page starts out enabled
347 if (!isset($defaults['is_confirm_enabled'])) {
348 $defaults['is_confirm_enabled'] = 1;
357 public function postProcess() {
358 $pageId = $this->get('id');
359 //page is newly created.
360 if ($pageId && !$this->_id
) {
361 $session = CRM_Core_Session
::singleton();
362 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/contribute', 'reset=1'));
366 public function endPostProcess() {
367 // make submit buttons keep the current working tab opened, or save and next tab
368 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
369 $className = CRM_Utils_String
::getClassName($this->_name
);
371 //retrieve list of pages from StateMachine and find next page
372 //this is quite painful because StateMachine is full of protected variables
373 //so we have to retrieve all pages, find current page, and then retrieve next
374 $stateMachine = new CRM_Contribute_StateMachine_ContributionPage($this);
375 $states = $stateMachine->getStates();
376 $statesList = array_keys($states);
377 $currKey = array_search($className, $statesList);
378 $nextPage = (array_key_exists($currKey +
1, $statesList)) ?
$statesList[$currKey +
1] : '';
380 //unfortunately, some classes don't map to subpage names, so we alter the exceptions
382 switch ($className) {
384 $attributes = $this->getVar('_attributes');
385 $subPage = CRM_Utils_Request
::retrieveComponent($attributes);
386 if ($subPage == 'friend') {
387 $nextPage = 'custom';
390 $nextPage = 'settings';
394 case 'MembershipBlock':
395 $subPage = 'membership';
396 $nextPage = 'thankyou';
405 $subPage = strtolower($className);
406 $nextPage = strtolower($nextPage);
408 if ($subPage == 'amount') {
409 $nextPage = 'membership';
411 elseif ($subPage == 'thankyou') {
412 $nextPage = 'friend';
417 CRM_Core_Session
::setStatus(ts("'%1' information has been saved.",
418 [1 => CRM_Utils_Array
::value('title', CRM_Utils_Array
::value($subPage, $this->get('tabHeader')), $className)]
419 ), $this->getTitle(), 'success');
421 $this->postProcessHook();
423 if ($this->controller
->getButtonName('submit') == "_qf_{$className}_next") {
424 CRM_Utils_System
::redirect(CRM_Utils_System
::url("civicrm/admin/contribute/{$subPage}",
425 "action=update&reset=1&id={$this->_id}"
428 elseif ($this->controller
->getButtonName('submit') == "_qf_{$className}_submit_savenext") {
430 CRM_Utils_System
::redirect(CRM_Utils_System
::url("civicrm/admin/contribute/{$nextPage}",
431 "action=update&reset=1&id={$this->_id}"
435 CRM_Utils_System
::redirect(CRM_Utils_System
::url("civicrm/admin/contribute",
441 CRM_Utils_System
::redirect(CRM_Utils_System
::url("civicrm/admin/contribute", 'reset=1'));
447 * Use the form name to create the tpl file name.
455 public function getTemplateFileName() {
456 if ($this->controller
->getPrint() ||
$this->getVar('_id') <= 0 ||
457 ($this->_action
& CRM_Core_Action
::DELETE
) ||
458 (CRM_Utils_String
::getClassName($this->_name
) == 'AddProduct')
460 return parent
::getTemplateFileName();
463 // hack lets suppress the form rendering for now
464 self
::$_template->assign('isForm', FALSE);
465 return 'CRM/Contribute/Form/ContributionPage/Tab.tpl';