CRM/Case/Form/Task/Delete.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to delete a group of
  38  * case records. This class provides functionality for the actual
  39  * deletion.
  40  */
  41 class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task {
  42
  43   /**
  44    * Are we operating in "single mode", i.e. deleting one
  45    * specific case?
  46    *
  47    * @var boolean
  48    */
  49   protected $_single = FALSE;
  50
  51   /**
  52    * Are we moving case to Trash.
  53    *
  54    * @var boolean
  55    */
  56   public $_moveToTrash = TRUE;
  57
  58   /**
  59    * Build all the data structures needed to build the form.
  60    */
  61   public function preProcess() {
  62     if (!CRM_Core_Permission::checkActionPermission('CiviCase', CRM_Core_Action::DELETE)) {
  63       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  64     }
  65     parent::preProcess();
  66   }
  67
  68   /**
  69    * Build the form object.
  70    *
  71    * @return void
  72    */
  73   public function buildQuickForm() {
  74     $this->addDefaultButtons(ts('Delete Cases'), 'done');
  75   }
  76
  77   /**
  78    * Process the form after the input has been submitted and validated.
  79    *
  80    * @return void
  81    */
  82   public function postProcess() {
  83     $deletedCases = 0;
  84     foreach ($this->_caseIds as $caseId) {
  85       if (CRM_Case_BAO_Case::deleteCase($caseId, $this->_moveToTrash)) {
  86         $deletedCases++;
  87       }
  88     }
  89
  90     CRM_Core_Session::setStatus($deletedCases, ts('Deleted Cases'), 'success');
  91     CRM_Core_Session::setStatus('', ts('Total Selected Case(s): %1', array(1 => count($this->_caseIds))), 'info');
  92   }
  93
  94 }