Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
6b83d5bd | 5 | * @copyright CiviCRM LLC (c) 2004-2019 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/EntityFile.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
e380ee3b | 9 | * (GenCodeChecksum:febc5ccbfb965f8f4ba8477d4db0e5f3) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the EntityFile entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_EntityFile extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
fa45b5b9 | 22 | public static $_tableName = 'civicrm_entity_file'; |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
fa45b5b9 | 29 | public static $_log = TRUE; |
c3fc2621 | 30 | |
e501603b TO |
31 | /** |
32 | * primary key | |
33 | * | |
34 | * @var int unsigned | |
35 | */ | |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * physical tablename for entity being joined to file, e.g. civicrm_contact | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | public $entity_table; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * FK to entity table specified in entity_table column. | |
47 | * | |
48 | * @var int unsigned | |
49 | */ | |
50 | public $entity_id; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * FK to civicrm_file | |
54 | * | |
55 | * @var int unsigned | |
56 | */ | |
57 | public $file_id; | |
c3fc2621 | 58 | |
e501603b | 59 | /** |
f41f0342 | 60 | * Class constructor. |
e501603b | 61 | */ |
c3fc2621 | 62 | public function __construct() { |
e501603b TO |
63 | $this->__table = 'civicrm_entity_file'; |
64 | parent::__construct(); | |
65 | } | |
c3fc2621 | 66 | |
e501603b | 67 | /** |
f41f0342 | 68 | * Returns foreign keys and entity references. |
e501603b TO |
69 | * |
70 | * @return array | |
71 | * [CRM_Core_Reference_Interface] | |
72 | */ | |
c3fc2621 | 73 | public static function getReferenceColumns() { |
346aaaba | 74 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 75 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
76 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'file_id', 'civicrm_file', 'id'); |
77 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); | |
346aaaba | 78 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 79 | } |
346aaaba | 80 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 81 | } |
c3fc2621 | 82 | |
e501603b TO |
83 | /** |
84 | * Returns all the column names of this table | |
85 | * | |
86 | * @return array | |
87 | */ | |
c3fc2621 | 88 | public static function &fields() { |
346aaaba | 89 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
90 | Civi::$statics[__CLASS__]['fields'] = [ |
91 | 'id' => [ | |
e501603b TO |
92 | 'name' => 'id', |
93 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 94 | 'title' => ts('Entity File ID'), |
215b423e | 95 | 'description' => ts('primary key'), |
c3fc2621 | 96 | 'required' => TRUE, |
522a26c9 | 97 | 'table_name' => 'civicrm_entity_file', |
98 | 'entity' => 'EntityFile', | |
99 | 'bao' => 'CRM_Core_DAO_EntityFile', | |
6a7e5e5d | 100 | 'localizable' => 0, |
c3fc2621 CW |
101 | ], |
102 | 'entity_table' => [ | |
e501603b TO |
103 | 'name' => 'entity_table', |
104 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 105 | 'title' => ts('Entity Table'), |
215b423e | 106 | 'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'), |
e501603b TO |
107 | 'maxlength' => 64, |
108 | 'size' => CRM_Utils_Type::BIG, | |
522a26c9 | 109 | 'table_name' => 'civicrm_entity_file', |
110 | 'entity' => 'EntityFile', | |
111 | 'bao' => 'CRM_Core_DAO_EntityFile', | |
6a7e5e5d | 112 | 'localizable' => 0, |
c3fc2621 CW |
113 | ], |
114 | 'entity_id' => [ | |
e501603b TO |
115 | 'name' => 'entity_id', |
116 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 117 | 'title' => ts('Entity ID'), |
215b423e | 118 | 'description' => ts('FK to entity table specified in entity_table column.'), |
c3fc2621 | 119 | 'required' => TRUE, |
522a26c9 | 120 | 'table_name' => 'civicrm_entity_file', |
121 | 'entity' => 'EntityFile', | |
122 | 'bao' => 'CRM_Core_DAO_EntityFile', | |
6a7e5e5d | 123 | 'localizable' => 0, |
c3fc2621 CW |
124 | ], |
125 | 'file_id' => [ | |
e501603b TO |
126 | 'name' => 'file_id', |
127 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 128 | 'title' => ts('File'), |
215b423e | 129 | 'description' => ts('FK to civicrm_file'), |
c3fc2621 | 130 | 'required' => TRUE, |
522a26c9 | 131 | 'table_name' => 'civicrm_entity_file', |
132 | 'entity' => 'EntityFile', | |
133 | 'bao' => 'CRM_Core_DAO_EntityFile', | |
6a7e5e5d | 134 | 'localizable' => 0, |
e501603b | 135 | 'FKClassName' => 'CRM_Core_DAO_File', |
c3fc2621 CW |
136 | ], |
137 | ]; | |
346aaaba | 138 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 139 | } |
346aaaba | 140 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 141 | } |
c3fc2621 | 142 | |
e501603b | 143 | /** |
bd8e0b14 | 144 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
145 | * |
146 | * @return array | |
bd8e0b14 | 147 | * Array(string $name => string $uniqueName). |
e501603b | 148 | */ |
c3fc2621 | 149 | public static function &fieldKeys() { |
bd8e0b14 TO |
150 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
151 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 152 | } |
bd8e0b14 | 153 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 154 | } |
c3fc2621 | 155 | |
e501603b TO |
156 | /** |
157 | * Returns the names of this table | |
158 | * | |
159 | * @return string | |
160 | */ | |
c3fc2621 | 161 | public static function getTableName() { |
e501603b TO |
162 | return self::$_tableName; |
163 | } | |
c3fc2621 | 164 | |
e501603b TO |
165 | /** |
166 | * Returns if this table needs to be logged | |
167 | * | |
c3fc2621 | 168 | * @return bool |
e501603b | 169 | */ |
c3fc2621 | 170 | public function getLog() { |
e501603b TO |
171 | return self::$_log; |
172 | } | |
c3fc2621 | 173 | |
e501603b TO |
174 | /** |
175 | * Returns the list of fields that can be imported | |
176 | * | |
177 | * @param bool $prefix | |
178 | * | |
179 | * @return array | |
180 | */ | |
c3fc2621 CW |
181 | public static function &import($prefix = FALSE) { |
182 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_file', $prefix, []); | |
60808919 | 183 | return $r; |
e501603b | 184 | } |
c3fc2621 | 185 | |
e501603b TO |
186 | /** |
187 | * Returns the list of fields that can be exported | |
188 | * | |
189 | * @param bool $prefix | |
190 | * | |
191 | * @return array | |
192 | */ | |
c3fc2621 CW |
193 | public static function &export($prefix = FALSE) { |
194 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_file', $prefix, []); | |
60808919 | 195 | return $r; |
e501603b | 196 | } |
c3fc2621 | 197 | |
e7a6b91a AS |
198 | /** |
199 | * Returns the list of indices | |
c3fc2621 CW |
200 | * |
201 | * @param bool $localize | |
202 | * | |
203 | * @return array | |
e7a6b91a AS |
204 | */ |
205 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
206 | $indices = [ |
207 | 'index_entity' => [ | |
e7a6b91a | 208 | 'name' => 'index_entity', |
c3fc2621 | 209 | 'field' => [ |
e7a6b91a AS |
210 | 0 => 'entity_table', |
211 | 1 => 'entity_id', | |
c3fc2621 CW |
212 | ], |
213 | 'localizable' => FALSE, | |
e7a6b91a | 214 | 'sig' => 'civicrm_entity_file::0::entity_table::entity_id', |
c3fc2621 | 215 | ], |
8506cda6 | 216 | 'UI_entity_table_entity_id_file_id' => [ |
217 | 'name' => 'UI_entity_table_entity_id_file_id', | |
c3fc2621 | 218 | 'field' => [ |
e7a6b91a AS |
219 | 0 => 'entity_table', |
220 | 1 => 'entity_id', | |
221 | 2 => 'file_id', | |
c3fc2621 CW |
222 | ], |
223 | 'localizable' => FALSE, | |
8506cda6 | 224 | 'unique' => TRUE, |
225 | 'sig' => 'civicrm_entity_file::1::entity_table::entity_id::file_id', | |
c3fc2621 CW |
226 | ], |
227 | ]; | |
e7a6b91a AS |
228 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
229 | } | |
c3fc2621 | 230 | |
e501603b | 231 | } |