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