CRM/Contribute/BAO/ManagePremiums.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33 class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product {
  34
  35   /**
  36    * Static holder for the default LT.
  37    */
  38   static $_defaultContributionType = NULL;
  39
  40   /**
  41    * Class constructor.
  42    */
  43   public function __construct() {
  44     parent::__construct();
  45   }
  46
  47   /**
  48    * Fetch object based on array of properties.
  49    *
  50    * @param array $params
  51    *   (reference ) an assoc array of name/value pairs.
  52    * @param array $defaults
  53    *   (reference ) an assoc array to hold the flattened values.
  54    *
  55    * @return CRM_Contribute_BAO_ManagePremium
  56    */
  57   public static function retrieve(&$params, &$defaults) {
  58     $premium = new CRM_Contribute_DAO_Product();
  59     $premium->copyValues($params);
  60     if ($premium->find(TRUE)) {
  61       $premium->product_name = $premium->name;
  62       CRM_Core_DAO::storeValues($premium, $defaults);
  63       return $premium;
  64     }
  65     return NULL;
  66   }
  67
  68   /**
  69    * Update the is_active flag in the db.
  70    *
  71    * @param int $id
  72    *   Id of the database record.
  73    * @param bool $is_active
  74    *   Value we want to set the is_active field.
  75    *
  76    * @return bool
  77    */
  78   public static function setIsActive($id, $is_active) {
  79     if (!$is_active) {
  80       $dao = new CRM_Contribute_DAO_PremiumsProduct();
  81       $dao->product_id = $id;
  82       $dao->delete();
  83     }
  84     return CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Product', $id, 'is_active', $is_active);
  85   }
  86
  87   /**
  88    * Add a premium product to the database, and return it.
  89    *
  90    * @param array $params
  91    *   Reference array contains the values submitted by the form.
  92    * @param array $ids (deprecated)
  93    *   Reference array contains the id.
  94    *
  95    * @return CRM_Contribute_DAO_Product
  96    */
  97   public static function add(&$params, $ids) {
  98     $id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('premium', $ids));
  99     $params = array_merge(array(
 100       'id' => $id,
 101       'image' => '',
 102       'thumbnail' => '',
 103       'is_active' => 0,
 104       'is_deductible' => FALSE,
 105       'currency' => CRM_Core_Config::singleton()->defaultCurrency,
 106     ), $params);
 107
 108     // Modify the submitted values for 'image' and 'thumbnail' so that we use
 109     // local URLs for these images when possible.
 110     $params['image'] = CRM_Utils_String::simplifyURL($params['image'], TRUE);
 111     $params['thumbnail'] = CRM_Utils_String::simplifyURL($params['thumbnail'], TRUE);
 112
 113     // Save and return
 114     $premium = new CRM_Contribute_DAO_Product();
 115     $premium->copyValues($params);
 116     $premium->save();
 117     return $premium;
 118   }
 119
 120   /**
 121    * Delete premium Types.
 122    *
 123    * @param int $productID
 124    *
 125    * @throws \CRM_Core_Exception
 126    */
 127   public static function del($productID) {
 128     //check dependencies
 129     $premiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
 130     $premiumsProduct->product_id = $productID;
 131     if ($premiumsProduct->find(TRUE)) {
 132       $session = CRM_Core_Session::singleton();
 133       $message .= ts('This Premium is being linked to <a href=\'%1\'>Online Contribution page</a>. Please remove it in order to delete this Premium.', array(1 => CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1')), ts('Deletion Error'), 'error');
 134       CRM_Core_Session::setStatus($message);
 135       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/contribute/managePremiums', 'reset=1&action=browse'));
 136     }
 137
 138     //delete from financial Type table
 139     $premium = new CRM_Contribute_DAO_Product();
 140     $premium->id = $productID;
 141     $premium->delete();
 142   }
 143
 144 }