Documentation

CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup
in package

CRM

implements HookInterface

Business object for managing custom data groups.

Interfaces

HookInterface: Interface HookInterface

Constants

BULK_INSERT_COUNT = 200
BULK_INSERT_HIGH_COUNT = 200
DB_DAO_NOTNULL = 128
IS_NULL = 2
NOT_NULL = 1
QUERY_FORMAT_NO_QUOTES = 2
QUERY_FORMAT_WILDCARD = 1
SERIALIZE_COMMA = 5: Comma separated string, no quotes, no spaces
SERIALIZE_JSON = 3: Recommended serialization format
SERIALIZE_NONE = 0: No serialization.
SERIALIZE_PHP = 4
SERIALIZE_SEPARATOR_BOOKEND = 1: Serialized string separated by and bookended with VALUE_SEPARATOR
SERIALIZE_SEPARATOR_TRIMMED = 2
VALUE_SEPARATOR = "\x01"

Properties

$_dbColumnValueCache : mixed
$_icon : string: Icon associated with this entity.
$_labelField : string: Field to show when displaying a record.
$_nullArray : array<string|int, mixed>
$_nullObject : null
$_primaryKey : array<string|int, string>: Primary key field(s).
$_testEntitiesToSkip : array<string|int, mixed>: Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted
$collapse_adv_display : bool|string
$collapse_display : bool|string
$created_date : string|null
$created_id : int|string|null
$extends : string|null
$extends_entity_column_id : int|string|null
$extends_entity_column_value : string|null
$help_post : string|null
$help_pre : string|null
$icon : string|null
$id : int|string|null
$is_active : bool|string
$is_multiple : bool|string
$is_public : bool|string
$is_reserved : bool|string
$max_multiple : int|string|null
$min_multiple : int|string|null
$name : string|null
$style : string|null
$table_name : string|null
$title : string
$weight : int|string
$_options : array<string|int, mixed>: https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings
$resultCopies : int: How many times has this instance been cloned.

Methods

__clone() : mixed
__construct() : static: Class constructor.
__destruct() : mixed: Class destructor.
acceptedSQLOperators() : array<string|int, string>
addSelectWhereClause() : array<string|int, mixed>: Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
appendPseudoConstantsToFields() : mixed: Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
autoCreateByActivityType() : mixed
buildCustomDataView() : array<string|int, mixed>|int: Build custom data view.
buildCustomFieldData() : mixed: Build the entity-specific custom data into the group tree on a per-field basis
buildEntityTreeMultipleFields() : mixed: Build the group tree for Custom fields which are 'is_multiple'
buildEntityTreeSingleFields() : mixed: Build the group tree for Custom fields which are not 'is_multiple'
buildOptions() : array<string|int, mixed>|bool: Legacy field options getter.
buildOptionsContext() : array<string|int, mixed>: Provides documentation and validation for the buildOptions $context param
buildQuickForm() : mixed: Generic function to build all the form elements for a specific group tree.
buildTreeEntityDataFromQuery() : mixed: Build the tree entity data - starting from a query retrieving the custom fields build the group tree data for the relevant entity (entity is included in the query).
cascadeUpdate() : CRM_Core_DAO|null: Cascade update through related entities.
checkConstraintExists() : bool: Checks if a constraint exists for a specified table.
checkCustomField() : bool
checkFieldHasAlwaysValue() : mixed: Check whether a specific column in a specific table has always the same value.
checkFieldIsAlwaysNull() : mixed: Check whether a specific column in a specific table is always NULL.
checkFKConstraintInFormat() : mixed: Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
checkGroupAccess() : bool
checkTableExists() : bool: Check if there is a given table in the database.
checkTableHasData() : bool: Check if a given table has data.
checkTriggerViewPermission() : bool
commonRetrieveAll() : object: Fetch object based on array of properties.
composeQuery() : string: Compose the query by merging the parameters into it.
copyCustomFields() : mixed: Method that copies custom fields values from an old entity to a new one.
copyGeneric() : CRM_Core_DAO|bool: Make a shallow copy of an object and all the fields in the object.
copyValues() : bool: Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
create() : CRM_Core_DAO_CustomGroup: FIXME: This function is too complex because it's trying to handle both api-style inputs and quickform inputs. Needs to be deprecated and broken up.
createReferenceColumns() : array<string|int, CRM_Core_Reference_Interface>: Given a list of fields, create a list of references.
createSQLFilter() : null|string|array<string|int, mixed>: Get SQL where clause for SQL filter syntax input parameters.
createTable() : mixed
createTestObject() : object|array<string|int, mixed>|null: Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING
createTriggers() : mixed
customGroupDataExistsForEntity() : bool: Check whether the custom group has any data for the given entity.
debugPrint() : mixed
delete() : int|false: Deletes items from table which match current objects variables.
deleteEntityContact() : mixed: Unused function.
deleteGroup() : bool: Delete the Custom Group.
deleteRecord() : CRM_Core_DAO: Delete a record from supplied params.
deleteRecords() : array<string|int, static>: Bulk delete multiple records.
deleteTestObjects() : mixed: Deletes the this object plus any dependent objects that are associated with it.
disableFullGroupByMode() : mixed: Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
dropAllTables() : mixed: Drop all CiviCRM tables.
dropTriggers() : mixed: Wrapper function to drop triggers.
escapeString() : string
escapeStrings() : string: Escape a list of strings for use with "WHERE X IN (...)" queries.
escapeWildCardString() : string
executeQuery() : CRM_Core_DAO|object: Execute a query.
executeUnbufferedQuery() : CRM_Core_DAO: Execute an unbuffered query.
export() : array<string|int, mixed>: Returns the list of fields that can be exported
extractGetParams() : array<string|int, mixed>: Extract the get params from the url, validate and store it in session.
fetchAll() : array<string|int, mixed>: Returns all results as array-encoded records.
fetchGenerator() : mixed: Return the results as PHP generator.
fetchMap() : array<string|int, mixed>: Get all the result records as mapping between columns.
fetchValue() : mixed|null: Returns a singular value.
fieldKeys() : array<string|int, mixed>: Return a mapping from field-name to the corresponding key (as used in fields()).
fields() : array<string|int, mixed>: Returns all the column names of this table.
fillValues() : array<string|int, mixed>: Given an incomplete record, attempt to fill missing field values from the database
findById() : static: Find a DAO object for the given ID and return it.
findReferences() : array<string|int, CRM_Core_DAO>: Find all records which refer to this entity.
formatFieldValues() : void: Format field values according to fields() metadata.
formatGroupTree() : array<string|int, mixed>: Function returns formatted groupTree, so that form can be easily built in template
freeResult() : mixed
getActiveGroups() : mixed
getAll() : array<string|int, array<string|int, mixed>>: Return custom groups and fields in a nested array, with optional filters and permissions applied.
getAllCustomGroupsByBaseEntity() : CRM_Core_DAO_CustomGroup
getAttribute() : array<string|int, mixed>: Get the size and maxLength attributes for this text field.
getConnection() : DB_common
getContactIDsFromComponent() : array<string|int, mixed>: Given the component id, compute the contact id since its used for things like send email
getCustomGroupDetail() : array<string|int, mixed>
getCustomGroupExtendsOptions() : array<string|int, array{id: string, label: string, grouping: string, table_name: string}>: List all possible values for `CustomGroup.extends`.
getDatabaseName() : string: Get the name of the CiviCRM database.
getDbVal() : array<string|int, mixed>|bool|int|string|null: Fetch a single field value from the database.
getDefaultFallbackValues() : mixed: Callback for `default_fallback` field values
getDynamicReferencesToTable() : array<string|int, mixed>: Get all dynamic references to the given table.
getEntityDescription() : string|null: Returns user-friendly description of this entity.
getEntityForGroup() : string: Given the name of a custom group, gets the name of the API entity the group extends.
getEntityFromExtends() : string: Translate CustomGroup.extends to entity name.
getEntityIcon() : string|null: Overridable function to get icon for a particular entity.
getEntityPaths() : array<string|int, mixed>: Returns system paths related to this entity (as defined in the xml schema)
getEntityRefFilters() : array<string|int, mixed>
getEntityTitle() : string: Returns localized title of this entity.
getExportableFieldsWithPseudoConstants() : array<string|int, mixed>: Get exportable fields with pseudoconstants rendered as an extra field.
getExtendedObjectTypes() : mixed: Deprecated function, use APIv4 getFields instead.
getExtendsEntityColumnIdOptions() : array<string|int, mixed>: Loads pseudoconstant option values for the `extends_entity_column_id` field.
getExtendsEntityColumnValueOptions() : array<string|int, mixed>: Loads pseudoconstant option values for the `extends_entity_column_value` field.
getExtensionName() : string|null: Get name of extension in which this DAO is defined.
getFieldSpec() : bool|array<string|int, mixed>
getFieldValue() : string|int|null: Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
getGlobalSetting() : mixed: Lookup the value of a MySQL global configuration variable.
getGroup() : array<string|int, mixed>|null: Retrieve a group by id, name, etc.
getGroupDetail() : mixed: Get custom group details for a group. Legacy function for backwards compatibility.
getGroupTitles() : array<string|int, mixed>
getLabelField() : string|null
getLocaleTableName() : string: Get localized name of this table, if applicable.
getLog() : bool: Returns if this table needs to be logged
getMultipleFieldGroup() : array<string|int, mixed>
getOptionLabels() : mixed: Populate option labels for this object's fields.
getReferenceColumns() : array<string|int, CRM_Core_Reference_Basic>: Returns list of FK relationships.
getReferenceCounts() : array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}>
getReferencesToContactTable() : mixed: Get all references to contact table.
getReferencesToTable() : array<string|int, CRM_Core_Reference_Interface>: List all tables which have either: - hard foreign keys to this table, or - a dynamic foreign key that includes this table as a possible target.
getSelectWhereClause() : array<string|int, mixed>: This returns the final permissioned query string for this entity
getSortString() : mixed: Unused function.
getSubTypes() : array<string|int, mixed>: Use APIv4 getFields (or self::getExtendsEntityColumnValueOptions) instead of this beast.
getSupportedFields() : array<string|int, mixed>: Returns all usable fields, indexed by name.
getTableName() : string: Returns the name of this table
getTableNameByEntityName() : mixed: Unused function.
getTableNames() : array<string|int, mixed>: Gets the names of all enabled schema tables.
getTitle() : string: Get the group title.
getTree() : array<string|int, array<string|int, mixed>>
hasCustomGroup() : bool
hasReachedMaxLimit() : bool: Returns TRUE if this is a multivalued group which has reached the max for a given entity.
import() : array<string|int, mixed>: Returns the list of fields that can be imported
indices() : array<string|int, mixed>
init() : mixed: Initialize the DAO object.
initialize() : mixed: Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
isComponentEnabled() : bool: Check if component is enabled for this DAO class
isDBMyISAM() : bool
isGroupEmpty() : bool|null: Check whether custom group is empty or not.
isValidOption() : bool: Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
keys() : array<string|int, string>: Returns primary keys (usually ['id'])
log() : mixed
makeAttribute() : array<string|int, mixed>|null: Create an attribute for this specific field. We only do this for strings and text
mapTableName() : string: Get table name for extends.
objectExists() : bool: Check if there is a record with the same name in the db.
postProcess() : mixed
query() : object: Execute a query by the current DAO, localizing it along the way (if needed).
reenableFullGroupByMode() : mixed: Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.
requireSafeDBName() : bool: ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insensitive.
reset() : mixed: Reset the DAO object.
retrieve() : self|null
save() : CRM_Core_DAO: Save DAO object.
schemaRequiresRebuilding() : mixed: Checks if CONSTRAINT keyword exists for a specified table.
self_hook_civicrm_post() : void
sequenceKey() : array<string|int, mixed>: Tells DB_DataObject which keys use autoincrement.
serializeField() : string|null: Transform an array to a serialized string for database storage.
setApiFilter() : mixed
setCreateDefaults() : mixed: Set defaults when creating new entity.
setDefaults() : mixed: Set defaults.
setFieldValue() : bool: Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
setIsActive() : bool
setOptions() : mixed: https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
shortenSQLName() : string: SQL has a limit of 64 characters on various names: table name, trigger name, column name ... For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.
singleValueQuery() : string|null: Execute a query and get the single result.
storeValues() : mixed: Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.
table() : array<string|int, mixed>: Get/set an associative array of table columns
tableHasBeenAdded() : bool: Checks if this DAO's table ought to exist.
triggerRebuild() : mixed: Build a list of triggers via hook and add them to (err, reconcile them with) the database.
unSerializeField() : array<string|int, mixed>|null: Transform a serialized string from the database into an array.
validateCustomGroupName() : mixed: Ensure group name does not conflict with an existing field
writeRecord() : static: Create or update a record from supplied params.
writeRecords() : array<string|int, static>: Bulk save multiple records
_setDBOptions() : mixed: https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
assignTestFK() : mixed
assignTestValue() : mixed: Generate and assign an arbitrary value to a field of a test object.
copyLocalizable() : mixed: Method that copies localizable fields from an old entity to a new one.
formatFieldValue() : mixed: Format a value according to field metadata.
getDynamicFkAclClauses() : array<string|int, mixed>: Get an array of ACL clauses for a dynamic FK (entity_id/entity_table combo)
getFirstPrimaryKey() : string
getMungedEntity() : string: Get the munged entity.
getTableAddVersion() : string
_addWhereAdd() : mixed
buildLegacyGroupTree() : mixed: Recreates legacy formatting for getTree but uses the new cached function to retrieve data.
clearDbColumnValueCache() : mixed: Remove item from static cache during update/delete operations
formatLegacyDbValues() : void: Recreates the crude string-only format originally produced by self::getTree.
getEntityDefinition() : array<string|int, mixed>
getEntityInfo() : array<string|int, mixed>
getFieldLength() : string|null
getSchemaFields() : array<string|int, mixed>
loadAll() : array<string|int, array<string|int, mixed>>: Fetch all custom groups and fields in a nested array.
loadSchemaFields() : array<string|int, mixed>
makeNameFromLabel() : void: When creating a record without a supplied name, create a unique, clean name derived from the label.
setDefaultsFromCallback() : void: Set default values for fields based on callback functions
validateSubTypeByEntity() : string: Validates contact subtypes and event types.

