/**
* Get price set details
*
* An array containing price set details (including price fields) is returned
*
* @param int $setId - price set id whose details are needed
* @return array $setTree - array consisting of field details
*/
public static function getSetDetail($setID, $required = true)
{
// create a new tree
$setTree = array();
$select = $from = $where = $orderBy = '';
$priceFields = array('id', 'name', 'label', 'html_type', 'is_enter_qty', 'help_post', 'is_display_amounts', 'options_per_line', 'is_active');
if ($required == true) {
$priceFields[] = 'is_required';
}
// create select
$select = 'SELECT ' . implode(',', $priceFields);
$from = ' FROM civicrm_price_field';
$params = array();
$params[1] = array($setID, 'Integer');
$where = ' WHERE price_set_id = %1';
$where .= ' AND is_active = 1';
$orderBy = ' ORDER BY weight';
$sql = $select . $from . $where . $orderBy;
$dao =& CRM_Core_DAO::executeQuery($sql, $params);
while ($dao->fetch()) {
$fieldID = $dao->id;
$setTree[$setID]['fields'][$fieldID] = array();
$setTree[$setID]['fields'][$fieldID]['id'] = $fieldID;
foreach ($priceFields as $field) {
if ($field == 'id' || is_null($dao->{$field})) {
continue;
}
$setTree[$setID]['fields'][$fieldID][$field] = $dao->{$field};
}
$setTree[$setID]['fields'][$fieldID]['options'] = CRM_Price_BAO_Field::getOptions($fieldID, false);
}
// also get the pre and post help from this price set
$sql = "\nSELECT help_pre, help_post\nFROM civicrm_price_set\nWHERE id = %1";
$dao =& CRM_Core_DAO::executeQuery($sql, $params);
if ($dao->fetch()) {
$setTree[$setID]['help_pre'] = $dao->help_pre;
$setTree[$setID]['help_post'] = $dao->help_post;
}
return $setTree;
}
/**
* This function for building custom fields
*
* @param object $qf form object (reference)
* @param string $elementName name of the custom field
* @param boolean $inactiveNeeded
* @param boolean $useRequired true if required else false
* @param boolean $search true if used for search else false
* @param string $label label for custom field
*
* @access public
* @static
*/
public static function addQuickFormElement(&$qf, $elementName, $fieldId, $inactiveNeeded, $useRequired = true, $label = null, $fieldOptions = null, $feezeOptions = array())
{
require_once 'CRM/Utils/Money.php';
$field = new CRM_Price_DAO_Field();
$field->id = $fieldId;
if (!$field->find(true)) {
/* FIXME: failure! */
return null;
}
$config = CRM_Core_Config::singleton();
$qf->assign('currencySymbol', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Currency', $config->defaultCurrency, 'symbol', 'name'));
if (!isset($label)) {
$label = $field->label;
}
if (isset($qf->_online) && $qf->_online) {
$useRequired = false;
}
$customOption = $fieldOptions;
if (!is_array($customOption)) {
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
}
//use value field.
$valueFieldName = 'amount';
$seperator = '|';
switch ($field->html_type) {
case 'Text':
$optionKey = key($customOption);
$count = CRM_Utils_Array::value('count', $customOption[$optionKey], '');
$max_value = CRM_Utils_Array::value('max_value', $customOption[$optionKey], '');
$priceVal = implode($seperator, array($customOption[$optionKey][$valueFieldName], $count, $max_value));
//check for label.
if (CRM_Utils_Array::value('label', $fieldOptions[$optionKey])) {
$label = $fieldOptions[$optionKey]['label'];
}
if ($field->is_display_amounts) {
$label .= ' - ';
$label .= CRM_Utils_Money::format(CRM_Utils_Array::value($valueFieldName, $customOption[$optionKey]));
}
$element =& $qf->add('text', $elementName, $label, array_merge(array('size' => "4"), array('price' => json_encode(array($optionKey, $priceVal)))), $useRequired && $field->is_required);
// CRM-6902
if (in_array($optionKey, $feezeOptions)) {
$element->freeze();
}
// integers will have numeric rule applied to them.
$qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'positiveInteger');
break;
case 'Radio':
$choice = array();
foreach ($customOption as $opId => $opt) {
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
$choice[$opId] = $qf->createElement('radio', null, '', $opt['label'], $opt['id'], array('price' => json_encode(array($elementName, $priceVal))));
// CRM-6902
if (in_array($opId, $feezeOptions)) {
$choice[$opId]->freeze();
}
}
if (!$field->is_required) {
// add "none" option
$choice[] = $qf->createElement('radio', null, '', '-none-', '0', array('price' => json_encode(array($elementName, "0"))));
}
$element =& $qf->addGroup($choice, $elementName, $label);
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
case 'Select':
$selectOption = $allowedOptions = $priceVal = array();
foreach ($customOption as $opt) {
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal[$opt['id']] = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$selectOption[$opt['id']] = $opt['label'];
if (!in_array($opt['id'], $feezeOptions)) {
$allowedOptions[] = $opt['id'];
}
}
$element =& $qf->add('select', $elementName, $label, array('' => ts('- select -')) + $selectOption, $useRequired && $field->is_required, array('price' => json_encode($priceVal)));
// CRM-6902
$button = substr($qf->controller->getButtonName(), -4);
if (!empty($feezeOptions) && $button != 'skip') {
$qf->addRule($elementName, ts('Participant count for this option is full.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
}
break;
case 'CheckBox':
$check = array();
foreach ($customOption as $opId => $opt) {
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$check[$opId] =& $qf->createElement('checkbox', $opt['id'], null, $opt['label'], array('price' => json_encode(array($opt['id'], $priceVal))));
// CRM-6902
if (in_array($opId, $feezeOptions)) {
$check[$opId]->freeze();
}
}
$element =& $qf->addGroup($check, $elementName, $label);
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
}
if (isset($qf->_online) && $qf->_online) {
$element->freeze();
}
}
/**
* This function for building custom fields
*
* @param object $qf form object (reference)
* @param string $elementName name of the custom field
* @param boolean $inactiveNeeded
* @param boolean $useRequired true if required else false
* @param boolean $search true if used for search else false
* @param string $label label for custom field
*
* @access public
* @static
*/
public static function addQuickFormElement(&$qf, $elementName, $fieldId, $inactiveNeeded, $useRequired = TRUE, $label = NULL, $fieldOptions = NULL, $feezeOptions = array())
{
$field = new CRM_Price_DAO_Field();
$field->id = $fieldId;
if (!$field->find(TRUE)) {
/* FIXME: failure! */
return NULL;
}
$otherAmount = $qf->get('values');
$config = CRM_Core_Config::singleton();
$qf->assign('currencySymbol', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Currency', $config->defaultCurrency, 'symbol', 'name'));
// get currency name for price field and option attributes
$currencyName = $config->defaultCurrency;
if (!isset($label)) {
$label = property_exists($qf, '_membershipBlock') && CRM_Utils_Array::value('is_separate_payment', $qf->_membershipBlock) && $field->name == 'contribution_amount' && !CRM_Utils_Array::value('is_allow_other_amount', $otherAmount) ? ts('Additional Contribution') : $field->label;
}
if ($field->name == 'contribution_amount') {
$qf->_contributionAmount = 1;
}
if (isset($qf->_online) && $qf->_online) {
$useRequired = FALSE;
}
$customOption = $fieldOptions;
if (!is_array($customOption)) {
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
}
//use value field.
$valueFieldName = 'amount';
$seperator = '|';
switch ($field->html_type) {
case 'Text':
$optionKey = key($customOption);
$count = CRM_Utils_Array::value('count', $customOption[$optionKey], '');
$max_value = CRM_Utils_Array::value('max_value', $customOption[$optionKey], '');
$priceVal = implode($seperator, array($customOption[$optionKey][$valueFieldName], $count, $max_value));
$extra = array();
if (property_exists($qf, '_quickConfig') && $qf->_quickConfig && property_exists($qf, '_contributionAmount') && $qf->_contributionAmount) {
$qf->assign('priceset', $elementName);
$extra = array('onclick' => 'useAmountOther();');
}
// if seperate membership payment is used with quick config priceset then change the other amount label
if (property_exists($qf, '_membershipBlock') && CRM_Utils_Array::value('is_separate_payment', $qf->_membershipBlock) && $qf->_quickConfig && $field->name == 'other_amount' && !property_exists($qf, '_contributionAmount')) {
$label = ts('Additional Contribution');
$useRequired = 0;
} elseif (CRM_Utils_Array::value('label', $fieldOptions[$optionKey])) {
//check for label.
$label = $fieldOptions[$optionKey]['label'];
}
if ($field->is_display_amounts) {
$label .= ' - ';
$label .= CRM_Utils_Money::format(CRM_Utils_Array::value($valueFieldName, $customOption[$optionKey]));
}
$element =& $qf->add('text', $elementName, $label, array_merge($extra, array('price' => json_encode(array($optionKey, $priceVal)), 'size' => '4')), $useRequired && $field->is_required);
// CRM-6902
if (in_array($optionKey, $feezeOptions)) {
$element->freeze();
}
//CRM-10117
if (property_exists($qf, '_quickConfig') && $qf->_quickConfig) {
$message = ts("Please enter a valid amount.");
$type = "money";
} else {
$message = ts('%1 must be an integer (whole number).', array(1 => $label));
$type = "positiveInteger";
}
// integers will have numeric rule applied to them.
$qf->addRule($elementName, $message, $type);
break;
case 'Radio':
$choice = array();
if (property_exists($qf, '_quickConfig') && $qf->_quickConfig && property_exists($qf, '_contributionAmount') && $qf->_contributionAmount) {
$qf->assign('contriPriceset', $elementName);
}
foreach ($customOption as $opId => $opt) {
if ($field->is_display_amounts) {
$opt['label'] = CRM_Utils_Array::value('label', $opt) ? $opt['label'] . ' - ' : '';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
$extra = array('price' => json_encode(array($elementName, $priceVal)), 'data-amount' => $opt[$valueFieldName], 'data-currency' => $currencyName);
if (property_exists($qf, '_quickConfig') && $qf->_quickConfig && $field->name == 'contribution_amount') {
$extra += array('onclick' => 'clearAmountOther();');
} elseif (property_exists($qf, '_quickConfig') && $qf->_quickConfig && $field->name == 'membership_amount') {
$extra += array('onclick' => "return showHideAutoRenew({$opt['membership_type_id']});", 'membership-type' => $opt['membership_type_id']);
$qf->assign('membershipFieldID', $field->id);
}
$choice[$opId] = $qf->createElement('radio', NULL, '', $opt['label'], $opt['id'], $extra);
// CRM-6902
if (in_array($opId, $feezeOptions)) {
$choice[$opId]->freeze();
}
}
if (property_exists($qf, '_membershipBlock') && CRM_Utils_Array::value('is_separate_payment', $qf->_membershipBlock) && $field->name == 'contribution_amount') {
$choice[] = $qf->createElement('radio', NULL, '', 'No thank you', '-1', array('onclick' => 'clearAmountOther();'));
}
if (!$field->is_required) {
// add "none" option
if (CRM_Utils_Array::value('is_allow_other_amount', $otherAmount) && $field->name == 'contribution_amount') {
$none = ts('Other Amount');
} elseif (property_exists($qf, '_membershipBlock') && !CRM_Utils_Array::value('is_required', $qf->_membershipBlock) && $field->name == 'membership_amount') {
$none = ts('No thank you');
} else {
$none = ts('-none-');
}
$choice[] = $qf->createElement('radio', NULL, '', $none, '0', array('price' => json_encode(array($elementName, "0"))));
}
$element =& $qf->addGroup($choice, $elementName, $label);
// make contribution field required for quick config when membership block is enabled
if (($field->name == 'contribution_amount' || $field->name == 'membership_amount') && property_exists($qf, '_membershipBlock') && !empty($qf->_membershipBlock) && !$field->is_required) {
$useRequired = $field->is_required = TRUE;
}
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
case 'Select':
$selectOption = $allowedOptions = $priceVal = array();
foreach ($customOption as $opt) {
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal[$opt['id']] = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$selectOption[$opt['id']] = $opt['label'];
if (!in_array($opt['id'], $feezeOptions)) {
$allowedOptions[] = $opt['id'];
}
}
$element =& $qf->add('select', $elementName, $label, array('' => ts('- select -')) + $selectOption, $useRequired && $field->is_required, array('price' => json_encode($priceVal)));
// CRM-6902
$button = substr($qf->controller->getButtonName(), -4);
if (!empty($feezeOptions) && $button != 'skip') {
$qf->addRule($elementName, ts('Sorry, this option is currently sold out.'), 'regex', "/" . implode('|', $allowedOptions) . "/");
}
break;
case 'CheckBox':
$check = array();
foreach ($customOption as $opId => $opt) {
$count = CRM_Utils_Array::value('count', $opt, '');
$max_value = CRM_Utils_Array::value('max_value', $opt, '');
$priceVal = implode($seperator, array($opt[$valueFieldName], $count, $max_value));
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$check[$opId] =& $qf->createElement('checkbox', $opt['id'], NULL, $opt['label'], array('price' => json_encode(array($opt['id'], $priceVal)), 'data-amount' => $opt[$valueFieldName], 'data-currency' => $currencyName));
// CRM-6902
if (in_array($opId, $feezeOptions)) {
$check[$opId]->freeze();
}
}
$element =& $qf->addGroup($check, $elementName, $label);
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
}
if (isset($qf->_online) && $qf->_online) {
$element->freeze();
}
}
/**
* Get price set details
*
* An array containing price set details (including price fields) is returned
*
* @param int $setId - price set id whose details are needed
*
* @return array $setTree - array consisting of field details
*/
public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE)
{
// create a new tree
$setTree = array();
$select = $from = $where = $orderBy = '';
$priceFields = array('id', 'name', 'label', 'html_type', 'is_enter_qty', 'help_pre', 'help_post', 'weight', 'is_display_amounts', 'options_per_line', 'is_active', 'active_on', 'expire_on', 'javascript', 'visibility_id', 'is_required');
if ($required == TRUE) {
$priceFields[] = 'is_required';
}
// create select
$select = 'SELECT ' . implode(',', $priceFields);
$from = ' FROM civicrm_price_field';
$params = array();
$params[1] = array($setID, 'Integer');
$where = '
WHERE price_set_id = %1
AND is_active = 1
';
$dateSelect = '';
if ($validOnly) {
$currentTime = date('YmdHis');
$dateSelect = "\nAND ( active_on IS NULL OR active_on <= {$currentTime} )\nAND ( expire_on IS NULL OR expire_on >= {$currentTime} )\n";
}
$orderBy = ' ORDER BY weight';
$sql = $select . $from . $where . $dateSelect . $orderBy;
$dao = CRM_Core_DAO::executeQuery($sql, $params);
$visibility = CRM_Core_PseudoConstant::visibility('name');
while ($dao->fetch()) {
$fieldID = $dao->id;
$setTree[$setID]['fields'][$fieldID] = array();
$setTree[$setID]['fields'][$fieldID]['id'] = $fieldID;
foreach ($priceFields as $field) {
if ($field == 'id' || is_null($dao->{$field})) {
continue;
}
if ($field == 'visibility_id') {
$setTree[$setID]['fields'][$fieldID]['visibility'] = $visibility[$dao->{$field}];
}
$setTree[$setID]['fields'][$fieldID][$field] = $dao->{$field};
}
$setTree[$setID]['fields'][$fieldID]['options'] = CRM_Price_BAO_Field::getOptions($fieldID, FALSE);
}
// also get the pre and post help from this price set
$sql = "\nSELECT extends, contribution_type_id, help_pre, help_post, is_quick_config\nFROM civicrm_price_set\nWHERE id = %1";
$dao = CRM_Core_DAO::executeQuery($sql, $params);
if ($dao->fetch()) {
$setTree[$setID]['extends'] = $dao->extends;
$setTree[$setID]['contribution_type_id'] = $dao->contribution_type_id;
$setTree[$setID]['help_pre'] = $dao->help_pre;
$setTree[$setID]['help_post'] = $dao->help_post;
$setTree[$setID]['is_quick_config'] = $dao->is_quick_config;
}
return $setTree;
}
/**
* This function for building custom fields
*
* @param object $qf form object (reference)
* @param string $elementName name of the custom field
* @param boolean $inactiveNeeded
* @param boolean $useRequired true if required else false
* @param boolean $search true if used for search else false
* @param string $label label for custom field
*
* @access public
* @static
*/
public static function addQuickFormElement(&$qf, $elementName, $fieldId, $inactiveNeeded, $useRequired = true, $label = null)
{
require_once 'CRM/Utils/Money.php';
$field =& new CRM_Price_DAO_Field();
$field->id = $fieldId;
if (!$field->find(true)) {
/* FIXME: failure! */
return null;
}
$config =& CRM_Core_Config::singleton();
$qf->assign('currencySymbol', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Currency', $config->defaultCurrency, 'symbol', 'name'));
if (!isset($label)) {
$label = $field->label;
}
if (isset($qf->_online) && $qf->_online) {
$useRequired = false;
}
//use value field.
$valueFieldName = 'value';
switch ($field->html_type) {
case 'Text':
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
// text fields only have one option
$optionKey = key($customOption);
if ($field->is_display_amounts) {
$label .= ' - ';
$label .= CRM_Utils_Money::format(CRM_Utils_Array::value($valueFieldName, $customOption[$optionKey]));
}
$element =& $qf->add('text', $elementName, $label, array_merge(array('size' => "4"), array('price' => json_encode(array($optionKey, $customOption[$optionKey][$valueFieldName])))), $useRequired && $field->is_required);
// integers will have numeric rule applied to them.
$qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'positiveInteger');
break;
case 'Radio':
$choice = array();
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
if (!$field->is_required) {
// add "none" option
$choice[] = $qf->createElement('radio', null, '', '-none-', '0', array('price' => json_encode(array($elementName, "0"))));
}
foreach ($customOption as $opt) {
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$choice[] = $qf->createElement('radio', null, '', $opt['label'], $opt['id'], array('price' => json_encode(array($elementName, $opt[$valueFieldName]))));
}
$element =& $qf->addGroup($choice, $elementName, $label);
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
case 'Select':
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
$selectOption = array();
foreach ($customOption as $opt) {
$amount[$opt['id']] = $opt[$valueFieldName];
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$selectOption[$opt['id']] = $opt['label'];
}
$element =& $qf->add('select', $elementName, $label, array('' => ts('- select -')) + $selectOption, $useRequired && $field->is_required, array('price' => json_encode($amount)));
break;
case 'CheckBox':
$customOption = CRM_Price_BAO_Field::getOptions($field->id, $inactiveNeeded);
$check = array();
foreach ($customOption as $opt) {
if ($field->is_display_amounts) {
$opt['label'] .= ' - ';
$opt['label'] .= CRM_Utils_Money::format($opt[$valueFieldName]);
}
$check[] =& $qf->createElement('checkbox', $opt['id'], null, $opt['label'], array('price' => json_encode(array($opt['id'], $opt[$valueFieldName]))));
}
$element =& $qf->addGroup($check, $elementName, $label);
if ($useRequired && $field->is_required) {
$qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
}
break;
}
if (isset($qf->_online) && $qf->_online) {
$element->freeze();
}
}
