+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
*
* @param $ids
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
- * @static
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
*/
public static function &add(&$params, $ids) {
*
* @param $ids
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
- * @static
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
*/
public static function create(&$params, $ids) {
if (!is_array($params) || empty($params)) {
- return;
+ return NULL;
}
if ($id = CRM_Utils_Array::value('id', $ids)) {
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array.
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
- * @static
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
*/
public static function retrieve(&$params, &$defaults) {
return CRM_Core_DAO::commonRetrieve('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $params, $defaults);
}
/**
- * Retrive the all values for given field id
+ * Retrive the all values for given field id.
*
* @param int $fieldId
* Price_field_id.
* For order by, default weight.
* @param bool|int $isActive is_active, default false
*
- * @return array $values
+ * @return array
*
- * @static
*/
public static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
$fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
* @param int $id
* Id of field option.
*
- * @return string name
- *
- * @static
+ * @return string
+ * name
*
*/
public static function getOptionLabel($id) {
}
/**
- * Update the is_active flag in the db
+ * Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
- * @static
*/
public static function setIsActive($id, $is_active) {
return CRM_Core_DAO::setFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'is_active', $is_active);
}
/**
- * Delete all values of the given field id
+ * Delete all values of the given field id.
*
* @param int $fieldId
* Price field id.
*
- * @return boolean
+ * @return bool
*
- * @static
*/
public static function deleteValues($fieldId) {
if (!$fieldId) {
* @param int $id
* Id.
*
- * @return boolean
+ * @return bool
*
- * @static
*/
public static function del($id) {
if (!$id) {
$fieldValueDAO->id = $id;
return $fieldValueDAO->delete();
}
+
}