BULK_INSERT_COUNT


    public
        mixed
    BULK_INSERT_COUNT
    = 200

BULK_INSERT_HIGH_COUNT


    public
        mixed
    BULK_INSERT_HIGH_COUNT
    = 200

DB_DAO_NOTNULL


    public
        mixed
    DB_DAO_NOTNULL
    = 128

IS_NULL


    public
        mixed
    IS_NULL
    = 2

NOT_NULL


    public
        mixed
    NOT_NULL
    = 1

QUERY_FORMAT_NO_QUOTES


    public
        mixed
    QUERY_FORMAT_NO_QUOTES
    = 2

QUERY_FORMAT_WILDCARD


    public
        mixed
    QUERY_FORMAT_WILDCARD
    = 1

SERIALIZE_COMMA

Comma separated string, no quotes, no spaces


    public
        mixed
    SERIALIZE_COMMA
    = 5

SERIALIZE_JSON

Recommended serialization format


    public
        mixed
    SERIALIZE_JSON
    = 3

SERIALIZE_NONE

No serialization.


    public
        mixed
    SERIALIZE_NONE
    = 0

SERIALIZE_PHP

format using php serialize()


    public
        mixed
    SERIALIZE_PHP
    = 4

SERIALIZE_SEPARATOR_BOOKEND

Serialized string separated by and bookended with VALUE_SEPARATOR


    public
        mixed
    SERIALIZE_SEPARATOR_BOOKEND
    = 1

SERIALIZE_SEPARATOR_TRIMMED

format separated by VALUE_SEPARATOR


    public
        mixed
    SERIALIZE_SEPARATOR_TRIMMED
    = 2

VALUE_SEPARATOR


    public
        mixed
    VALUE_SEPARATOR
    = "\x01"

$_dbColumnValueCache


    public
    static    mixed
    $_dbColumnValueCache
     = \NULL

$_icon

Icon associated with this entity.


    public
    static    string
    $_icon
     = \NULL

$_labelField

Field to show when displaying a record.


    public
    static    string
    $_labelField
     = \NULL

$_nullArray


    public
    static    array<string|int, mixed>
    $_nullArray
     = []

$_nullObject


    public
    static    null
    $_nullObject
     = \NULL

$_primaryKey

Primary key field(s).


    public
    static    array<string|int, string>
    $_primaryKey
     = ['id']

$_testEntitiesToSkip

Define entities that shouldn't be created or deleted when creating/ deleting test objects - this prevents world regions, countries etc from being added / deleted


    public
    static    array<string|int, mixed>
    $_testEntitiesToSkip
     = []

$collapse_adv_display


    public
        bool|string
    $collapse_adv_display

$collapse_display


    public
        bool|string
    $collapse_display

$created_date


    public
        string|null
    $created_date

$created_id


    public
        int|string|null
    $created_id

$extends


    public
        string|null
    $extends

$extends_entity_column_id


    public
        int|string|null
    $extends_entity_column_id

$extends_entity_column_value


    public
        string|null
    $extends_entity_column_value

$help_post


    public
        string|null
    $help_post

$help_pre


    public
        string|null
    $help_pre

$icon


    public
        string|null
    $icon

$id


    public
        int|string|null
    $id

$is_active


    public
        bool|string
    $is_active

$is_multiple


    public
        bool|string
    $is_multiple

$is_public


    public
        bool|string
    $is_public

$is_reserved


    public
        bool|string
    $is_reserved

$max_multiple


    public
        int|string|null
    $max_multiple

$min_multiple


    public
        int|string|null
    $min_multiple

$name


    public
        string|null
    $name

$style


    public
        string|null
    $style

$table_name


    public
        string|null
    $table_name

$title


    public
        string
    $title

$weight


    public
        int|string
    $weight

$_options

https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings


    protected
        array<string|int, mixed>
    $_options
     = []

$resultCopies

How many times has this instance been cloned.


    protected
        int
    $resultCopies
     = 0

__clone()


    public
                    __clone() : mixed

__construct()

Class constructor.


    public
                    __construct() : static

Return values

static

__destruct()

Class destructor.


    public
                    __destruct() : mixed

