CRM/Core/DAO/Domain.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/Domain.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:99a50c29878792b8864e20d184ce9bbb)
  10  */
  11
  12 /**
  13  * Database access object for the Domain entity.
  14  */
  15 class CRM_Core_DAO_Domain extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.1';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_domain';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * Domain ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Name of Domain / Organization
  42    *
  43    * @var string
  44    */
  45   public $name;
  46
  47   /**
  48    * Description of Domain.
  49    *
  50    * @var string
  51    */
  52   public $description;
  53
  54   /**
  55    * The civicrm version this instance is running
  56    *
  57    * @var string
  58    */
  59   public $version;
  60
  61   /**
  62    * FK to Contact ID. This is specifically not an FK to avoid circular constraints
  63    *
  64    * @var int
  65    */
  66   public $contact_id;
  67
  68   /**
  69    * list of locales supported by the current db state (NULL for single-lang install)
  70    *
  71    * @var text
  72    */
  73   public $locales;
  74
  75   /**
  76    * Locale specific string overrides
  77    *
  78    * @var text
  79    */
  80   public $locale_custom_strings;
  81
  82   /**
  83    * Class constructor.
  84    */
  85   public function __construct() {
  86     $this->__table = 'civicrm_domain';
  87     parent::__construct();
  88   }
  89
  90   /**
  91    * Returns localized title of this entity.
  92    *
  93    * @param bool $plural
  94    *   Whether to return the plural version of the title.
  95    */
  96   public static function getEntityTitle($plural = FALSE) {
  97     return $plural ? ts('Domains') : ts('Domain');
  98   }
  99
 100   /**
 101    * Returns foreign keys and entity references.
 102    *
 103    * @return array
 104    *   [CRM_Core_Reference_Interface]
 105    */
 106   public static function getReferenceColumns() {
 107     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 108       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 109       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
 110       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 111     }
 112     return Civi::$statics[__CLASS__]['links'];
 113   }
 114
 115   /**
 116    * Returns all the column names of this table
 117    *
 118    * @return array
 119    */
 120   public static function &fields() {
 121     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 122       Civi::$statics[__CLASS__]['fields'] = [
 123         'id' => [
 124           'name' => 'id',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('Domain ID'),
 127           'description' => ts('Domain ID'),
 128           'required' => TRUE,
 129           'where' => 'civicrm_domain.id',
 130           'table_name' => 'civicrm_domain',
 131           'entity' => 'Domain',
 132           'bao' => 'CRM_Core_BAO_Domain',
 133           'localizable' => 0,
 134           'add' => '1.1',
 135         ],
 136         'name' => [
 137           'name' => 'name',
 138           'type' => CRM_Utils_Type::T_STRING,
 139           'title' => ts('Domain Name'),
 140           'description' => ts('Name of Domain / Organization'),
 141           'maxlength' => 64,
 142           'size' => CRM_Utils_Type::BIG,
 143           'where' => 'civicrm_domain.name',
 144           'table_name' => 'civicrm_domain',
 145           'entity' => 'Domain',
 146           'bao' => 'CRM_Core_BAO_Domain',
 147           'localizable' => 0,
 148           'html' => [
 149             'type' => 'Text',
 150           ],
 151           'add' => '1.1',
 152         ],
 153         'description' => [
 154           'name' => 'description',
 155           'type' => CRM_Utils_Type::T_STRING,
 156           'title' => ts('Domain Description'),
 157           'description' => ts('Description of Domain.'),
 158           'maxlength' => 255,
 159           'size' => CRM_Utils_Type::HUGE,
 160           'where' => 'civicrm_domain.description',
 161           'table_name' => 'civicrm_domain',
 162           'entity' => 'Domain',
 163           'bao' => 'CRM_Core_BAO_Domain',
 164           'localizable' => 0,
 165           'html' => [
 166             'type' => 'Text',
 167           ],
 168           'add' => '1.1',
 169         ],
 170         'version' => [
 171           'name' => 'version',
 172           'type' => CRM_Utils_Type::T_STRING,
 173           'title' => ts('CiviCRM Version'),
 174           'description' => ts('The civicrm version this instance is running'),
 175           'maxlength' => 32,
 176           'size' => CRM_Utils_Type::MEDIUM,
 177           'where' => 'civicrm_domain.version',
 178           'table_name' => 'civicrm_domain',
 179           'entity' => 'Domain',
 180           'bao' => 'CRM_Core_BAO_Domain',
 181           'localizable' => 0,
 182           'add' => '2.0',
 183         ],
 184         'contact_id' => [
 185           'name' => 'contact_id',
 186           'type' => CRM_Utils_Type::T_INT,
 187           'title' => ts('Domain Contact'),
 188           'description' => ts('FK to Contact ID. This is specifically not an FK to avoid circular constraints'),
 189           'where' => 'civicrm_domain.contact_id',
 190           'table_name' => 'civicrm_domain',
 191           'entity' => 'Domain',
 192           'bao' => 'CRM_Core_BAO_Domain',
 193           'localizable' => 0,
 194           'FKClassName' => 'CRM_Contact_DAO_Contact',
 195           'add' => '4.3',
 196         ],
 197         'locales' => [
 198           'name' => 'locales',
 199           'type' => CRM_Utils_Type::T_TEXT,
 200           'title' => ts('Supported Languages'),
 201           'description' => ts('list of locales supported by the current db state (NULL for single-lang install)'),
 202           'where' => 'civicrm_domain.locales',
 203           'table_name' => 'civicrm_domain',
 204           'entity' => 'Domain',
 205           'bao' => 'CRM_Core_BAO_Domain',
 206           'localizable' => 0,
 207           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 208           'add' => '2.1',
 209         ],
 210         'locale_custom_strings' => [
 211           'name' => 'locale_custom_strings',
 212           'type' => CRM_Utils_Type::T_TEXT,
 213           'title' => ts('Language Customizations'),
 214           'description' => ts('Locale specific string overrides'),
 215           'where' => 'civicrm_domain.locale_custom_strings',
 216           'table_name' => 'civicrm_domain',
 217           'entity' => 'Domain',
 218           'bao' => 'CRM_Core_BAO_Domain',
 219           'localizable' => 0,
 220           'serialize' => self::SERIALIZE_PHP,
 221           'add' => '3.2',
 222         ],
 223       ];
 224       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 225     }
 226     return Civi::$statics[__CLASS__]['fields'];
 227   }
 228
 229   /**
 230    * Return a mapping from field-name to the corresponding key (as used in fields()).
 231    *
 232    * @return array
 233    *   Array(string $name => string $uniqueName).
 234    */
 235   public static function &fieldKeys() {
 236     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 237       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 238     }
 239     return Civi::$statics[__CLASS__]['fieldKeys'];
 240   }
 241
 242   /**
 243    * Returns the names of this table
 244    *
 245    * @return string
 246    */
 247   public static function getTableName() {
 248     return self::$_tableName;
 249   }
 250
 251   /**
 252    * Returns if this table needs to be logged
 253    *
 254    * @return bool
 255    */
 256   public function getLog() {
 257     return self::$_log;
 258   }
 259
 260   /**
 261    * Returns the list of fields that can be imported
 262    *
 263    * @param bool $prefix
 264    *
 265    * @return array
 266    */
 267   public static function &import($prefix = FALSE) {
 268     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'domain', $prefix, []);
 269     return $r;
 270   }
 271
 272   /**
 273    * Returns the list of fields that can be exported
 274    *
 275    * @param bool $prefix
 276    *
 277    * @return array
 278    */
 279   public static function &export($prefix = FALSE) {
 280     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'domain', $prefix, []);
 281     return $r;
 282   }
 283
 284   /**
 285    * Returns the list of indices
 286    *
 287    * @param bool $localize
 288    *
 289    * @return array
 290    */
 291   public static function indices($localize = TRUE) {
 292     $indices = [
 293       'UI_name' => [
 294         'name' => 'UI_name',
 295         'field' => [
 296           0 => 'name',
 297         ],
 298         'localizable' => FALSE,
 299         'unique' => TRUE,
 300         'sig' => 'civicrm_domain::1::name',
 301       ],
 302     ];
 303     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 304   }
 305
 306 }