CRM/Case/Form/Task/Restore.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 provides the functionality to restore a group of participations.
  36  */
  37 class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task {
  38
  39   /**
  40    * Are we operating in "single mode", i.e. deleting one
  41    * specific case?
  42    *
  43    * @var boolean
  44    */
  45   protected $_single = FALSE;
  46
  47   /**
  48    * Build all the data structures needed to build the form.
  49    */
  50   public function preProcess() {
  51     parent::preProcess();
  52   }
  53
  54   /**
  55    * Build the form object.
  56    */
  57   public function buildQuickForm() {
  58     $this->addDefaultButtons(ts('Restore Cases'), 'done');
  59   }
  60
  61   /**
  62    * Process the form after the input has been submitted and validated.
  63    */
  64   public function postProcess() {
  65     $restoredCases = $failed = 0;
  66     foreach ($this->_entityIds as $caseId) {
  67       if (CRM_Case_BAO_Case::restoreCase($caseId)) {
  68         $restoredCases++;
  69       }
  70       else {
  71         $failed++;
  72       }
  73     }
  74
  75     if ($restoredCases) {
  76       $msg = ts('%count case restored from trash.', array(
  77         'plural' => '%count cases restored from trash.',
  78         'count' => $restoredCases,
  79       ));
  80       CRM_Core_Session::setStatus($msg, ts('Restored'), 'success');
  81     }
  82
  83     if ($failed) {
  84       CRM_Core_Session::setStatus(ts('1 could not be restored.', array('plural' => '%count could not be restored.', 'count' => $failed)), ts('Error'), 'error');
  85     }
  86   }
  87
  88 }