acceptedSQLOperators()


    public
            static        acceptedSQLOperators() : array<string|int, string>

Return values

array<string|int, string>

addSelectWhereClause()

Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity


    public
                    addSelectWhereClause([string|null $entityName = NULL ][, int|null $userId = NULL ][, array<string|int, mixed> $conditions = [] ]) : array<string|int, mixed>

Return format is in the form of fieldname => clauses starting with an operator. e.g.:

  [
    // Each string in the array will get joined with AND
    'location_type_id' => ['IS NOT NULL', 'IN (1,2,3)'],
    // Each sub-array in the array will get joined with OR, field names must be enclosed in curly braces
    'privacy' => [
                   ['= 0', '= 1 AND {contact_id} = 456'],
                 ],
  ]

Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values. The query strings MAY reference other fields in this entity; they must be enclosed in {curly_braces}.

Parameters

$entityName : string|null = NULL: Name of the entity being queried (for normal BAO files implementing this method, this variable is redundant as there is a 1-1 relationship between most entities and most BAOs. However the variable is passed in to support dynamic entities such as ECK).
$userId : int|null = NULL: Contact id of the current user. This param is more aspirational than functional for now. Someday the API may support checking permissions for contacts other than the current user, but at present this is always NULL which defaults to the current user.
$conditions : array<string|int, mixed> = []: Contains field/value pairs gleaned from the WHERE clause or ON clause (depending on how the entity was added to the query). Can be used for optimization/deduping of clauses.

Return values

array<string|int, mixed>

appendPseudoConstantsToFields()

Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.


    public
            static        appendPseudoConstantsToFields(array<string|int, mixed> &$fields) : mixed

This is relevant where we want to offer both the ID field and the label field as an option, e.g. search builder.

It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.

Parameters

$fields : array<string|int, mixed>

autoCreateByActivityType()


    public
            static        autoCreateByActivityType(int $activityTypeId) : mixed

Function moved

Parameters

$activityTypeId : int

buildCustomDataView()

Build custom data view.


    public
            static        buildCustomDataView(CRM_Core_Form|CRM_Core_Page $form, array<string|int, mixed> $groupTree[, bool $returnCount = FALSE ][, int $gID = NULL ][, null $prefix = NULL ][, int $customValueId = NULL ][, int $entityId = NULL ][, bool $checkEditPermission = FALSE ]) : array<string|int, mixed>|int

Parameters

$form : CRM_Core_Form|CRM_Core_Page: Page object.
$groupTree : array<string|int, mixed>
$returnCount : bool = FALSE: True if customValue count needs to be returned.
$gID : int = NULL
$prefix : null = NULL
$customValueId : int = NULL
$entityId : int = NULL
$checkEditPermission : bool = FALSE

Return values

array<string|int, mixed>|int

buildCustomFieldData()

Build the entity-specific custom data into the group tree on a per-field basis


    public
            static        buildCustomFieldData(object $dao, array<string|int, mixed> &$groupTree, string $table, int $groupID, int $fieldID[, string|int $singleRecord = NULL ]) : mixed

Parameters

$dao : object: Object representing the custom field to be populated into the groupTree.
$groupTree : array<string|int, mixed>: (reference) the group tree being build.
$table : string: Table name.
$groupID : int: Custom group ID.
$fieldID : int: Custom field ID.
$singleRecord : string|int = NULL: holds 'new' or id if loading view/edit/copy for a single record.

buildEntityTreeMultipleFields()

Build the group tree for Custom fields which are 'is_multiple'


    public
            static        buildEntityTreeMultipleFields(array<string|int, mixed> &$groupTree, int $entityID, array<string|int, mixed> $entityMultipleSelectClauses, array<string|int, mixed> $multipleFieldTablesWithEntityData[, string|int $singleRecord = NULL ]) : mixed

This is done one table at a time to avoid Cross-Joins resulting in too many rows being returned

Parameters

$groupTree : array<string|int, mixed>: (reference) group tree array which is being built.
$entityID : int: Id of entity for whom the tree is being build up.
$entityMultipleSelectClauses : array<string|int, mixed>: Array of select clauses relevant to the entity.
$multipleFieldTablesWithEntityData : array<string|int, mixed>: Array of tables in which this entity has data.
$singleRecord : string|int = NULL: holds 'new' or id if view/edit/copy form for a single record is being loaded.

buildEntityTreeSingleFields()

Build the group tree for Custom fields which are not 'is_multiple'


    public
            static        buildEntityTreeSingleFields(array<string|int, mixed> &$groupTree, int $entityID, array<string|int, mixed> $entitySingleSelectClauses, array<string|int, mixed> $singleFieldTablesWithEntityData) : mixed

The combination of all these fields in one query with a 'using' join was not working for multiple fields. These now have a new behaviour (one at a time) but the single fields still use this mechanism as it seemed to be acceptable in this context

Parameters

$groupTree : array<string|int, mixed>: (reference) group tree array which is being built.
$entityID : int: Id of entity for whom the tree is being build up.
$entitySingleSelectClauses : array<string|int, mixed>: Array of select clauses relevant to the entity.
$singleFieldTablesWithEntityData : array<string|int, mixed>: Array of tables in which this entity has data.

buildOptions()

Legacy field options getter.


    public
            static        buildOptions(string $fieldName[, string $context = NULL ][, array<string|int, mixed> $values = [] ]) : array<string|int, mixed>|bool

in favor of Civi::entity()->getOptions()

Overriding this function is no longer recommended as a way to customize options. Instead, option lists can be customized by either:

Using a pseudoconstant callback
Implementing hook_civicrm_fieldOptions

Parameters

$fieldName : string
$context : string = NULL
$values : array<string|int, mixed> = []: Raw field values; whatever is known about this bao object.

Note: $values can contain unsanitized input and should be handled with care by CRM_Core_PseudoConstant::get

Return values

array<string|int, mixed>|bool

buildOptionsContext()

Provides documentation and validation for the buildOptions $context param


    public
            static        buildOptionsContext([string $context = NULL ]) : array<string|int, mixed>

Parameters

$context : string = NULL

Return values

array<string|int, mixed>

buildQuickForm()

Generic function to build all the form elements for a specific group tree.


    public
            static        buildQuickForm(CRM_Core_Form $form, array<string|int, mixed> $groupTree[, bool $inactiveNeeded = FALSE ][, string $prefix = '' ]) : mixed

Parameters

$form : CRM_Core_Form: The form object.
$groupTree : array<string|int, mixed>: The group tree object.
$inactiveNeeded : bool = FALSE: Return inactive custom groups.
$prefix : string = '': Prefix for custom grouptree assigned to template.

buildTreeEntityDataFromQuery()

Build the tree entity data - starting from a query retrieving the custom fields build the group tree data for the relevant entity (entity is included in the query).


    public
            static        buildTreeEntityDataFromQuery(array<string|int, mixed> &$groupTree, string $query, array<string|int, mixed> $includedTables[, string|int $singleRecord = NULL ]) : mixed

This function represents shared code between the buildEntityTreeMultipleFields & the buildEntityTreeSingleFields function

Parameters

$groupTree : array<string|int, mixed>: (reference) group tree array which is being built.
$query : string
$includedTables : array<string|int, mixed>: Tables to include - required because the function (for historical reasons). iterates through the group tree
$singleRecord : string|int = NULL: holds 'new' OR id if view/edit/copy form for a single record is being loaded.

cascadeUpdate()

Cascade update through related entities.


    public
            static        cascadeUpdate(string $daoName, mixed $fromId, mixed $toId[, array<string|int, mixed> $newData = [] ]) : CRM_Core_DAO|null

Parameters

$daoName : string
$fromId : mixed
$toId : mixed
$newData : array<string|int, mixed> = []

Return values

CRM_Core_DAO|null

checkConstraintExists()

Checks if a constraint exists for a specified table.


    public
            static        checkConstraintExists(string $tableName, string $constraint) : bool

Parameters

$tableName : string
$constraint : string

Return values

bool —

true if constraint exists, false otherwise

checkCustomField()


    public
            static        checkCustomField(int $customFieldId, array<string|int, mixed> $removeCustomFieldTypes) : bool

Silly function that does almost nothing.

Parameters

$customFieldId : int
$removeCustomFieldTypes : array<string|int, mixed>: Remove custom fields of a type eg: array("Individual") ;.

Return values

bool

checkFieldHasAlwaysValue()

Check whether a specific column in a specific table has always the same value.


    public
            static        checkFieldHasAlwaysValue(mixed $tableName, mixed $columnName, mixed $columnValue) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed
$columnValue : mixed

checkFieldIsAlwaysNull()

Check whether a specific column in a specific table is always NULL.


    public
            static        checkFieldIsAlwaysNull(mixed $tableName, mixed $columnName) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed

checkFKConstraintInFormat()

Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.


    public
            static        checkFKConstraintInFormat(mixed $tableName, mixed $columnName) : mixed

in 5.72 will be removed in 5.85

Parameters

$tableName : mixed
$columnName : mixed

checkGroupAccess()


    public
            static        checkGroupAccess(int $groupId[, int $operation = CRM_Core_Permission::EDIT ][, int|null $userId = NULL ]) : bool

Parameters

$groupId : int
$operation : int = CRM_Core_Permission::EDIT
$userId : int|null = NULL

