CRM/Core/DAO/UFJoin.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/UFJoin.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:09aaa3fd826c1b3407d39966f0f11aa7)
  10  */
  11
  12 /**
  13  * Database access object for the UFJoin entity.
  14  */
  15 class CRM_Core_DAO_UFJoin 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_join';
  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    * Is this join currently active?
  40    *
  41    * @var boolean
  42    */
  43   public $is_active;
  44
  45   /**
  46    * Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.
  47    *
  48    * @var string
  49    */
  50   public $module;
  51
  52   /**
  53    * Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.
  54    *
  55    * @var string
  56    */
  57   public $entity_table;
  58
  59   /**
  60    * Foreign key to the referenced item.
  61    *
  62    * @var int unsigned
  63    */
  64   public $entity_id;
  65
  66   /**
  67    * Controls display order when multiple user framework groups are setup for concurrent display.
  68    *
  69    * @var int
  70    */
  71   public $weight;
  72
  73   /**
  74    * Which form does this field belong to.
  75    *
  76    * @var int unsigned
  77    */
  78   public $uf_group_id;
  79
  80   /**
  81    * Json serialized array of data used by the ufjoin.module
  82    *
  83    * @var longtext
  84    */
  85   public $module_data;
  86
  87   /**
  88    * Class constructor.
  89    */
  90   public function __construct() {
  91     $this->__table = 'civicrm_uf_join';
  92     parent::__construct();
  93   }
  94
  95   /**
  96    * Returns foreign keys and entity references.
  97    *
  98    * @return array
  99    *   [CRM_Core_Reference_Interface]
 100    */
 101   public static function getReferenceColumns() {
 102     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 103       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 104       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'uf_group_id', 'civicrm_uf_group', 'id');
 105       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
 106       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 107     }
 108     return Civi::$statics[__CLASS__]['links'];
 109   }
 110
 111   /**
 112    * Returns all the column names of this table
 113    *
 114    * @return array
 115    */
 116   public static function &fields() {
 117     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 118       Civi::$statics[__CLASS__]['fields'] = [
 119         'id' => [
 120           'name' => 'id',
 121           'type' => CRM_Utils_Type::T_INT,
 122           'title' => ts('UF Join ID'),
 123           'description' => ts('Unique table ID'),
 124           'required' => TRUE,
 125           'where' => 'civicrm_uf_join.id',
 126           'table_name' => 'civicrm_uf_join',
 127           'entity' => 'UFJoin',
 128           'bao' => 'CRM_Core_BAO_UFJoin',
 129           'localizable' => 0,
 130         ],
 131         'is_active' => [
 132           'name' => 'is_active',
 133           'type' => CRM_Utils_Type::T_BOOLEAN,
 134           'title' => ts('Profile Use is active'),
 135           'description' => ts('Is this join currently active?'),
 136           'where' => 'civicrm_uf_join.is_active',
 137           'default' => '1',
 138           'table_name' => 'civicrm_uf_join',
 139           'entity' => 'UFJoin',
 140           'bao' => 'CRM_Core_BAO_UFJoin',
 141           'localizable' => 0,
 142         ],
 143         'module' => [
 144           'name' => 'module',
 145           'type' => CRM_Utils_Type::T_STRING,
 146           'title' => ts('Profile Module'),
 147           'description' => ts('Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.'),
 148           'required' => TRUE,
 149           'maxlength' => 64,
 150           'size' => CRM_Utils_Type::BIG,
 151           'where' => 'civicrm_uf_join.module',
 152           'table_name' => 'civicrm_uf_join',
 153           'entity' => 'UFJoin',
 154           'bao' => 'CRM_Core_BAO_UFJoin',
 155           'localizable' => 0,
 156         ],
 157         'entity_table' => [
 158           'name' => 'entity_table',
 159           'type' => CRM_Utils_Type::T_STRING,
 160           'title' => ts('Profile Entity Table'),
 161           'description' => ts('Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.'),
 162           'maxlength' => 64,
 163           'size' => CRM_Utils_Type::BIG,
 164           'where' => 'civicrm_uf_join.entity_table',
 165           'table_name' => 'civicrm_uf_join',
 166           'entity' => 'UFJoin',
 167           'bao' => 'CRM_Core_BAO_UFJoin',
 168           'localizable' => 0,
 169           'pseudoconstant' => [
 170             'callback' => 'CRM_Core_BAO_UFJoin::entityTables',
 171           ]
 172         ],
 173         'entity_id' => [
 174           'name' => 'entity_id',
 175           'type' => CRM_Utils_Type::T_INT,
 176           'title' => ts('Profile Entity ID'),
 177           'description' => ts('Foreign key to the referenced item.'),
 178           'where' => 'civicrm_uf_join.entity_id',
 179           'table_name' => 'civicrm_uf_join',
 180           'entity' => 'UFJoin',
 181           'bao' => 'CRM_Core_BAO_UFJoin',
 182           'localizable' => 0,
 183         ],
 184         'weight' => [
 185           'name' => 'weight',
 186           'type' => CRM_Utils_Type::T_INT,
 187           'title' => ts('Order'),
 188           'description' => ts('Controls display order when multiple user framework groups are setup for concurrent display.'),
 189           'required' => TRUE,
 190           'where' => 'civicrm_uf_join.weight',
 191           'default' => '1',
 192           'table_name' => 'civicrm_uf_join',
 193           'entity' => 'UFJoin',
 194           'bao' => 'CRM_Core_BAO_UFJoin',
 195           'localizable' => 0,
 196         ],
 197         'uf_group_id' => [
 198           'name' => 'uf_group_id',
 199           'type' => CRM_Utils_Type::T_INT,
 200           'title' => ts('Profile ID'),
 201           'description' => ts('Which form does this field belong to.'),
 202           'required' => TRUE,
 203           'where' => 'civicrm_uf_join.uf_group_id',
 204           'table_name' => 'civicrm_uf_join',
 205           'entity' => 'UFJoin',
 206           'bao' => 'CRM_Core_BAO_UFJoin',
 207           'localizable' => 0,
 208           'FKClassName' => 'CRM_Core_DAO_UFGroup',
 209           'html' => [
 210             'type' => 'Select',
 211           ],
 212           'pseudoconstant' => [
 213             'table' => 'civicrm_uf_group',
 214             'keyColumn' => 'id',
 215             'labelColumn' => 'title',
 216           ]
 217         ],
 218         'module_data' => [
 219           'name' => 'module_data',
 220           'type' => CRM_Utils_Type::T_LONGTEXT,
 221           'title' => ts('Profile Use Data'),
 222           'description' => ts('Json serialized array of data used by the ufjoin.module'),
 223           'where' => 'civicrm_uf_join.module_data',
 224           'table_name' => 'civicrm_uf_join',
 225           'entity' => 'UFJoin',
 226           'bao' => 'CRM_Core_BAO_UFJoin',
 227           'localizable' => 0,
 228           'serialize' => self::SERIALIZE_JSON,
 229         ],
 230       ];
 231       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 232     }
 233     return Civi::$statics[__CLASS__]['fields'];
 234   }
 235
 236   /**
 237    * Return a mapping from field-name to the corresponding key (as used in fields()).
 238    *
 239    * @return array
 240    *   Array(string $name => string $uniqueName).
 241    */
 242   public static function &fieldKeys() {
 243     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 244       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 245     }
 246     return Civi::$statics[__CLASS__]['fieldKeys'];
 247   }
 248
 249   /**
 250    * Returns the names of this table
 251    *
 252    * @return string
 253    */
 254   public static function getTableName() {
 255     return self::$_tableName;
 256   }
 257
 258   /**
 259    * Returns if this table needs to be logged
 260    *
 261    * @return bool
 262    */
 263   public function getLog() {
 264     return self::$_log;
 265   }
 266
 267   /**
 268    * Returns the list of fields that can be imported
 269    *
 270    * @param bool $prefix
 271    *
 272    * @return array
 273    */
 274   public static function &import($prefix = FALSE) {
 275     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_join', $prefix, []);
 276     return $r;
 277   }
 278
 279   /**
 280    * Returns the list of fields that can be exported
 281    *
 282    * @param bool $prefix
 283    *
 284    * @return array
 285    */
 286   public static function &export($prefix = FALSE) {
 287     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_join', $prefix, []);
 288     return $r;
 289   }
 290
 291   /**
 292    * Returns the list of indices
 293    *
 294    * @param bool $localize
 295    *
 296    * @return array
 297    */
 298   public static function indices($localize = TRUE) {
 299     $indices = [
 300       'index_entity' => [
 301         'name' => 'index_entity',
 302         'field' => [
 303           0 => 'entity_table',
 304           1 => 'entity_id',
 305         ],
 306         'localizable' => FALSE,
 307         'sig' => 'civicrm_uf_join::0::entity_table::entity_id',
 308       ],
 309     ];
 310     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 311   }
 312
 313 }