3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Core/UFJoin.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:fde4a7125f1dd6d9e5081b534f151db6)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Core_DAO_UFJoin constructor.
40 class CRM_Core_DAO_UFJoin
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_uf_join';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
60 * Is this join currently active?
66 * Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.
72 * 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.
78 * Foreign key to the referenced item.
84 * Controls display order when multiple user framework groups are setup for concurrent display.
90 * Which form does this field belong to.
96 * Json serialized array of data used by the ufjoin.module
104 function __construct() {
105 $this->__table
= 'civicrm_uf_join';
106 parent
::__construct();
109 * Returns foreign keys and entity references.
112 * [CRM_Core_Reference_Interface]
114 static function getReferenceColumns() {
115 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
116 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
117 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'uf_group_id', 'civicrm_uf_group', 'id');
118 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
119 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
121 return Civi
::$statics[__CLASS__
]['links'];
124 * Returns all the column names of this table
128 static function &fields() {
129 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
130 Civi
::$statics[__CLASS__
]['fields'] = array(
133 'type' => CRM_Utils_Type
::T_INT
,
134 'title' => ts('UF Join ID') ,
135 'description' => 'Unique table ID',
137 'table_name' => 'civicrm_uf_join',
138 'entity' => 'UFJoin',
139 'bao' => 'CRM_Core_BAO_UFJoin',
142 'is_active' => array(
143 'name' => 'is_active',
144 'type' => CRM_Utils_Type
::T_BOOLEAN
,
145 'title' => ts('Profile Use is active') ,
146 'description' => 'Is this join currently active?',
148 'table_name' => 'civicrm_uf_join',
149 'entity' => 'UFJoin',
150 'bao' => 'CRM_Core_BAO_UFJoin',
155 'type' => CRM_Utils_Type
::T_STRING
,
156 'title' => ts('Profile Module') ,
157 'description' => 'Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.',
160 'size' => CRM_Utils_Type
::BIG
,
161 'table_name' => 'civicrm_uf_join',
162 'entity' => 'UFJoin',
163 'bao' => 'CRM_Core_BAO_UFJoin',
166 'entity_table' => array(
167 'name' => 'entity_table',
168 'type' => CRM_Utils_Type
::T_STRING
,
169 'title' => ts('Profile Entity Table') ,
170 '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.',
172 'size' => CRM_Utils_Type
::BIG
,
173 'table_name' => 'civicrm_uf_join',
174 'entity' => 'UFJoin',
175 'bao' => 'CRM_Core_BAO_UFJoin',
177 'pseudoconstant' => array(
178 'callback' => 'CRM_Core_BAO_UFJoin::entityTables',
181 'entity_id' => array(
182 'name' => 'entity_id',
183 'type' => CRM_Utils_Type
::T_INT
,
184 'title' => ts('Profile Entity ID') ,
185 'description' => 'Foreign key to the referenced item.',
186 'table_name' => 'civicrm_uf_join',
187 'entity' => 'UFJoin',
188 'bao' => 'CRM_Core_BAO_UFJoin',
193 'type' => CRM_Utils_Type
::T_INT
,
194 'title' => ts('Order') ,
195 'description' => 'Controls display order when multiple user framework groups are setup for concurrent display.',
198 'table_name' => 'civicrm_uf_join',
199 'entity' => 'UFJoin',
200 'bao' => 'CRM_Core_BAO_UFJoin',
203 'uf_group_id' => array(
204 'name' => 'uf_group_id',
205 'type' => CRM_Utils_Type
::T_INT
,
206 'title' => ts('Profile ID') ,
207 'description' => 'Which form does this field belong to.',
209 'table_name' => 'civicrm_uf_join',
210 'entity' => 'UFJoin',
211 'bao' => 'CRM_Core_BAO_UFJoin',
213 'FKClassName' => 'CRM_Core_DAO_UFGroup',
217 'pseudoconstant' => array(
218 'table' => 'civicrm_uf_group',
220 'labelColumn' => 'title',
223 'module_data' => array(
224 'name' => 'module_data',
225 'type' => CRM_Utils_Type
::T_LONGTEXT
,
226 'title' => ts('Profile Use Data') ,
227 'description' => 'Json serialized array of data used by the ufjoin.module',
228 'table_name' => 'civicrm_uf_join',
229 'entity' => 'UFJoin',
230 'bao' => 'CRM_Core_BAO_UFJoin',
234 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
236 return Civi
::$statics[__CLASS__
]['fields'];
239 * Return a mapping from field-name to the corresponding key (as used in fields()).
242 * Array(string $name => string $uniqueName).
244 static function &fieldKeys() {
245 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
246 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
248 return Civi
::$statics[__CLASS__
]['fieldKeys'];
251 * Returns the names of this table
255 static function getTableName() {
256 return self
::$_tableName;
259 * Returns if this table needs to be logged
267 * Returns the list of fields that can be imported
269 * @param bool $prefix
273 static function &import($prefix = false) {
274 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'uf_join', $prefix, array());
278 * Returns the list of fields that can be exported
280 * @param bool $prefix
284 static function &export($prefix = false) {
285 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'uf_join', $prefix, array());
289 * Returns the list of indices
291 public static function indices($localize = TRUE) {
293 'index_entity' => array(
294 'name' => 'index_entity',
299 'localizable' => false,
300 'sig' => 'civicrm_uf_join::0::entity_table::entity_id',
303 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;