Return values

bool

checkTableExists()

Check if there is a given table in the database.


    public
            static        checkTableExists(string $tableName) : bool

Parameters

$tableName : string

Return values

bool —

true if exists, else false

checkTableHasData()

Check if a given table has data.


    public
            static        checkTableHasData(string $tableName) : bool

Parameters

$tableName : string

Return values

bool —

TRUE if $tableName has at least one record.

checkTriggerViewPermission()


    public
            static        checkTriggerViewPermission([bool $view = TRUE ][, bool $trigger = TRUE ]) : bool

Parameters

$view : bool = TRUE
$trigger : bool = TRUE

Return values

bool

commonRetrieveAll()

Fetch object based on array of properties.


    public
            static        commonRetrieveAll(string $daoName, string $fieldIdName, int $fieldId, mixed &$details[, array<string|int, mixed> $returnProperities = NULL ]) : object

Parameters

$daoName : string: Name of the dao object.
$fieldIdName : string
$fieldId : int
$details : mixed
$returnProperities : array<string|int, mixed> = NULL: An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').

Return values

object —

an object of type referenced by daoName

composeQuery()

Compose the query by merging the parameters into it.


    public
            static        composeQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ]) : string

Parameters

$query : string
$params : array<string|int, mixed> = []
$abort : bool = TRUE

Return values

string

copyCustomFields()

Method that copies custom fields values from an old entity to a new one.


    public
                    copyCustomFields(int $entityID, int $newEntityID[, string $parentOperation = NULL ]) : mixed

Fixes bug CRM-19302, where if a custom field of File type was present, left both events using the same file, breaking download URL's for the old event.

Parameters

$entityID : int
$newEntityID : int
$parentOperation : string = NULL

copyGeneric()

Make a shallow copy of an object and all the fields in the object.


    public
            static        copyGeneric(string $daoName, array<string|int, mixed> $criteria[, array<string|int, mixed> $newData = NULL ][, string $fieldsFix = NULL ][, string $blockCopyOfDependencies = NULL ][, bool $blockCopyofCustomValues = FALSE ]) : CRM_Core_DAO|bool

Parameters

$daoName : string: Name of the dao.
$criteria : array<string|int, mixed>: Array of all the fields & values. on which basis to copy
$newData : array<string|int, mixed> = NULL: Array of all the fields & values. to be copied besides the other fields
$fieldsFix : string = NULL: Array of fields that you want to prefix/suffix/replace.
$blockCopyOfDependencies : string = NULL: Fields that you want to block from. getting copied
$blockCopyofCustomValues : bool = FALSE: Case when you don't want to copy the custom values set in a template as it will override/ignore the submitted custom values

Return values

CRM_Core_DAO|bool —

the newly created copy of the object. False if none created.

copyValues()

Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values


    public
                    copyValues(array<string|int, mixed> $params) : bool

Parameters

$params : array<string|int, mixed>: Array of name/value pairs to save.

Return values

bool —

Did we copy all null values into the object

create()

FIXME: This function is too complex because it's trying to handle both api-style inputs and quickform inputs. Needs to be deprecated and broken up.


    public
            static        create(array<string|int, mixed> &$params) : CRM_Core_DAO_CustomGroup

Parameters

$params : array<string|int, mixed>: (reference) an assoc array of name/value pairs.

Return values

CRM_Core_DAO_CustomGroup

createReferenceColumns()

Given a list of fields, create a list of references.


    public
            static        createReferenceColumns(string $className) : array<string|int, CRM_Core_Reference_Interface>

Parameters

$className : string: BAO/DAO class name.

Return values

array<string|int, CRM_Core_Reference_Interface>

createSQLFilter()

Get SQL where clause for SQL filter syntax input parameters.


    public
            static        createSQLFilter(string $fieldName, array<string|int, mixed> $filter[, string $type = NULL ][, string $alias = NULL ][, bool $returnSanitisedArray = FALSE ]) : null|string|array<string|int, mixed>

SQL version of api function to assign filters to the DAO based on the syntax $field => array('IN' => array(4,6,9)) OR $field => array('LIKE' => array('%me%)) etc

Parameters

$fieldName : string: Name of fields.
$filter : array<string|int, mixed>: filter to be applied indexed by operator.
$type : string = NULL: type of field (not actually used - nor in api @todo ).
$alias : string = NULL: alternative field name ('as') @todo- not actually used.
$returnSanitisedArray : bool = FALSE: Return a sanitised array instead of a clause. this is primarily so we can add filters @ the api level to the Query object based fields

Return values

null|string|array<string|int, mixed> —

a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL depending on whether it is supported as yet

createTable()


    public
            static        createTable(mixed $group) : mixed

Parameters

$group : mixed

createTestObject()

Creates a test object, including any required objects it needs via recursion createOnly: only create in database, do not store or return the objects (useful for perf testing) ONLY USE FOR TESTING


    public
            static        createTestObject(string $daoName[, array<string|int, mixed> $params = [] ][, int $numObjects = 1 ][, bool $createOnly = FALSE ]) : object|array<string|int, mixed>|null

Parameters

$daoName : string
$params : array<string|int, mixed> = []
$numObjects : int = 1
$createOnly : bool = FALSE

Return values

object|array<string|int, mixed>|null —

NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.

createTriggers()


    public
            static        createTriggers(array<string|int, mixed> &$info[, string $onlyTableName = NULL ]) : mixed

Parameters

$info : array<string|int, mixed>: per hook_civicrm_triggerInfo.
$onlyTableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.

customGroupDataExistsForEntity()

Check whether the custom group has any data for the given entity.


    public
            static        customGroupDataExistsForEntity(int $entityID, string $table[, bool $getCount = FALSE ]) : bool

Parameters

$entityID : int: Id of entity for whom we are checking data for.
$table : string: Table that we are checking.
$getCount : bool = FALSE

Return values

bool —

does this entity have data in this custom table

debugPrint()


    public
            static        debugPrint([null $message = NULL ][, bool $printDAO = TRUE ]) : mixed

Parameters

$message : null = NULL
$printDAO : bool = TRUE

delete()

Deletes items from table which match current objects variables.


    public
                    delete([bool $useWhere = FALSE ]) : int|false

Returns the true on success

for example

Designed to be extended

$object = new mytable(); $object->ID=123; echo $object->delete(); // builds a conditon

$object = new mytable(); $object->whereAdd('age > 12'); $object->limit(1); $object->orderBy('age DESC'); $object->delete(true); // dont use object vars, use the conditions, limit and order.

Parameters

$useWhere : bool = FALSE: (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then we will build the condition only using the whereAdd's. Default is to build the condition only using the object parameters.

Return values

int|false —

Int (No. of rows affected) on success, false on failure, 0 on no data affected

deleteEntityContact()

Unused function.


    public
            static        deleteEntityContact(mixed $daoName, mixed $contactId) : mixed

in 5.47 will be removed in 5.80

Parameters

$daoName : mixed
$contactId : mixed

deleteGroup()

Delete the Custom Group.


    public
            static        deleteGroup(CRM_Core_BAO_CustomGroup $group[, bool $force = FALSE ]) : bool

Parameters

$group : CRM_Core_BAO_CustomGroup: Custom group object.
$force : bool = FALSE: whether to force the deletion, even if there are custom fields.

Return values

bool —

False if field exists for this group, true if group gets deleted.

deleteRecord()

Delete a record from supplied params.


    public
            static        deleteRecord(array<string|int, mixed> $record) : CRM_Core_DAO

API3 calls deleteGroup() which removes the related civicrm_value_X table. This function does the same for API4.

Parameters

$record : array<string|int, mixed>: 'id' is required.

Return values

CRM_Core_DAO

deleteRecords()

Bulk delete multiple records.


    public
            static        deleteRecords(array<string|int, array<string|int, mixed>> $records) : array<string|int, static>

Parameters

$records : array<string|int, array<string|int, mixed>>

Return values

array<string|int, static>

deleteTestObjects()

Deletes the this object plus any dependent objects that are associated with it.


    public
            static        deleteTestObjects(string $daoName[, array<string|int, mixed> $params = [] ]) : mixed

ONLY USE FOR TESTING

Parameters

$daoName : string
$params : array<string|int, mixed> = []

disableFullGroupByMode()

Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary


    public
            static        disableFullGroupByMode() : mixed

dropAllTables()

Drop all CiviCRM tables.


    public
            static        dropAllTables() : mixed

dropTriggers()

Wrapper function to drop triggers.


    public
            static        dropTriggers([string $tableName = NULL ]) : mixed

Parameters

$tableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.

escapeString()


    public
            static        escapeString(mixed $string) : string

Parameters

$string : mixed

Return values

string

escapeStrings()

Escape a list of strings for use with "WHERE X IN (...)" queries.


    public
            static        escapeStrings(array<string|int, mixed> $strings[, string $default = NULL ]) : string

Parameters

$strings : array<string|int, mixed>
$default : string = NULL: the value to use if $strings has no elements.

Return values

string —

eg "abc","def","ghi"

escapeWildCardString()


    public
            static        escapeWildCardString(mixed $string) : string

Parameters

$string : mixed

Return values

string

executeQuery()

Execute a query.


    public
            static    &    executeQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, null $daoName = NULL ][, bool $freeDAO = FALSE ][, bool $i18nRewrite = TRUE ][, bool $trapException = FALSE ][, array<string|int, mixed> $options = [] ]) : CRM_Core_DAO|object

Parameters

$query : string: Query to be executed.
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$daoName : null = NULL
$freeDAO : bool = FALSE
$i18nRewrite : bool = TRUE
$trapException : bool = FALSE
$options : array<string|int, mixed> = []

Return values

CRM_Core_DAO|object —

object that holds the results of the query NB - if this is defined as just returning a DAO phpstorm keeps pointing out all the properties that are not part of the DAO

executeUnbufferedQuery()

Execute an unbuffered query.


    public
            static        executeUnbufferedQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, null $daoName = NULL ][, bool $freeDAO = FALSE ][, bool $i18nRewrite = TRUE ][, bool $trapException = FALSE ]) : CRM_Core_DAO

