3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * Business objects for managing price fields.
40 class CRM_Price_BAO_PriceField
extends CRM_Price_DAO_PriceField
{
45 * takes an associative array and creates a price field object
47 * the function extract all the params it needs to initialize the create a
48 * price field object. the params array could contain additional unused name/value
51 * @param array $params (reference ) an assoc array of name/value pairs
53 * @internal param array $ids the array that holds all the db ids
55 * @return object CRM_Price_BAO_PriceField object
59 static function &add(&$params) {
60 $priceFieldBAO = new CRM_Price_BAO_PriceField();
62 $priceFieldBAO->copyValues($params);
64 if ($id = CRM_Utils_Array
::value('id', $params)) {
65 $priceFieldBAO->id
= $id;
68 $priceFieldBAO->save();
69 return $priceFieldBAO;
73 * takes an associative array and creates a price field object
75 * This function is invoked from within the web form layer and also from the api layer
77 * @param array $params (reference) an assoc array of name/value pairs
79 * @return object CRM_Price_DAO_PriceField object
83 static function create(&$params) {
84 $transaction = new CRM_Core_Transaction();
86 $priceField = self
::add($params);
88 if (is_a($priceField, 'CRM_Core_Error')) {
89 $transaction->rollback();
93 $options = $optionsIds = array();
94 $maxIndex = CRM_Price_Form_Field
::NUM_OPTION
;
96 if ($priceField->html_type
== 'Text') {
99 $fieldValue = new CRM_Price_DAO_PriceFieldValue();
100 $fieldValue->price_field_id
= $priceField->id
;
102 // update previous field values( if any )
103 if ($fieldValue->find(TRUE)) {
104 $optionsIds['id'] = $fieldValue->id
;
107 $defaultArray = array();
108 if ($params['html_type'] == 'CheckBox' && isset($params['default_checkbox_option'])) {
109 $tempArray = array_keys($params['default_checkbox_option']);
110 foreach ($tempArray as $v) {
111 if ($params['option_amount'][$v]) {
112 $defaultArray[$v] = 1;
117 if (!empty($params['default_option'])) {
118 $defaultArray[$params['default_option']] = 1;
122 for ($index = 1; $index <= $maxIndex; $index++
) {
123 if (array_key_exists('option_amount', $params) &&
124 array_key_exists($index, $params['option_amount']) &&
125 (CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_label', $params)) ||
!empty($params['is_quick_config'])) &&
126 !CRM_Utils_System
::isNull($params['option_amount'][$index])
129 'price_field_id' => $priceField->id
,
130 'label' => trim($params['option_label'][$index]),
131 'name' => CRM_Utils_String
::munge($params['option_label'][$index], '_', 64),
132 'amount' => CRM_Utils_Rule
::cleanMoney(trim($params['option_amount'][$index])),
133 'count' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_count', $params), NULL),
134 'max_value' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_max_value', $params), NULL),
135 'description' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('option_description', $params), NULL),
136 'membership_type_id' => CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_type_id', $params), NULL),
137 'weight' => $params['option_weight'][$index],
139 'is_default' => CRM_Utils_Array
::value($params['option_weight'][$index], $defaultArray) ?
$defaultArray[$params['option_weight'][$index]] : 0,
140 'membership_num_terms' => NULL,
143 if ($options['membership_type_id']) {
144 $options['membership_num_terms'] = CRM_Utils_Array
::value($index, CRM_Utils_Array
::value('membership_num_terms', $params), 1);
147 if (CRM_Utils_Array
::value( $index, CRM_Utils_Array
::value('option_financial_type_id', $params))) {
148 $options['financial_type_id'] = $params['option_financial_type_id'][$index];
149 } elseif (!empty($params['financial_type_id'])) {
150 $options['financial_type_id'] = $params['financial_type_id'];
153 if ($opIds = CRM_Utils_Array
::value('option_id', $params)) {
154 if ($opId = CRM_Utils_Array
::value($index, $opIds)) {
155 $optionsIds['id'] = $opId;
157 $optionsIds['id'] = NULL;
160 CRM_Price_BAO_PriceFieldValue
::create($options, $optionsIds);
164 $transaction->commit();
169 * Takes a bunch of params that are needed to match certain criteria and
170 * retrieves the relevant objects. Typically the valid params are only
171 * contact_id. We'll tweak this function to be more full featured over a period
172 * of time. This is the inverse function of create. It also stores all the retrieved
173 * values in the default array
175 * @param array $params (reference ) an assoc array of name/value pairs
176 * @param array $defaults (reference ) an assoc array to hold the flattened values
178 * @return object CRM_Price_DAO_PriceField object
182 static function retrieve(&$params, &$defaults) {
183 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceField', $params, $defaults);
187 * update the is_active flag in the db
189 * @param int $id Id of the database record
190 * @param boolean $is_active Value we want to set the is_active field
192 * @return Object DAO object on sucess, null otherwise
197 static function setIsActive($id, $is_active) {
198 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active);
202 * Get the field title.
204 * @param int $id id of field.
206 * @return string name
212 public static function getTitle($id) {
213 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $id, 'label');
217 * This function for building custom fields
219 * @param object $qf form object (reference)
220 * @param string $elementName name of the custom field
222 * @param boolean $inactiveNeeded
223 * @param boolean $useRequired true if required else false
224 * @param string $label label for custom field
226 * @param null $fieldOptions
227 * @param array $feezeOptions
230 * @internal param bool $search true if used for search else false
234 public static function addQuickFormElement(&$qf,
240 $fieldOptions = NULL,
241 $feezeOptions = array()
244 $field = new CRM_Price_DAO_PriceField();
245 $field->id
= $fieldId;
246 if (!$field->find(TRUE)) {
247 /* FIXME: failure! */
252 if (isset($qf->_mode
) && empty($qf->_mode
)) {
255 elseif (isset($qf->_values
)) {
256 $is_pay_later = CRM_Utils_Array
::value( 'is_pay_later', $qf->_values
);
259 $otherAmount = $qf->get('values');
260 $config = CRM_Core_Config
::singleton();
261 $currencySymbol = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_Currency',$config->defaultCurrency
,'symbol','name');
262 $qf->assign('currencySymbol', $currencySymbol);
263 // get currency name for price field and option attributes
264 $currencyName = $config->defaultCurrency
;
266 if (!isset($label)) {
267 $label = (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') ?
ts('Additional Contribution') : $field->label
;
270 if ($field->name
== 'contribution_amount') {
271 $qf->_contributionAmount
= 1;
274 if (isset($qf->_online
) && $qf->_online
) {
275 $useRequired = FALSE;
278 $customOption = $fieldOptions;
279 if (!is_array($customOption)) {
280 $customOption = CRM_Price_BAO_PriceField
::getOptions($field->id
, $inactiveNeeded);
284 $valueFieldName = 'amount';
286 switch ($field->html_type
) {
288 $optionKey = key($customOption);
289 $count = CRM_Utils_Array
::value('count', $customOption[$optionKey], '');
290 $max_value = CRM_Utils_Array
::value('max_value', $customOption[$optionKey], '');
291 $priceVal = implode($seperator, array($customOption[$optionKey][$valueFieldName], $count, $max_value));
294 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
)) {
295 foreach($fieldOptions as &$fieldOption) {
296 if ($fieldOption['name'] == 'other_amount') {
297 $fieldOption['label'] = $fieldOption['label'] . ' ' . $currencySymbol;
300 $qf->assign('priceset', $elementName);
301 $extra = array('onclick' => 'useAmountOther();');
304 if (!empty($qf->_membershipBlock
) && !empty($qf->_quickConfig
) && $field->name
== 'other_amount' && empty($qf->_contributionAmount
)) {
307 elseif (!empty($fieldOptions[$optionKey]['label'])) { //check for label.
308 $label = $fieldOptions[$optionKey]['label'];
311 $element = &$qf->add('text', $elementName, $label,
313 array('price' => json_encode(array($optionKey, $priceVal)),
317 $useRequired && $field->is_required
320 $qf->add( 'text', 'txt-'.$elementName, $label, array( 'size' => '4'));
324 if (in_array($optionKey, $feezeOptions)) {
329 if (!empty($qf->_quickConfig
)) {
330 $message = ts('Please enter a valid amount.');
334 $message = ts('%1 must be an integer (whole number).', array(1 => $label));
335 $type = 'positiveInteger';
337 // integers will have numeric rule applied to them.
338 $qf->addRule($elementName, $message, $type);
344 if (!empty($qf->_quickConfig
) && !empty($qf->_contributionAmount
)) {
345 $qf->assign('contriPriceset', $elementName);
348 foreach ($customOption as $opId => $opt) {
349 if ($field->is_display_amounts
) {
350 $opt['label'] = !empty($opt['label']) ?
$opt['label'] : '';
351 $opt['label'] = '<span class="crm-price-amount-amount">' . CRM_Utils_Money
::format($opt[$valueFieldName]) . '</span> <span class="crm-price-amount-label">' . $opt['label'] . '</span>';
353 $count = CRM_Utils_Array
::value('count', $opt, '');
354 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
355 $priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
356 $extra = array('price' => json_encode(array($elementName, $priceVal)),
357 'data-amount' => $opt[$valueFieldName],
358 'data-currency' => $currencyName,
360 if (!empty($qf->_quickConfig
) && $field->name
== 'contribution_amount') {
361 $extra +
= array('onclick' => 'clearAmountOther();');
363 elseif (!empty($qf->_quickConfig
) && $field->name
== 'membership_amount') {
365 'onclick' => "return showHideAutoRenew({$opt['membership_type_id']});",
366 'membership-type' => $opt['membership_type_id'],
368 $qf->assign('membershipFieldID',$field->id
);
371 $choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
374 $qf->add( 'text', 'txt-'.$elementName, $label, array( 'size' => '4'));
378 if (in_array($opId, $feezeOptions)) {
379 $choice[$opId]->freeze();
382 if (!empty($qf->_membershipBlock
) && $field->name
== 'contribution_amount') {
383 $choice[] = $qf->createElement('radio', NULL, '', ts('No thank you'), '-1',
385 'onclick' => 'clearAmountOther();',
390 if (!$field->is_required
) {
392 if (!empty($otherAmount['is_allow_other_amount']) && $field->name
== 'contribution_amount') {
393 $none = ts('Other Amount');
395 elseif (!empty($qf->_membershipBlock
) && empty($qf->_membershipBlock
['is_required']) && $field->name
== 'membership_amount') {
396 $none = ts('No thank you');
399 $none = ts('- none -');
402 $choice[] = $qf->createElement('radio', NULL, '', $none, '0',
403 array('price' => json_encode(array($elementName, '0')))
407 $element = &$qf->addGroup($choice, $elementName, $label);
409 // make contribution field required for quick config when membership block is enabled
410 if (($field->name
== 'membership_amount' ||
$field->name
== 'contribution_amount')
411 && !empty($qf->_membershipBlock
) && !$field->is_required
) {
412 $useRequired = $field->is_required
= TRUE;
415 if ($useRequired && $field->is_required
) {
416 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
421 $selectOption = $allowedOptions = $priceVal = array();
423 foreach ($customOption as $opt) {
424 $count = CRM_Utils_Array
::value('count', $opt, '');
425 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
426 $priceVal[$opt['id']] = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
428 if ($field->is_display_amounts
) {
429 $opt['label'] .= ' - ';
430 $opt['label'] .= CRM_Utils_Money
::format($opt[$valueFieldName]);
432 $selectOption[$opt['id']] = $opt['label'];
434 if (!in_array($opt['id'], $feezeOptions)) {
435 $allowedOptions[] = $opt['id'];
438 $qf->add( 'text', 'txt-'.$elementName, $label, array( 'size' => '4'));
441 $element = &$qf->add('select', $elementName, $label,
443 '' => ts('- select -')) +
$selectOption,
444 $useRequired && $field->is_required
,
445 array('price' => json_encode($priceVal))
449 $button = substr($qf->controller
->getButtonName(), -4);
450 if (!empty($feezeOptions) && $button != 'skip') {
451 $qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
458 foreach ($customOption as $opId => $opt) {
459 $count = CRM_Utils_Array
::value('count', $opt, '');
460 $max_value = CRM_Utils_Array
::value('max_value', $opt, '');
461 $priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
463 if ($field->is_display_amounts
) {
464 $opt['label'] .= ' - ';
465 $opt['label'] .= CRM_Utils_Money
::format($opt[$valueFieldName]);
467 $check[$opId] = &$qf->createElement('checkbox', $opt['id'], NULL, $opt['label'],
468 array('price' => json_encode(array($opt['id'], $priceVal)),
469 'data-amount' => $opt[$valueFieldName],
470 'data-currency' => $currencyName,
474 $txtcheck[$opId] =& $qf->createElement( 'text', $opId, $opt['label'], array( 'size' => '4' ) );
475 $qf->addGroup($txtcheck, 'txt-'.$elementName, $label);
478 if (in_array($opId, $feezeOptions)) {
479 $check[$opId]->freeze();
482 $element = &$qf->addGroup($check, $elementName, $label);
483 if ($useRequired && $field->is_required
) {
484 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
488 if (isset($qf->_online
) && $qf->_online
) {
494 * Retrieve a list of options for the specified field
496 * @param int $fieldId price field ID
497 * @param bool $inactiveNeeded include inactive options
498 * @param bool $reset ignore stored values\
500 * @return array array of options
502 public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE) {
503 static $options = array();
505 if ($reset ||
empty($options[$fieldId])) {
507 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $values, 'weight', !$inactiveNeeded);
508 $options[$fieldId] = $values;
511 return $options[$fieldId];
514 public static function getOptionId($optionLabel, $fid) {
515 if (!$optionLabel ||
!$fid) {
519 $optionGroupName = "civicrm_price_field.amount.{$fid}";
523 option_value.id as id
525 civicrm_option_value option_value,
526 civicrm_option_group option_group
528 option_group.name = %1
529 AND option_group.id = option_value.option_group_id
530 AND option_value.label = %2";
532 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($optionGroupName, 'String'), 2 => array($optionLabel, 'String')));
534 while ($dao->fetch()) {
540 * Delete the price set field.
542 * @param int $id Field Id
550 public static function deleteField($id) {
551 $field = new CRM_Price_DAO_PriceField();
554 if ($field->find(TRUE)) {
555 // delete the options for this field
556 CRM_Price_BAO_PriceFieldValue
::deleteValues($id);
558 // reorder the weight before delete
559 $fieldValues = array('price_set_id' => $field->price_set_id
);
561 CRM_Utils_Weight
::delWeight('CRM_Price_DAO_PriceField', $field->id
, $fieldValues);
563 // now delete the field
564 return $field->delete();
570 static function &htmlTypes() {
571 static $htmlTypes = NULL;
574 'Text' => ts('Text / Numeric Quantity'),
575 'Select' => ts('Select'),
576 'Radio' => ts('Radio'),
577 'CheckBox' => ts('CheckBox'),
584 * Validate the priceset
586 * @param int $priceSetId, array $fields
588 * retrun the error string
595 public static function priceSetValidation($priceSetId, $fields, &$error, $allowNoneSelection = FALSE) {
596 // check for at least one positive
597 // amount price field should be selected.
598 $priceField = new CRM_Price_DAO_PriceField();
599 $priceField->price_set_id
= $priceSetId;
602 $priceFields = array();
604 if ($allowNoneSelection) {
605 $noneSelectedPriceFields = array();
608 while ($priceField->fetch()) {
609 $key = "price_{$priceField->id}";
611 if ($allowNoneSelection) {
612 if (array_key_exists($key, $fields)) {
613 if ($fields[$key] == 0 && !$priceField->is_required
) {
614 $noneSelectedPriceFields[] = $priceField->id
;
619 if (!empty($fields[$key])) {
620 $priceFields[$priceField->id
] = $fields[$key];
624 if (!empty($priceFields)) {
625 // we should has to have positive amount.
628 FROM civicrm_price_field
629 WHERE id IN (" . implode(',', array_keys($priceFields)) . ')';
630 $fieldDAO = CRM_Core_DAO
::executeQuery($sql);
631 $htmlTypes = array();
632 while ($fieldDAO->fetch()) {
633 $htmlTypes[$fieldDAO->id
] = $fieldDAO->html_type
;
636 $selectedAmounts = array();
638 foreach ($htmlTypes as $fieldId => $type) {
640 CRM_Price_BAO_PriceFieldValue
::getValues($fieldId, $options);
642 if (empty($options)) {
646 if ($type == 'Text') {
647 foreach ($options as $opId => $option) {
648 $selectedAmounts[$opId] = $priceFields[$fieldId] * $option['amount'];
652 elseif (is_array($fields["price_{$fieldId}"])) {
653 foreach (array_keys($fields["price_{$fieldId}"]) as $opId) {
654 $selectedAmounts[$opId] = $options[$opId]['amount'];
657 elseif (in_array($fields["price_{$fieldId}"], array_keys($options))) {
658 $selectedAmounts[$fields["price_{$fieldId}"]] = $options[$fields["price_{$fieldId}"]]['amount'];
662 list($componentName) = explode(':', $fields['_qf_default']);
663 // now we have all selected amount in hand.
664 $totalAmount = array_sum($selectedAmounts);
665 if ($totalAmount < 0) {
666 $error['_qf_default'] = ts('%1 amount can not be less than zero. Please select the options accordingly.', array(1 => $componentName));
670 if ($allowNoneSelection) {
671 if (empty($noneSelectedPriceFields)) {
672 $error['_qf_default'] = ts('Please select at least one option from price set.');
675 $error['_qf_default'] = ts('Please select at least one option from price set.');