5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/EntityFile.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:70221552c8c9532b2aaf9cd89e73a68d)
13 * Database access object for the EntityFile entity.
15 class CRM_Core_DAO_EntityFile
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.5';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_entity_file';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = TRUE;
41 * physical tablename for entity being joined to file, e.g. civicrm_contact
48 * FK to entity table specified in entity_table column.
64 public function __construct() {
65 $this->__table
= 'civicrm_entity_file';
66 parent
::__construct();
70 * Returns localized title of this entity.
73 * Whether to return the plural version of the title.
75 public static function getEntityTitle($plural = FALSE) {
76 return $plural ?
ts('Entity Files') : ts('Entity File');
80 * Returns foreign keys and entity references.
83 * [CRM_Core_Reference_Interface]
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']);
92 return Civi
::$statics[__CLASS__
]['links'];
96 * Returns all the column names of this table
100 public static function &fields() {
101 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
102 Civi
::$statics[__CLASS__
]['fields'] = [
105 'type' => CRM_Utils_Type
::T_INT
,
106 'title' => ts('Entity File ID'),
107 'description' => ts('primary key'),
109 'where' => 'civicrm_entity_file.id',
110 'table_name' => 'civicrm_entity_file',
111 'entity' => 'EntityFile',
112 'bao' => 'CRM_Core_DAO_EntityFile',
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'),
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',
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.'),
136 'where' => 'civicrm_entity_file.entity_id',
137 'table_name' => 'civicrm_entity_file',
138 'entity' => 'EntityFile',
139 'bao' => 'CRM_Core_DAO_EntityFile',
145 'type' => CRM_Utils_Type
::T_INT
,
146 'title' => ts('File'),
147 'description' => ts('FK to civicrm_file'),
149 'where' => 'civicrm_entity_file.file_id',
150 'table_name' => 'civicrm_entity_file',
151 'entity' => 'EntityFile',
152 'bao' => 'CRM_Core_DAO_EntityFile',
154 'FKClassName' => 'CRM_Core_DAO_File',
158 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
160 return Civi
::$statics[__CLASS__
]['fields'];
164 * Return a mapping from field-name to the corresponding key (as used in fields()).
167 * Array(string $name => string $uniqueName).
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()));
173 return Civi
::$statics[__CLASS__
]['fieldKeys'];
177 * Returns the names of this table
181 public static function getTableName() {
182 return self
::$_tableName;
186 * Returns if this table needs to be logged
190 public function getLog() {
195 * Returns the list of fields that can be imported
197 * @param bool $prefix
201 public static function &import($prefix = FALSE) {
202 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'entity_file', $prefix, []);
207 * Returns the list of fields that can be exported
209 * @param bool $prefix
213 public static function &export($prefix = FALSE) {
214 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'entity_file', $prefix, []);
219 * Returns the list of indices
221 * @param bool $localize
225 public static function indices($localize = TRUE) {
228 'name' => 'index_entity',
233 'localizable' => FALSE,
234 'sig' => 'civicrm_entity_file::0::entity_table::entity_id',
236 'UI_entity_table_entity_id_file_id' => [
237 'name' => 'UI_entity_table_entity_id_file_id',
243 'localizable' => FALSE,
245 'sig' => 'civicrm_entity_file::1::entity_table::entity_id::file_id',
248 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;