<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
class CRM_Core_BAO_CustomOption {
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * contact_id. We'll tweak this function to be more full featured over a period
- * of time. This is the inverse function of create. It also stores all the retrieved
- * values in the default array
+ * Fetch object based on array of properties
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the flattened values
*
- * @return object CRM_Core_BAO_CustomOption object
+ * @return CRM_Core_BAO_CustomOption object
* @access public
* @static
*/
/**
* 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 ?
+ * @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
*
* @param $fieldId int the custom field ID
* @pram $value string the value (typically from the DB) of this custom field
+ * @param $value
* @param $htmlType string the html type of the field (optional)
* @param $dataType string the data type of the field (optional)
*
}
/**
- * Function to delete Option
+ * Delete Option
*
* param $optionId integer option id
*
}
}
+ /**
+ * @param array $params
+ *
+ * @throws Exception
+ */
static function updateCustomValues($params) {
$optionDAO = new CRM_Core_DAO_OptionValue();
$optionDAO->id = $params['optionId'];
}
}
- static function &valuesByID($customFieldID, $optionGroupID = NULL) {
+ /**
+ * @param int $customFieldID
+ * @param int $optionGroupID
+ *
+ * @return array
+ */
+ static function valuesByID($customFieldID, $optionGroupID = NULL) {
if (!$optionGroupID) {
$optionGroupID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
$customFieldID,
);
}
- $options = CRM_Core_OptionGroup::valuesByID($optionGroupID);
+ $options = $optionGroupID ? CRM_Core_OptionGroup::valuesByID($optionGroupID) : array();
CRM_Utils_Hook::customFieldOptions($customFieldID, $options, FALSE);