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/UFJoin.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
e380ee3b | 9 | * (GenCodeChecksum:09aaa3fd826c1b3407d39966f0f11aa7) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the UFJoin entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_UFJoin extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
22 | static $_tableName = 'civicrm_uf_join'; | |
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 | */ |
c3fc2621 CW |
29 | static $_log = TRUE; |
30 | ||
e501603b TO |
31 | /** |
32 | * Unique table ID | |
33 | * | |
34 | * @var int unsigned | |
35 | */ | |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * Is this join currently active? | |
40 | * | |
41 | * @var boolean | |
42 | */ | |
43 | public $is_active; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc. | |
47 | * | |
48 | * @var string | |
49 | */ | |
50 | public $module; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id. | |
54 | * | |
55 | * @var string | |
56 | */ | |
57 | public $entity_table; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Foreign key to the referenced item. | |
61 | * | |
62 | * @var int unsigned | |
63 | */ | |
64 | public $entity_id; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * Controls display order when multiple user framework groups are setup for concurrent display. | |
68 | * | |
69 | * @var int | |
70 | */ | |
71 | public $weight; | |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * Which form does this field belong to. | |
75 | * | |
76 | * @var int unsigned | |
77 | */ | |
78 | public $uf_group_id; | |
c3fc2621 | 79 | |
e501603b TO |
80 | /** |
81 | * Json serialized array of data used by the ufjoin.module | |
82 | * | |
83 | * @var longtext | |
84 | */ | |
85 | public $module_data; | |
c3fc2621 | 86 | |
e501603b | 87 | /** |
f41f0342 | 88 | * Class constructor. |
e501603b | 89 | */ |
c3fc2621 | 90 | public function __construct() { |
e501603b TO |
91 | $this->__table = 'civicrm_uf_join'; |
92 | parent::__construct(); | |
93 | } | |
c3fc2621 | 94 | |
e501603b | 95 | /** |
f41f0342 | 96 | * Returns foreign keys and entity references. |
e501603b TO |
97 | * |
98 | * @return array | |
99 | * [CRM_Core_Reference_Interface] | |
100 | */ | |
c3fc2621 | 101 | public static function getReferenceColumns() { |
346aaaba TO |
102 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
103 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
c3fc2621 CW |
104 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'uf_group_id', 'civicrm_uf_group', 'id'); |
105 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); | |
346aaaba | 106 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 107 | } |
346aaaba | 108 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 109 | } |
c3fc2621 | 110 | |
e501603b TO |
111 | /** |
112 | * Returns all the column names of this table | |
113 | * | |
114 | * @return array | |
115 | */ | |
c3fc2621 | 116 | public static function &fields() { |
346aaaba | 117 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
118 | Civi::$statics[__CLASS__]['fields'] = [ |
119 | 'id' => [ | |
e501603b TO |
120 | 'name' => 'id', |
121 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 122 | 'title' => ts('UF Join ID'), |
215b423e | 123 | 'description' => ts('Unique table ID'), |
c3fc2621 | 124 | 'required' => TRUE, |
522a26c9 | 125 | 'table_name' => 'civicrm_uf_join', |
126 | 'entity' => 'UFJoin', | |
127 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 128 | 'localizable' => 0, |
c3fc2621 CW |
129 | ], |
130 | 'is_active' => [ | |
e501603b TO |
131 | 'name' => 'is_active', |
132 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 133 | 'title' => ts('Profile Use is active'), |
215b423e | 134 | 'description' => ts('Is this join currently active?'), |
e501603b | 135 | 'default' => '1', |
522a26c9 | 136 | 'table_name' => 'civicrm_uf_join', |
137 | 'entity' => 'UFJoin', | |
138 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 139 | 'localizable' => 0, |
c3fc2621 CW |
140 | ], |
141 | 'module' => [ | |
e501603b TO |
142 | 'name' => 'module', |
143 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 144 | 'title' => ts('Profile Module'), |
215b423e | 145 | 'description' => ts('Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.'), |
c3fc2621 | 146 | 'required' => TRUE, |
e501603b TO |
147 | 'maxlength' => 64, |
148 | 'size' => CRM_Utils_Type::BIG, | |
522a26c9 | 149 | 'table_name' => 'civicrm_uf_join', |
150 | 'entity' => 'UFJoin', | |
151 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 152 | 'localizable' => 0, |
c3fc2621 CW |
153 | ], |
154 | 'entity_table' => [ | |
e501603b TO |
155 | 'name' => 'entity_table', |
156 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 157 | 'title' => ts('Profile Entity Table'), |
215b423e | 158 | 'description' => ts('Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.'), |
e501603b TO |
159 | 'maxlength' => 64, |
160 | 'size' => CRM_Utils_Type::BIG, | |
522a26c9 | 161 | 'table_name' => 'civicrm_uf_join', |
162 | 'entity' => 'UFJoin', | |
163 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 164 | 'localizable' => 0, |
c3fc2621 | 165 | 'pseudoconstant' => [ |
e501603b | 166 | 'callback' => 'CRM_Core_BAO_UFJoin::entityTables', |
c3fc2621 CW |
167 | ] |
168 | ], | |
169 | 'entity_id' => [ | |
e501603b TO |
170 | 'name' => 'entity_id', |
171 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 172 | 'title' => ts('Profile Entity ID'), |
215b423e | 173 | 'description' => ts('Foreign key to the referenced item.'), |
522a26c9 | 174 | 'table_name' => 'civicrm_uf_join', |
175 | 'entity' => 'UFJoin', | |
176 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 177 | 'localizable' => 0, |
c3fc2621 CW |
178 | ], |
179 | 'weight' => [ | |
e501603b TO |
180 | 'name' => 'weight', |
181 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 182 | 'title' => ts('Order'), |
215b423e | 183 | 'description' => ts('Controls display order when multiple user framework groups are setup for concurrent display.'), |
c3fc2621 | 184 | 'required' => TRUE, |
e501603b | 185 | 'default' => '1', |
522a26c9 | 186 | 'table_name' => 'civicrm_uf_join', |
187 | 'entity' => 'UFJoin', | |
188 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 189 | 'localizable' => 0, |
c3fc2621 CW |
190 | ], |
191 | 'uf_group_id' => [ | |
e501603b TO |
192 | 'name' => 'uf_group_id', |
193 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 194 | 'title' => ts('Profile ID'), |
215b423e | 195 | 'description' => ts('Which form does this field belong to.'), |
c3fc2621 | 196 | 'required' => TRUE, |
522a26c9 | 197 | 'table_name' => 'civicrm_uf_join', |
198 | 'entity' => 'UFJoin', | |
199 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 200 | 'localizable' => 0, |
e501603b | 201 | 'FKClassName' => 'CRM_Core_DAO_UFGroup', |
c3fc2621 | 202 | 'html' => [ |
e501603b | 203 | 'type' => 'Select', |
c3fc2621 CW |
204 | ], |
205 | 'pseudoconstant' => [ | |
e501603b TO |
206 | 'table' => 'civicrm_uf_group', |
207 | 'keyColumn' => 'id', | |
208 | 'labelColumn' => 'title', | |
c3fc2621 CW |
209 | ] |
210 | ], | |
211 | 'module_data' => [ | |
e501603b TO |
212 | 'name' => 'module_data', |
213 | 'type' => CRM_Utils_Type::T_LONGTEXT, | |
c3fc2621 | 214 | 'title' => ts('Profile Use Data'), |
215b423e | 215 | 'description' => ts('Json serialized array of data used by the ufjoin.module'), |
522a26c9 | 216 | 'table_name' => 'civicrm_uf_join', |
217 | 'entity' => 'UFJoin', | |
218 | 'bao' => 'CRM_Core_BAO_UFJoin', | |
6a7e5e5d | 219 | 'localizable' => 0, |
2a5c9b4d | 220 | 'serialize' => self::SERIALIZE_JSON, |
c3fc2621 CW |
221 | ], |
222 | ]; | |
346aaaba | 223 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 224 | } |
346aaaba | 225 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 226 | } |
c3fc2621 | 227 | |
e501603b | 228 | /** |
bd8e0b14 | 229 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
230 | * |
231 | * @return array | |
bd8e0b14 | 232 | * Array(string $name => string $uniqueName). |
e501603b | 233 | */ |
c3fc2621 | 234 | public static function &fieldKeys() { |
bd8e0b14 TO |
235 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
236 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 237 | } |
bd8e0b14 | 238 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 239 | } |
c3fc2621 | 240 | |
e501603b TO |
241 | /** |
242 | * Returns the names of this table | |
243 | * | |
244 | * @return string | |
245 | */ | |
c3fc2621 | 246 | public static function getTableName() { |
e501603b TO |
247 | return self::$_tableName; |
248 | } | |
c3fc2621 | 249 | |
e501603b TO |
250 | /** |
251 | * Returns if this table needs to be logged | |
252 | * | |
c3fc2621 | 253 | * @return bool |
e501603b | 254 | */ |
c3fc2621 | 255 | public function getLog() { |
e501603b TO |
256 | return self::$_log; |
257 | } | |
c3fc2621 | 258 | |
e501603b TO |
259 | /** |
260 | * Returns the list of fields that can be imported | |
261 | * | |
262 | * @param bool $prefix | |
263 | * | |
264 | * @return array | |
265 | */ | |
c3fc2621 CW |
266 | public static function &import($prefix = FALSE) { |
267 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_join', $prefix, []); | |
60808919 | 268 | return $r; |
e501603b | 269 | } |
c3fc2621 | 270 | |
e501603b TO |
271 | /** |
272 | * Returns the list of fields that can be exported | |
273 | * | |
274 | * @param bool $prefix | |
275 | * | |
276 | * @return array | |
277 | */ | |
c3fc2621 CW |
278 | public static function &export($prefix = FALSE) { |
279 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_join', $prefix, []); | |
60808919 | 280 | return $r; |
e501603b | 281 | } |
c3fc2621 | 282 | |
e7a6b91a AS |
283 | /** |
284 | * Returns the list of indices | |
c3fc2621 CW |
285 | * |
286 | * @param bool $localize | |
287 | * | |
288 | * @return array | |
e7a6b91a AS |
289 | */ |
290 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
291 | $indices = [ |
292 | 'index_entity' => [ | |
e7a6b91a | 293 | 'name' => 'index_entity', |
c3fc2621 | 294 | 'field' => [ |
e7a6b91a AS |
295 | 0 => 'entity_table', |
296 | 1 => 'entity_id', | |
c3fc2621 CW |
297 | ], |
298 | 'localizable' => FALSE, | |
e7a6b91a | 299 | 'sig' => 'civicrm_uf_join::0::entity_table::entity_id', |
c3fc2621 CW |
300 | ], |
301 | ]; | |
e7a6b91a AS |
302 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
303 | } | |
c3fc2621 | 304 | |
e501603b | 305 | } |