Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
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 | /** | |
100fef9d | 38 | * Class constructor |
6a488035 | 39 | */ |
00be9182 | 40 | public function __construct() { |
6a488035 TO |
41 | parent::__construct(); |
42 | } | |
43 | ||
44 | /** | |
c490a46a | 45 | * Fetch object based on array of properties |
6a488035 | 46 | * |
6a0b768e TO |
47 | * @param array $params |
48 | * (reference ) an assoc array of name/value pairs. | |
49 | * @param array $defaults | |
50 | * (reference ) an assoc array to hold the flattened values. | |
6a488035 | 51 | * |
c490a46a | 52 | * @return CRM_Core_BAO_OptionGroup object |
6a488035 TO |
53 | * @static |
54 | */ | |
00be9182 | 55 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
56 | $optionGroup = new CRM_Core_DAO_OptionGroup(); |
57 | $optionGroup->copyValues($params); | |
58 | if ($optionGroup->find(TRUE)) { | |
59 | CRM_Core_DAO::storeValues($optionGroup, $defaults); | |
60 | return $optionGroup; | |
61 | } | |
62 | return NULL; | |
63 | } | |
64 | ||
65 | /** | |
100fef9d | 66 | * Update the is_active flag in the db |
6a488035 | 67 | * |
6a0b768e TO |
68 | * @param int $id |
69 | * Id of the database record. | |
70 | * @param bool $is_active | |
71 | * Value we want to set the is_active field. | |
6a488035 TO |
72 | * |
73 | * @return Object DAO object on sucess, null otherwise | |
74 | * @static | |
75 | */ | |
00be9182 | 76 | public static function setIsActive($id, $is_active) { |
6a488035 TO |
77 | return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active); |
78 | } | |
79 | ||
80 | /** | |
100fef9d | 81 | * Add the Option Group |
6a488035 | 82 | * |
6a0b768e TO |
83 | * @param array $params |
84 | * Reference array contains the values submitted by the form. | |
85 | * @param array $ids | |
86 | * Reference array contains the id. | |
6a488035 | 87 | * |
6a488035 TO |
88 | * @static |
89 | * | |
90 | * @return object | |
91 | */ | |
00be9182 | 92 | public static function add(&$params, $ids = array()) { |
9b873358 | 93 | if (empty($params['id'])) { |
4033343a | 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 | /** | |
100fef9d | 114 | * Delete Option Group |
6a488035 | 115 | * |
6a0b768e TO |
116 | * @param int $optionGroupId |
117 | * Id of the Option Group to be deleted. | |
6a488035 TO |
118 | * |
119 | * @return void | |
120 | * | |
6a488035 TO |
121 | * @static |
122 | */ | |
00be9182 | 123 | public static function del($optionGroupId) { |
6a488035 TO |
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 | /** | |
100fef9d | 135 | * Get title of the option group |
6a488035 | 136 | * |
6a0b768e TO |
137 | * @param int $optionGroupId |
138 | * Id of the Option Group. | |
6a488035 TO |
139 | * |
140 | * @return String title | |
141 | * | |
6a488035 TO |
142 | * @static |
143 | */ | |
00be9182 | 144 | public static function getTitle($optionGroupId) { |
6a488035 TO |
145 | $optionGroup = new CRM_Core_DAO_OptionGroup(); |
146 | $optionGroup->id = $optionGroupId; | |
147 | $optionGroup->find(TRUE); | |
148 | return $optionGroup->name; | |
149 | } | |
6a488035 | 150 | } |