CRM/Contribute/Form/ContributionPage.php

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