CRM/Core/DAO/UFField.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/UFField.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:c73a4661d33e4dde2240d6d8ac7fd2c4)
  10  */
  11
  12 /**
  13  * Database access object for the UFField entity.
  14  */
  15 class CRM_Core_DAO_UFField extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_uf_field';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Unique table ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Which form does this field belong to.
  40    *
  41    * @var int unsigned
  42    */
  43   public $uf_group_id;
  44
  45   /**
  46    * Name for CiviCRM field which is being exposed for sharing.
  47    *
  48    * @var string
  49    */
  50   public $field_name;
  51
  52   /**
  53    * Is this field currently shareable? If false, hide the field for all sharing contexts.
  54    *
  55    * @var boolean
  56    */
  57   public $is_active;
  58
  59   /**
  60    * the field is view only and not editable in user forms.
  61    *
  62    * @var boolean
  63    */
  64   public $is_view;
  65
  66   /**
  67    * Is this field required when included in a user or registration form?
  68    *
  69    * @var boolean
  70    */
  71   public $is_required;
  72
  73   /**
  74    * Controls field display order when user framework fields are displayed in registration and account editing forms.
  75    *
  76    * @var int
  77    */
  78   public $weight;
  79
  80   /**
  81    * Description and/or help text to display after this field.
  82    *
  83    * @var text
  84    */
  85   public $help_post;
  86
  87   /**
  88    * Description and/or help text to display before this field.
  89    *
  90    * @var text
  91    */
  92   public $help_pre;
  93
  94   /**
  95    * In what context(s) is this field visible.
  96    *
  97    * @var string
  98    */
  99   public $visibility;
 100
 101   /**
 102    * Is this field included as a column in the selector table?
 103    *
 104    * @var boolean
 105    */
 106   public $in_selector;
 107
 108   /**
 109    * Is this field included search form of profile?
 110    *
 111    * @var boolean
 112    */
 113   public $is_searchable;
 114
 115   /**
 116    * Location type of this mapping, if required
 117    *
 118    * @var int unsigned
 119    */
 120   public $location_type_id;
 121
 122   /**
 123    * Phone Type Id, if required
 124    *
 125    * @var int unsigned
 126    */
 127   public $phone_type_id;
 128
 129   /**
 130    * Website Type Id, if required
 131    *
 132    * @var int unsigned
 133    */
 134   public $website_type_id;
 135
 136   /**
 137    * To save label for fields.
 138    *
 139    * @var string
 140    */
 141   public $label;
 142
 143   /**
 144    * This field saves field type (ie individual,household.. field etc).
 145    *
 146    * @var string
 147    */
 148   public $field_type;
 149
 150   /**
 151    * Is this field reserved for use by some other CiviCRM functionality?
 152    *
 153    * @var boolean
 154    */
 155   public $is_reserved;
 156
 157   /**
 158    * Include in multi-record listing?
 159    *
 160    * @var boolean
 161    */
 162   public $is_multi_summary;
 163
 164   /**
 165    * Class constructor.
 166    */
 167   public function __construct() {
 168     $this->__table = 'civicrm_uf_field';
 169     parent::__construct();
 170   }
 171
 172   /**
 173    * Returns foreign keys and entity references.
 174    *
 175    * @return array
 176    *   [CRM_Core_Reference_Interface]
 177    */
 178   public static function getReferenceColumns() {
 179     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 180       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 181       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'uf_group_id', 'civicrm_uf_group', 'id');
 182       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'location_type_id', 'civicrm_location_type', 'id');
 183       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 184     }
 185     return Civi::$statics[__CLASS__]['links'];
 186   }
 187
 188   /**
 189    * Returns all the column names of this table
 190    *
 191    * @return array
 192    */
 193   public static function &fields() {
 194     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 195       Civi::$statics[__CLASS__]['fields'] = [
 196         'id' => [
 197           'name' => 'id',
 198           'type' => CRM_Utils_Type::T_INT,
 199           'title' => ts('Profile Field ID'),
 200           'description' => ts('Unique table ID'),
 201           'required' => TRUE,
 202           'table_name' => 'civicrm_uf_field',
 203           'entity' => 'UFField',
 204           'bao' => 'CRM_Core_BAO_UFField',
 205           'localizable' => 0,
 206         ],
 207         'uf_group_id' => [
 208           'name' => 'uf_group_id',
 209           'type' => CRM_Utils_Type::T_INT,
 210           'title' => ts('Profile ID'),
 211           'description' => ts('Which form does this field belong to.'),
 212           'required' => TRUE,
 213           'table_name' => 'civicrm_uf_field',
 214           'entity' => 'UFField',
 215           'bao' => 'CRM_Core_BAO_UFField',
 216           'localizable' => 0,
 217           'FKClassName' => 'CRM_Core_DAO_UFGroup',
 218           'html' => [
 219             'type' => 'Select',
 220           ],
 221           'pseudoconstant' => [
 222             'table' => 'civicrm_uf_group',
 223             'keyColumn' => 'id',
 224             'labelColumn' => 'title',
 225           ]
 226         ],
 227         'field_name' => [
 228           'name' => 'field_name',
 229           'type' => CRM_Utils_Type::T_STRING,
 230           'title' => ts('Profile Field Name'),
 231           'description' => ts('Name for CiviCRM field which is being exposed for sharing.'),
 232           'required' => TRUE,
 233           'maxlength' => 64,
 234           'size' => CRM_Utils_Type::BIG,
 235           'table_name' => 'civicrm_uf_field',
 236           'entity' => 'UFField',
 237           'bao' => 'CRM_Core_BAO_UFField',
 238           'localizable' => 0,
 239           'pseudoconstant' => [
 240             'callback' => 'CRM_Core_BAO_UFField::getAvailableFieldTitles',
 241           ]
 242         ],
 243         'is_active' => [
 244           'name' => 'is_active',
 245           'type' => CRM_Utils_Type::T_BOOLEAN,
 246           'title' => ts('Profile Field Is Active'),
 247           'description' => ts('Is this field currently shareable? If false, hide the field for all sharing contexts.'),
 248           'default' => '1',
 249           'table_name' => 'civicrm_uf_field',
 250           'entity' => 'UFField',
 251           'bao' => 'CRM_Core_BAO_UFField',
 252           'localizable' => 0,
 253         ],
 254         'is_view' => [
 255           'name' => 'is_view',
 256           'type' => CRM_Utils_Type::T_BOOLEAN,
 257           'title' => ts('Profile Is View Only'),
 258           'description' => ts('the field is view only and not editable in user forms.'),
 259           'default' => '0',
 260           'table_name' => 'civicrm_uf_field',
 261           'entity' => 'UFField',
 262           'bao' => 'CRM_Core_BAO_UFField',
 263           'localizable' => 0,
 264         ],
 265         'is_required' => [
 266           'name' => 'is_required',
 267           'type' => CRM_Utils_Type::T_BOOLEAN,
 268           'title' => ts('Profile Field Is Required'),
 269           'description' => ts('Is this field required when included in a user or registration form?'),
 270           'default' => '0',
 271           'table_name' => 'civicrm_uf_field',
 272           'entity' => 'UFField',
 273           'bao' => 'CRM_Core_BAO_UFField',
 274           'localizable' => 0,
 275         ],
 276         'weight' => [
 277           'name' => 'weight',
 278           'type' => CRM_Utils_Type::T_INT,
 279           'title' => ts('Order'),
 280           'description' => ts('Controls field display order when user framework fields are displayed in registration and account editing forms.'),
 281           'required' => TRUE,
 282           'default' => '1',
 283           'table_name' => 'civicrm_uf_field',
 284           'entity' => 'UFField',
 285           'bao' => 'CRM_Core_BAO_UFField',
 286           'localizable' => 0,
 287         ],
 288         'help_post' => [
 289           'name' => 'help_post',
 290           'type' => CRM_Utils_Type::T_TEXT,
 291           'title' => ts('Profile Field Post Help'),
 292           'description' => ts('Description and/or help text to display after this field.'),
 293           'table_name' => 'civicrm_uf_field',
 294           'entity' => 'UFField',
 295           'bao' => 'CRM_Core_BAO_UFField',
 296           'localizable' => 1,
 297         ],
 298         'help_pre' => [
 299           'name' => 'help_pre',
 300           'type' => CRM_Utils_Type::T_TEXT,
 301           'title' => ts('Profile Field Pre Help'),
 302           'description' => ts('Description and/or help text to display before this field.'),
 303           'table_name' => 'civicrm_uf_field',
 304           'entity' => 'UFField',
 305           'bao' => 'CRM_Core_BAO_UFField',
 306           'localizable' => 1,
 307         ],
 308         'visibility' => [
 309           'name' => 'visibility',
 310           'type' => CRM_Utils_Type::T_STRING,
 311           'title' => ts('Profile Field Visibility'),
 312           'description' => ts('In what context(s) is this field visible.'),
 313           'maxlength' => 32,
 314           'size' => CRM_Utils_Type::MEDIUM,
 315           'default' => 'User and User Admin Only',
 316           'table_name' => 'civicrm_uf_field',
 317           'entity' => 'UFField',
 318           'bao' => 'CRM_Core_BAO_UFField',
 319           'localizable' => 0,
 320           'html' => [
 321             'type' => 'Select',
 322           ],
 323           'pseudoconstant' => [
 324             'callback' => 'CRM_Core_SelectValues::ufVisibility',
 325           ]
 326         ],
 327         'in_selector' => [
 328           'name' => 'in_selector',
 329           'type' => CRM_Utils_Type::T_BOOLEAN,
 330           'title' => ts('Profile Field Is a Filter'),
 331           'description' => ts('Is this field included as a column in the selector table?'),
 332           'default' => '0',
 333           'table_name' => 'civicrm_uf_field',
 334           'entity' => 'UFField',
 335           'bao' => 'CRM_Core_BAO_UFField',
 336           'localizable' => 0,
 337         ],
 338         'is_searchable' => [
 339           'name' => 'is_searchable',
 340           'type' => CRM_Utils_Type::T_BOOLEAN,
 341           'title' => ts('Profile Field Is Searchable'),
 342           'description' => ts('Is this field included search form of profile?'),
 343           'default' => '0',
 344           'table_name' => 'civicrm_uf_field',
 345           'entity' => 'UFField',
 346           'bao' => 'CRM_Core_BAO_UFField',
 347           'localizable' => 0,
 348         ],
 349         'location_type_id' => [
 350           'name' => 'location_type_id',
 351           'type' => CRM_Utils_Type::T_INT,
 352           'title' => ts('Profile Field Location Type'),
 353           'description' => ts('Location type of this mapping, if required'),
 354           'table_name' => 'civicrm_uf_field',
 355           'entity' => 'UFField',
 356           'bao' => 'CRM_Core_BAO_UFField',
 357           'localizable' => 0,
 358           'FKClassName' => 'CRM_Core_DAO_LocationType',
 359         ],
 360         'phone_type_id' => [
 361           'name' => 'phone_type_id',
 362           'type' => CRM_Utils_Type::T_INT,
 363           'title' => ts('Profile Field Phone Type'),
 364           'description' => ts('Phone Type Id, if required'),
 365           'table_name' => 'civicrm_uf_field',
 366           'entity' => 'UFField',
 367           'bao' => 'CRM_Core_BAO_UFField',
 368           'localizable' => 0,
 369           'pseudoconstant' => [
 370             'optionGroupName' => 'phone_type',
 371             'optionEditPath' => 'civicrm/admin/options/phone_type',
 372           ]
 373         ],
 374         'website_type_id' => [
 375           'name' => 'website_type_id',
 376           'type' => CRM_Utils_Type::T_INT,
 377           'title' => ts('Profile Field Website Type'),
 378           'description' => ts('Website Type Id, if required'),
 379           'table_name' => 'civicrm_uf_field',
 380           'entity' => 'UFField',
 381           'bao' => 'CRM_Core_BAO_UFField',
 382           'localizable' => 0,
 383           'pseudoconstant' => [
 384             'optionGroupName' => 'website_type',
 385             'optionEditPath' => 'civicrm/admin/options/website_type',
 386           ]
 387         ],
 388         'label' => [
 389           'name' => 'label',
 390           'type' => CRM_Utils_Type::T_STRING,
 391           'title' => ts('Profile Field Label'),
 392           'description' => ts('To save label for fields.'),
 393           'required' => TRUE,
 394           'maxlength' => 255,
 395           'size' => CRM_Utils_Type::HUGE,
 396           'table_name' => 'civicrm_uf_field',
 397           'entity' => 'UFField',
 398           'bao' => 'CRM_Core_BAO_UFField',
 399           'localizable' => 1,
 400         ],
 401         'field_type' => [
 402           'name' => 'field_type',
 403           'type' => CRM_Utils_Type::T_STRING,
 404           'title' => ts('Profile Field Type'),
 405           'description' => ts('This field saves field type (ie individual,household.. field etc).'),
 406           'maxlength' => 255,
 407           'size' => CRM_Utils_Type::HUGE,
 408           'table_name' => 'civicrm_uf_field',
 409           'entity' => 'UFField',
 410           'bao' => 'CRM_Core_BAO_UFField',
 411           'localizable' => 0,
 412         ],
 413         'is_reserved' => [
 414           'name' => 'is_reserved',
 415           'type' => CRM_Utils_Type::T_BOOLEAN,
 416           'title' => ts('Profile Field Is Reserved'),
 417           'description' => ts('Is this field reserved for use by some other CiviCRM functionality?'),
 418           'table_name' => 'civicrm_uf_field',
 419           'entity' => 'UFField',
 420           'bao' => 'CRM_Core_BAO_UFField',
 421           'localizable' => 0,
 422         ],
 423         'is_multi_summary' => [
 424           'name' => 'is_multi_summary',
 425           'type' => CRM_Utils_Type::T_BOOLEAN,
 426           'title' => ts('Profile Field Supports Multiple'),
 427           'description' => ts('Include in multi-record listing?'),
 428           'default' => '0',
 429           'table_name' => 'civicrm_uf_field',
 430           'entity' => 'UFField',
 431           'bao' => 'CRM_Core_BAO_UFField',
 432           'localizable' => 0,
 433         ],
 434       ];
 435       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 436     }
 437     return Civi::$statics[__CLASS__]['fields'];
 438   }
 439
 440   /**
 441    * Return a mapping from field-name to the corresponding key (as used in fields()).
 442    *
 443    * @return array
 444    *   Array(string $name => string $uniqueName).
 445    */
 446   public static function &fieldKeys() {
 447     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 448       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 449     }
 450     return Civi::$statics[__CLASS__]['fieldKeys'];
 451   }
 452
 453   /**
 454    * Returns the names of this table
 455    *
 456    * @return string
 457    */
 458   public static function getTableName() {
 459     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 460   }
 461
 462   /**
 463    * Returns if this table needs to be logged
 464    *
 465    * @return bool
 466    */
 467   public function getLog() {
 468     return self::$_log;
 469   }
 470
 471   /**
 472    * Returns the list of fields that can be imported
 473    *
 474    * @param bool $prefix
 475    *
 476    * @return array
 477    */
 478   public static function &import($prefix = FALSE) {
 479     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_field', $prefix, []);
 480     return $r;
 481   }
 482
 483   /**
 484    * Returns the list of fields that can be exported
 485    *
 486    * @param bool $prefix
 487    *
 488    * @return array
 489    */
 490   public static function &export($prefix = FALSE) {
 491     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_field', $prefix, []);
 492     return $r;
 493   }
 494
 495   /**
 496    * Returns the list of indices
 497    *
 498    * @param bool $localize
 499    *
 500    * @return array
 501    */
 502   public static function indices($localize = TRUE) {
 503     $indices = [
 504       'IX_website_type_id' => [
 505         'name' => 'IX_website_type_id',
 506         'field' => [
 507           0 => 'website_type_id',
 508         ],
 509         'localizable' => FALSE,
 510         'sig' => 'civicrm_uf_field::0::website_type_id',
 511       ],
 512     ];
 513     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 514   }
 515
 516 }