INFRA-132 - CRM/Contribute - Convert single-line @param to multi-line
[civicrm-core.git] / CRM / Contribute / BAO / ManagePremiums.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 class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product {
36
37 /**
38 * Static holder for the default LT
39 */
40 static $_defaultContributionType = NULL;
41
42 /**
43 * Class constructor
44 */
45 public function __construct() {
46 parent::__construct();
47 }
48
49 /**
50 * Fetch object based on array of properties
51 *
52 * @param array $params
53 * (reference ) an assoc array of name/value pairs.
54 * @param array $defaults
55 * (reference ) an assoc array to hold the flattened values.
56 *
57 * @return CRM_Contribute_BAO_ManagePremium object
58 * @static
59 */
60 public static function retrieve(&$params, &$defaults) {
61 $premium = new CRM_Contribute_DAO_Product();
62 $premium->copyValues($params);
63 if ($premium->find(TRUE)) {
64 $premium->product_name = $premium->name;
65 CRM_Core_DAO::storeValues($premium, $defaults);
66 return $premium;
67 }
68 return NULL;
69 }
70
71 /**
72 * Update the is_active flag in the db
73 *
74 * @param int $id
75 * Id of the database record.
76 * @param bool $is_active
77 * Value we want to set the is_active field.
78 *
79 * @return Object DAO object on sucess, null otherwise
80 * @static
81 */
82 public static function setIsActive($id, $is_active) {
83 if (!$is_active) {
84 $dao = new CRM_Contribute_DAO_PremiumsProduct();
85 $dao->product_id = $id;
86 $dao->delete();
87 }
88 return CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Product', $id, 'is_active', $is_active);
89 }
90
91 /**
92 * add the financial types
93 *
94 * @param array $params
95 * Reference array contains the values submitted by the form.
96 * @param array $ids
97 * Reference array contains the id.
98 *
99 * @static
100 *
101 * @return object
102 */
103 public static function add(&$params, &$ids) {
104 // CRM-14283 - strip protocol and domain from image URLs
105 $image_type = array('image', 'thumbnail');
106 foreach ($image_type as $key) {
107 if (isset($params[$key])) {
108 $parsedURL = explode('/', $params[$key]);
109 $pathComponents = array_slice($parsedURL, 3);
110 $params[$key] = '/' . implode('/', $pathComponents);
111 }
112 }
113
114 $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
115 $params['is_deductible'] = CRM_Utils_Array::value('is_deductible', $params, FALSE);
116
117 // action is taken depending upon the mode
118 $premium = new CRM_Contribute_DAO_Product();
119 $premium->copyValues($params);
120
121 $premium->id = CRM_Utils_Array::value('premium', $ids);
122
123 // set currency for CRM-1496
124 if (!isset($premium->currency)) {
125 $config = CRM_Core_Config::singleton();
126 $premium->currency = $config->defaultCurrency;
127 }
128
129 $premium->save();
130 return $premium;
131 }
132
133 /**
134 * Delete premium Types
135 *
136 * @param int $productID
137 * @static
138 */
139
140 public static function del($productID) {
141 //check dependencies
142 $premiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
143 $premiumsProduct->product_id = $productID;
144 if ($premiumsProduct->find(TRUE)) {
145 $session = CRM_Core_Session::singleton();
146 $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');
147 CRM_Core_Session::setStatus($message);
148 return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/contribute/managePremiums', 'reset=1&action=browse'));
149 }
150
151 //delete from financial Type table
152 $premium = new CRM_Contribute_DAO_Product();
153 $premium->id = $productID;
154 $premium->delete();
155 }
156 }