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