Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { | |
36 | ||
37 | /** | |
38 | * class constructor | |
39 | */ | |
40 | function __construct() { | |
41 | parent::__construct(); | |
42 | } | |
43 | ||
44 | /** | |
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 | |
50 | * | |
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 | |
53 | * | |
54 | * @return object CRM_Core_BAO_OptionGroup object | |
55 | * @access public | |
56 | * @static | |
57 | */ | |
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); | |
63 | return $optionGroup; | |
64 | } | |
65 | return NULL; | |
66 | } | |
67 | ||
68 | /** | |
69 | * update the is_active flag in the db | |
70 | * | |
71 | * @param int $id id of the database record | |
72 | * @param boolean $is_active value we want to set the is_active field | |
73 | * | |
74 | * @return Object DAO object on sucess, null otherwise | |
75 | * @static | |
76 | */ | |
77 | static function setIsActive($id, $is_active) { | |
78 | return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active); | |
79 | } | |
80 | ||
81 | /** | |
82 | * function to add the Option Group | |
83 | * | |
84 | * @param array $params reference array contains the values submitted by the form | |
85 | * @param array $ids reference array contains the id | |
86 | * | |
87 | * @access public | |
88 | * @static | |
89 | * | |
90 | * @return object | |
91 | */ | |
4033343a | 92 | static function add(&$params, $ids = array()) { |
93 | if(empty($params['id'])){ | |
94 | $params['id'] = CRM_Utils_Array::value('optionGroup', $ids); | |
95 | } | |
96 | ||
6a488035 TO |
97 | $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE); |
98 | $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE); | |
99 | ||
100 | // action is taken depending upon the mode | |
101 | $optionGroup = new CRM_Core_DAO_OptionGroup(); | |
102 | $optionGroup->copyValues($params);; | |
103 | ||
104 | if ($params['is_default']) { | |
105 | $query = "UPDATE civicrm_option_group SET is_default = 0"; | |
106 | CRM_Core_DAO::executeQuery($query); | |
107 | } | |
108 | ||
6a488035 TO |
109 | $optionGroup->save(); |
110 | return $optionGroup; | |
111 | } | |
112 | ||
113 | /** | |
114 | * Function to delete Option Group | |
115 | * | |
116 | * @param int $optionGroupId Id of the Option Group to be deleted. | |
117 | * | |
118 | * @return void | |
119 | * | |
120 | * @access public | |
121 | * @static | |
122 | */ | |
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(); | |
128 | ||
129 | $optionGroup = new CRM_Core_DAO_OptionGroup(); | |
130 | $optionGroup->id = $optionGroupId; | |
131 | $optionGroup->delete(); | |
132 | } | |
133 | ||
134 | /** | |
135 | * Function to get title of the option group | |
136 | * | |
137 | * @param int $optionGroupId Id of the Option Group. | |
138 | * | |
139 | * @return String title | |
140 | * | |
141 | * @access public | |
142 | * @static | |
143 | */ | |
144 | static function getTitle($optionGroupId) { | |
145 | $optionGroup = new CRM_Core_DAO_OptionGroup(); | |
146 | $optionGroup->id = $optionGroupId; | |
147 | $optionGroup->find(TRUE); | |
148 | return $optionGroup->name; | |
149 | } | |
6a488035 TO |
150 | } |
151 |