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