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
35 class CRM_Core_BAO_OptionGroup
extends CRM_Core_DAO_OptionGroup
{
40 function __construct() {
41 parent
::__construct();
45 * Takes a bunch of params that are needed to match certain criteria and
46 * retrieves the relevant objects. Typically the valid params are only
47 * contact_id. We'll tweak this function to be more full featured over a period
48 * of time. This is the inverse function of create. It also stores all the retrieved
49 * values in the default array
51 * @param array $params (reference ) an assoc array of name/value pairs
52 * @param array $defaults (reference ) an assoc array to hold the flattened values
54 * @return object CRM_Core_BAO_OptionGroup object
58 static function retrieve(&$params, &$defaults) {
59 $optionGroup = new CRM_Core_DAO_OptionGroup();
60 $optionGroup->copyValues($params);
61 if ($optionGroup->find(TRUE)) {
62 CRM_Core_DAO
::storeValues($optionGroup, $defaults);
69 * update the is_active flag in the db
71 * @param int $id id of the database record
72 * @param boolean $is_active value we want to set the is_active field
74 * @return Object DAO object on sucess, null otherwise
77 static function setIsActive($id, $is_active) {
78 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active);
82 * function to add the Option Group
84 * @param array $params reference array contains the values submitted by the form
85 * @param array $ids reference array contains the id
92 static function add(&$params, $ids = array()) {
93 if(empty($params['id'])){
94 $params['id'] = CRM_Utils_Array
::value('optionGroup', $ids);
97 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
98 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
100 // action is taken depending upon the mode
101 $optionGroup = new CRM_Core_DAO_OptionGroup();
102 $optionGroup->copyValues($params);;
104 if ($params['is_default']) {
105 $query = "UPDATE civicrm_option_group SET is_default = 0";
106 CRM_Core_DAO
::executeQuery($query);
109 $optionGroup->save();
114 * Function to delete Option Group
116 * @param int $optionGroupId Id of the Option Group to be deleted.
123 static function del($optionGroupId) {
124 // need to delete all option value field before deleting group
125 $optionValue = new CRM_Core_DAO_OptionValue();
126 $optionValue->option_group_id
= $optionGroupId;
127 $optionValue->delete();
129 $optionGroup = new CRM_Core_DAO_OptionGroup();
130 $optionGroup->id
= $optionGroupId;
131 $optionGroup->delete();
135 * Function to get title of the option group
137 * @param int $optionGroupId Id of the Option Group.
139 * @return String title
144 static function getTitle($optionGroupId) {
145 $optionGroup = new CRM_Core_DAO_OptionGroup();
146 $optionGroup->id
= $optionGroupId;
147 $optionGroup->find(TRUE);
148 return $optionGroup->name
;