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/UFField.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:4777c5b97760d4bd4b7138468d18ded5)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Core_DAO_UFField constructor.
40 class CRM_Core_DAO_UFField
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_uf_field';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
60 * Which form does this field belong to.
66 * Name for CiviCRM field which is being exposed for sharing.
72 * Is this field currently shareable? If false, hide the field for all sharing contexts.
78 * the field is view only and not editable in user forms.
84 * Is this field required when included in a user or registration form?
90 * Controls field display order when user framework fields are displayed in registration and account editing forms.
96 * Description and/or help text to display after this field.
102 * Description and/or help text to display before this field.
108 * In what context(s) is this field visible.
114 * Is this field included as a column in the selector table?
120 * Is this field included search form of profile?
124 public $is_searchable;
126 * Location type of this mapping, if required
130 public $location_type_id;
132 * Phone Type Id, if required
136 public $phone_type_id;
138 * Website Type Id, if required
142 public $website_type_id;
144 * To save label for fields.
150 * This field saves field type (ie individual,household.. field etc).
156 * Is this field reserved for use by some other CiviCRM functionality?
162 * Include in multi-record listing?
166 public $is_multi_summary;
170 function __construct() {
171 $this->__table
= 'civicrm_uf_field';
172 parent
::__construct();
175 * Returns foreign keys and entity references.
178 * [CRM_Core_Reference_Interface]
180 static function getReferenceColumns() {
181 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
182 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
183 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'uf_group_id', 'civicrm_uf_group', 'id');
184 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'location_type_id', 'civicrm_location_type', 'id');
185 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
187 return Civi
::$statics[__CLASS__
]['links'];
190 * Returns all the column names of this table
194 static function &fields() {
195 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
196 Civi
::$statics[__CLASS__
]['fields'] = array(
199 'type' => CRM_Utils_Type
::T_INT
,
200 'title' => ts('Profile Field ID') ,
201 'description' => 'Unique table ID',
203 'table_name' => 'civicrm_uf_field',
204 'entity' => 'UFField',
205 'bao' => 'CRM_Core_BAO_UFField',
208 'uf_group_id' => array(
209 'name' => 'uf_group_id',
210 'type' => CRM_Utils_Type
::T_INT
,
211 'title' => ts('Profile ID') ,
212 'description' => 'Which form does this field belong to.',
214 'table_name' => 'civicrm_uf_field',
215 'entity' => 'UFField',
216 'bao' => 'CRM_Core_BAO_UFField',
218 'FKClassName' => 'CRM_Core_DAO_UFGroup',
222 'pseudoconstant' => array(
223 'table' => 'civicrm_uf_group',
225 'labelColumn' => 'title',
228 'field_name' => array(
229 'name' => 'field_name',
230 'type' => CRM_Utils_Type
::T_STRING
,
231 'title' => ts('Profile Field Name') ,
232 'description' => 'Name for CiviCRM field which is being exposed for sharing.',
235 'size' => CRM_Utils_Type
::BIG
,
236 'table_name' => 'civicrm_uf_field',
237 'entity' => 'UFField',
238 'bao' => 'CRM_Core_BAO_UFField',
241 'is_active' => array(
242 'name' => 'is_active',
243 'type' => CRM_Utils_Type
::T_BOOLEAN
,
244 'title' => ts('Profile Field Is Active') ,
245 'description' => 'Is this field currently shareable? If false, hide the field for all sharing contexts.',
247 'table_name' => 'civicrm_uf_field',
248 'entity' => 'UFField',
249 'bao' => 'CRM_Core_BAO_UFField',
254 'type' => CRM_Utils_Type
::T_BOOLEAN
,
255 'title' => ts('Profile Is View Only') ,
256 'description' => 'the field is view only and not editable in user forms.',
257 'table_name' => 'civicrm_uf_field',
258 'entity' => 'UFField',
259 'bao' => 'CRM_Core_BAO_UFField',
262 'is_required' => array(
263 'name' => 'is_required',
264 'type' => CRM_Utils_Type
::T_BOOLEAN
,
265 'title' => ts('Profile Field Is Required') ,
266 'description' => 'Is this field required when included in a user or registration form?',
267 'table_name' => 'civicrm_uf_field',
268 'entity' => 'UFField',
269 'bao' => 'CRM_Core_BAO_UFField',
274 'type' => CRM_Utils_Type
::T_INT
,
275 'title' => ts('Order') ,
276 'description' => 'Controls field display order when user framework fields are displayed in registration and account editing forms.',
279 'table_name' => 'civicrm_uf_field',
280 'entity' => 'UFField',
281 'bao' => 'CRM_Core_BAO_UFField',
284 'help_post' => array(
285 'name' => 'help_post',
286 'type' => CRM_Utils_Type
::T_TEXT
,
287 'title' => ts('Profile Field Post Help') ,
288 'description' => 'Description and/or help text to display after this field.',
289 'table_name' => 'civicrm_uf_field',
290 'entity' => 'UFField',
291 'bao' => 'CRM_Core_BAO_UFField',
295 'name' => 'help_pre',
296 'type' => CRM_Utils_Type
::T_TEXT
,
297 'title' => ts('Profile Field Pre Help') ,
298 'description' => 'Description and/or help text to display before this field.',
299 'table_name' => 'civicrm_uf_field',
300 'entity' => 'UFField',
301 'bao' => 'CRM_Core_BAO_UFField',
304 'visibility' => array(
305 'name' => 'visibility',
306 'type' => CRM_Utils_Type
::T_STRING
,
307 'title' => ts('Profile Field Visibility') ,
308 'description' => 'In what context(s) is this field visible.',
310 'size' => CRM_Utils_Type
::MEDIUM
,
311 'default' => 'User and User Admin Only',
312 'table_name' => 'civicrm_uf_field',
313 'entity' => 'UFField',
314 'bao' => 'CRM_Core_BAO_UFField',
319 'pseudoconstant' => array(
320 'callback' => 'CRM_Core_SelectValues::ufVisibility',
323 'in_selector' => array(
324 'name' => 'in_selector',
325 'type' => CRM_Utils_Type
::T_BOOLEAN
,
326 'title' => ts('Profile Field Is a Filter') ,
327 'description' => 'Is this field included as a column in the selector table?',
328 'table_name' => 'civicrm_uf_field',
329 'entity' => 'UFField',
330 'bao' => 'CRM_Core_BAO_UFField',
333 'is_searchable' => array(
334 'name' => 'is_searchable',
335 'type' => CRM_Utils_Type
::T_BOOLEAN
,
336 'title' => ts('Profile Field Is Searchable') ,
337 'description' => 'Is this field included search form of profile?',
338 'table_name' => 'civicrm_uf_field',
339 'entity' => 'UFField',
340 'bao' => 'CRM_Core_BAO_UFField',
343 'location_type_id' => array(
344 'name' => 'location_type_id',
345 'type' => CRM_Utils_Type
::T_INT
,
346 'title' => ts('Profile Field Location Type') ,
347 'description' => 'Location type of this mapping, if required',
348 'table_name' => 'civicrm_uf_field',
349 'entity' => 'UFField',
350 'bao' => 'CRM_Core_BAO_UFField',
352 'FKClassName' => 'CRM_Core_DAO_LocationType',
354 'phone_type_id' => array(
355 'name' => 'phone_type_id',
356 'type' => CRM_Utils_Type
::T_INT
,
357 'title' => ts('Profile Field Phone Type') ,
358 'description' => 'Phone Type Id, if required',
359 'table_name' => 'civicrm_uf_field',
360 'entity' => 'UFField',
361 'bao' => 'CRM_Core_BAO_UFField',
364 'website_type_id' => array(
365 'name' => 'website_type_id',
366 'type' => CRM_Utils_Type
::T_INT
,
367 'title' => ts('Profile Field Website Type') ,
368 'description' => 'Website Type Id, if required',
369 'table_name' => 'civicrm_uf_field',
370 'entity' => 'UFField',
371 'bao' => 'CRM_Core_BAO_UFField',
376 'type' => CRM_Utils_Type
::T_STRING
,
377 'title' => ts('Profile Field Label') ,
378 'description' => 'To save label for fields.',
381 'size' => CRM_Utils_Type
::HUGE
,
382 'table_name' => 'civicrm_uf_field',
383 'entity' => 'UFField',
384 'bao' => 'CRM_Core_BAO_UFField',
387 'field_type' => array(
388 'name' => 'field_type',
389 'type' => CRM_Utils_Type
::T_STRING
,
390 'title' => ts('Profile Field Type') ,
391 'description' => 'This field saves field type (ie individual,household.. field etc).',
393 'size' => CRM_Utils_Type
::HUGE
,
394 'table_name' => 'civicrm_uf_field',
395 'entity' => 'UFField',
396 'bao' => 'CRM_Core_BAO_UFField',
399 'is_reserved' => array(
400 'name' => 'is_reserved',
401 'type' => CRM_Utils_Type
::T_BOOLEAN
,
402 'title' => ts('Profile Field Is Reserved') ,
403 'description' => 'Is this field reserved for use by some other CiviCRM functionality?',
404 'table_name' => 'civicrm_uf_field',
405 'entity' => 'UFField',
406 'bao' => 'CRM_Core_BAO_UFField',
409 'is_multi_summary' => array(
410 'name' => 'is_multi_summary',
411 'type' => CRM_Utils_Type
::T_BOOLEAN
,
412 'title' => ts('Profile Field Supports Multiple') ,
413 'description' => 'Include in multi-record listing?',
414 'table_name' => 'civicrm_uf_field',
415 'entity' => 'UFField',
416 'bao' => 'CRM_Core_BAO_UFField',
420 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
422 return Civi
::$statics[__CLASS__
]['fields'];
425 * Return a mapping from field-name to the corresponding key (as used in fields()).
428 * Array(string $name => string $uniqueName).
430 static function &fieldKeys() {
431 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
432 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
434 return Civi
::$statics[__CLASS__
]['fieldKeys'];
437 * Returns the names of this table
441 static function getTableName() {
442 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
445 * Returns if this table needs to be logged
453 * Returns the list of fields that can be imported
455 * @param bool $prefix
459 static function &import($prefix = false) {
460 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'uf_field', $prefix, array());
464 * Returns the list of fields that can be exported
466 * @param bool $prefix
470 static function &export($prefix = false) {
471 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'uf_field', $prefix, array());
475 * Returns the list of indices
477 public static function indices($localize = TRUE) {
479 'IX_website_type_id' => array(
480 'name' => 'IX_website_type_id',
482 0 => 'website_type_id',
484 'localizable' => false,
485 'sig' => 'civicrm_uf_field::0::website_type_id',
488 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;