CRM/Core/DAO/OptionValue.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Core/OptionValue.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:8cf699b034cbd9d7b8fe0a69250a79ba)
  10  */
  11
  12 /**
  13  * Database access object for the OptionValue entity.
  14  */
  15 class CRM_Core_DAO_OptionValue extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_option_value';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   static $_log = TRUE;
  30
  31   /**
  32    * Option ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Group which this option belongs to.
  40    *
  41    * @var int unsigned
  42    */
  43   public $option_group_id;
  44
  45   /**
  46    * Option string as displayed to users - e.g. the label in an HTML OPTION tag.
  47    *
  48    * @var string
  49    */
  50   public $label;
  51
  52   /**
  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.
  54    *
  55    * @var string
  56    */
  57   public $value;
  58
  59   /**
  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.
  61    *
  62    * @var string
  63    */
  64   public $name;
  65
  66   /**
  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.
  68    *
  69    * @var string
  70    */
  71   public $grouping;
  72
  73   /**
  74    * Bitwise logic can be used to create subsets of options within an option_group for different uses.
  75    *
  76    * @var int unsigned
  77    */
  78   public $filter;
  79
  80   /**
  81    * Is this the default option for the group?
  82    *
  83    * @var boolean
  84    */
  85   public $is_default;
  86
  87   /**
  88    * Controls display sort order.
  89    *
  90    * @var int unsigned
  91    */
  92   public $weight;
  93
  94   /**
  95    * Optional description.
  96    *
  97    * @var text
  98    */
  99   public $description;
 100
 101   /**
 102    * Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options?
 103    *
 104    * @var boolean
 105    */
 106   public $is_optgroup;
 107
 108   /**
 109    * Is this a predefined system object?
 110    *
 111    * @var boolean
 112    */
 113   public $is_reserved;
 114
 115   /**
 116    * Is this option active?
 117    *
 118    * @var boolean
 119    */
 120   public $is_active;
 121
 122   /**
 123    * Component that this option value belongs/caters to.
 124    *
 125    * @var int unsigned
 126    */
 127   public $component_id;
 128
 129   /**
 130    * Which Domain is this option value for
 131    *
 132    * @var int unsigned
 133    */
 134   public $domain_id;
 135
 136   /**
 137    * @var int unsigned
 138    */
 139   public $visibility_id;
 140
 141   /**
 142    * crm-i icon class
 143    *
 144    * @var string
 145    */
 146   public $icon;
 147
 148   /**
 149    * Hex color value e.g. #ffffff
 150    *
 151    * @var string
 152    */
 153   public $color;
 154
 155   /**
 156    * Class constructor.
 157    */
 158   public function __construct() {
 159     $this->__table = 'civicrm_option_value';
 160     parent::__construct();
 161   }
 162
 163   /**
 164    * Returns foreign keys and entity references.
 165    *
 166    * @return array
 167    *   [CRM_Core_Reference_Interface]
 168    */
 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']);
 176     }
 177     return Civi::$statics[__CLASS__]['links'];
 178   }
 179
 180   /**
 181    * Returns all the column names of this table
 182    *
 183    * @return array
 184    */
 185   public static function &fields() {
 186     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 187       Civi::$statics[__CLASS__]['fields'] = [
 188         'id' => [
 189           'name' => 'id',
 190           'type' => CRM_Utils_Type::T_INT,
 191           'title' => ts('Option Value ID'),
 192           'description' => 'Option ID',
 193           'required' => TRUE,
 194           'table_name' => 'civicrm_option_value',
 195           'entity' => 'OptionValue',
 196           'bao' => 'CRM_Core_BAO_OptionValue',
 197           'localizable' => 0,
 198         ],
 199         'option_group_id' => [
 200           'name' => 'option_group_id',
 201           'type' => CRM_Utils_Type::T_INT,
 202           'title' => ts('Option Group ID'),
 203           'description' => 'Group which this option belongs to.',
 204           'required' => TRUE,
 205           'table_name' => 'civicrm_option_value',
 206           'entity' => 'OptionValue',
 207           'bao' => 'CRM_Core_BAO_OptionValue',
 208           'localizable' => 0,
 209           'FKClassName' => 'CRM_Core_DAO_OptionGroup',
 210           'html' => [
 211             'type' => 'Select',
 212           ],
 213           'pseudoconstant' => [
 214             'table' => 'civicrm_option_group',
 215             'keyColumn' => 'id',
 216             'labelColumn' => 'name',
 217           ]
 218         ],
 219         'label' => [
 220           'name' => 'label',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Option Label'),
 223           'description' => 'Option string as displayed to users - e.g. the label in an HTML OPTION tag.',
 224           'required' => TRUE,
 225           'maxlength' => 512,
 226           'size' => CRM_Utils_Type::HUGE,
 227           'table_name' => 'civicrm_option_value',
 228           'entity' => 'OptionValue',
 229           'bao' => 'CRM_Core_BAO_OptionValue',
 230           'localizable' => 1,
 231         ],
 232         'value' => [
 233           'name' => 'value',
 234           'type' => CRM_Utils_Type::T_STRING,
 235           'title' => ts('Option Value'),
 236           'description' => '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.',
 237           'required' => TRUE,
 238           'maxlength' => 512,
 239           'size' => CRM_Utils_Type::HUGE,
 240           'table_name' => 'civicrm_option_value',
 241           'entity' => 'OptionValue',
 242           'bao' => 'CRM_Core_BAO_OptionValue',
 243           'localizable' => 0,
 244         ],
 245         'name' => [
 246           'name' => 'name',
 247           'type' => CRM_Utils_Type::T_STRING,
 248           'title' => ts('Option Name'),
 249           'description' => 'Stores a fixed (non-translated) name for this option value. Lookup functions should use the name as the key for the option value row.',
 250           'maxlength' => 255,
 251           'size' => CRM_Utils_Type::HUGE,
 252           'import' => TRUE,
 253           'where' => 'civicrm_option_value.name',
 254           'headerPattern' => '',
 255           'dataPattern' => '',
 256           'export' => TRUE,
 257           'table_name' => 'civicrm_option_value',
 258           'entity' => 'OptionValue',
 259           'bao' => 'CRM_Core_BAO_OptionValue',
 260           'localizable' => 0,
 261         ],
 262         'grouping' => [
 263           'name' => 'grouping',
 264           'type' => CRM_Utils_Type::T_STRING,
 265           'title' => ts('Option Grouping Name'),
 266           'description' => '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.',
 267           'maxlength' => 255,
 268           'size' => CRM_Utils_Type::HUGE,
 269           'table_name' => 'civicrm_option_value',
 270           'entity' => 'OptionValue',
 271           'bao' => 'CRM_Core_BAO_OptionValue',
 272           'localizable' => 0,
 273         ],
 274         'filter' => [
 275           'name' => 'filter',
 276           'type' => CRM_Utils_Type::T_INT,
 277           'title' => ts('Filter'),
 278           'description' => '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',
 282           'localizable' => 0,
 283         ],
 284         'is_default' => [
 285           'name' => 'is_default',
 286           'type' => CRM_Utils_Type::T_BOOLEAN,
 287           'title' => ts('Option is Default?'),
 288           'description' => 'Is this the default option for the group?',
 289           'table_name' => 'civicrm_option_value',
 290           'entity' => 'OptionValue',
 291           'bao' => 'CRM_Core_BAO_OptionValue',
 292           'localizable' => 0,
 293         ],
 294         'weight' => [
 295           'name' => 'weight',
 296           'type' => CRM_Utils_Type::T_INT,
 297           'title' => ts('Order'),
 298           'description' => 'Controls display sort order.',
 299           'required' => TRUE,
 300           'table_name' => 'civicrm_option_value',
 301           'entity' => 'OptionValue',
 302           'bao' => 'CRM_Core_BAO_OptionValue',
 303           'localizable' => 0,
 304         ],
 305         'description' => [
 306           'name' => 'description',
 307           'type' => CRM_Utils_Type::T_TEXT,
 308           'title' => ts('Option Description'),
 309           'description' => 'Optional description.',
 310           'rows' => 8,
 311           'cols' => 60,
 312           'table_name' => 'civicrm_option_value',
 313           'entity' => 'OptionValue',
 314           'bao' => 'CRM_Core_BAO_OptionValue',
 315           'localizable' => 1,
 316           'html' => [
 317             'type' => 'TextArea',
 318           ],
 319         ],
 320         'is_optgroup' => [
 321           'name' => 'is_optgroup',
 322           'type' => CRM_Utils_Type::T_BOOLEAN,
 323           'title' => ts('Option is Header?'),
 324           'description' => 'Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options?',
 325           'table_name' => 'civicrm_option_value',
 326           'entity' => 'OptionValue',
 327           'bao' => 'CRM_Core_BAO_OptionValue',
 328           'localizable' => 0,
 329         ],
 330         'is_reserved' => [
 331           'name' => 'is_reserved',
 332           'type' => CRM_Utils_Type::T_BOOLEAN,
 333           'title' => ts('Option Is Reserved?'),
 334           'description' => 'Is this a predefined system object?',
 335           'table_name' => 'civicrm_option_value',
 336           'entity' => 'OptionValue',
 337           'bao' => 'CRM_Core_BAO_OptionValue',
 338           'localizable' => 0,
 339         ],
 340         'is_active' => [
 341           'name' => 'is_active',
 342           'type' => CRM_Utils_Type::T_BOOLEAN,
 343           'title' => ts('Option Is Active'),
 344           'description' => 'Is this option active?',
 345           'default' => '1',
 346           'table_name' => 'civicrm_option_value',
 347           'entity' => 'OptionValue',
 348           'bao' => 'CRM_Core_BAO_OptionValue',
 349           'localizable' => 0,
 350         ],
 351         'component_id' => [
 352           'name' => 'component_id',
 353           'type' => CRM_Utils_Type::T_INT,
 354           'title' => ts('Option Component'),
 355           'description' => 'Component that this option value belongs/caters to.',
 356           'table_name' => 'civicrm_option_value',
 357           'entity' => 'OptionValue',
 358           'bao' => 'CRM_Core_BAO_OptionValue',
 359           'localizable' => 0,
 360           'FKClassName' => 'CRM_Core_DAO_Component',
 361           'html' => [
 362             'type' => 'Select',
 363           ],
 364           'pseudoconstant' => [
 365             'table' => 'civicrm_component',
 366             'keyColumn' => 'id',
 367             'labelColumn' => 'name',
 368           ]
 369         ],
 370         'domain_id' => [
 371           'name' => 'domain_id',
 372           'type' => CRM_Utils_Type::T_INT,
 373           'title' => ts('Option Domain'),
 374           'description' => 'Which Domain is this option value for',
 375           'table_name' => 'civicrm_option_value',
 376           'entity' => 'OptionValue',
 377           'bao' => 'CRM_Core_BAO_OptionValue',
 378           'localizable' => 0,
 379           'FKClassName' => 'CRM_Core_DAO_Domain',
 380           'pseudoconstant' => [
 381             'table' => 'civicrm_domain',
 382             'keyColumn' => 'id',
 383             'labelColumn' => 'name',
 384           ]
 385         ],
 386         'visibility_id' => [
 387           'name' => 'visibility_id',
 388           'type' => CRM_Utils_Type::T_INT,
 389           'title' => ts('Option Visibility'),
 390           'default' => 'NULL',
 391           'table_name' => 'civicrm_option_value',
 392           'entity' => 'OptionValue',
 393           'bao' => 'CRM_Core_BAO_OptionValue',
 394           'localizable' => 0,
 395         ],
 396         'icon' => [
 397           'name' => 'icon',
 398           'type' => CRM_Utils_Type::T_STRING,
 399           'title' => ts('Icon'),
 400           'description' => 'crm-i icon class',
 401           'maxlength' => 255,
 402           'size' => CRM_Utils_Type::HUGE,
 403           'default' => 'NULL',
 404           'table_name' => 'civicrm_option_value',
 405           'entity' => 'OptionValue',
 406           'bao' => 'CRM_Core_BAO_OptionValue',
 407           'localizable' => 0,
 408         ],
 409         'color' => [
 410           'name' => 'color',
 411           'type' => CRM_Utils_Type::T_STRING,
 412           'title' => ts('Color'),
 413           'description' => 'Hex color value e.g. #ffffff',
 414           'maxlength' => 255,
 415           'size' => CRM_Utils_Type::HUGE,
 416           'default' => 'NULL',
 417           'table_name' => 'civicrm_option_value',
 418           'entity' => 'OptionValue',
 419           'bao' => 'CRM_Core_BAO_OptionValue',
 420           'localizable' => 0,
 421         ],
 422       ];
 423       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 424     }
 425     return Civi::$statics[__CLASS__]['fields'];
 426   }
 427
 428   /**
 429    * Return a mapping from field-name to the corresponding key (as used in fields()).
 430    *
 431    * @return array
 432    *   Array(string $name => string $uniqueName).
 433    */
 434   public static function &fieldKeys() {
 435     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 436       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 437     }
 438     return Civi::$statics[__CLASS__]['fieldKeys'];
 439   }
 440
 441   /**
 442    * Returns the names of this table
 443    *
 444    * @return string
 445    */
 446   public static function getTableName() {
 447     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 448   }
 449
 450   /**
 451    * Returns if this table needs to be logged
 452    *
 453    * @return bool
 454    */
 455   public function getLog() {
 456     return self::$_log;
 457   }
 458
 459   /**
 460    * Returns the list of fields that can be imported
 461    *
 462    * @param bool $prefix
 463    *
 464    * @return array
 465    */
 466   public static function &import($prefix = FALSE) {
 467     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'option_value', $prefix, []);
 468     return $r;
 469   }
 470
 471   /**
 472    * Returns the list of fields that can be exported
 473    *
 474    * @param bool $prefix
 475    *
 476    * @return array
 477    */
 478   public static function &export($prefix = FALSE) {
 479     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'option_value', $prefix, []);
 480     return $r;
 481   }
 482
 483   /**
 484    * Returns the list of indices
 485    *
 486    * @param bool $localize
 487    *
 488    * @return array
 489    */
 490   public static function indices($localize = TRUE) {
 491     $indices = [
 492       'index_option_group_id_value' => [
 493         'name' => 'index_option_group_id_value',
 494         'field' => [
 495           0 => 'value(128)',
 496           1 => 'option_group_id',
 497         ],
 498         'localizable' => FALSE,
 499         'sig' => 'civicrm_option_value::0::value(128)::option_group_id',
 500       ],
 501       'index_option_group_id_name' => [
 502         'name' => 'index_option_group_id_name',
 503         'field' => [
 504           0 => 'name(128)',
 505           1 => 'option_group_id',
 506         ],
 507         'localizable' => FALSE,
 508         'sig' => 'civicrm_option_value::0::name(128)::option_group_id',
 509       ],
 510     ];
 511     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 512   }
 513
 514 }