CRM/Core/DAO/EntityFile.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/EntityFile.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:d55d2dfbb297a954c71f0395e31a21d3)
  10  */
  11
  12 /**
  13  * Database access object for the EntityFile entity.
  14  */
  15 class CRM_Core_DAO_EntityFile extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.5';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_entity_file';
  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 = TRUE;
  32
  33   /**
  34    * primary key
  35    *
  36    * @var int|string|null
  37    *   (SQL type: int unsigned)
  38    *   Note that values will be retrieved from the database as a string.
  39    */
  40   public $id;
  41
  42   /**
  43    * physical tablename for entity being joined to file, e.g. civicrm_contact
  44    *
  45    * @var string|null
  46    *   (SQL type: varchar(64))
  47    *   Note that values will be retrieved from the database as a string.
  48    */
  49   public $entity_table;
  50
  51   /**
  52    * FK to entity table specified in entity_table column.
  53    *
  54    * @var int|string
  55    *   (SQL type: int unsigned)
  56    *   Note that values will be retrieved from the database as a string.
  57    */
  58   public $entity_id;
  59
  60   /**
  61    * FK to civicrm_file
  62    *
  63    * @var int|string
  64    *   (SQL type: int unsigned)
  65    *   Note that values will be retrieved from the database as a string.
  66    */
  67   public $file_id;
  68
  69   /**
  70    * Class constructor.
  71    */
  72   public function __construct() {
  73     $this->__table = 'civicrm_entity_file';
  74     parent::__construct();
  75   }
  76
  77   /**
  78    * Returns localized title of this entity.
  79    *
  80    * @param bool $plural
  81    *   Whether to return the plural version of the title.
  82    */
  83   public static function getEntityTitle($plural = FALSE) {
  84     return $plural ? ts('Entity Files') : ts('Entity File');
  85   }
  86
  87   /**
  88    * Returns foreign keys and entity references.
  89    *
  90    * @return array
  91    *   [CRM_Core_Reference_Interface]
  92    */
  93   public static function getReferenceColumns() {
  94     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  95       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  96       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'file_id', 'civicrm_file', 'id');
  97       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
  98       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  99     }
 100     return Civi::$statics[__CLASS__]['links'];
 101   }
 102
 103   /**
 104    * Returns all the column names of this table
 105    *
 106    * @return array
 107    */
 108   public static function &fields() {
 109     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 110       Civi::$statics[__CLASS__]['fields'] = [
 111         'id' => [
 112           'name' => 'id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Entity File ID'),
 115           'description' => ts('primary key'),
 116           'required' => TRUE,
 117           'where' => 'civicrm_entity_file.id',
 118           'table_name' => 'civicrm_entity_file',
 119           'entity' => 'EntityFile',
 120           'bao' => 'CRM_Core_DAO_EntityFile',
 121           'localizable' => 0,
 122           'html' => [
 123             'type' => 'Number',
 124           ],
 125           'readonly' => TRUE,
 126           'add' => '1.5',
 127         ],
 128         'entity_table' => [
 129           'name' => 'entity_table',
 130           'type' => CRM_Utils_Type::T_STRING,
 131           'title' => ts('Entity Table'),
 132           'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'),
 133           'maxlength' => 64,
 134           'size' => CRM_Utils_Type::BIG,
 135           'where' => 'civicrm_entity_file.entity_table',
 136           'table_name' => 'civicrm_entity_file',
 137           'entity' => 'EntityFile',
 138           'bao' => 'CRM_Core_DAO_EntityFile',
 139           'localizable' => 0,
 140           'add' => '1.5',
 141         ],
 142         'entity_id' => [
 143           'name' => 'entity_id',
 144           'type' => CRM_Utils_Type::T_INT,
 145           'title' => ts('Entity ID'),
 146           'description' => ts('FK to entity table specified in entity_table column.'),
 147           'required' => TRUE,
 148           'where' => 'civicrm_entity_file.entity_id',
 149           'table_name' => 'civicrm_entity_file',
 150           'entity' => 'EntityFile',
 151           'bao' => 'CRM_Core_DAO_EntityFile',
 152           'localizable' => 0,
 153           'add' => '1.5',
 154         ],
 155         'file_id' => [
 156           'name' => 'file_id',
 157           'type' => CRM_Utils_Type::T_INT,
 158           'title' => ts('File ID'),
 159           'description' => ts('FK to civicrm_file'),
 160           'required' => TRUE,
 161           'where' => 'civicrm_entity_file.file_id',
 162           'table_name' => 'civicrm_entity_file',
 163           'entity' => 'EntityFile',
 164           'bao' => 'CRM_Core_DAO_EntityFile',
 165           'localizable' => 0,
 166           'FKClassName' => 'CRM_Core_DAO_File',
 167           'html' => [
 168             'label' => ts("File"),
 169           ],
 170           'add' => '1.5',
 171         ],
 172       ];
 173       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 174     }
 175     return Civi::$statics[__CLASS__]['fields'];
 176   }
 177
 178   /**
 179    * Return a mapping from field-name to the corresponding key (as used in fields()).
 180    *
 181    * @return array
 182    *   Array(string $name => string $uniqueName).
 183    */
 184   public static function &fieldKeys() {
 185     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 186       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 187     }
 188     return Civi::$statics[__CLASS__]['fieldKeys'];
 189   }
 190
 191   /**
 192    * Returns the names of this table
 193    *
 194    * @return string
 195    */
 196   public static function getTableName() {
 197     return self::$_tableName;
 198   }
 199
 200   /**
 201    * Returns if this table needs to be logged
 202    *
 203    * @return bool
 204    */
 205   public function getLog() {
 206     return self::$_log;
 207   }
 208
 209   /**
 210    * Returns the list of fields that can be imported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   public static function &import($prefix = FALSE) {
 217     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_file', $prefix, []);
 218     return $r;
 219   }
 220
 221   /**
 222    * Returns the list of fields that can be exported
 223    *
 224    * @param bool $prefix
 225    *
 226    * @return array
 227    */
 228   public static function &export($prefix = FALSE) {
 229     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_file', $prefix, []);
 230     return $r;
 231   }
 232
 233   /**
 234    * Returns the list of indices
 235    *
 236    * @param bool $localize
 237    *
 238    * @return array
 239    */
 240   public static function indices($localize = TRUE) {
 241     $indices = [
 242       'UI_entity_id_entity_table_file_id' => [
 243         'name' => 'UI_entity_id_entity_table_file_id',
 244         'field' => [
 245           0 => 'entity_id',
 246           1 => 'entity_table',
 247           2 => 'file_id',
 248         ],
 249         'localizable' => FALSE,
 250         'unique' => TRUE,
 251         'sig' => 'civicrm_entity_file::1::entity_id::entity_table::file_id',
 252       ],
 253     ];
 254     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 255   }
 256
 257 }