CRM/Core/DAO/UFField.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2017
   6  *
   7  * Generated from xml/schema/CRM/Core/UFField.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:4777c5b97760d4bd4b7138468d18ded5)
  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   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   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' => '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' => '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' => '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         ],
 240         'is_active' => [
 241           'name' => 'is_active',
 242           'type' => CRM_Utils_Type::T_BOOLEAN,
 243           'title' => ts('Profile Field Is Active'),
 244           'description' => 'Is this field currently shareable? If false, hide the field for all sharing contexts.',
 245           'default' => '1',
 246           'table_name' => 'civicrm_uf_field',
 247           'entity' => 'UFField',
 248           'bao' => 'CRM_Core_BAO_UFField',
 249           'localizable' => 0,
 250         ],
 251         'is_view' => [
 252           'name' => 'is_view',
 253           'type' => CRM_Utils_Type::T_BOOLEAN,
 254           'title' => ts('Profile Is View Only'),
 255           'description' => 'the field is view only and not editable in user forms.',
 256           'table_name' => 'civicrm_uf_field',
 257           'entity' => 'UFField',
 258           'bao' => 'CRM_Core_BAO_UFField',
 259           'localizable' => 0,
 260         ],
 261         'is_required' => [
 262           'name' => 'is_required',
 263           'type' => CRM_Utils_Type::T_BOOLEAN,
 264           'title' => ts('Profile Field Is Required'),
 265           'description' => 'Is this field required when included in a user or registration form?',
 266           'table_name' => 'civicrm_uf_field',
 267           'entity' => 'UFField',
 268           'bao' => 'CRM_Core_BAO_UFField',
 269           'localizable' => 0,
 270         ],
 271         'weight' => [
 272           'name' => 'weight',
 273           'type' => CRM_Utils_Type::T_INT,
 274           'title' => ts('Order'),
 275           'description' => 'Controls field display order when user framework fields are displayed in registration and account editing forms.',
 276           'required' => TRUE,
 277           'default' => '1',
 278           'table_name' => 'civicrm_uf_field',
 279           'entity' => 'UFField',
 280           'bao' => 'CRM_Core_BAO_UFField',
 281           'localizable' => 0,
 282         ],
 283         'help_post' => [
 284           'name' => 'help_post',
 285           'type' => CRM_Utils_Type::T_TEXT,
 286           'title' => ts('Profile Field Post Help'),
 287           'description' => 'Description and/or help text to display after this field.',
 288           'table_name' => 'civicrm_uf_field',
 289           'entity' => 'UFField',
 290           'bao' => 'CRM_Core_BAO_UFField',
 291           'localizable' => 1,
 292         ],
 293         'help_pre' => [
 294           'name' => 'help_pre',
 295           'type' => CRM_Utils_Type::T_TEXT,
 296           'title' => ts('Profile Field Pre Help'),
 297           'description' => 'Description and/or help text to display before this field.',
 298           'table_name' => 'civicrm_uf_field',
 299           'entity' => 'UFField',
 300           'bao' => 'CRM_Core_BAO_UFField',
 301           'localizable' => 1,
 302         ],
 303         'visibility' => [
 304           'name' => 'visibility',
 305           'type' => CRM_Utils_Type::T_STRING,
 306           'title' => ts('Profile Field Visibility'),
 307           'description' => 'In what context(s) is this field visible.',
 308           'maxlength' => 32,
 309           'size' => CRM_Utils_Type::MEDIUM,
 310           'default' => 'User and User Admin Only',
 311           'table_name' => 'civicrm_uf_field',
 312           'entity' => 'UFField',
 313           'bao' => 'CRM_Core_BAO_UFField',
 314           'localizable' => 0,
 315           'html' => [
 316             'type' => 'Select',
 317           ],
 318           'pseudoconstant' => [
 319             'callback' => 'CRM_Core_SelectValues::ufVisibility',
 320           ]
 321         ],
 322         'in_selector' => [
 323           'name' => 'in_selector',
 324           'type' => CRM_Utils_Type::T_BOOLEAN,
 325           'title' => ts('Profile Field Is a Filter'),
 326           'description' => 'Is this field included as a column in the selector table?',
 327           'table_name' => 'civicrm_uf_field',
 328           'entity' => 'UFField',
 329           'bao' => 'CRM_Core_BAO_UFField',
 330           'localizable' => 0,
 331         ],
 332         'is_searchable' => [
 333           'name' => 'is_searchable',
 334           'type' => CRM_Utils_Type::T_BOOLEAN,
 335           'title' => ts('Profile Field Is Searchable'),
 336           'description' => 'Is this field included search form of profile?',
 337           'table_name' => 'civicrm_uf_field',
 338           'entity' => 'UFField',
 339           'bao' => 'CRM_Core_BAO_UFField',
 340           'localizable' => 0,
 341         ],
 342         'location_type_id' => [
 343           'name' => 'location_type_id',
 344           'type' => CRM_Utils_Type::T_INT,
 345           'title' => ts('Profile Field Location Type'),
 346           'description' => 'Location type of this mapping, if required',
 347           'table_name' => 'civicrm_uf_field',
 348           'entity' => 'UFField',
 349           'bao' => 'CRM_Core_BAO_UFField',
 350           'localizable' => 0,
 351           'FKClassName' => 'CRM_Core_DAO_LocationType',
 352         ],
 353         'phone_type_id' => [
 354           'name' => 'phone_type_id',
 355           'type' => CRM_Utils_Type::T_INT,
 356           'title' => ts('Profile Field Phone Type'),
 357           'description' => 'Phone Type Id, if required',
 358           'table_name' => 'civicrm_uf_field',
 359           'entity' => 'UFField',
 360           'bao' => 'CRM_Core_BAO_UFField',
 361           'localizable' => 0,
 362         ],
 363         'website_type_id' => [
 364           'name' => 'website_type_id',
 365           'type' => CRM_Utils_Type::T_INT,
 366           'title' => ts('Profile Field Website Type'),
 367           'description' => 'Website Type Id, if required',
 368           'table_name' => 'civicrm_uf_field',
 369           'entity' => 'UFField',
 370           'bao' => 'CRM_Core_BAO_UFField',
 371           'localizable' => 0,
 372         ],
 373         'label' => [
 374           'name' => 'label',
 375           'type' => CRM_Utils_Type::T_STRING,
 376           'title' => ts('Profile Field Label'),
 377           'description' => 'To save label for fields.',
 378           'required' => TRUE,
 379           'maxlength' => 255,
 380           'size' => CRM_Utils_Type::HUGE,
 381           'table_name' => 'civicrm_uf_field',
 382           'entity' => 'UFField',
 383           'bao' => 'CRM_Core_BAO_UFField',
 384           'localizable' => 1,
 385         ],
 386         'field_type' => [
 387           'name' => 'field_type',
 388           'type' => CRM_Utils_Type::T_STRING,
 389           'title' => ts('Profile Field Type'),
 390           'description' => 'This field saves field type (ie individual,household.. field etc).',
 391           'maxlength' => 255,
 392           'size' => CRM_Utils_Type::HUGE,
 393           'table_name' => 'civicrm_uf_field',
 394           'entity' => 'UFField',
 395           'bao' => 'CRM_Core_BAO_UFField',
 396           'localizable' => 0,
 397         ],
 398         'is_reserved' => [
 399           'name' => 'is_reserved',
 400           'type' => CRM_Utils_Type::T_BOOLEAN,
 401           'title' => ts('Profile Field Is Reserved'),
 402           'description' => 'Is this field reserved for use by some other CiviCRM functionality?',
 403           'table_name' => 'civicrm_uf_field',
 404           'entity' => 'UFField',
 405           'bao' => 'CRM_Core_BAO_UFField',
 406           'localizable' => 0,
 407         ],
 408         'is_multi_summary' => [
 409           'name' => 'is_multi_summary',
 410           'type' => CRM_Utils_Type::T_BOOLEAN,
 411           'title' => ts('Profile Field Supports Multiple'),
 412           'description' => 'Include in multi-record listing?',
 413           'table_name' => 'civicrm_uf_field',
 414           'entity' => 'UFField',
 415           'bao' => 'CRM_Core_BAO_UFField',
 416           'localizable' => 0,
 417         ],
 418       ];
 419       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 420     }
 421     return Civi::$statics[__CLASS__]['fields'];
 422   }
 423
 424   /**
 425    * Return a mapping from field-name to the corresponding key (as used in fields()).
 426    *
 427    * @return array
 428    *   Array(string $name => string $uniqueName).
 429    */
 430   public static function &fieldKeys() {
 431     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 432       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 433     }
 434     return Civi::$statics[__CLASS__]['fieldKeys'];
 435   }
 436
 437   /**
 438    * Returns the names of this table
 439    *
 440    * @return string
 441    */
 442   public static function getTableName() {
 443     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 444   }
 445
 446   /**
 447    * Returns if this table needs to be logged
 448    *
 449    * @return bool
 450    */
 451   public function getLog() {
 452     return self::$_log;
 453   }
 454
 455   /**
 456    * Returns the list of fields that can be imported
 457    *
 458    * @param bool $prefix
 459    *
 460    * @return array
 461    */
 462   public static function &import($prefix = FALSE) {
 463     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_field', $prefix, []);
 464     return $r;
 465   }
 466
 467   /**
 468    * Returns the list of fields that can be exported
 469    *
 470    * @param bool $prefix
 471    *
 472    * @return array
 473    */
 474   public static function &export($prefix = FALSE) {
 475     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_field', $prefix, []);
 476     return $r;
 477   }
 478
 479   /**
 480    * Returns the list of indices
 481    *
 482    * @param bool $localize
 483    *
 484    * @return array
 485    */
 486   public static function indices($localize = TRUE) {
 487     $indices = [
 488       'IX_website_type_id' => [
 489         'name' => 'IX_website_type_id',
 490         'field' => [
 491           0 => 'website_type_id',
 492         ],
 493         'localizable' => FALSE,
 494         'sig' => 'civicrm_uf_field::0::website_type_id',
 495       ],
 496     ];
 497     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 498   }
 499
 500 }