3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Contribute_BAO_Premium
extends CRM_Contribute_DAO_Premium
{
36 * Product information.
40 private static $productInfo;
45 public function __construct() {
46 parent
::__construct();
50 * Fetch object based on array of properties.
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.
57 * @return CRM_Contribute_DAO_Product
59 public static function retrieve(&$params, &$defaults) {
60 $premium = new CRM_Contribute_DAO_Product();
61 $premium->copyValues($params);
62 if ($premium->find(TRUE)) {
63 CRM_Core_DAO
::storeValues($premium, $defaults);
70 * Update the is_active flag in the db.
73 * Id of the database record.
74 * @param bool $is_active
75 * Value we want to set the is_active field.
78 * true if we found and updated the object, else false
80 public static function setIsActive($id, $is_active) {
81 return CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Premium', $id, 'premiums_active ', $is_active);
85 * Delete financial Types.
87 * @param int $premiumID
89 public static function del($premiumID) {
90 $premium = new CRM_Contribute_DAO_Premium();
91 $premium->id
= $premiumID;
96 * Build Premium Block im Contribution Pages.
98 * @param CRM_Core_Form $form
100 * @param bool $formItems
101 * @param int $selectedProductID
102 * @param string $selectedOption
104 public static function buildPremiumBlock(&$form, $pageID, $formItems = FALSE, $selectedProductID = NULL, $selectedOption = NULL) {
105 $form->add('hidden', "selectProduct", $selectedProductID, ['id' => 'selectProduct']);
107 $premiumDao = new CRM_Contribute_DAO_Premium();
108 $premiumDao->entity_table
= 'civicrm_contribution_page';
109 $premiumDao->entity_id
= $pageID;
110 $premiumDao->premiums_active
= 1;
112 if ($premiumDao->find(TRUE)) {
113 $premiumID = $premiumDao->id
;
115 CRM_Core_DAO
::storeValues($premiumDao, $premiumBlock);
117 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, CRM_Core_Action
::ADD
);
118 $addWhere = "financial_type_id IN (0)";
119 if (!empty($financialTypes)) {
120 $addWhere = "financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
122 $addWhere = "{$addWhere} OR financial_type_id IS NULL";
124 $premiumsProductDao = new CRM_Contribute_DAO_PremiumsProduct();
125 $premiumsProductDao->premiums_id
= $premiumID;
126 $premiumsProductDao->whereAdd($addWhere);
127 $premiumsProductDao->orderBy('weight');
128 $premiumsProductDao->find();
131 while ($premiumsProductDao->fetch()) {
132 $productDAO = new CRM_Contribute_DAO_Product();
133 $productDAO->id
= $premiumsProductDao->product_id
;
134 $productDAO->is_active
= 1;
135 if ($productDAO->find(TRUE)) {
136 if ($selectedProductID != NULL) {
137 if ($selectedProductID == $productDAO->id
) {
138 if ($selectedOption) {
139 $productDAO->options
= ts('Selected Option') . ': ' . $selectedOption;
142 $productDAO->options
= NULL;
144 CRM_Core_DAO
::storeValues($productDAO, $products[$productDAO->id
]);
148 CRM_Core_DAO
::storeValues($productDAO, $products[$productDAO->id
]);
151 $options = $temp = [];
152 $temp = explode(',', $productDAO->options
);
153 foreach ($temp as $value) {
154 $options[trim($value)] = trim($value);
156 if ($temp[0] != '') {
157 $form->addElement('select', 'options_' . $productDAO->id
, NULL, $options);
160 if (count($products)) {
161 $form->assign('showPremium', $formItems);
162 $form->assign('showSelectOptions', $formItems);
163 $form->assign('products', $products);
164 $form->assign('premiumBlock', $premiumBlock);
170 * Build Premium B im Contribution Pages.
172 * @param CRM_Core_Form $form
173 * @param int $productID
174 * @param int $premiumProductID
176 public function buildPremiumPreviewBlock($form, $productID, $premiumProductID = NULL) {
177 if ($premiumProductID) {
178 $dao = new CRM_Contribute_DAO_PremiumsProduct();
179 $dao->id
= $premiumProductID;
181 $productID = $dao->product_id
;
183 $productDAO = new CRM_Contribute_DAO_Product();
184 $productDAO->id
= $productID;
185 $productDAO->is_active
= 1;
186 if ($productDAO->find(TRUE)) {
187 CRM_Core_DAO
::storeValues($productDAO, $products[$productDAO->id
]);
190 $radio[$productDAO->id
] = $form->createElement('radio', NULL, NULL, NULL, $productDAO->id
, NULL);
191 $options = $temp = [];
192 $temp = explode(',', $productDAO->options
);
193 foreach ($temp as $value) {
194 $options[$value] = $value;
196 if ($temp[0] != '') {
197 $form->add('select', 'options_' . $productDAO->id
, NULL, $options);
200 $form->addGroup($radio, 'selectProduct', NULL);
202 $form->assign('showRadio', TRUE);
203 $form->assign('showSelectOptions', TRUE);
204 $form->assign('products', $products);
205 $form->assign('preview', TRUE);
209 * Delete premium associated w/ contribution page.
211 * @param int $contributionPageID
213 public static function deletePremium($contributionPageID) {
214 if (!$contributionPageID) {
218 //need to delete entries from civicrm_premiums
219 //as well as from civicrm_premiums_product, CRM-4586
222 'entity_id' => $contributionPageID,
223 'entity_table' => 'civicrm_contribution_page',
226 $premium = new CRM_Contribute_DAO_Premium();
227 $premium->copyValues($params);
229 while ($premium->fetch()) {
230 //lets delete from civicrm_premiums_product
231 $premiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
232 $premiumsProduct->premiums_id
= $premium->id
;
233 $premiumsProduct->delete();
241 * Retrieve premium product and their options.
244 * product and option arrays
246 public static function getPremiumProductInfo() {
247 if (!self
::$productInfo) {
248 $products = $options = [];
250 $dao = new CRM_Contribute_DAO_Product();
254 while ($dao->fetch()) {
255 $products[$dao->id
] = $dao->name
. " ( " . $dao->sku
. " )";
256 $opts = explode(',', $dao->options
);
257 foreach ($opts as $k => $v) {
261 $options[$dao->id
] = $opts;
265 self
::$productInfo = [$products, $options];
267 return self
::$productInfo;