CRM/Contribute/Form/Task/Delete.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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 boolean
  46    */
  47   protected $_single = FALSE;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    *
  52    * @return void
  53    */
  54   public function preProcess() {
  55     //check for delete
  56     if (!CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
  57       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  58     }
  59     parent::preProcess();
  60   }
  61
  62   /**
  63    * Build the form object.
  64    *
  65    *
  66    * @return void
  67    */
  68   public function buildQuickForm() {
  69     $this->addDefaultButtons(ts('Delete Contributions'), 'done');
  70   }
  71
  72   /**
  73    * Process the form after the input has been submitted and validated.
  74    *
  75    *
  76    * @return void
  77    */
  78   public function postProcess() {
  79     $deleted = $failed = 0;
  80     foreach ($this->_contributionIds as $contributionId) {
  81       if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionId)) {
  82         $deleted++;
  83       }
  84       else {
  85         $failed++;
  86       }
  87     }
  88
  89     if ($deleted) {
  90       $msg = ts('%count contribution deleted.', array('plural' => '%count contributions deleted.', 'count' => $deleted));
  91       CRM_Core_Session::setStatus($msg, ts('Removed'), 'success');
  92     }
  93
  94     if ($failed) {
  95       CRM_Core_Session::setStatus(ts('1 could not be deleted.', array('plural' => '%count could not be deleted.', 'count' => $failed)), ts('Error'), 'error');
  96     }
  97   }
  98
  99 }