CRM/Import/Form/Preview.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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class previews the uploaded file and returns summary statistics.
  36  *
  37  * TODO: CRM-11254 - if preProcess and postProcess functions can be reconciled between the 5 child classes,
  38  * those classes can be removed entirely and this class will not need to be abstract
  39  */
  40 abstract class CRM_Import_Form_Preview extends CRM_Core_Form {
  41
  42   /**
  43    * Return a descriptive name for the page, used in wizard header.
  44    *
  45    * @return string
  46    */
  47   public function getTitle() {
  48     return ts('Preview');
  49   }
  50
  51   /**
  52    * Build the form object.
  53    */
  54   public function buildQuickForm() {
  55     $this->addButtons([
  56         [
  57           'type' => 'back',
  58           'name' => ts('Previous'),
  59         ],
  60         [
  61           'type' => 'next',
  62           'name' => ts('Import Now'),
  63           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
  64           'isDefault' => TRUE,
  65         ],
  66         [
  67           'type' => 'cancel',
  68           'name' => ts('Cancel'),
  69         ],
  70     ]);
  71   }
  72
  73   /**
  74    * Set status url for ajax.
  75    */
  76   public function setStatusUrl() {
  77     $statusID = $this->get('statusID');
  78     if (!$statusID) {
  79       $statusID = md5(uniqid(rand(), TRUE));
  80       $this->set('statusID', $statusID);
  81     }
  82     $statusUrl = CRM_Utils_System::url('civicrm/ajax/status', "id={$statusID}", FALSE, NULL, FALSE);
  83     $this->assign('statusUrl', $statusUrl);
  84   }
  85
  86 }