5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Core/CustomGroup.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:6b88842459aadee0598c08bd4d7518f2)
13 * Database access object for the CustomGroup entity.
15 class CRM_Core_DAO_CustomGroup
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_custom_group';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 * Unique Custom Group ID
39 * Variable name/programmatic handle for this group.
53 * Type of object this group extends (can add other options later e.g. contact_address, etc.).
60 * FK to civicrm_option_value.id (for option group custom_data_type.)
64 public $extends_entity_column_id;
67 * linking custom group for dynamic object
71 public $extends_entity_column_value;
74 * Visual relationship between this form and its parent.
81 * Will this group be in collapsed or expanded mode on initial display ?
85 public $collapse_display;
88 * Description and/or help text to display before fields in form.
95 * Description and/or help text to display after fields in form.
102 * Controls display order when multiple extended property groups are setup for the same class.
109 * Is this property active?
116 * Name of the table that holds the values for this group.
123 * Does this group hold multiple values?
130 * minimum number of multiple records (typically 0?)
134 public $min_multiple;
137 * maximum number of multiple records, if 0 - no max
141 public $max_multiple;
144 * Will this group be in collapsed or expanded mode on advanced search display ?
148 public $collapse_adv_display;
151 * FK to civicrm_contact, who created this custom group
158 * Date and time this custom group was created.
162 public $created_date;
165 * Is this a reserved Custom Group?
172 * Is this property public?
181 public function __construct() {
182 $this->__table
= 'civicrm_custom_group';
183 parent
::__construct();
187 * Returns foreign keys and entity references.
190 * [CRM_Core_Reference_Interface]
192 public static function getReferenceColumns() {
193 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
194 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
195 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'created_id', 'civicrm_contact', 'id');
196 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
198 return Civi
::$statics[__CLASS__
]['links'];
202 * Returns all the column names of this table
206 public static function &fields() {
207 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
208 Civi
::$statics[__CLASS__
]['fields'] = [
211 'type' => CRM_Utils_Type
::T_INT
,
212 'title' => ts('Custom Group ID'),
213 'description' => 'Unique Custom Group ID',
215 'table_name' => 'civicrm_custom_group',
216 'entity' => 'CustomGroup',
217 'bao' => 'CRM_Core_BAO_CustomGroup',
222 'type' => CRM_Utils_Type
::T_STRING
,
223 'title' => ts('Custom Group Name'),
224 'description' => 'Variable name/programmatic handle for this group.',
226 'size' => CRM_Utils_Type
::BIG
,
227 'table_name' => 'civicrm_custom_group',
228 'entity' => 'CustomGroup',
229 'bao' => 'CRM_Core_BAO_CustomGroup',
234 'type' => CRM_Utils_Type
::T_STRING
,
235 'title' => ts('Custom Group Title'),
236 'description' => 'Friendly Name.',
239 'size' => CRM_Utils_Type
::BIG
,
240 'table_name' => 'civicrm_custom_group',
241 'entity' => 'CustomGroup',
242 'bao' => 'CRM_Core_BAO_CustomGroup',
247 'type' => CRM_Utils_Type
::T_STRING
,
248 'title' => ts('Custom Group Extends'),
249 'description' => 'Type of object this group extends (can add other options later e.g. contact_address, etc.).',
251 'size' => CRM_Utils_Type
::HUGE
,
252 'default' => 'Contact',
253 'table_name' => 'civicrm_custom_group',
254 'entity' => 'CustomGroup',
255 'bao' => 'CRM_Core_BAO_CustomGroup',
258 'extends_entity_column_id' => [
259 'name' => 'extends_entity_column_id',
260 'type' => CRM_Utils_Type
::T_INT
,
261 'title' => ts('Custom Group Subtype List'),
262 'description' => 'FK to civicrm_option_value.id (for option group custom_data_type.)',
264 'table_name' => 'civicrm_custom_group',
265 'entity' => 'CustomGroup',
266 'bao' => 'CRM_Core_BAO_CustomGroup',
271 'pseudoconstant' => [
272 'optionGroupName' => 'custom_data_type',
273 'optionEditPath' => 'civicrm/admin/options/custom_data_type',
276 'extends_entity_column_value' => [
277 'name' => 'extends_entity_column_value',
278 'type' => CRM_Utils_Type
::T_STRING
,
279 'title' => ts('Custom Group Subtype'),
280 'description' => 'linking custom group for dynamic object',
282 'size' => CRM_Utils_Type
::HUGE
,
283 'table_name' => 'civicrm_custom_group',
284 'entity' => 'CustomGroup',
285 'bao' => 'CRM_Core_BAO_CustomGroup',
287 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
291 'type' => CRM_Utils_Type
::T_STRING
,
292 'title' => ts('Custom Group Style'),
293 'description' => 'Visual relationship between this form and its parent.',
295 'size' => CRM_Utils_Type
::TWELVE
,
296 'table_name' => 'civicrm_custom_group',
297 'entity' => 'CustomGroup',
298 'bao' => 'CRM_Core_BAO_CustomGroup',
303 'pseudoconstant' => [
304 'callback' => 'CRM_Core_SelectValues::customGroupStyle',
307 'collapse_display' => [
308 'name' => 'collapse_display',
309 'type' => CRM_Utils_Type
::T_INT
,
310 'title' => ts('Collapse Custom Group?'),
311 'description' => 'Will this group be in collapsed or expanded mode on initial display ?',
312 'table_name' => 'civicrm_custom_group',
313 'entity' => 'CustomGroup',
314 'bao' => 'CRM_Core_BAO_CustomGroup',
318 'name' => 'help_pre',
319 'type' => CRM_Utils_Type
::T_TEXT
,
320 'title' => ts('Custom Group Pre Text'),
321 'description' => 'Description and/or help text to display before fields in form.',
324 'table_name' => 'civicrm_custom_group',
325 'entity' => 'CustomGroup',
326 'bao' => 'CRM_Core_BAO_CustomGroup',
329 'type' => 'TextArea',
333 'name' => 'help_post',
334 'type' => CRM_Utils_Type
::T_TEXT
,
335 'title' => ts('Custom Group Post Text'),
336 'description' => 'Description and/or help text to display after fields in form.',
339 'table_name' => 'civicrm_custom_group',
340 'entity' => 'CustomGroup',
341 'bao' => 'CRM_Core_BAO_CustomGroup',
344 'type' => 'TextArea',
349 'type' => CRM_Utils_Type
::T_INT
,
350 'title' => ts('Order'),
351 'description' => 'Controls display order when multiple extended property groups are setup for the same class.',
354 'table_name' => 'civicrm_custom_group',
355 'entity' => 'CustomGroup',
356 'bao' => 'CRM_Core_BAO_CustomGroup',
360 'name' => 'is_active',
361 'type' => CRM_Utils_Type
::T_BOOLEAN
,
362 'title' => ts('Custom Group Is Active?'),
363 'description' => 'Is this property active?',
365 'table_name' => 'civicrm_custom_group',
366 'entity' => 'CustomGroup',
367 'bao' => 'CRM_Core_BAO_CustomGroup',
371 'name' => 'table_name',
372 'type' => CRM_Utils_Type
::T_STRING
,
373 'title' => ts('Table Name'),
374 'description' => 'Name of the table that holds the values for this group.',
376 'size' => CRM_Utils_Type
::HUGE
,
377 'table_name' => 'civicrm_custom_group',
378 'entity' => 'CustomGroup',
379 'bao' => 'CRM_Core_BAO_CustomGroup',
383 'name' => 'is_multiple',
384 'type' => CRM_Utils_Type
::T_BOOLEAN
,
385 'title' => ts('Supports Multiple Records'),
386 'description' => 'Does this group hold multiple values?',
387 'table_name' => 'civicrm_custom_group',
388 'entity' => 'CustomGroup',
389 'bao' => 'CRM_Core_BAO_CustomGroup',
393 'name' => 'min_multiple',
394 'type' => CRM_Utils_Type
::T_INT
,
395 'title' => ts('Minimum Multiple Records'),
396 'description' => 'minimum number of multiple records (typically 0?)',
397 'table_name' => 'civicrm_custom_group',
398 'entity' => 'CustomGroup',
399 'bao' => 'CRM_Core_BAO_CustomGroup',
403 'name' => 'max_multiple',
404 'type' => CRM_Utils_Type
::T_INT
,
405 'title' => ts('Maximum Multiple Records'),
406 'description' => 'maximum number of multiple records, if 0 - no max',
407 'table_name' => 'civicrm_custom_group',
408 'entity' => 'CustomGroup',
409 'bao' => 'CRM_Core_BAO_CustomGroup',
412 'collapse_adv_display' => [
413 'name' => 'collapse_adv_display',
414 'type' => CRM_Utils_Type
::T_INT
,
415 'title' => ts('Collapse Group Display'),
416 'description' => 'Will this group be in collapsed or expanded mode on advanced search display ?',
417 'table_name' => 'civicrm_custom_group',
418 'entity' => 'CustomGroup',
419 'bao' => 'CRM_Core_BAO_CustomGroup',
423 'name' => 'created_id',
424 'type' => CRM_Utils_Type
::T_INT
,
425 'title' => ts('Custom Group Created By'),
426 'description' => 'FK to civicrm_contact, who created this custom group',
427 'table_name' => 'civicrm_custom_group',
428 'entity' => 'CustomGroup',
429 'bao' => 'CRM_Core_BAO_CustomGroup',
431 'FKClassName' => 'CRM_Contact_DAO_Contact',
434 'name' => 'created_date',
435 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
436 'title' => ts('Custom Group Created Date'),
437 'description' => 'Date and time this custom group was created.',
438 'table_name' => 'civicrm_custom_group',
439 'entity' => 'CustomGroup',
440 'bao' => 'CRM_Core_BAO_CustomGroup',
444 'name' => 'is_reserved',
445 'type' => CRM_Utils_Type
::T_BOOLEAN
,
446 'title' => ts('Reserved Group?'),
447 'description' => 'Is this a reserved Custom Group?',
448 'table_name' => 'civicrm_custom_group',
449 'entity' => 'CustomGroup',
450 'bao' => 'CRM_Core_BAO_CustomGroup',
454 'name' => 'is_public',
455 'type' => CRM_Utils_Type
::T_BOOLEAN
,
456 'title' => ts('Custom Group Is Public?'),
457 'description' => 'Is this property public?',
459 'table_name' => 'civicrm_custom_group',
460 'entity' => 'CustomGroup',
461 'bao' => 'CRM_Core_BAO_CustomGroup',
465 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
467 return Civi
::$statics[__CLASS__
]['fields'];
471 * Return a mapping from field-name to the corresponding key (as used in fields()).
474 * Array(string $name => string $uniqueName).
476 public static function &fieldKeys() {
477 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
478 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
480 return Civi
::$statics[__CLASS__
]['fieldKeys'];
484 * Returns the names of this table
488 public static function getTableName() {
489 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
493 * Returns if this table needs to be logged
497 public function getLog() {
502 * Returns the list of fields that can be imported
504 * @param bool $prefix
508 public static function &import($prefix = FALSE) {
509 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'custom_group', $prefix, []);
514 * Returns the list of fields that can be exported
516 * @param bool $prefix
520 public static function &export($prefix = FALSE) {
521 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'custom_group', $prefix, []);
526 * Returns the list of indices
528 * @param bool $localize
532 public static function indices($localize = TRUE) {
534 'UI_title_extends' => [
535 'name' => 'UI_title_extends',
540 'localizable' => TRUE,
542 'sig' => 'civicrm_custom_group::1::title::extends',
544 'UI_name_extends' => [
545 'name' => 'UI_name_extends',
550 'localizable' => FALSE,
552 'sig' => 'civicrm_custom_group::1::name::extends',
555 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;