CRM/Core/QuickForm/Action/Reload.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  * Define the reload action. Reload the page but do not do any validation.
  30  * This help with actions where we might want hooks to process some data
  31  * but not validate all the fields. Was incorporated to improve the discount
  32  * module integration.
  33  *
  34  * @package CRM
  35  * @copyright CiviCRM LLC (c) 2004-2019
  36  */
  37 class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action {
  38
  39   /**
  40    * Class constructor.
  41    *
  42    * @param object $stateMachine
  43    *   Reference to state machine object.
  44    *
  45    * @return \CRM_Core_QuickForm_Action_Reload
  46    */
  47   public function __construct(&$stateMachine) {
  48     parent::__construct($stateMachine);
  49   }
  50
  51   /**
  52    * Processes the request.
  53    *
  54    * @param CRM_Core_Form $page
  55    *   CRM_Core_Form the current form-page.
  56    * @param string $actionName
  57    *   Current action name, as one Action object can serve multiple actions.
  58    *
  59    * @return object|void
  60    */
  61   public function perform(&$page, $actionName) {
  62     // save the form values and validation status to the session
  63     $page->isFormBuilt() or $page->buildForm();
  64
  65     $pageName = $page->getAttribute('name');
  66     $data = &$page->controller->container();
  67     $data['values'][$pageName] = $page->exportValues();
  68
  69     return $page->handle('display');
  70   }
  71
  72 }