| 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 delete a group of case records. |
| 36 | */ |
| 37 | class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { |
| 38 | |
| 39 | /** |
| 40 | * Are we operating in "single mode", i.e. deleting one |
| 41 | * specific case? |
| 42 | * |
| 43 | * @var bool |
| 44 | */ |
| 45 | protected $_single = FALSE; |
| 46 | |
| 47 | /** |
| 48 | * Are we moving case to Trash. |
| 49 | * |
| 50 | * @var bool |
| 51 | */ |
| 52 | public $_moveToTrash = TRUE; |
| 53 | |
| 54 | /** |
| 55 | * Build all the data structures needed to build the form. |
| 56 | */ |
| 57 | public function preProcess() { |
| 58 | if (!CRM_Core_Permission::checkActionPermission('CiviCase', CRM_Core_Action::DELETE)) { |
| 59 | CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); |
| 60 | } |
| 61 | parent::preProcess(); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Build the form object. |
| 66 | */ |
| 67 | public function buildQuickForm() { |
| 68 | $this->addDefaultButtons(ts('Delete cases'), 'done'); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Process the form after the input has been submitted and validated. |
| 73 | */ |
| 74 | public function postProcess() { |
| 75 | $deleted = $failed = 0; |
| 76 | foreach ($this->_entityIds as $caseId) { |
| 77 | if (CRM_Case_BAO_Case::deleteCase($caseId, $this->_moveToTrash)) { |
| 78 | $deleted++; |
| 79 | } |
| 80 | else { |
| 81 | $failed++; |
| 82 | } |
| 83 | } |
| 84 | |
| 85 | if ($deleted) { |
| 86 | if ($this->_moveToTrash) { |
| 87 | $msg = ts('%count case moved to trash.', ['plural' => '%count cases moved to trash.', 'count' => $deleted]); |
| 88 | } |
| 89 | else { |
| 90 | $msg = ts('%count case permanently deleted.', ['plural' => '%count cases permanently deleted.', 'count' => $deleted]); |
| 91 | } |
| 92 | CRM_Core_Session::setStatus($msg, ts('Removed'), 'success'); |
| 93 | } |
| 94 | |
| 95 | if ($failed) { |
| 96 | CRM_Core_Session::setStatus(ts('1 could not be deleted.', ['plural' => '%count could not be deleted.', 'count' => $failed]), ts('Error'), 'error'); |
| 97 | } |
| 98 | } |
| 99 | |
| 100 | } |