5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Core/OptionGroup.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:2437cfeb4ae146ce21397bb38dfa08e1)
13 * Database access object for the OptionGroup entity.
15 class CRM_Core_DAO_OptionGroup
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_option_group';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
39 * Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.
53 * Option group description.
60 * Option group description.
67 * Is this a predefined system option group (i.e. it can not be deleted)?
74 * Is this option group active?
81 * A lock to remove the ability to add new options via the UI.
90 public function __construct() {
91 $this->__table
= 'civicrm_option_group';
92 parent
::__construct();
96 * Returns all the column names of this table
100 public static function &fields() {
101 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
102 Civi
::$statics[__CLASS__
]['fields'] = [
105 'type' => CRM_Utils_Type
::T_INT
,
106 'title' => ts('Option Group ID'),
107 'description' => ts('Option Group ID'),
109 'table_name' => 'civicrm_option_group',
110 'entity' => 'OptionGroup',
111 'bao' => 'CRM_Core_BAO_OptionGroup',
116 'type' => CRM_Utils_Type
::T_STRING
,
117 'title' => ts('Option Group Name'),
118 'description' => ts('Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.'),
121 'size' => CRM_Utils_Type
::BIG
,
122 'table_name' => 'civicrm_option_group',
123 'entity' => 'OptionGroup',
124 'bao' => 'CRM_Core_BAO_OptionGroup',
129 'type' => CRM_Utils_Type
::T_STRING
,
130 'title' => ts('Option Group title'),
131 'description' => ts('Option Group title.'),
133 'size' => CRM_Utils_Type
::HUGE
,
134 'table_name' => 'civicrm_option_group',
135 'entity' => 'OptionGroup',
136 'bao' => 'CRM_Core_BAO_OptionGroup',
140 'name' => 'description',
141 'type' => CRM_Utils_Type
::T_STRING
,
142 'title' => ts('Option Group Description'),
143 'description' => ts('Option group description.'),
145 'size' => CRM_Utils_Type
::HUGE
,
146 'table_name' => 'civicrm_option_group',
147 'entity' => 'OptionGroup',
148 'bao' => 'CRM_Core_BAO_OptionGroup',
152 'name' => 'data_type',
153 'type' => CRM_Utils_Type
::T_STRING
,
154 'title' => ts('Data Type for this option group'),
155 'description' => ts('Option group description.'),
157 'size' => CRM_Utils_Type
::HUGE
,
158 'table_name' => 'civicrm_option_group',
159 'entity' => 'OptionGroup',
160 'bao' => 'CRM_Core_BAO_OptionGroup',
162 'pseudoconstant' => [
163 'callback' => 'CRM_Utils_Type::dataTypes',
167 'name' => 'is_reserved',
168 'type' => CRM_Utils_Type
::T_BOOLEAN
,
169 'title' => ts('Option Group Is Reserved?'),
170 'description' => ts('Is this a predefined system option group (i.e. it can not be deleted)?'),
173 'table_name' => 'civicrm_option_group',
174 'entity' => 'OptionGroup',
175 'bao' => 'CRM_Core_BAO_OptionGroup',
179 'name' => 'is_active',
180 'type' => CRM_Utils_Type
::T_BOOLEAN
,
181 'title' => ts('Option Group Is Active?'),
182 'description' => ts('Is this option group active?'),
185 'table_name' => 'civicrm_option_group',
186 'entity' => 'OptionGroup',
187 'bao' => 'CRM_Core_BAO_OptionGroup',
191 'name' => 'is_locked',
192 'type' => CRM_Utils_Type
::T_BOOLEAN
,
193 'title' => ts('Option Group Is Locked'),
194 'description' => ts('A lock to remove the ability to add new options via the UI.'),
197 'table_name' => 'civicrm_option_group',
198 'entity' => 'OptionGroup',
199 'bao' => 'CRM_Core_BAO_OptionGroup',
203 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
205 return Civi
::$statics[__CLASS__
]['fields'];
209 * Return a mapping from field-name to the corresponding key (as used in fields()).
212 * Array(string $name => string $uniqueName).
214 public static function &fieldKeys() {
215 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
216 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
218 return Civi
::$statics[__CLASS__
]['fieldKeys'];
222 * Returns the names of this table
226 public static function getTableName() {
227 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
231 * Returns if this table needs to be logged
235 public function getLog() {
240 * Returns the list of fields that can be imported
242 * @param bool $prefix
246 public static function &import($prefix = FALSE) {
247 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'option_group', $prefix, []);
252 * Returns the list of fields that can be exported
254 * @param bool $prefix
258 public static function &export($prefix = FALSE) {
259 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'option_group', $prefix, []);
264 * Returns the list of indices
266 * @param bool $localize
270 public static function indices($localize = TRUE) {
277 'localizable' => FALSE,
279 'sig' => 'civicrm_option_group::1::name',
282 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;