CRM/Core/DAO/File.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/File.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:994c11201c8b27ec0913d1ce505ef864)
  10  */
  11
  12 /**
  13  * Database access object for the File entity.
  14  */
  15 class CRM_Core_DAO_File extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_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    * Unique ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Type of file (e.g. Transcript, Income Tax Return, etc). FK to civicrm_option_value.
  40    *
  41    * @var int unsigned
  42    */
  43   public $file_type_id;
  44
  45   /**
  46    * mime type of the document
  47    *
  48    * @var string
  49    */
  50   public $mime_type;
  51
  52   /**
  53    * uri of the file on disk
  54    *
  55    * @var string
  56    */
  57   public $uri;
  58
  59   /**
  60    * contents of the document
  61    *
  62    * @var mediumblob
  63    */
  64   public $document;
  65
  66   /**
  67    * Additional descriptive text regarding this attachment (optional).
  68    *
  69    * @var string
  70    */
  71   public $description;
  72
  73   /**
  74    * Date and time that this attachment was uploaded or written to server.
  75    *
  76    * @var datetime
  77    */
  78   public $upload_date;
  79
  80   /**
  81    * FK to civicrm_contact, who uploaded this file
  82    *
  83    * @var int unsigned
  84    */
  85   public $created_id;
  86
  87   /**
  88    * Class constructor.
  89    */
  90   public function __construct() {
  91     $this->__table = 'civicrm_file';
  92     parent::__construct();
  93   }
  94
  95   /**
  96    * Returns foreign keys and entity references.
  97    *
  98    * @return array
  99    *   [CRM_Core_Reference_Interface]
 100    */
 101   public static function getReferenceColumns() {
 102     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 103       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 104       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id');
 105       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 106     }
 107     return Civi::$statics[__CLASS__]['links'];
 108   }
 109
 110   /**
 111    * Returns all the column names of this table
 112    *
 113    * @return array
 114    */
 115   public static function &fields() {
 116     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 117       Civi::$statics[__CLASS__]['fields'] = [
 118         'id' => [
 119           'name' => 'id',
 120           'type' => CRM_Utils_Type::T_INT,
 121           'title' => ts('File ID'),
 122           'description' => ts('Unique ID'),
 123           'required' => TRUE,
 124           'where' => 'civicrm_file.id',
 125           'table_name' => 'civicrm_file',
 126           'entity' => 'File',
 127           'bao' => 'CRM_Core_BAO_File',
 128           'localizable' => 0,
 129         ],
 130         'file_type_id' => [
 131           'name' => 'file_type_id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('File Type'),
 134           'description' => ts('Type of file (e.g. Transcript, Income Tax Return, etc). FK to civicrm_option_value.'),
 135           'where' => 'civicrm_file.file_type_id',
 136           'table_name' => 'civicrm_file',
 137           'entity' => 'File',
 138           'bao' => 'CRM_Core_BAO_File',
 139           'localizable' => 0,
 140         ],
 141         'mime_type' => [
 142           'name' => 'mime_type',
 143           'type' => CRM_Utils_Type::T_STRING,
 144           'title' => ts('Mime Type'),
 145           'description' => ts('mime type of the document'),
 146           'maxlength' => 255,
 147           'size' => CRM_Utils_Type::HUGE,
 148           'where' => 'civicrm_file.mime_type',
 149           'table_name' => 'civicrm_file',
 150           'entity' => 'File',
 151           'bao' => 'CRM_Core_BAO_File',
 152           'localizable' => 0,
 153         ],
 154         'uri' => [
 155           'name' => 'uri',
 156           'type' => CRM_Utils_Type::T_STRING,
 157           'title' => ts('Path'),
 158           'description' => ts('uri of the file on disk'),
 159           'maxlength' => 255,
 160           'size' => CRM_Utils_Type::HUGE,
 161           'where' => 'civicrm_file.uri',
 162           'table_name' => 'civicrm_file',
 163           'entity' => 'File',
 164           'bao' => 'CRM_Core_BAO_File',
 165           'localizable' => 0,
 166         ],
 167         'document' => [
 168           'name' => 'document',
 169           'type' => CRM_Utils_Type::T_MEDIUMBLOB,
 170           'title' => ts('File Contents'),
 171           'description' => ts('contents of the document'),
 172           'where' => 'civicrm_file.document',
 173           'table_name' => 'civicrm_file',
 174           'entity' => 'File',
 175           'bao' => 'CRM_Core_BAO_File',
 176           'localizable' => 0,
 177         ],
 178         'description' => [
 179           'name' => 'description',
 180           'type' => CRM_Utils_Type::T_STRING,
 181           'title' => ts('File Description'),
 182           'description' => ts('Additional descriptive text regarding this attachment (optional).'),
 183           'maxlength' => 255,
 184           'size' => CRM_Utils_Type::HUGE,
 185           'where' => 'civicrm_file.description',
 186           'table_name' => 'civicrm_file',
 187           'entity' => 'File',
 188           'bao' => 'CRM_Core_BAO_File',
 189           'localizable' => 0,
 190         ],
 191         'upload_date' => [
 192           'name' => 'upload_date',
 193           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 194           'title' => ts('File Upload Date'),
 195           'description' => ts('Date and time that this attachment was uploaded or written to server.'),
 196           'where' => 'civicrm_file.upload_date',
 197           'table_name' => 'civicrm_file',
 198           'entity' => 'File',
 199           'bao' => 'CRM_Core_BAO_File',
 200           'localizable' => 0,
 201         ],
 202         'created_id' => [
 203           'name' => 'created_id',
 204           'type' => CRM_Utils_Type::T_INT,
 205           'title' => ts('Created By Contact ID'),
 206           'description' => ts('FK to civicrm_contact, who uploaded this file'),
 207           'where' => 'civicrm_file.created_id',
 208           'table_name' => 'civicrm_file',
 209           'entity' => 'File',
 210           'bao' => 'CRM_Core_BAO_File',
 211           'localizable' => 0,
 212           'FKClassName' => 'CRM_Contact_DAO_Contact',
 213         ],
 214       ];
 215       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 216     }
 217     return Civi::$statics[__CLASS__]['fields'];
 218   }
 219
 220   /**
 221    * Return a mapping from field-name to the corresponding key (as used in fields()).
 222    *
 223    * @return array
 224    *   Array(string $name => string $uniqueName).
 225    */
 226   public static function &fieldKeys() {
 227     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 228       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 229     }
 230     return Civi::$statics[__CLASS__]['fieldKeys'];
 231   }
 232
 233   /**
 234    * Returns the names of this table
 235    *
 236    * @return string
 237    */
 238   public static function getTableName() {
 239     return self::$_tableName;
 240   }
 241
 242   /**
 243    * Returns if this table needs to be logged
 244    *
 245    * @return bool
 246    */
 247   public function getLog() {
 248     return self::$_log;
 249   }
 250
 251   /**
 252    * Returns the list of fields that can be imported
 253    *
 254    * @param bool $prefix
 255    *
 256    * @return array
 257    */
 258   public static function &import($prefix = FALSE) {
 259     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'file', $prefix, []);
 260     return $r;
 261   }
 262
 263   /**
 264    * Returns the list of fields that can be exported
 265    *
 266    * @param bool $prefix
 267    *
 268    * @return array
 269    */
 270   public static function &export($prefix = FALSE) {
 271     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'file', $prefix, []);
 272     return $r;
 273   }
 274
 275   /**
 276    * Returns the list of indices
 277    *
 278    * @param bool $localize
 279    *
 280    * @return array
 281    */
 282   public static function indices($localize = TRUE) {
 283     $indices = [];
 284     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 285   }
 286
 287 }