CRM/Core/DAO/CustomGroup.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/CustomGroup.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:9131714b35a45d028cf14456d1e57170)
  10  */
  11
  12 /**
  13  * Database access object for the CustomGroup entity.
  14  */
  15 class CRM_Core_DAO_CustomGroup extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_custom_group';
  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 Custom Group ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Variable name/programmatic handle for this group.
  40    *
  41    * @var string
  42    */
  43   public $name;
  44
  45   /**
  46    * Friendly Name.
  47    *
  48    * @var string
  49    */
  50   public $title;
  51
  52   /**
  53    * Type of object this group extends (can add other options later e.g. contact_address, etc.).
  54    *
  55    * @var string
  56    */
  57   public $extends;
  58
  59   /**
  60    * FK to civicrm_option_value.id (for option group custom_data_type.)
  61    *
  62    * @var int unsigned
  63    */
  64   public $extends_entity_column_id;
  65
  66   /**
  67    * linking custom group for dynamic object
  68    *
  69    * @var string
  70    */
  71   public $extends_entity_column_value;
  72
  73   /**
  74    * Visual relationship between this form and its parent.
  75    *
  76    * @var string
  77    */
  78   public $style;
  79
  80   /**
  81    * Will this group be in collapsed or expanded mode on initial display ?
  82    *
  83    * @var int unsigned
  84    */
  85   public $collapse_display;
  86
  87   /**
  88    * Description and/or help text to display before fields in form.
  89    *
  90    * @var text
  91    */
  92   public $help_pre;
  93
  94   /**
  95    * Description and/or help text to display after fields in form.
  96    *
  97    * @var text
  98    */
  99   public $help_post;
 100
 101   /**
 102    * Controls display order when multiple extended property groups are setup for the same class.
 103    *
 104    * @var int
 105    */
 106   public $weight;
 107
 108   /**
 109    * Is this property active?
 110    *
 111    * @var boolean
 112    */
 113   public $is_active;
 114
 115   /**
 116    * Name of the table that holds the values for this group.
 117    *
 118    * @var string
 119    */
 120   public $table_name;
 121
 122   /**
 123    * Does this group hold multiple values?
 124    *
 125    * @var boolean
 126    */
 127   public $is_multiple;
 128
 129   /**
 130    * minimum number of multiple records (typically 0?)
 131    *
 132    * @var int unsigned
 133    */
 134   public $min_multiple;
 135
 136   /**
 137    * maximum number of multiple records, if 0 - no max
 138    *
 139    * @var int unsigned
 140    */
 141   public $max_multiple;
 142
 143   /**
 144    * Will this group be in collapsed or expanded mode on advanced search display ?
 145    *
 146    * @var int unsigned
 147    */
 148   public $collapse_adv_display;
 149
 150   /**
 151    * FK to civicrm_contact, who created this custom group
 152    *
 153    * @var int unsigned
 154    */
 155   public $created_id;
 156
 157   /**
 158    * Date and time this custom group was created.
 159    *
 160    * @var datetime
 161    */
 162   public $created_date;
 163
 164   /**
 165    * Is this a reserved Custom Group?
 166    *
 167    * @var boolean
 168    */
 169   public $is_reserved;
 170
 171   /**
 172    * Is this property public?
 173    *
 174    * @var boolean
 175    */
 176   public $is_public;
 177
 178   /**
 179    * Class constructor.
 180    */
 181   public function __construct() {
 182     $this->__table = 'civicrm_custom_group';
 183     parent::__construct();
 184   }
 185
 186   /**
 187    * Returns foreign keys and entity references.
 188    *
 189    * @return array
 190    *   [CRM_Core_Reference_Interface]
 191    */
 192   public static function getReferenceColumns() {
 193     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 194       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 195       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id');
 196       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 197     }
 198     return Civi::$statics[__CLASS__]['links'];
 199   }
 200
 201   /**
 202    * Returns all the column names of this table
 203    *
 204    * @return array
 205    */
 206   public static function &fields() {
 207     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 208       Civi::$statics[__CLASS__]['fields'] = [
 209         'id' => [
 210           'name' => 'id',
 211           'type' => CRM_Utils_Type::T_INT,
 212           'title' => ts('Custom Group ID'),
 213           'description' => ts('Unique Custom Group ID'),
 214           'required' => TRUE,
 215           'table_name' => 'civicrm_custom_group',
 216           'entity' => 'CustomGroup',
 217           'bao' => 'CRM_Core_BAO_CustomGroup',
 218           'localizable' => 0,
 219         ],
 220         'name' => [
 221           'name' => 'name',
 222           'type' => CRM_Utils_Type::T_STRING,
 223           'title' => ts('Custom Group Name'),
 224           'description' => ts('Variable name/programmatic handle for this group.'),
 225           'maxlength' => 64,
 226           'size' => CRM_Utils_Type::BIG,
 227           'table_name' => 'civicrm_custom_group',
 228           'entity' => 'CustomGroup',
 229           'bao' => 'CRM_Core_BAO_CustomGroup',
 230           'localizable' => 0,
 231         ],
 232         'title' => [
 233           'name' => 'title',
 234           'type' => CRM_Utils_Type::T_STRING,
 235           'title' => ts('Custom Group Title'),
 236           'description' => ts('Friendly Name.'),
 237           'required' => TRUE,
 238           'maxlength' => 64,
 239           'size' => CRM_Utils_Type::BIG,
 240           'table_name' => 'civicrm_custom_group',
 241           'entity' => 'CustomGroup',
 242           'bao' => 'CRM_Core_BAO_CustomGroup',
 243           'localizable' => 1,
 244         ],
 245         'extends' => [
 246           'name' => 'extends',
 247           'type' => CRM_Utils_Type::T_STRING,
 248           'title' => ts('Custom Group Extends'),
 249           'description' => ts('Type of object this group extends (can add other options later e.g. contact_address, etc.).'),
 250           'maxlength' => 255,
 251           'size' => CRM_Utils_Type::HUGE,
 252           'default' => 'Contact',
 253           'table_name' => 'civicrm_custom_group',
 254           'entity' => 'CustomGroup',
 255           'bao' => 'CRM_Core_BAO_CustomGroup',
 256           'localizable' => 0,
 257         ],
 258         'extends_entity_column_id' => [
 259           'name' => 'extends_entity_column_id',
 260           'type' => CRM_Utils_Type::T_INT,
 261           'title' => ts('Custom Group Subtype List'),
 262           'description' => ts('FK to civicrm_option_value.id (for option group custom_data_type.)'),
 263           'default' => 'NULL',
 264           'table_name' => 'civicrm_custom_group',
 265           'entity' => 'CustomGroup',
 266           'bao' => 'CRM_Core_BAO_CustomGroup',
 267           'localizable' => 0,
 268           'html' => [
 269             'type' => 'Select',
 270           ],
 271           'pseudoconstant' => [
 272             'optionGroupName' => 'custom_data_type',
 273             'optionEditPath' => 'civicrm/admin/options/custom_data_type',
 274           ]
 275         ],
 276         'extends_entity_column_value' => [
 277           'name' => 'extends_entity_column_value',
 278           'type' => CRM_Utils_Type::T_STRING,
 279           'title' => ts('Custom Group Subtype'),
 280           'description' => ts('linking custom group for dynamic object'),
 281           'maxlength' => 255,
 282           'size' => CRM_Utils_Type::HUGE,
 283           'table_name' => 'civicrm_custom_group',
 284           'entity' => 'CustomGroup',
 285           'bao' => 'CRM_Core_BAO_CustomGroup',
 286           'localizable' => 0,
 287           'serialize' => self::SERIALIZE_SEPARATOR_BOOKEND,
 288         ],
 289         'style' => [
 290           'name' => 'style',
 291           'type' => CRM_Utils_Type::T_STRING,
 292           'title' => ts('Custom Group Style'),
 293           'description' => ts('Visual relationship between this form and its parent.'),
 294           'maxlength' => 15,
 295           'size' => CRM_Utils_Type::TWELVE,
 296           'table_name' => 'civicrm_custom_group',
 297           'entity' => 'CustomGroup',
 298           'bao' => 'CRM_Core_BAO_CustomGroup',
 299           'localizable' => 0,
 300           'html' => [
 301             'type' => 'Select',
 302           ],
 303           'pseudoconstant' => [
 304             'callback' => 'CRM_Core_SelectValues::customGroupStyle',
 305           ]
 306         ],
 307         'collapse_display' => [
 308           'name' => 'collapse_display',
 309           'type' => CRM_Utils_Type::T_INT,
 310           'title' => ts('Collapse Custom Group?'),
 311           'description' => ts('Will this group be in collapsed or expanded mode on initial display ?'),
 312           'default' => '0',
 313           'table_name' => 'civicrm_custom_group',
 314           'entity' => 'CustomGroup',
 315           'bao' => 'CRM_Core_BAO_CustomGroup',
 316           'localizable' => 0,
 317         ],
 318         'help_pre' => [
 319           'name' => 'help_pre',
 320           'type' => CRM_Utils_Type::T_TEXT,
 321           'title' => ts('Custom Group Pre Text'),
 322           'description' => ts('Description and/or help text to display before fields in form.'),
 323           'rows' => 4,
 324           'cols' => 80,
 325           'table_name' => 'civicrm_custom_group',
 326           'entity' => 'CustomGroup',
 327           'bao' => 'CRM_Core_BAO_CustomGroup',
 328           'localizable' => 1,
 329           'html' => [
 330             'type' => 'TextArea',
 331           ],
 332         ],
 333         'help_post' => [
 334           'name' => 'help_post',
 335           'type' => CRM_Utils_Type::T_TEXT,
 336           'title' => ts('Custom Group Post Text'),
 337           'description' => ts('Description and/or help text to display after fields in form.'),
 338           'rows' => 4,
 339           'cols' => 80,
 340           'table_name' => 'civicrm_custom_group',
 341           'entity' => 'CustomGroup',
 342           'bao' => 'CRM_Core_BAO_CustomGroup',
 343           'localizable' => 1,
 344           'html' => [
 345             'type' => 'TextArea',
 346           ],
 347         ],
 348         'weight' => [
 349           'name' => 'weight',
 350           'type' => CRM_Utils_Type::T_INT,
 351           'title' => ts('Order'),
 352           'description' => ts('Controls display order when multiple extended property groups are setup for the same class.'),
 353           'required' => TRUE,
 354           'default' => '1',
 355           'table_name' => 'civicrm_custom_group',
 356           'entity' => 'CustomGroup',
 357           'bao' => 'CRM_Core_BAO_CustomGroup',
 358           'localizable' => 0,
 359         ],
 360         'is_active' => [
 361           'name' => 'is_active',
 362           'type' => CRM_Utils_Type::T_BOOLEAN,
 363           'title' => ts('Custom Group Is Active?'),
 364           'description' => ts('Is this property active?'),
 365           'default' => '1',
 366           'table_name' => 'civicrm_custom_group',
 367           'entity' => 'CustomGroup',
 368           'bao' => 'CRM_Core_BAO_CustomGroup',
 369           'localizable' => 0,
 370         ],
 371         'table_name' => [
 372           'name' => 'table_name',
 373           'type' => CRM_Utils_Type::T_STRING,
 374           'title' => ts('Table Name'),
 375           'description' => ts('Name of the table that holds the values for this group.'),
 376           'maxlength' => 255,
 377           'size' => CRM_Utils_Type::HUGE,
 378           'table_name' => 'civicrm_custom_group',
 379           'entity' => 'CustomGroup',
 380           'bao' => 'CRM_Core_BAO_CustomGroup',
 381           'localizable' => 0,
 382         ],
 383         'is_multiple' => [
 384           'name' => 'is_multiple',
 385           'type' => CRM_Utils_Type::T_BOOLEAN,
 386           'title' => ts('Supports Multiple Records'),
 387           'description' => ts('Does this group hold multiple values?'),
 388           'default' => '0',
 389           'table_name' => 'civicrm_custom_group',
 390           'entity' => 'CustomGroup',
 391           'bao' => 'CRM_Core_BAO_CustomGroup',
 392           'localizable' => 0,
 393         ],
 394         'min_multiple' => [
 395           'name' => 'min_multiple',
 396           'type' => CRM_Utils_Type::T_INT,
 397           'title' => ts('Minimum Multiple Records'),
 398           'description' => ts('minimum number of multiple records (typically 0?)'),
 399           'table_name' => 'civicrm_custom_group',
 400           'entity' => 'CustomGroup',
 401           'bao' => 'CRM_Core_BAO_CustomGroup',
 402           'localizable' => 0,
 403         ],
 404         'max_multiple' => [
 405           'name' => 'max_multiple',
 406           'type' => CRM_Utils_Type::T_INT,
 407           'title' => ts('Maximum Multiple Records'),
 408           'description' => ts('maximum number of multiple records, if 0 - no max'),
 409           'table_name' => 'civicrm_custom_group',
 410           'entity' => 'CustomGroup',
 411           'bao' => 'CRM_Core_BAO_CustomGroup',
 412           'localizable' => 0,
 413         ],
 414         'collapse_adv_display' => [
 415           'name' => 'collapse_adv_display',
 416           'type' => CRM_Utils_Type::T_INT,
 417           'title' => ts('Collapse Group Display'),
 418           'description' => ts('Will this group be in collapsed or expanded mode on advanced search display ?'),
 419           'default' => '0',
 420           'table_name' => 'civicrm_custom_group',
 421           'entity' => 'CustomGroup',
 422           'bao' => 'CRM_Core_BAO_CustomGroup',
 423           'localizable' => 0,
 424         ],
 425         'created_id' => [
 426           'name' => 'created_id',
 427           'type' => CRM_Utils_Type::T_INT,
 428           'title' => ts('Custom Group Created By'),
 429           'description' => ts('FK to civicrm_contact, who created this custom group'),
 430           'table_name' => 'civicrm_custom_group',
 431           'entity' => 'CustomGroup',
 432           'bao' => 'CRM_Core_BAO_CustomGroup',
 433           'localizable' => 0,
 434           'FKClassName' => 'CRM_Contact_DAO_Contact',
 435         ],
 436         'created_date' => [
 437           'name' => 'created_date',
 438           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 439           'title' => ts('Custom Group Created Date'),
 440           'description' => ts('Date and time this custom group was created.'),
 441           'table_name' => 'civicrm_custom_group',
 442           'entity' => 'CustomGroup',
 443           'bao' => 'CRM_Core_BAO_CustomGroup',
 444           'localizable' => 0,
 445         ],
 446         'is_reserved' => [
 447           'name' => 'is_reserved',
 448           'type' => CRM_Utils_Type::T_BOOLEAN,
 449           'title' => ts('Reserved Group?'),
 450           'description' => ts('Is this a reserved Custom Group?'),
 451           'default' => '0',
 452           'table_name' => 'civicrm_custom_group',
 453           'entity' => 'CustomGroup',
 454           'bao' => 'CRM_Core_BAO_CustomGroup',
 455           'localizable' => 0,
 456         ],
 457         'is_public' => [
 458           'name' => 'is_public',
 459           'type' => CRM_Utils_Type::T_BOOLEAN,
 460           'title' => ts('Custom Group Is Public?'),
 461           'description' => ts('Is this property public?'),
 462           'default' => '1',
 463           'table_name' => 'civicrm_custom_group',
 464           'entity' => 'CustomGroup',
 465           'bao' => 'CRM_Core_BAO_CustomGroup',
 466           'localizable' => 0,
 467         ],
 468       ];
 469       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 470     }
 471     return Civi::$statics[__CLASS__]['fields'];
 472   }
 473
 474   /**
 475    * Return a mapping from field-name to the corresponding key (as used in fields()).
 476    *
 477    * @return array
 478    *   Array(string $name => string $uniqueName).
 479    */
 480   public static function &fieldKeys() {
 481     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 482       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 483     }
 484     return Civi::$statics[__CLASS__]['fieldKeys'];
 485   }
 486
 487   /**
 488    * Returns the names of this table
 489    *
 490    * @return string
 491    */
 492   public static function getTableName() {
 493     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 494   }
 495
 496   /**
 497    * Returns if this table needs to be logged
 498    *
 499    * @return bool
 500    */
 501   public function getLog() {
 502     return self::$_log;
 503   }
 504
 505   /**
 506    * Returns the list of fields that can be imported
 507    *
 508    * @param bool $prefix
 509    *
 510    * @return array
 511    */
 512   public static function &import($prefix = FALSE) {
 513     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_group', $prefix, []);
 514     return $r;
 515   }
 516
 517   /**
 518    * Returns the list of fields that can be exported
 519    *
 520    * @param bool $prefix
 521    *
 522    * @return array
 523    */
 524   public static function &export($prefix = FALSE) {
 525     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_group', $prefix, []);
 526     return $r;
 527   }
 528
 529   /**
 530    * Returns the list of indices
 531    *
 532    * @param bool $localize
 533    *
 534    * @return array
 535    */
 536   public static function indices($localize = TRUE) {
 537     $indices = [
 538       'UI_title_extends' => [
 539         'name' => 'UI_title_extends',
 540         'field' => [
 541           0 => 'title',
 542           1 => 'extends',
 543         ],
 544         'localizable' => TRUE,
 545         'unique' => TRUE,
 546         'sig' => 'civicrm_custom_group::1::title::extends',
 547       ],
 548       'UI_name_extends' => [
 549         'name' => 'UI_name_extends',
 550         'field' => [
 551           0 => 'name',
 552           1 => 'extends',
 553         ],
 554         'localizable' => FALSE,
 555         'unique' => TRUE,
 556         'sig' => 'civicrm_custom_group::1::name::extends',
 557       ],
 558     ];
 559     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 560   }
 561
 562 }