5 * @copyright CiviCRM LLC (c) 2004-2017
7 * Generated from xml/schema/CRM/Core/UFJoin.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:141d4903e67ac8bce639e3db9c7ba875)
13 * Database access object for the UFJoin entity.
15 class CRM_Core_DAO_UFJoin
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_uf_join';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
39 * Is this join currently active?
46 * Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.
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.
60 * Foreign key to the referenced item.
67 * Controls display order when multiple user framework groups are setup for concurrent display.
74 * Which form does this field belong to.
81 * Json serialized array of data used by the ufjoin.module
90 public function __construct() {
91 $this->__table
= 'civicrm_uf_join';
92 parent
::__construct();
96 * Returns foreign keys and entity references.
99 * [CRM_Core_Reference_Interface]
101 public static function getReferenceColumns() {
102 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
103 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
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');
106 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
108 return Civi
::$statics[__CLASS__
]['links'];
112 * Returns all the column names of this table
116 public static function &fields() {
117 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
118 Civi
::$statics[__CLASS__
]['fields'] = [
121 'type' => CRM_Utils_Type
::T_INT
,
122 'title' => ts('UF Join ID'),
123 'description' => 'Unique table ID',
125 'table_name' => 'civicrm_uf_join',
126 'entity' => 'UFJoin',
127 'bao' => 'CRM_Core_BAO_UFJoin',
131 'name' => 'is_active',
132 'type' => CRM_Utils_Type
::T_BOOLEAN
,
133 'title' => ts('Profile Use is active'),
134 'description' => 'Is this join currently active?',
136 'table_name' => 'civicrm_uf_join',
137 'entity' => 'UFJoin',
138 'bao' => 'CRM_Core_BAO_UFJoin',
143 'type' => CRM_Utils_Type
::T_STRING
,
144 'title' => ts('Profile Module'),
145 'description' => 'Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.',
148 'size' => CRM_Utils_Type
::BIG
,
149 'table_name' => 'civicrm_uf_join',
150 'entity' => 'UFJoin',
151 'bao' => 'CRM_Core_BAO_UFJoin',
155 'name' => 'entity_table',
156 'type' => CRM_Utils_Type
::T_STRING
,
157 'title' => ts('Profile Entity Table'),
158 'description' => '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.',
160 'size' => CRM_Utils_Type
::BIG
,
161 'table_name' => 'civicrm_uf_join',
162 'entity' => 'UFJoin',
163 'bao' => 'CRM_Core_BAO_UFJoin',
165 'pseudoconstant' => [
166 'callback' => 'CRM_Core_BAO_UFJoin::entityTables',
170 'name' => 'entity_id',
171 'type' => CRM_Utils_Type
::T_INT
,
172 'title' => ts('Profile Entity ID'),
173 'description' => 'Foreign key to the referenced item.',
174 'table_name' => 'civicrm_uf_join',
175 'entity' => 'UFJoin',
176 'bao' => 'CRM_Core_BAO_UFJoin',
181 'type' => CRM_Utils_Type
::T_INT
,
182 'title' => ts('Order'),
183 'description' => 'Controls display order when multiple user framework groups are setup for concurrent display.',
186 'table_name' => 'civicrm_uf_join',
187 'entity' => 'UFJoin',
188 'bao' => 'CRM_Core_BAO_UFJoin',
192 'name' => 'uf_group_id',
193 'type' => CRM_Utils_Type
::T_INT
,
194 'title' => ts('Profile ID'),
195 'description' => 'Which form does this field belong to.',
197 'table_name' => 'civicrm_uf_join',
198 'entity' => 'UFJoin',
199 'bao' => 'CRM_Core_BAO_UFJoin',
201 'FKClassName' => 'CRM_Core_DAO_UFGroup',
205 'pseudoconstant' => [
206 'table' => 'civicrm_uf_group',
208 'labelColumn' => 'title',
212 'name' => 'module_data',
213 'type' => CRM_Utils_Type
::T_LONGTEXT
,
214 'title' => ts('Profile Use Data'),
215 'description' => 'Json serialized array of data used by the ufjoin.module',
216 'table_name' => 'civicrm_uf_join',
217 'entity' => 'UFJoin',
218 'bao' => 'CRM_Core_BAO_UFJoin',
220 'serialize' => self
::SERIALIZE_JSON
,
223 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
225 return Civi
::$statics[__CLASS__
]['fields'];
229 * Return a mapping from field-name to the corresponding key (as used in fields()).
232 * Array(string $name => string $uniqueName).
234 public static function &fieldKeys() {
235 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
236 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
238 return Civi
::$statics[__CLASS__
]['fieldKeys'];
242 * Returns the names of this table
246 public static function getTableName() {
247 return self
::$_tableName;
251 * Returns if this table needs to be logged
255 public function getLog() {
260 * Returns the list of fields that can be imported
262 * @param bool $prefix
266 public static function &import($prefix = FALSE) {
267 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'uf_join', $prefix, []);
272 * Returns the list of fields that can be exported
274 * @param bool $prefix
278 public static function &export($prefix = FALSE) {
279 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'uf_join', $prefix, []);
284 * Returns the list of indices
286 * @param bool $localize
290 public static function indices($localize = TRUE) {
293 'name' => 'index_entity',
298 'localizable' => FALSE,
299 'sig' => 'civicrm_uf_join::0::entity_table::entity_id',
302 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;