This is a wrapper around new functionality exposed with CRM-17748.

Parameters

$query : string: query to be executed
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$daoName : null = NULL
$freeDAO : bool = FALSE
$i18nRewrite : bool = TRUE
$trapException : bool = FALSE

Return values

CRM_Core_DAO —

Object that points to an unbuffered result set

export()

Returns the list of fields that can be exported


    public
            static        export([bool $prefix = FALSE ]) : array<string|int, mixed>

Parameters

$prefix : bool = FALSE

Return values

array<string|int, mixed>

extractGetParams()

Extract the get params from the url, validate and store it in session.


    public
            static        extractGetParams(CRM_Core_Form &$form, string $type) : array<string|int, mixed>

Parameters

$form : CRM_Core_Form: The form object.
$type : string: The type of custom group we are using.

Return values

array<string|int, mixed>

fetchAll()

Returns all results as array-encoded records.


    public
                    fetchAll([mixed $k = FALSE ][, mixed $v = FALSE ][, mixed $method = FALSE ]) : array<string|int, mixed>

Parameters

$k : mixed = FALSE
$v : mixed = FALSE
$method : mixed = FALSE

Return values

array<string|int, mixed>

fetchGenerator()

Return the results as PHP generator.


    public
                    fetchGenerator([string $type = 'dao' ]) : mixed

Parameters

$type : string = 'dao': Whether the generator yields 'dao' objects or 'array's.

fetchMap()

Get all the result records as mapping between columns.


    public
                    fetchMap(string $keyColumn, string $valueColumn) : array<string|int, mixed>

Parameters

$keyColumn : string: Ex: "name"
$valueColumn : string: Ex: "label"

Return values

array<string|int, mixed> —

Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]

fetchValue()

Returns a singular value.


    public
                    fetchValue() : mixed|null

Return values

mixed|null

fieldKeys()

Return a mapping from field-name to the corresponding key (as used in fields()).


    public
            static        fieldKeys() : array<string|int, mixed>

Return values

array<string|int, mixed> —

[string $name => string $uniqueName]

fields()

Returns all the column names of this table.


    public
            static    &    fields() : array<string|int, mixed>

Return values

array<string|int, mixed>

fillValues()

Given an incomplete record, attempt to fill missing field values from the database


    public
            static        fillValues(array<string|int, mixed> $existingValues, mixed $fieldsToRetrieve) : array<string|int, mixed>

Parameters

$existingValues : array<string|int, mixed>
$fieldsToRetrieve : mixed

Return values

array<string|int, mixed>

findById()

Find a DAO object for the given ID and return it.


    public
            static        findById(int $id) : static

Parameters

$id : int: Id of the DAO object being searched for.

Return values

static —

Object of the type of the class that called this function.

findReferences()

Find all records which refer to this entity.


    public
                    findReferences() : array<string|int, CRM_Core_DAO>

Return values

array<string|int, CRM_Core_DAO>

formatFieldValues()

Format field values according to fields() metadata.


    public
            static        formatFieldValues(array<string|int, mixed> &$fieldValues) : void

When fetching results from a query, every field is returned as a string. This function automatically converts them to the correct data type.

Parameters

$fieldValues : array<string|int, mixed>

formatGroupTree()

Function returns formatted groupTree, so that form can be easily built in template


    public
            static        formatGroupTree(array<string|int, mixed> $groupTree[, int $groupCount = 1 ][, CRM_Core_Form &$form = NULL ]) : array<string|int, mixed>

Parameters

$groupTree : array<string|int, mixed>
$groupCount : int = 1: Group count by default 1, but can vary for multiple value custom data.
$form : CRM_Core_Form = NULL

Return values

array<string|int, mixed>

freeResult()


    public
            static        freeResult([null $ids = NULL ]) : mixed

Parameters

$ids : null = NULL

getActiveGroups()


    public
            static    &    getActiveGroups(mixed $entityType, mixed $path[, mixed $cidToken = '%%cid%%' ]) : mixed

since 5.71, will be removed around 5.85

Parameters

$entityType : mixed
$path : mixed
$cidToken : mixed = '%%cid%%'

getAll()

Return custom groups and fields in a nested array, with optional filters and permissions applied.


    public
            static        getAll([array<string|int, mixed> $filters = [] ][, int|null $permissionType = NULL ][, int|null $userId = NULL ]) : array<string|int, array<string|int, mixed>>

With no params, this returns every custom group and field, including disabled.

Parameters

$filters : array<string|int, mixed> = []

[key => value] pairs to filter each custom group.

$filters[extends] will auto-expand Contact types (if passed as a string)
$filters[is_active] will also filter the fields

$permissionType : int|null = NULL

Check permission: (CRM_Core_Permission::VIEW | CRM_Core_Permission::EDIT)

$userId : int|null = NULL

User contact id for permission check (defaults to current user)

Return values

array<string|int, array<string|int, mixed>>

getAllCustomGroupsByBaseEntity()


    public
            static        getAllCustomGroupsByBaseEntity(string $entityType) : CRM_Core_DAO_CustomGroup

since 5.71 will be removed around 5.85

Parameters

$entityType : string

Return values

CRM_Core_DAO_CustomGroup

getAttribute()

Get the size and maxLength attributes for this text field.


    public
            static        getAttribute(string $class[, string $fieldName = NULL ]) : array<string|int, mixed>

(or for all text fields) in the DAO object.

Parameters

$class : string: Name of DAO class.
$fieldName : string = NULL: Field that i'm interested in or null if. you want the attributes for all DAO text fields

Return values

array<string|int, mixed> —

assoc array of name => attribute pairs

getConnection()


    public
            static        getConnection() : DB_common

Return values

DB_common

getContactIDsFromComponent()

Given the component id, compute the contact id since its used for things like send email


    public
            static        getContactIDsFromComponent(mixed $componentIDs, string $tableName[, string $idField = 'id' ]) : array<string|int, mixed>

Parameters

$componentIDs : mixed
$tableName : string
$idField : string = 'id'

Return values

array<string|int, mixed>

getCustomGroupDetail()


    public
            static    &    getCustomGroupDetail([int $groupId = NULL ][, array<string|int, mixed> $extends = NULL ][, bool $inSelector = NULL ]) : array<string|int, mixed>

Legacy function

Parameters

$groupId : int = NULL: Group id whose details are needed.
$extends : array<string|int, mixed> = NULL: Which table does it extend if any.
$inSelector : bool = NULL

Return values

array<string|int, mixed> —

array consisting of all group and field details

getCustomGroupExtendsOptions()

List all possible values for `CustomGroup.extends`.


    public
            static        getCustomGroupExtendsOptions() : array<string|int, array{id: string, label: string, grouping: string, table_name: string}>

This includes the pseudo-entities "Individual", "Organization", "Household".

Returns a mix of hard-coded array and cg_extend_objects OptionValues.

'id' return key (maps to cg_extend_objects.value).
'grouping' key refers to the entity field used to select a sub-type.
'is_multiple' (@internal, not returned by getFields.loadOptions) (maps to cg_extend_objects.filter) controls whether the entity supports multi-record custom groups.
'table_name' (@internal, not returned by getFields.loadOptions) (maps to cg_extend_objects.name). We don't return it as the 'name' in getFields because it is not always unique (since contact types are pseudo-entities).

Return values

array<string|int, array{id: string, label: string, grouping: string, table_name: string}>

getDatabaseName()

Get the name of the CiviCRM database.


    public
            static        getDatabaseName() : string

use mysql DATABASE() within the query.

Return values

string

getDbVal()

Fetch a single field value from the database.


    public
            static        getDbVal(string $returnColumn, string|int $searchValue[, string $searchColumn = 'id' ]) : array<string|int, mixed>|bool|int|string|null

Uses static caching and applies formatting.

Parameters

$returnColumn : string
$searchValue : string|int
$searchColumn : string = 'id'

Return values

Returned value will be formatted according to data type.

getDefaultFallbackValues()

Callback for `default_fallback` field values


    public
            static        getDefaultFallbackValues(array<string|int, mixed> $record, string $entityName, string $fieldName, array<string|int, mixed> $field) : mixed

Parameters

$record : array<string|int, mixed>
$entityName : string
$fieldName : string
$field : array<string|int, mixed>

getDynamicReferencesToTable()

