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:db6759b7a93a170611ad4eb003cb9f54)
  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           'html' => [
 115             'type' => 'Number',
 116           ],
 117           'readonly' => TRUE,
 118           'add' => '1.5',
 119         ],
 120         'entity_table' => [
 121           'name' => 'entity_table',
 122           'type' => CRM_Utils_Type::T_STRING,
 123           'title' => ts('Entity Table'),
 124           'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'),
 125           'maxlength' => 64,
 126           'size' => CRM_Utils_Type::BIG,
 127           'where' => 'civicrm_entity_file.entity_table',
 128           'table_name' => 'civicrm_entity_file',
 129           'entity' => 'EntityFile',
 130           'bao' => 'CRM_Core_DAO_EntityFile',
 131           'localizable' => 0,
 132           'add' => '1.5',
 133         ],
 134         'entity_id' => [
 135           'name' => 'entity_id',
 136           'type' => CRM_Utils_Type::T_INT,
 137           'title' => ts('Entity ID'),
 138           'description' => ts('FK to entity table specified in entity_table column.'),
 139           'required' => TRUE,
 140           'where' => 'civicrm_entity_file.entity_id',
 141           'table_name' => 'civicrm_entity_file',
 142           'entity' => 'EntityFile',
 143           'bao' => 'CRM_Core_DAO_EntityFile',
 144           'localizable' => 0,
 145           'add' => '1.5',
 146         ],
 147         'file_id' => [
 148           'name' => 'file_id',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('File ID'),
 151           'description' => ts('FK to civicrm_file'),
 152           'required' => TRUE,
 153           'where' => 'civicrm_entity_file.file_id',
 154           'table_name' => 'civicrm_entity_file',
 155           'entity' => 'EntityFile',
 156           'bao' => 'CRM_Core_DAO_EntityFile',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Core_DAO_File',
 159           'html' => [
 160             'label' => ts("File"),
 161           ],
 162           'add' => '1.5',
 163         ],
 164       ];
 165       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 166     }
 167     return Civi::$statics[__CLASS__]['fields'];
 168   }
 169
 170   /**
 171    * Return a mapping from field-name to the corresponding key (as used in fields()).
 172    *
 173    * @return array
 174    *   Array(string $name => string $uniqueName).
 175    */
 176   public static function &fieldKeys() {
 177     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 178       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 179     }
 180     return Civi::$statics[__CLASS__]['fieldKeys'];
 181   }
 182
 183   /**
 184    * Returns the names of this table
 185    *
 186    * @return string
 187    */
 188   public static function getTableName() {
 189     return self::$_tableName;
 190   }
 191
 192   /**
 193    * Returns if this table needs to be logged
 194    *
 195    * @return bool
 196    */
 197   public function getLog() {
 198     return self::$_log;
 199   }
 200
 201   /**
 202    * Returns the list of fields that can be imported
 203    *
 204    * @param bool $prefix
 205    *
 206    * @return array
 207    */
 208   public static function &import($prefix = FALSE) {
 209     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_file', $prefix, []);
 210     return $r;
 211   }
 212
 213   /**
 214    * Returns the list of fields that can be exported
 215    *
 216    * @param bool $prefix
 217    *
 218    * @return array
 219    */
 220   public static function &export($prefix = FALSE) {
 221     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_file', $prefix, []);
 222     return $r;
 223   }
 224
 225   /**
 226    * Returns the list of indices
 227    *
 228    * @param bool $localize
 229    *
 230    * @return array
 231    */
 232   public static function indices($localize = TRUE) {
 233     $indices = [
 234       'UI_entity_id_entity_table_file_id' => [
 235         'name' => 'UI_entity_id_entity_table_file_id',
 236         'field' => [
 237           0 => 'entity_id',
 238           1 => 'entity_table',
 239           2 => 'file_id',
 240         ],
 241         'localizable' => FALSE,
 242         'unique' => TRUE,
 243         'sig' => 'civicrm_entity_file::1::entity_id::entity_table::file_id',
 244       ],
 245     ];
 246     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 247   }
 248
 249 }