crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Core/DAO/EntityFile.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  30  *
  31  * Generated from xml/schema/CRM/Core/EntityFile.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Core_DAO_EntityFile extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_entity_file';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = true;
  82   /**
  83    * primary key
  84    *
  85    * @var int unsigned
  86    */
  87   public $id;
  88   /**
  89    * physical tablename for entity being joined to file, e.g. civicrm_contact
  90    *
  91    * @var string
  92    */
  93   public $entity_table;
  94   /**
  95    * FK to entity table specified in entity_table column.
  96    *
  97    * @var int unsigned
  98    */
  99   public $entity_id;
 100   /**
 101    * FK to civicrm_file
 102    *
 103    * @var int unsigned
 104    */
 105   public $file_id;
 106   /**
 107    * class constructor
 108    *
 109    * @return civicrm_entity_file
 110    */
 111   function __construct() {
 112     $this->__table = 'civicrm_entity_file';
 113     parent::__construct();
 114   }
 115   /**
 116    * Returns foreign keys and entity references
 117    *
 118    * @return array
 119    *   [CRM_Core_Reference_Interface]
 120    */
 121   static function getReferenceColumns() {
 122     if (!self::$_links) {
 123       self::$_links = static ::createReferenceColumns(__CLASS__);
 124       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'file_id', 'civicrm_file', 'id');
 125       self::$_links[] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 126     }
 127     return self::$_links;
 128   }
 129   /**
 130    * Returns all the column names of this table
 131    *
 132    * @return array
 133    */
 134   static function &fields() {
 135     if (!(self::$_fields)) {
 136       self::$_fields = array(
 137         'id' => array(
 138           'name' => 'id',
 139           'type' => CRM_Utils_Type::T_INT,
 140           'description' => 'primary key',
 141           'required' => true,
 142         ) ,
 143         'entity_table' => array(
 144           'name' => 'entity_table',
 145           'type' => CRM_Utils_Type::T_STRING,
 146           'title' => ts('Entity Table') ,
 147           'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
 148           'maxlength' => 64,
 149           'size' => CRM_Utils_Type::BIG,
 150         ) ,
 151         'entity_id' => array(
 152           'name' => 'entity_id',
 153           'type' => CRM_Utils_Type::T_INT,
 154           'description' => 'FK to entity table specified in entity_table column.',
 155           'required' => true,
 156         ) ,
 157         'file_id' => array(
 158           'name' => 'file_id',
 159           'type' => CRM_Utils_Type::T_INT,
 160           'description' => 'FK to civicrm_file',
 161           'required' => true,
 162           'FKClassName' => 'CRM_Core_DAO_File',
 163         ) ,
 164       );
 165     }
 166     return self::$_fields;
 167   }
 168   /**
 169    * Returns an array containing, for each field, the arary key used for that
 170    * field in self::$_fields.
 171    *
 172    * @return array
 173    */
 174   static function &fieldKeys() {
 175     if (!(self::$_fieldKeys)) {
 176       self::$_fieldKeys = array(
 177         'id' => 'id',
 178         'entity_table' => 'entity_table',
 179         'entity_id' => 'entity_id',
 180         'file_id' => 'file_id',
 181       );
 182     }
 183     return self::$_fieldKeys;
 184   }
 185   /**
 186    * Returns the names of this table
 187    *
 188    * @return string
 189    */
 190   static function getTableName() {
 191     return self::$_tableName;
 192   }
 193   /**
 194    * Returns if this table needs to be logged
 195    *
 196    * @return boolean
 197    */
 198   function getLog() {
 199     return self::$_log;
 200   }
 201   /**
 202    * Returns the list of fields that can be imported
 203    *
 204    * @param bool $prefix
 205    *
 206    * @return array
 207    */
 208   static function &import($prefix = false) {
 209     if (!(self::$_import)) {
 210       self::$_import = array();
 211       $fields = self::fields();
 212       foreach($fields as $name => $field) {
 213         if (CRM_Utils_Array::value('import', $field)) {
 214           if ($prefix) {
 215             self::$_import['entity_file'] = & $fields[$name];
 216           } else {
 217             self::$_import[$name] = & $fields[$name];
 218           }
 219         }
 220       }
 221     }
 222     return self::$_import;
 223   }
 224   /**
 225    * Returns the list of fields that can be exported
 226    *
 227    * @param bool $prefix
 228    *
 229    * @return array
 230    */
 231   static function &export($prefix = false) {
 232     if (!(self::$_export)) {
 233       self::$_export = array();
 234       $fields = self::fields();
 235       foreach($fields as $name => $field) {
 236         if (CRM_Utils_Array::value('export', $field)) {
 237           if ($prefix) {
 238             self::$_export['entity_file'] = & $fields[$name];
 239           } else {
 240             self::$_export[$name] = & $fields[$name];
 241           }
 242         }
 243       }
 244     }
 245     return self::$_export;
 246   }
 247 }