Get all dynamic references to the given table.


    public
            static        getDynamicReferencesToTable(string $tableName) : array<string|int, mixed>

Parameters

$tableName : string

Return values

array<string|int, mixed>

getEntityDescription()

Returns user-friendly description of this entity.


    public
            static        getEntityDescription() : string|null

Return values

string|null

getEntityForGroup()

Given the name of a custom group, gets the name of the API entity the group extends.


    public
            static        getEntityForGroup(string $groupName) : string

Sort of the inverse of this function:

Parameters

$groupName : string

Return values

string

getEntityFromExtends()

Translate CustomGroup.extends to entity name.


    public
            static        getEntityFromExtends(string $extends) : string

CustomGroup.extends pretty much maps 1-1 with entity names, except for Individual, Organization & Household.

Parameters

$extends : string

Return values

string

getEntityIcon()

Overridable function to get icon for a particular entity.


    public
            static        getEntityIcon(string $entityName[, int|null $entityId = NULL ]) : string|null

Parameters

$entityName : string: Short name of the entity. This may seem redundant because the entity name can usually be inferred from the BAO class being called, but not always. Some virtual entities share a BAO class.
$entityId : int|null = NULL: Id of the entity.

Return values

string|null

getEntityPaths()

Returns system paths related to this entity (as defined in the xml schema)


    public
            static        getEntityPaths() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityRefFilters()


    public
            static        getEntityRefFilters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityTitle()

Returns localized title of this entity.


    public
            static        getEntityTitle([mixed $plural = FALSE ]) : string

Parameters

$plural : mixed = FALSE

Return values

string

getExportableFieldsWithPseudoConstants()

Get exportable fields with pseudoconstants rendered as an extra field.


    public
            static        getExportableFieldsWithPseudoConstants(string $baoClass) : array<string|int, mixed>

Parameters

$baoClass : string

Return values

array<string|int, mixed>

getExtendedObjectTypes()

Deprecated function, use APIv4 getFields instead.


    public
            static        getExtendedObjectTypes([array<string|int, mixed> &$types = [] ]) : mixed

Parameters

$types : array<string|int, mixed> = []: Var which should have the list appended.

getExtendsEntityColumnIdOptions()

