5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Core/OptionValue.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:356278f04173ed064fa82cacafa7edbe)
13 * Database access object for the OptionValue entity.
15 class CRM_Core_DAO_OptionValue
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_option_value';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
39 * Group which this option belongs to.
43 public $option_group_id;
46 * Option string as displayed to users - e.g. the label in an HTML OPTION tag.
53 * The actual value stored (as a foreign key) in the data record. Functions which need lookup option_value.title should use civicrm_option_value.option_group_id plus civicrm_option_value.value as the key.
60 * Stores a fixed (non-translated) name for this option value. Lookup functions should use the name as the key for the option value row.
67 * Use to sort and/or set display properties for sub-set(s) of options within an option group. EXAMPLE: Use for college_interest field, to differentiate partners from non-partners.
74 * Bitwise logic can be used to create subsets of options within an option_group for different uses.
81 * Is this the default option for the group?
88 * Controls display sort order.
95 * Optional description.
102 * Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options?
109 * Is this a predefined system object?
116 * Is this option active?
123 * Component that this option value belongs/caters to.
127 public $component_id;
130 * Which Domain is this option value for
139 public $visibility_id;
149 * Hex color value e.g. #ffffff
158 public function __construct() {
159 $this->__table
= 'civicrm_option_value';
160 parent
::__construct();
164 * Returns foreign keys and entity references.
167 * [CRM_Core_Reference_Interface]
169 public static function getReferenceColumns() {
170 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
171 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
172 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'option_group_id', 'civicrm_option_group', 'id');
173 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'component_id', 'civicrm_component', 'id');
174 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'domain_id', 'civicrm_domain', 'id');
175 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
177 return Civi
::$statics[__CLASS__
]['links'];
181 * Returns all the column names of this table
185 public static function &fields() {
186 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
187 Civi
::$statics[__CLASS__
]['fields'] = [
190 'type' => CRM_Utils_Type
::T_INT
,
191 'title' => ts('Option Value ID'),
192 'description' => ts('Option ID'),
194 'table_name' => 'civicrm_option_value',
195 'entity' => 'OptionValue',
196 'bao' => 'CRM_Core_BAO_OptionValue',
199 'option_group_id' => [
200 'name' => 'option_group_id',
201 'type' => CRM_Utils_Type
::T_INT
,
202 'title' => ts('Option Group ID'),
203 'description' => ts('Group which this option belongs to.'),
205 'table_name' => 'civicrm_option_value',
206 'entity' => 'OptionValue',
207 'bao' => 'CRM_Core_BAO_OptionValue',
209 'FKClassName' => 'CRM_Core_DAO_OptionGroup',
213 'pseudoconstant' => [
214 'table' => 'civicrm_option_group',
216 'labelColumn' => 'name',
221 'type' => CRM_Utils_Type
::T_STRING
,
222 'title' => ts('Option Label'),
223 'description' => ts('Option string as displayed to users - e.g. the label in an HTML OPTION tag.'),
226 'size' => CRM_Utils_Type
::HUGE
,
227 'table_name' => 'civicrm_option_value',
228 'entity' => 'OptionValue',
229 'bao' => 'CRM_Core_BAO_OptionValue',
234 'type' => CRM_Utils_Type
::T_STRING
,
235 'title' => ts('Option Value'),
236 'description' => ts('The actual value stored (as a foreign key) in the data record. Functions which need lookup option_value.title should use civicrm_option_value.option_group_id plus civicrm_option_value.value as the key.'),
239 'size' => CRM_Utils_Type
::HUGE
,
240 'table_name' => 'civicrm_option_value',
241 'entity' => 'OptionValue',
242 'bao' => 'CRM_Core_BAO_OptionValue',
247 'type' => CRM_Utils_Type
::T_STRING
,
248 'title' => ts('Option Name'),
249 'description' => ts('Stores a fixed (non-translated) name for this option value. Lookup functions should use the name as the key for the option value row.'),
251 'size' => CRM_Utils_Type
::HUGE
,
253 'where' => 'civicrm_option_value.name',
254 'headerPattern' => '',
257 'table_name' => 'civicrm_option_value',
258 'entity' => 'OptionValue',
259 'bao' => 'CRM_Core_BAO_OptionValue',
263 'name' => 'grouping',
264 'type' => CRM_Utils_Type
::T_STRING
,
265 'title' => ts('Option Grouping Name'),
266 'description' => ts('Use to sort and/or set display properties for sub-set(s) of options within an option group. EXAMPLE: Use for college_interest field, to differentiate partners from non-partners.'),
268 'size' => CRM_Utils_Type
::HUGE
,
269 'table_name' => 'civicrm_option_value',
270 'entity' => 'OptionValue',
271 'bao' => 'CRM_Core_BAO_OptionValue',
276 'type' => CRM_Utils_Type
::T_INT
,
277 'title' => ts('Filter'),
278 'description' => ts('Bitwise logic can be used to create subsets of options within an option_group for different uses.'),
279 'table_name' => 'civicrm_option_value',
280 'entity' => 'OptionValue',
281 'bao' => 'CRM_Core_BAO_OptionValue',
285 'name' => 'is_default',
286 'type' => CRM_Utils_Type
::T_BOOLEAN
,
287 'title' => ts('Option is Default?'),
288 'description' => ts('Is this the default option for the group?'),
290 'table_name' => 'civicrm_option_value',
291 'entity' => 'OptionValue',
292 'bao' => 'CRM_Core_BAO_OptionValue',
297 'type' => CRM_Utils_Type
::T_INT
,
298 'title' => ts('Order'),
299 'description' => ts('Controls display sort order.'),
301 'table_name' => 'civicrm_option_value',
302 'entity' => 'OptionValue',
303 'bao' => 'CRM_Core_BAO_OptionValue',
307 'name' => 'description',
308 'type' => CRM_Utils_Type
::T_TEXT
,
309 'title' => ts('Option Description'),
310 'description' => ts('Optional description.'),
313 'table_name' => 'civicrm_option_value',
314 'entity' => 'OptionValue',
315 'bao' => 'CRM_Core_BAO_OptionValue',
318 'type' => 'TextArea',
322 'name' => 'is_optgroup',
323 'type' => CRM_Utils_Type
::T_BOOLEAN
,
324 'title' => ts('Option is Header?'),
325 'description' => ts('Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options?'),
327 'table_name' => 'civicrm_option_value',
328 'entity' => 'OptionValue',
329 'bao' => 'CRM_Core_BAO_OptionValue',
333 'name' => 'is_reserved',
334 'type' => CRM_Utils_Type
::T_BOOLEAN
,
335 'title' => ts('Option Is Reserved?'),
336 'description' => ts('Is this a predefined system object?'),
338 'table_name' => 'civicrm_option_value',
339 'entity' => 'OptionValue',
340 'bao' => 'CRM_Core_BAO_OptionValue',
344 'name' => 'is_active',
345 'type' => CRM_Utils_Type
::T_BOOLEAN
,
346 'title' => ts('Option Is Active'),
347 'description' => ts('Is this option active?'),
349 'table_name' => 'civicrm_option_value',
350 'entity' => 'OptionValue',
351 'bao' => 'CRM_Core_BAO_OptionValue',
355 'name' => 'component_id',
356 'type' => CRM_Utils_Type
::T_INT
,
357 'title' => ts('Option Component'),
358 'description' => ts('Component that this option value belongs/caters to.'),
359 'table_name' => 'civicrm_option_value',
360 'entity' => 'OptionValue',
361 'bao' => 'CRM_Core_BAO_OptionValue',
363 'FKClassName' => 'CRM_Core_DAO_Component',
367 'pseudoconstant' => [
368 'table' => 'civicrm_component',
370 'labelColumn' => 'name',
374 'name' => 'domain_id',
375 'type' => CRM_Utils_Type
::T_INT
,
376 'title' => ts('Option Domain'),
377 'description' => ts('Which Domain is this option value for'),
378 'table_name' => 'civicrm_option_value',
379 'entity' => 'OptionValue',
380 'bao' => 'CRM_Core_BAO_OptionValue',
382 'FKClassName' => 'CRM_Core_DAO_Domain',
383 'pseudoconstant' => [
384 'table' => 'civicrm_domain',
386 'labelColumn' => 'name',
390 'name' => 'visibility_id',
391 'type' => CRM_Utils_Type
::T_INT
,
392 'title' => ts('Option Visibility'),
394 'table_name' => 'civicrm_option_value',
395 'entity' => 'OptionValue',
396 'bao' => 'CRM_Core_BAO_OptionValue',
398 'pseudoconstant' => [
399 'optionGroupName' => 'visibility',
400 'optionEditPath' => 'civicrm/admin/options/visibility',
405 'type' => CRM_Utils_Type
::T_STRING
,
406 'title' => ts('Icon'),
407 'description' => ts('crm-i icon class'),
409 'size' => CRM_Utils_Type
::HUGE
,
411 'table_name' => 'civicrm_option_value',
412 'entity' => 'OptionValue',
413 'bao' => 'CRM_Core_BAO_OptionValue',
418 'type' => CRM_Utils_Type
::T_STRING
,
419 'title' => ts('Color'),
420 'description' => ts('Hex color value e.g. #ffffff'),
422 'size' => CRM_Utils_Type
::HUGE
,
424 'table_name' => 'civicrm_option_value',
425 'entity' => 'OptionValue',
426 'bao' => 'CRM_Core_BAO_OptionValue',
430 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
432 return Civi
::$statics[__CLASS__
]['fields'];
436 * Return a mapping from field-name to the corresponding key (as used in fields()).
439 * Array(string $name => string $uniqueName).
441 public static function &fieldKeys() {
442 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
443 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
445 return Civi
::$statics[__CLASS__
]['fieldKeys'];
449 * Returns the names of this table
453 public static function getTableName() {
454 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
458 * Returns if this table needs to be logged
462 public function getLog() {
467 * Returns the list of fields that can be imported
469 * @param bool $prefix
473 public static function &import($prefix = FALSE) {
474 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'option_value', $prefix, []);
479 * Returns the list of fields that can be exported
481 * @param bool $prefix
485 public static function &export($prefix = FALSE) {
486 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'option_value', $prefix, []);
491 * Returns the list of indices
493 * @param bool $localize
497 public static function indices($localize = TRUE) {
499 'index_option_group_id_value' => [
500 'name' => 'index_option_group_id_value',
503 1 => 'option_group_id',
505 'localizable' => FALSE,
506 'sig' => 'civicrm_option_value::0::value(128)::option_group_id',
508 'index_option_group_id_name' => [
509 'name' => 'index_option_group_id_name',
512 1 => 'option_group_id',
514 'localizable' => FALSE,
515 'sig' => 'civicrm_option_value::0::name(128)::option_group_id',
518 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;