/**
* Get the values of all option values given an option group ID. Store in system cache
* Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve
* from memory
*
* @param int $optionGroupID
* The option group for which we want the values from.
*
* @return array
* an array of array of values for this option group
*/
public static function getOptionValuesArray($optionGroupID)
{
// check if we can get the field values from the system cache
$cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}";
$cache = CRM_Utils_Cache::singleton();
$optionValues = $cache->get($cacheKey);
if (empty($optionValues)) {
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = $optionGroupID;
$dao->orderBy('weight ASC, label ASC');
$dao->find();
$optionValues = array();
while ($dao->fetch()) {
$optionValues[$dao->id] = array();
CRM_Core_DAO::storeValues($dao, $optionValues[$dao->id]);
}
$cache->set($cacheKey, $optionValues);
}
return $optionValues;
}
/**
* Retrieve list of Label Formats.
*
* @param bool $namesOnly return simple list of names
* @param string $groupName group name of the label format option group
*
* @return array (reference) label format list
* @static
* @access public
*/
static function &getList($namesOnly = FALSE, $groupName = 'label_format')
{
static $list = array();
if (self::_getGid($groupName)) {
// get saved label formats from Option Value table
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = self::_getGid($groupName);
$dao->is_active = 1;
$dao->orderBy('weight');
$dao->find();
while ($dao->fetch()) {
if ($namesOnly) {
$list[$groupName][$dao->name] = $dao->label;
} else {
CRM_Core_DAO::storeValues($dao, $list[$groupName][$dao->id]);
}
}
}
return $list[$groupName];
}
/**
* Get list of PDF Page Formats.
*
* @param bool $namesOnly
* Return simple list of names.
*
* @return array
* (reference) PDF Page Format list
*/
public static function &getList($namesOnly = FALSE)
{
static $list = array();
if (self::_getGid()) {
// get saved PDF Page Formats from Option Value table
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = self::_getGid();
$dao->is_active = 1;
$dao->orderBy('weight');
$dao->find();
while ($dao->fetch()) {
if ($namesOnly) {
$list[$dao->id] = $dao->name;
} else {
CRM_Core_DAO::storeValues($dao, $list[$dao->id]);
}
}
}
return $list;
}
/**
* Return option-values of a particular group
*
* @param array $groupParams
* Array containing group fields whose option-values is to retrieved.
* @param array $links
* Has links like edit, delete, disable ..etc.
* @param string $orderBy
* For orderBy clause.
*
* @return array
* Array of option-values
*
*/
public static function getRows($groupParams, $links, $orderBy = 'weight')
{
$optionValue = array();
$optionGroupID = NULL;
if (!isset($groupParams['id']) || !$groupParams['id']) {
if ($groupParams['name']) {
$config = CRM_Core_Config::singleton();
$optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $dnc);
$optionGroupID = $optionGroup->id;
}
} else {
$optionGroupID = $groupParams['id'];
}
$groupName = CRM_Utils_Array::value('name', $groupParams);
if (!$groupName && $optionGroupID) {
$groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $optionGroupID, 'name', 'id');
}
$dao = new CRM_Core_DAO_OptionValue();
if ($optionGroupID) {
$dao->option_group_id = $optionGroupID;
if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) {
$dao->domain_id = CRM_Core_Config::domainID();
}
$dao->orderBy($orderBy);
$dao->find();
}
if ($groupName == 'case_type') {
$caseTypeIds = CRM_Case_BAO_Case::getUsedCaseType();
} elseif ($groupName == 'case_status') {
$caseStatusIds = CRM_Case_BAO_Case::getUsedCaseStatuses();
}
$componentNames = CRM_Core_Component::getNames();
$visibilityLabels = CRM_Core_PseudoConstant::visibility();
while ($dao->fetch()) {
$optionValue[$dao->id] = array();
CRM_Core_DAO::storeValues($dao, $optionValue[$dao->id]);
// form all action links
$action = array_sum(array_keys($links));
// update enable/disable links depending on if it is is_reserved or is_active
if ($dao->is_reserved) {
$action = CRM_Core_Action::UPDATE;
} else {
if ($dao->is_active) {
$action -= CRM_Core_Action::ENABLE;
} else {
$action -= CRM_Core_Action::DISABLE;
}
if ($groupName == 'case_type' && in_array($dao->value, $caseTypeIds) || $groupName == 'case_status' && in_array($dao->value, $caseStatusIds)) {
$action -= CRM_Core_Action::DELETE;
}
}
$optionValue[$dao->id]['label'] = htmlspecialchars($optionValue[$dao->id]['label']);
$optionValue[$dao->id]['order'] = $optionValue[$dao->id]['weight'];
$optionValue[$dao->id]['action'] = CRM_Core_Action::formLink($links, $action, array('id' => $dao->id, 'gid' => $optionGroupID, 'value' => $dao->value), ts('more'), FALSE, 'optionValue.row.actions', 'optionValue', $dao->id);
if (!empty($optionValue[$dao->id]['component_id'])) {
$optionValue[$dao->id]['component_name'] = $componentNames[$optionValue[$dao->id]['component_id']];
} else {
$optionValue[$dao->id]['component_name'] = 'Contact';
}
if (!empty($optionValue[$dao->id]['visibility_id'])) {
$optionValue[$dao->id]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id]['visibility_id']];
}
}
return $optionValue;
}
function upgrade_3_3_beta1($rev)
{
$upgrade = new CRM_Upgrade_Form();
$upgrade->processSQL($rev);
// CRM-6902
// Add column price_field_value_id in civicrm_line_item.
// Do not drop option_group_id column now since we need it to
// update line items.
$updateLineItem1 = "ALTER TABLE civicrm_line_item ADD COLUMN price_field_value_id int(10) unsigned default NULL;";
CRM_Core_DAO::executeQuery($updateLineItem1);
$priceFieldDAO = new CRM_Price_DAO_Field();
$priceFieldDAO->find();
$ids = array();
while ($priceFieldDAO->fetch()) {
$opGroupDAO = new CRM_Core_DAO_OptionGroup();
$opGroupDAO->name = 'civicrm_price_field.amount.' . $priceFieldDAO->id;
if (!$opGroupDAO->find(TRUE)) {
$opGroupDAO->free();
continue;
}
$opValueDAO = new CRM_Core_DAO_OptionValue();
$opValueDAO->option_group_id = $opGroupDAO->id;
$opValueDAO->find();
while ($opValueDAO->fetch()) {
// FIX ME: not migrating description(?), there will
// be a field description for each option.
$fieldValue = array('price_field_id' => $priceFieldDAO->id, 'label' => $opValueDAO->label, 'name' => CRM_Utils_String::munge($opValueDAO->label, '_', 64), 'amount' => $opValueDAO->name, 'weight' => $opValueDAO->weight, 'is_default' => $opValueDAO->is_default, 'is_active' => $opValueDAO->is_active);
if ($priceFieldDAO->count) {
// Migrate Participant Counts on option level.
// count of each option will be the same
// as earlier field count.
$fieldValue['count'] = $priceFieldDAO->count;
}
$fieldValueDAO = CRM_Price_BAO_FieldValue::add($fieldValue, $ids);
$lineItemDAO = new CRM_Price_DAO_LineItem();
$lineItemDAO->option_group_id = $opGroupDAO->id;
$lineItemDAO->label = $opValueDAO->label;
$lineItemDAO->unit_price = $opValueDAO->name;
$labelFound = $priceFound = FALSE;
// check with label and amount
if (!$lineItemDAO->find(TRUE)) {
$lineItemDAO->free();
$lineItemDAO = new CRM_Price_DAO_LineItem();
$lineItemDAO->option_group_id = $opGroupDAO->id;
$lineItemDAO->label = $opValueDAO->label;
// check with label only
if ($lineItemDAO->find(TRUE)) {
$labelFound = TRUE;
}
} else {
$labelFound = TRUE;
$priceFound = TRUE;
}
$lineItemDAO->free();
// update civicrm_line_item for price_field_value_id.
// Used query to avoid line by line update.
if ($labelFound || $priceFound) {
$lineItemParams = array(1 => array($fieldValueDAO->id, 'Integer'), 2 => array($opValueDAO->label, 'String'));
$updateLineItems = "UPDATE civicrm_line_item SET price_field_value_id = %1 WHERE label = %2";
if ($priceFound) {
$lineItemParams[3] = array($opValueDAO->name, 'Float');
$updateLineItems .= " AND unit_price = %3";
}
CRM_Core_DAO::executeQuery($updateLineItems, $lineItemParams);
}
}
$opGroupDAO->delete();
$opValueDAO->free();
$opGroupDAO->free();
}
$priceFieldDAO->free();
// Now drop option_group_id column from civicrm_line_item
$updateLineItem2 = "ALTER TABLE civicrm_line_item DROP option_group_id,\n ADD CONSTRAINT `FK_civicrm_price_field_value_id` FOREIGN KEY (price_field_value_id) REFERENCES civicrm_price_field_value(id) ON DELETE SET NULL;";
CRM_Core_DAO::executeQuery($updateLineItem2, array(), TRUE, NULL, FALSE, FALSE);
$updatePriceField = "ALTER TABLE civicrm_price_field DROP count";
CRM_Core_DAO::executeQuery($updatePriceField, array(), TRUE, NULL, FALSE, FALSE);
// as the table 'civicrm_price_field' is localised and column 'count' is dropped
// after the views are rebuild, we need to rebuild views to avoid invalid refrence of table.
if ($upgrade->multilingual) {
CRM_Core_I18n_Schema::rebuildMultilingualSchema($upgrade->locales, $rev);
}
}
/**
* Browse all options value.
*
*
* @return void
* @access public
* @static
*/
function browse()
{
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = $this->_gid;
if (in_array($this->_gName, CRM_Core_OptionGroup::$_domainIDGroups)) {
$dao->domain_id = CRM_Core_Config::domainID();
}
if ($this->_gName == 'encounter_medium') {
$mediumIds = CRM_Case_BAO_Case::getUsedEncounterMediums();
} elseif ($this->_gName == 'case_status') {
$caseStatusIds = CRM_Case_BAO_Case::getUsedCaseStatuses();
} elseif ($this->_gName == 'case_type') {
$caseTypeIds = CRM_Case_BAO_Case::getUsedCaseType();
}
$dao->orderBy('name');
$dao->find();
$optionValue = array();
while ($dao->fetch()) {
$optionValue[$dao->id] = array();
CRM_Core_DAO::storeValues($dao, $optionValue[$dao->id]);
// form all action links
$action = array_sum(array_keys($this->links()));
if ($dao->is_default) {
$optionValue[$dao->id]['default_value'] = '[x]';
}
//do not show default option for email/postal greeting and addressee, CRM-4575
if (!in_array($this->_gName, array('email_greeting', 'postal_greeting', 'addressee'))) {
$this->assign('showIsDefault', TRUE);
}
// update enable/disable links depending on if it is is_reserved or is_active
if ($dao->is_reserved) {
$action = CRM_Core_Action::UPDATE;
} else {
if ($dao->is_active) {
$action -= CRM_Core_Action::ENABLE;
} else {
$action -= CRM_Core_Action::DISABLE;
}
if ($this->_gName == 'encounter_medium' && in_array($dao->value, $mediumIds) || $this->_gName == 'case_status' && in_array($dao->value, $caseStatusIds) || $this->_gName == 'case_type' && in_array($dao->value, $caseTypeIds)) {
$action -= CRM_Core_Action::DELETE;
}
}
$optionValue[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action, array('id' => $dao->id, 'gid' => $this->_gid));
}
$this->assign('rows', $optionValue);
}
/**
* Returns all active options ordered by weight for a given field
*
* @param int $fieldId field whose options are needed
* @param boolean $inactiveNeeded do we need inactive options ?
*
* @return array $customOption all active options for fieldId
* @static
*/
static function getCustomOption($fieldID, $inactiveNeeded = false)
{
$options = array();
if (!$fieldID) {
return $options;
}
// get the option group id
$optionGroupID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $fieldID, 'option_group_id');
if (!$optionGroupID) {
return $options;
}
require_once 'CRM/Core/DAO/OptionValue.php';
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = $optionGroupID;
if (!$inactiveNeeded) {
$dao->is_active = 1;
}
$dao->orderBy('weight ASC, label ASC');
$dao->find();
while ($dao->fetch()) {
$options[$dao->id] = array();
$options[$dao->id]['id'] = $dao->id;
$options[$dao->id]['label'] = $dao->label;
$options[$dao->id]['value'] = $dao->value;
}
require_once 'CRM/Utils/Hook.php';
CRM_Utils_Hook::customFieldOptions($fieldID, $options, true);
return $options;
}
static function getGrantStatuses()
{
$og = CRM_Grant_BAO_Grant::getGrantStatusOptGroup();
require_once 'CRM/Core/BAO/OptionValue.php';
$dao = new CRM_Core_DAO_OptionValue();
$dao->option_group_id = $og->id;
$dao->find();
$statuses = array();
while ($dao->fetch()) {
$statuses[$dao->id] = $dao->label;
}
return $statuses;
}
