CRM/Core/DAO/EntityFile.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/EntityFile.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:354c22131251fde259f5b796e102fccf)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_EntityFile constructor.
  39  */
  40 class CRM_Core_DAO_EntityFile extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_entity_file';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * primary key
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * physical tablename for entity being joined to file, e.g. civicrm_contact
  61    *
  62    * @var string
  63    */
  64   public $entity_table;
  65   /**
  66    * FK to entity table specified in entity_table column.
  67    *
  68    * @var int unsigned
  69    */
  70   public $entity_id;
  71   /**
  72    * FK to civicrm_file
  73    *
  74    * @var int unsigned
  75    */
  76   public $file_id;
  77   /**
  78    * Class constructor.
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_entity_file';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns foreign keys and entity references.
  86    *
  87    * @return array
  88    *   [CRM_Core_Reference_Interface]
  89    */
  90   static function getReferenceColumns() {
  91     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  92       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  93       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'file_id', 'civicrm_file', 'id');
  94       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
  95       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  96     }
  97     return Civi::$statics[__CLASS__]['links'];
  98   }
  99   /**
 100    * Returns all the column names of this table
 101    *
 102    * @return array
 103    */
 104   static function &fields() {
 105     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 106       Civi::$statics[__CLASS__]['fields'] = array(
 107         'id' => array(
 108           'name' => 'id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('Entity File ID') ,
 111           'description' => 'primary key',
 112           'required' => true,
 113           'table_name' => 'civicrm_entity_file',
 114           'entity' => 'EntityFile',
 115           'bao' => 'CRM_Core_DAO_EntityFile',
 116           'localizable' => 0,
 117         ) ,
 118         'entity_table' => array(
 119           'name' => 'entity_table',
 120           'type' => CRM_Utils_Type::T_STRING,
 121           'title' => ts('Entity Table') ,
 122           'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
 123           'maxlength' => 64,
 124           'size' => CRM_Utils_Type::BIG,
 125           'table_name' => 'civicrm_entity_file',
 126           'entity' => 'EntityFile',
 127           'bao' => 'CRM_Core_DAO_EntityFile',
 128           'localizable' => 0,
 129         ) ,
 130         'entity_id' => array(
 131           'name' => 'entity_id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('Entity ID') ,
 134           'description' => 'FK to entity table specified in entity_table column.',
 135           'required' => true,
 136           'table_name' => 'civicrm_entity_file',
 137           'entity' => 'EntityFile',
 138           'bao' => 'CRM_Core_DAO_EntityFile',
 139           'localizable' => 0,
 140         ) ,
 141         'file_id' => array(
 142           'name' => 'file_id',
 143           'type' => CRM_Utils_Type::T_INT,
 144           'title' => ts('File') ,
 145           'description' => 'FK to civicrm_file',
 146           'required' => true,
 147           'table_name' => 'civicrm_entity_file',
 148           'entity' => 'EntityFile',
 149           'bao' => 'CRM_Core_DAO_EntityFile',
 150           'localizable' => 0,
 151           'FKClassName' => 'CRM_Core_DAO_File',
 152         ) ,
 153       );
 154       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 155     }
 156     return Civi::$statics[__CLASS__]['fields'];
 157   }
 158   /**
 159    * Return a mapping from field-name to the corresponding key (as used in fields()).
 160    *
 161    * @return array
 162    *   Array(string $name => string $uniqueName).
 163    */
 164   static function &fieldKeys() {
 165     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 166       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 167     }
 168     return Civi::$statics[__CLASS__]['fieldKeys'];
 169   }
 170   /**
 171    * Returns the names of this table
 172    *
 173    * @return string
 174    */
 175   static function getTableName() {
 176     return self::$_tableName;
 177   }
 178   /**
 179    * Returns if this table needs to be logged
 180    *
 181    * @return boolean
 182    */
 183   function getLog() {
 184     return self::$_log;
 185   }
 186   /**
 187    * Returns the list of fields that can be imported
 188    *
 189    * @param bool $prefix
 190    *
 191    * @return array
 192    */
 193   static function &import($prefix = false) {
 194     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_file', $prefix, array());
 195     return $r;
 196   }
 197   /**
 198    * Returns the list of fields that can be exported
 199    *
 200    * @param bool $prefix
 201    *
 202    * @return array
 203    */
 204   static function &export($prefix = false) {
 205     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_file', $prefix, array());
 206     return $r;
 207   }
 208   /**
 209    * Returns the list of indices
 210    */
 211   public static function indices($localize = TRUE) {
 212     $indices = array(
 213       'index_entity' => array(
 214         'name' => 'index_entity',
 215         'field' => array(
 216           0 => 'entity_table',
 217           1 => 'entity_id',
 218         ) ,
 219         'localizable' => false,
 220         'sig' => 'civicrm_entity_file::0::entity_table::entity_id',
 221       ) ,
 222       'index_entity_file_id' => array(
 223         'name' => 'index_entity_file_id',
 224         'field' => array(
 225           0 => 'entity_table',
 226           1 => 'entity_id',
 227           2 => 'file_id',
 228         ) ,
 229         'localizable' => false,
 230         'sig' => 'civicrm_entity_file::0::entity_table::entity_id::file_id',
 231       ) ,
 232     );
 233     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 234   }
 235 }