Loads pseudoconstant option values for the `extends_entity_column_id` field.


    public
            static        getExtendsEntityColumnIdOptions([string|null $fieldName = NULL ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$fieldName : string|null = NULL
$params : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getExtendsEntityColumnValueOptions()

Loads pseudoconstant option values for the `extends_entity_column_value` field.


    public
            static        getExtendsEntityColumnValueOptions(mixed $context, array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$context : mixed
$params : array<string|int, mixed>

Return values

array<string|int, mixed>

getExtensionName()

Get name of extension in which this DAO is defined.


    public
            static        getExtensionName() : string|null

Return values

string|null

getFieldSpec()


    public
                    getFieldSpec(string $fieldName) : bool|array<string|int, mixed>

Parameters

$fieldName : string

Return values

bool|array<string|int, mixed>

getFieldValue()

Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record


    public
            static        getFieldValue(string $daoName, int $searchValue[, string $returnColumn = 'name' ][, string $searchColumn = 'id' ][, bool $force = FALSE ]) : string|int|null

Parameters

$daoName : string: Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
$searchValue : int: Value of the column you want to search by.
$returnColumn : string = 'name': Name of the column you want to GET the value of.
$searchColumn : string = 'id': Name of the column you want to search by.
$force : bool = FALSE: Skip use of the cache.

Return values

string|int|null —

Value of $returnColumn in the retrieved record

getGlobalSetting()

Lookup the value of a MySQL global configuration variable.


    public
            static        getGlobalSetting(string $name[, mixed $default = NULL ]) : mixed

Parameters

$name : string: E.g. "thread_stack".
$default : mixed = NULL

getGroup()

Retrieve a group by id, name, etc.


    public
            static        getGroup(array<string|int, mixed> $filter[, int|null $permissionType = NULL ][, int|null $userId = NULL ]) : array<string|int, mixed>|null

Parameters

$filter : array<string|int, mixed>: Simplified version of $filters in self::getAll; returns first group that matches every filter. e.g. ['id' => 23] or ['name' => 'MyGroup']
$permissionType : int|null = NULL: Check permission: (CRM_Core_Permission::VIEW | CRM_Core_Permission::EDIT)
$userId : int|null = NULL: User contact id for permission check (defaults to current user)

Return values

array<string|int, mixed>|null —

Result includes all custom fields in addition to group info.

getGroupDetail()

Get custom group details for a group. Legacy function for backwards compatibility.


    public
            static    &    getGroupDetail([mixed $groupId = NULL ][, mixed $searchable = FALSE ][, mixed &$extends = NULL ][, mixed $inSelector = NULL ]) : mixed

Legacy function

Parameters

$groupId : mixed = NULL
$searchable : mixed = FALSE
$extends : mixed = NULL
$inSelector : mixed = NULL

getGroupTitles()


    public
            static        getGroupTitles(array<string|int, mixed> $fieldIds) : array<string|int, mixed>

Silly function that shouldn't exist.

Parameters

$fieldIds : array<string|int, mixed>: Array of custom field ids.

Return values

array<string|int, mixed> —

array consisting of groups and fields labels with ids.

getLabelField()


    public
            static        getLabelField() : string|null

Return values

string|null

getLocaleTableName()

Get localized name of this table, if applicable.


    public
            static        getLocaleTableName([string|null $tableName = NULL ]) : string

If this is a multi-language installation and the table has localized columns, will return table name with language string appended, which points to a sql view. Otherwise, this returns the same output as

Parameters

$tableName : string|null = NULL: Unnecessary deprecated param

Return values

string

getLog()

Returns if this table needs to be logged


    public
                    getLog() : bool

Return values

bool

getMultipleFieldGroup()


    public
            static        getMultipleFieldGroup() : array<string|int, mixed>

Return values

array<string|int, mixed>

getOptionLabels()

Populate option labels for this object's fields.


    public
                    getOptionLabels() : mixed

getReferenceColumns()

Returns list of FK relationships.


    public
            static        getReferenceColumns() : array<string|int, CRM_Core_Reference_Basic>

Return values

array<string|int, CRM_Core_Reference_Basic>

getReferenceCounts()


    public
                    getReferenceCounts() : array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}>

Return values

array<string|int, array{name: string, type: string, count: int, table: string|null, key: string|null}> —

each item has keys:

name: string
type: string
count: int
table: string|null SQL table name
key: string|null SQL column name

getReferencesToContactTable()

Get all references to contact table.


    public
            static        getReferencesToContactTable() : mixed

This includes core tables, custom group tables, tables added by the merge hook and the entity_tag table.

Refer to CRM-17454 for information on the danger of querying the information schema to derive this.

getReferencesToTable()

List all tables which have either: - hard foreign keys to this table, or - a dynamic foreign key that includes this table as a possible target.


    public
            static        getReferencesToTable(string $tableName) : array<string|int, CRM_Core_Reference_Interface>

Parameters

$tableName : string: Table referred to.

Return values

array<string|int, CRM_Core_Reference_Interface> —

structure of table and column, listing every table with a foreign key reference to $tableName, and the column where the key appears.

getSelectWhereClause()

This returns the final permissioned query string for this entity


    public
            static        getSelectWhereClause([string|null $tableAlias = NULL ][, string|null $entityName = NULL ][, array<string|int, mixed> $conditions = [] ]) : array<string|int, mixed>

With acls from related entities + additional clauses from hook_civicrm_selectWhereClause

DO NOT OVERRIDE THIS FUNCTION

Parameters

$tableAlias : string|null = NULL
$entityName : string|null = NULL
$conditions : array<string|int, mixed> = []: Values from WHERE or ON clause

Return values

array<string|int, mixed>

getSortString()

Unused function.


    public
            static        getSortString(mixed $sort[, mixed $default = NULL ]) : mixed

in 5.72 will be removed in 5.85

Parameters

$sort : mixed
$default : mixed = NULL

getSubTypes()

Use APIv4 getFields (or self::getExtendsEntityColumnValueOptions) instead of this beast.


    public
            static        getSubTypes() : array<string|int, mixed>

as of 5.72 use getExtendsEntityColumnValueOptions - will be removed by 5.78

Return values

array<string|int, mixed>

getSupportedFields()

Returns all usable fields, indexed by name.


    public
            static        getSupportedFields([bool $checkPermissions = FALSE ]) : array<string|int, mixed>

This function differs from fields() in that it indexes by name rather than unique_name.

It excludes fields not added yet by pending upgrades. This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.

Parameters

$checkPermissions : bool = FALSE: Filter by field permissions.

Return values

array<string|int, mixed>

getTableName()

Returns the name of this table


    public
            static        getTableName() : string

Return values

string

getTableNameByEntityName()

Unused function.


    public
            static        getTableNameByEntityName(mixed $entityType) : mixed

since 5.71 will be removed around 5.85

Parameters

$entityType : mixed

getTableNames()

Gets the names of all enabled schema tables.


    public
            static        getTableNames() : array<string|int, mixed>

Includes tables from core, components & enabled extensions.
Excludes log tables, temp tables, and missing/disabled extensions.

Return values

array<string|int, mixed>

getTitle()

Get the group title.


    public
            static        getTitle(int $id) : string

Parameters

$id : int: Id of group.

Return values

string —

title

getTree()


    public
            static        getTree(string $entityType[, array<string|int, mixed> $toReturn = [] ][, int $entityID = NULL ][, int $groupID = NULL ][, array<string|int, mixed> $subTypes = [] ][, string $subName = NULL ][, bool $fromCache = TRUE ][, bool $onlySubType = NULL ][, bool $returnAll = FALSE ][, bool|int $checkPermission = CRM_Core_Permission::EDIT ][, string|int $singleRecord = NULL ][, bool $showPublicOnly = FALSE ]) : array<string|int, array<string|int, mixed>>

Function demonstrates just how bad code can get from 20 years of entropy.

This function takes an overcomplicated set of params and returns an overcomplicated mix of custom groups, custom fields, custom values (if passed $entityID), and other random stuff.

Parameters

$entityType : string: Of the contact whose contact type is needed.
$toReturn : array<string|int, mixed> = []: What data should be returned. ['custom_group' => ['id', 'name', etc.], 'custom_field' => ['id', 'label', etc.]]
$entityID : int = NULL
$groupID : int = NULL
$subTypes : array<string|int, mixed> = []
$subName : string = NULL
$fromCache : bool = TRUE
$onlySubType : bool = NULL: Only return specified subtype or return specified subtype + unrestricted fields.
$returnAll : bool = FALSE: Do not restrict by subtype at all.
$checkPermission : bool|int = CRM_Core_Permission::EDIT: Either a CRM_Core_Permission constant or FALSE to disable checks
$singleRecord : string|int = NULL: holds 'new' or id if view/edit/copy form for a single record is being loaded.
$showPublicOnly : bool = FALSE

Return values

array<string|int, array<string|int, mixed>> —

The returned array is keyed by group id and has the custom group table fields and a subkey 'fields' holding the specific custom fields. If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data'

hasCustomGroup()


    public
            static        hasCustomGroup(string $extends, int $columnId, string $columnValue) : bool

since 5.71 will be removed around 5.85.

Parameters

$extends : string: E.g. "Individual", "Activity".
$columnId : int: E.g. custom-group matching mechanism (usu NULL for matching on sub type-id); see extends_entity_column_id.
$columnValue : string: E.g. "Student" or "3" or "3\05"; see extends_entity_column_value.

Return values

bool

hasReachedMaxLimit()

Returns TRUE if this is a multivalued group which has reached the max for a given entity.


    public
            static        hasReachedMaxLimit(int $customGroupId, int $entityId) : bool

Parameters

$customGroupId : int
$entityId : int

Return values

bool

import()

Returns the list of fields that can be imported


    public
            static        import([bool $prefix = FALSE ]) : array<string|int, mixed>

Parameters

$prefix : bool = FALSE

Return values

array<string|int, mixed>

indices()


    public
            static        indices([bool $localize = TRUE ]) : array<string|int, mixed>

Parameters

$localize : bool = TRUE

Return values

array<string|int, mixed>

init()

Initialize the DAO object.


    public
            static        init(string $dsn) : mixed

Parameters

$dsn : string: The database connection string.

initialize()

Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.


    public
                    initialize() : mixed

isComponentEnabled()

Check if component is enabled for this DAO class


    public
            static        isComponentEnabled() : bool

Return values

bool

isDBMyISAM()


    public
            static        isDBMyISAM([int $maxTablesToCheck = 10 ]) : bool

Parameters

$maxTablesToCheck : int = 10

Return values

bool

isGroupEmpty()

Check whether custom group is empty or not.


    public
            static        isGroupEmpty(int $gID) : bool|null

Parameters

$gID : int: Custom group id.

Return values

bool|null —

true if empty otherwise false.

isValidOption()

Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level


    public
                    isValidOption(array<string|int, mixed> $options) : bool

Parameters

$options : array<string|int, mixed>

Return values

bool —

Provided options are valid

keys()

Returns primary keys (usually ['id'])


    public
                    keys() : array<string|int, string>

Return values

array<string|int, string>

log()


    public
                    log([bool $created = FALSE ]) : mixed

Parameters

$created : bool = FALSE

makeAttribute()

Create an attribute for this specific field. We only do this for strings and text


    public
            static        makeAttribute(array<string|int, mixed> $field) : array<string|int, mixed>|null

Parameters

$field : array<string|int, mixed>: The field under task.

Return values

array<string|int, mixed>|null —

the attributes for the object

mapTableName()

Get table name for extends.


    public
            static        mapTableName(string $entityName) : string

Parameters

$entityName : string

Return values

string

objectExists()

Check if there is a record with the same name in the db.


    public
            static        objectExists(string $value, string $daoName, string $daoID[, string $fieldName = 'name' ][, string $domainID = NULL ]) : bool

Parameters

$value : string: The value of the field we are checking.
$daoName : string: The dao object name.
$daoID : string: The id of the object being updated. u can change your name. as long as there is no conflict
$fieldName : string = 'name': The name of the field in the DAO.
$domainID : string = NULL: The id of the domain. Object exists only for the given domain.

Return values

bool —

true if object exists

postProcess()


    public
            static        postProcess(array<string|int, mixed> &$groupTree, array<string|int, mixed> &$params[, bool $skipFile = FALSE ]) : mixed

since 5.71 will be remvoed around 5.77

Parameters

$groupTree : array<string|int, mixed>
$params : array<string|int, mixed>
$skipFile : bool = FALSE

query()

Execute a query by the current DAO, localizing it along the way (if needed).


    public
                    query(string $query[, bool $i18nRewrite = TRUE ]) : object

Parameters

$query : string: The SQL query for execution.
$i18nRewrite : bool = TRUE: Whether to rewrite the query.

Return values

object —

the current DAO object after the query execution

reenableFullGroupByMode()

Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.


    public
            static        reenableFullGroupByMode() : mixed

requireSafeDBName()

ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insensitive.


    public
            static        requireSafeDBName(mixed $database) : bool

Parameters

$database : mixed

Return values

bool

reset()

Reset the DAO object.


    public
                    reset() : mixed

DAO is kinda crappy in that there is an unwritten rule of one query per DAO.

We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution

retrieve()


    public
            static        retrieve(array<string|int, mixed> $params, array<string|int, mixed> &$defaults) : self|null

Parameters

$params : array<string|int, mixed>
$defaults : array<string|int, mixed>

Return values

self|null

save()

Save DAO object.


    public
                    save([bool $hook = TRUE ]) : CRM_Core_DAO

Parameters

$hook : bool = TRUE

Return values

CRM_Core_DAO

schemaRequiresRebuilding()

Checks if CONSTRAINT keyword exists for a specified table.


    public
            static        schemaRequiresRebuilding([mixed $tables = ["civicrm_contact"] ]) : mixed

in 5.72 will be removed in 5.85

Parameters

$tables : mixed = ["civicrm_contact"]

self_hook_civicrm_post()


    public
            static        self_hook_civicrm_post(PostEvent $e) : void

Parameters

$e : PostEvent

sequenceKey()

Tells DB_DataObject which keys use autoincrement.


    public
                    sequenceKey() : array<string|int, mixed>

'id' is autoincrementing by default.

FIXME: this should return all autoincrement keys not just the first.

Return values

array<string|int, mixed>

serializeField()

Transform an array to a serialized string for database storage.


    public
            static        serializeField(array<string|int, mixed>|null $value, int $serializationType) : string|null

Parameters

$value : array<string|int, mixed>|null
$serializationType : int

Return values

string|null

setApiFilter()


    public
                    setApiFilter(array<string|int, mixed> &$params) : mixed

Parameters

$params : array<string|int, mixed>

setCreateDefaults()

Set defaults when creating new entity.


    public
            static        setCreateDefaults(array<string|int, mixed> &$params, mixed $defaults) : mixed

(don't call this set defaults as already in use with different signature in some places)

Parameters

$params : array<string|int, mixed>
$defaults : mixed

setDefaults()

Set defaults.


    public
            static        setDefaults(array<string|int, mixed> $groupTree, array<string|int, mixed> &$defaults[, bool $viewMode = FALSE ][, bool $inactiveNeeded = FALSE ][, int $action = CRM_Core_Action::NONE ]) : mixed

Parameters

$groupTree : array<string|int, mixed>
$defaults : array<string|int, mixed>
$viewMode : bool = FALSE
$inactiveNeeded : bool = FALSE
$action : int = CRM_Core_Action::NONE

setFieldValue()

Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record


    public
            static        setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue[, string $searchColumn = 'id' ]) : bool

Parameters

$daoName : string: Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
$searchValue : int: Value of the column you want to search by.
$setColumn : string: Name of the column you want to SET the value of.
$setValue : string: SET the setColumn to this value.
$searchColumn : string = 'id': Name of the column you want to search by.

Return values

bool —

true if we found and updated the object, else false

setIsActive()


    public
            static        setIsActive(int $id, bool $is_active) : bool

this bypasses hooks.

Parameters

$id : int
$is_active : bool

Return values

bool

setOptions()

https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query


    public
                    setOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>

shortenSQLName()

SQL has a limit of 64 characters on various names: table name, trigger name, column name ... For custom groups and fields we generated names from user entered input which can be longer than this length, this function helps with creating strings that meet various criteria.


    public
            static        shortenSQLName(string $string[, int $length = 60 ][, bool $makeRandom = FALSE ]) : string

Parameters

$string : string: The string to be shortened.
$length : int = 60: The max length of the string.
$makeRandom : bool = FALSE

Return values

string

singleValueQuery()

Execute a query and get the single result.


    public
            static    &    singleValueQuery(string $query[, array<string|int, mixed> $params = [] ][, bool $abort = TRUE ][, bool $i18nRewrite = TRUE ]) : string|null

Parameters

$query : string: Query to be executed.
$params : array<string|int, mixed> = []
$abort : bool = TRUE
$i18nRewrite : bool = TRUE

Return values

string|null —

the result of the query if any

storeValues()

Store all the values from this object in an associative array this is a destructive store, calling function is responsible for keeping sanity of id's.


    public
            static        storeValues(object &$object, array<string|int, mixed> &$values) : mixed

Parameters

$object : object: The object that we are extracting data from.
$values : array<string|int, mixed>: (reference ) associative array of name/value pairs.

table()

Get/set an associative array of table columns


    public
                    table() : array<string|int, mixed>

Return values

array<string|int, mixed> —

(associative)

tableHasBeenAdded()

Checks if this DAO's table ought to exist.


    public
            static        tableHasBeenAdded() : bool

If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.

Return values

bool

triggerRebuild()

Build a list of triggers via hook and add them to (err, reconcile them with) the database.


    public
            static        triggerRebuild([string $tableName = NULL ][, bool $force = FALSE ]) : mixed

Parameters

$tableName : string = NULL: the specific table requiring a rebuild; or NULL to rebuild all tables.
$force : bool = FALSE

unSerializeField()

Transform a serialized string from the database into an array.


    public
            static        unSerializeField(string|null $value, mixed $serializationType) : array<string|int, mixed>|null

Parameters

$value : string|null
$serializationType : mixed

Return values

array<string|int, mixed>|null

validateCustomGroupName()

Ensure group name does not conflict with an existing field


    public
            static        validateCustomGroupName(CRM_Core_DAO_CustomGroup $group) : mixed

Parameters

$group : CRM_Core_DAO_CustomGroup

writeRecord()

Create or update a record from supplied params.


    public
            static        writeRecord(array<string|int, mixed> $record) : static

If 'id' is supplied, an existing record will be updated Otherwise a new record will be created.

Parameters

$record : array<string|int, mixed>

Return values

static

writeRecords()

Bulk save multiple records


    public
            static        writeRecords(array<string|int, array<string|int, mixed>> $records) : array<string|int, static>

Parameters

$records : array<string|int, array<string|int, mixed>>

Return values

array<string|int, static>

_setDBOptions()

https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level


    protected
                    _setDBOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>

assignTestFK()


    protected
                    assignTestFK(string $fieldName, mixed $fieldDef, array<string|int, mixed> $params) : mixed

Parameters

$fieldName : string
$fieldDef : mixed
$params : array<string|int, mixed>

assignTestValue()

Generate and assign an arbitrary value to a field of a test object.


    protected
                    assignTestValue(string $fieldName, array<string|int, mixed> &$fieldDef, int $counter) : mixed

Parameters

$fieldName : string
$fieldDef : array<string|int, mixed>
$counter : int: The globally-unique ID of the test object.

copyLocalizable()

Method that copies localizable fields from an old entity to a new one.


    protected
                    copyLocalizable(int $entityID, int $newEntityID, array<string|int, mixed> $fieldsToPrefix, array<string|int, mixed> $fieldsToSuffix, array<string|int, mixed> $fieldsToReplace) : mixed

Fixes bug dev/core#2479, where non current locale fields are copied from current locale losing translation when copying

Parameters

$entityID : int
$newEntityID : int
$fieldsToPrefix : array<string|int, mixed>
$fieldsToSuffix : array<string|int, mixed>
$fieldsToReplace : array<string|int, mixed>

formatFieldValue()

Format a value according to field metadata.


    protected
            static        formatFieldValue(string|null $value, array<string|int, mixed>|null $fieldSpec) : mixed

Parameters

$value : string|null
$fieldSpec : array<string|int, mixed>|null

getDynamicFkAclClauses()

Get an array of ACL clauses for a dynamic FK (entity_id/entity_table combo)


    protected
            static        getDynamicFkAclClauses(string $entityTableField, string $entityIdField[, mixed|null $entityTableValues = NULL ]) : array<string|int, mixed>

Parameters

$entityTableField : string
$entityIdField : string
$entityTableValues : mixed|null = NULL

Return values

array<string|int, mixed>

getFirstPrimaryKey()


    protected
                    getFirstPrimaryKey() : string

Return values

string

getMungedEntity()

Get the munged entity.


    protected
            static        getMungedEntity(string $extends[, int|null $extendsEntityColumn = NULL ]) : string

This is the entity eg. Relationship or the name of the sub entity e.g ParticipantRole.

Parameters

$extends : string
$extendsEntityColumn : int|null = NULL

Return values

string

getTableAddVersion()


    protected
            static        getTableAddVersion() : string

Return values

string —

Version in which table was added

_addWhereAdd()


    private
            static        _addWhereAdd(mixed &$customGroupDAO, mixed $entityType[, mixed $entityID = NULL ][, mixed $allSubtypes = FALSE ]) : mixed

since 5.71 will be removed around 5.85

Parameters

$customGroupDAO : mixed
$entityType : mixed
$entityID : mixed = NULL
$allSubtypes : mixed = FALSE

buildLegacyGroupTree()

Recreates legacy formatting for getTree but uses the new cached function to retrieve data.


    private
            static        buildLegacyGroupTree(mixed $filters, mixed $permission, mixed $subTypes) : mixed

only used by legacy function.

Parameters

$filters : mixed
$permission : mixed
$subTypes : mixed

clearDbColumnValueCache()

Remove item from static cache during update/delete operations


    private
                    clearDbColumnValueCache() : mixed

formatLegacyDbValues()

Recreates the crude string-only format originally produced by self::getTree.


    private
            static        formatLegacyDbValues(array<string|int, mixed> &$values) : void

only used by legacy functions.

Parameters

$values : array<string|int, mixed>

getEntityDefinition()


    private
            static        getEntityDefinition() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityInfo()


    private
            static        getEntityInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFieldLength()


    private
            static        getFieldLength(mixed $sqlType) : string|null

Parameters

$sqlType : mixed

Return values

string|null

getSchemaFields()


    private
            static        getSchemaFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

loadAll()

Fetch all custom groups and fields in a nested array.


    private
            static        loadAll() : array<string|int, array<string|int, mixed>>

Output includes all custom group data + fields.

Return values

array<string|int, array<string|int, mixed>>

loadSchemaFields()


    private
            static        loadSchemaFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

makeNameFromLabel()

When creating a record without a supplied name, create a unique, clean name derived from the label.


    private
                    makeNameFromLabel() : void

Note: this function does nothing unless a unique index exists for "name" column.

setDefaultsFromCallback()

Set default values for fields based on callback functions


    private
            static        setDefaultsFromCallback(string $entityName, array<string|int, mixed> &$record) : void

Parameters

$entityName : string: The entity name
$record : array<string|int, mixed>: The record array to set default values for

validateSubTypeByEntity()

Validates contact subtypes and event types.


    private
            static        validateSubTypeByEntity(string $entityType, string $subType) : string

Performs case-insensitive matching of strings and outputs the correct case. e.g. an input of "meeting" would output "Meeting".

For all other entities, it doesn't validate except to check the subtype is an integer.

Parameters

$entityType : string
$subType : string

Return values

string

CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup in package CRM implements HookInterface

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

BULK_INSERT_COUNT

BULK_INSERT_HIGH_COUNT

DB_DAO_NOTNULL

IS_NULL

NOT_NULL

QUERY_FORMAT_NO_QUOTES

QUERY_FORMAT_WILDCARD

SERIALIZE_COMMA

SERIALIZE_JSON

SERIALIZE_NONE

SERIALIZE_PHP

SERIALIZE_SEPARATOR_BOOKEND

SERIALIZE_SEPARATOR_TRIMMED

VALUE_SEPARATOR

Properties

$_dbColumnValueCache

$_icon

$_labelField

$_nullArray

$_nullObject

$_primaryKey

$_testEntitiesToSkip

$collapse_adv_display

$collapse_display

$created_date

$created_id

$extends

$extends_entity_column_id

$extends_entity_column_value

$help_post

$help_pre

$icon

$id

$is_active

$is_multiple

$is_public

$is_reserved

$max_multiple

$min_multiple

$name

$style

$table_name

$title

$weight

$_options

$resultCopies

Methods

__clone()

__construct()

Return values

__destruct()

acceptedSQLOperators()

Tags

Return values

addSelectWhereClause()

Parameters

Return values

appendPseudoConstantsToFields()

Parameters

autoCreateByActivityType()

Parameters

buildCustomDataView()

Parameters

Tags

Return values

buildCustomFieldData()

Parameters

buildEntityTreeMultipleFields()

Parameters

buildEntityTreeSingleFields()

Parameters

buildOptions()

Parameters

CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup
in package

CRM

implements HookInterface