CRM/Contribute/Form/Task/Delete.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 delete a group of contributions.
  36  *
  37  * This class provides functionality for the actual deletion.
  38  */
  39 class CRM_Contribute_Form_Task_Delete extends CRM_Contribute_Form_Task {
  40
  41   /**
  42    * Are we operating in "single mode", i.e. deleting one
  43    * specific contribution?
  44    *
  45    * @var bool
  46    */
  47   protected $_single = FALSE;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    */
  52   public function preProcess() {
  53     //check for delete
  54     if (!CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
  55       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  56     }
  57     parent::preProcess();
  58   }
  59
  60   /**
  61    * Build the form object.
  62    */
  63   public function buildQuickForm() {
  64     $count = 0;
  65     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  66       foreach ($this->_contributionIds as $key => $id) {
  67         $finTypeID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $id, 'financial_type_id');
  68         if (!CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($finTypeID))) {
  69           unset($this->_contributionIds[$key]);
  70           $count++;
  71         }
  72         // Now check for lineItems
  73         if ($lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($id)) {
  74           foreach ($lineItems as $items) {
  75             if (!CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($items['financial_type_id']))) {
  76               unset($this->_contributionIds[$key]);
  77               $count++;
  78               break;
  79             }
  80           }
  81         }
  82       }
  83     }
  84     if ($count && empty($this->_contributionIds)) {
  85       CRM_Core_Session::setStatus(ts('1 contribution could not be deleted.', ['plural' => '%count contributions could not be deleted.', 'count' => $count]), ts('Error'), 'error');
  86       $this->addButtons([
  87         [
  88           'type' => 'back',
  89           'name' => ts('Cancel'),
  90         ],
  91       ]);
  92     }
  93     elseif ($count && !empty($this->_contributionIds)) {
  94       CRM_Core_Session::setStatus(ts('1 contribution will not be deleted.', ['plural' => '%count contributions will not be deleted.', 'count' => $count]), ts('Warning'), 'warning');
  95       $this->addDefaultButtons(ts('Delete Contributions'), 'done');
  96     }
  97     else {
  98       $this->addDefaultButtons(ts('Delete Contributions'), 'done');
  99     }
 100   }
 101
 102   /**
 103    * Process the form after the input has been submitted and validated.
 104    */
 105   public function postProcess() {
 106     $deleted = $failed = 0;
 107     foreach ($this->_contributionIds as $contributionId) {
 108       if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionId)) {
 109         $deleted++;
 110       }
 111       else {
 112         $failed++;
 113       }
 114     }
 115
 116     if ($deleted) {
 117       $msg = ts('%count contribution deleted.', ['plural' => '%count contributions deleted.', 'count' => $deleted]);
 118       CRM_Core_Session::setStatus($msg, ts('Removed'), 'success');
 119     }
 120
 121     if ($failed) {
 122       CRM_Core_Session::setStatus(ts('1 could not be deleted.', ['plural' => '%count could not be deleted.', 'count' => $failed]), ts('Error'), 'error');
 123     }
 124   }
 125
 126 }