CRM_Core_BAO_CustomField
class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField
Business objects for managing custom data fields.
Constants
NOT_NULL |
|
IS_NULL |
|
DB_DAO_NOTNULL |
|
VALUE_SEPARATOR |
|
BULK_INSERT_COUNT |
|
BULK_INSERT_HIGH_COUNT |
|
QUERY_FORMAT_WILDCARD |
|
QUERY_FORMAT_NO_QUOTES |
|
Properties
static null | $_nullObject | from CRM_Core_DAO | |
static array | $_nullArray | from CRM_Core_DAO | |
static | $_dbColumnValueCache | from CRM_Core_DAO | |
static array | $_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 | from CRM_Core_DAO |
static object | $_factory | The factory class for this application. | from CRM_Core_DAO |
static | $_checkedSqlFunctionsExist | from CRM_Core_DAO | |
protected | $_options | https://issues.civicrm.org/jira/browse/CRM-17748 internal variable for DAO to hold per-query settings | from CRM_Core_DAO |
static string | $_tableName | Static instance to hold the table name. | from CRM_Core_DAO_CustomField |
static boolean | $_log | Should CiviCRM log any modifications to this table in the civicrm_log table. | from CRM_Core_DAO_CustomField |
int | $id | Unique Custom Field ID | from CRM_Core_DAO_CustomField |
int | $custom_group_id | FK to civicrm_custom_group. | from CRM_Core_DAO_CustomField |
string | $name | Variable name/programmatic handle for this group. | from CRM_Core_DAO_CustomField |
string | $label | Text for form field label (also friendly name for administering this custom property). | from CRM_Core_DAO_CustomField |
string | $data_type | Controls location of data storage in extended_data table. | from CRM_Core_DAO_CustomField |
string | $html_type | HTML types plus several built-in extended types. | from CRM_Core_DAO_CustomField |
string | $default_value | Use form_options.is_default for field_types which use options. | from CRM_Core_DAO_CustomField |
boolean | $is_required | Is a value required for this property. | from CRM_Core_DAO_CustomField |
boolean | $is_searchable | Is this property searchable. | from CRM_Core_DAO_CustomField |
boolean | $is_search_range | Is this property range searchable. | from CRM_Core_DAO_CustomField |
int | $weight | Controls field display order within an extended property group. | from CRM_Core_DAO_CustomField |
text | $help_pre | Description and/or help text to display before this field. | from CRM_Core_DAO_CustomField |
text | $help_post | Description and/or help text to display after this field. | from CRM_Core_DAO_CustomField |
string | $mask | Optional format instructions for specific field types, like date types. | from CRM_Core_DAO_CustomField |
string | $attributes | Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes | from CRM_Core_DAO_CustomField |
string | $javascript | Optional scripting attributes for field. | from CRM_Core_DAO_CustomField |
boolean | $is_active | Is this property active? | from CRM_Core_DAO_CustomField |
boolean | $is_view | Is this property set by PHP Code? A code field is viewable but not editable | from CRM_Core_DAO_CustomField |
int | $options_per_line | number of options per line for checkbox and radio | from CRM_Core_DAO_CustomField |
int | $text_length | field length if alphanumeric | from CRM_Core_DAO_CustomField |
int | $start_date_years | Date may be up to start_date_years years prior to the current date. | from CRM_Core_DAO_CustomField |
int | $end_date_years | Date may be up to end_date_years years after the current date. | from CRM_Core_DAO_CustomField |
string | $date_format | date format for custom date | from CRM_Core_DAO_CustomField |
int | $time_format | time format for custom date | from CRM_Core_DAO_CustomField |
int | $note_columns | Number of columns in Note Field | from CRM_Core_DAO_CustomField |
int | $note_rows | Number of rows in Note Field | from CRM_Core_DAO_CustomField |
string | $column_name | Name of the column that holds the values for this field. | from CRM_Core_DAO_CustomField |
int | $option_group_id | For elements with options, the option group id that is used | from CRM_Core_DAO_CustomField |
string | $filter | Stores Contact Get API params contact reference custom fields. May be used for other filters in the future. | from CRM_Core_DAO_CustomField |
boolean | $in_selector | Should the multi-record custom field values be displayed in tab table listing | from CRM_Core_DAO_CustomField |
static array | $_dataType | Array for valid combinations of data_type & descriptions. | |
static array | $_dataToHtml | Array for valid combinations of data_type & html_type. | |
static array | $_importFields | Array to hold (formatted) fields for import |
Methods
Generate and assign an arbitrary value to a field of a test object.
Execute a query by the current DAO, localizing it along the way (if needed).
Static function to set the factory instance for this class.
Factory method to instantiate a new object from a table name.
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
Returns foreign keys and entity references.
Deletes items from table which match current objects variables.
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
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.
Create an attribute for this specific field. We only do this for strings and text
Get the size and maxLength attributes for this text field.
Check if there is a record with the same name in the db.
Check if there is a given column in a specific table.
Scans all the tables using a slow query and table name.
Checks if a constraint exists for a specified table.
Checks if CONSTRAINT keyword exists for a specified table.
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
Check whether a specific column in a specific table has always the same value.
Check whether a specific column in a specific table is always NULL.
Check if there is a given table in the database.
Get all the result records as mapping between columns.
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
Get sort string.
Fetch object based on array of properties.
Delete the object records that are associated with this contact.
Execute an unbuffered query.
Execute a query.
Execute a query and get the single result.
Compose the query by merging the parameters into it.
make a shallow copy of an object.
Cascade update through related entities.
Given the component id, compute the contact id since its used for things like send email
Fetch object based on array of properties.
Escape a list of strings for use with "WHERE X IN (.
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
Deletes the this object plus any dependent objects that are associated with it.
Set defaults when creating new entity.
No description
No description
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
Given a list of fields, create a list of references.
List all tables which have hard foreign keys to this table.
Lookup the value of a MySQL global configuration variable.
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
Get options for the called BAO object's field.
Provides documentation and validation for the buildOptions $context param
Get SQL where clause for SQL filter syntax input parameters.
SQL has a limit of 64 characters on various names: table name, trigger name, column name .
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
This returns the final permissioned query string for this entity
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
Return a mapping from field-name to the corresponding key (as used in fields()).
Returns the list of fields that can be imported
Returns the list of fields that can be exported
Build and retrieve the list of data types and descriptions.
Get data to html array.
Takes an associative array and creates a custom field object.
Fetch object based on array of properties.
Update the is_active flag in the db.
Get the field title.
No description
Store and return an array of all active custom fields.
Return the field ids and names (with groups) for import purpose.
Get the field id from an import key.
Use the cache to get all values of a specific custom field.
Add a custom field to an existing form.
Delete the Custom Field.
No description
Set default values for custom data used in profile.
Get file url.
Format custom fields before inserting.
Get default custom table schema.
Create custom field.
Determine whether it would be safe to move a field.
Move a custom data field from one group (table) to another.
Get the database table name and column name for a custom field.
Get custom option groups.
Fix orphan groups.
Check if option group is related to more than one custom field.
Get option group default.
Post process function.
Get custom field ID.
Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
Validate custom data.
Is this field a multi record field.
Does this field store a serialized string?
Get api entity for this field
Details
in CRM_Core_DAO_CustomField at line 236
CRM_Core_DAO
__construct()
Class constructor.
in CRM_Core_DAO_CustomField at line 631
static
getTableName()
Returns the names of this table
in CRM_Core_DAO at line 112
static
init(string $dsn)
Initialize the DAO object.
in CRM_Core_DAO at line 131
static DB_common
getConnection()
in CRM_Core_DAO at line 142
protected
assignTestFK(string $fieldName, $fieldDef, array $params)
in CRM_Core_DAO at line 191
protected
assignTestValue(string $fieldName, array $fieldDef, int $counter)
Generate and assign an arbitrary value to a field of a test object.
in CRM_Core_DAO at line 303
reset()
Reset the DAO object.
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
in CRM_Core_DAO at line 323
static string
getLocaleTableName(string $tableName)
in CRM_Core_DAO at line 345
object
query(string $query, bool $i18nRewrite = TRUE)
Execute a query by the current DAO, localizing it along the way (if needed).
in CRM_Core_DAO at line 374
static
setFactory(object $factory)
Static function to set the factory instance for this class.
in CRM_Core_DAO at line 383
factory(string $table = '')
Factory method to instantiate a new object from a table name.
in CRM_Core_DAO at line 395
initialize()
Initialization for all DAO objects. Since we access DB_DO programatically we need to set the links manually.
in CRM_Core_DAO at line 411
array
keys()
Defines the default key as 'id'.
in CRM_Core_DAO at line 426
array
sequenceKey()
Tells DB_DataObject which keys use autoincrement.
'id' is autoincrementing by default.
in CRM_Core_DAO_CustomField at line 246
static array
getReferenceColumns()
Returns foreign keys and entity references.
in CRM_Core_DAO_CustomField at line 259
static array
fields()
Returns all the column names of this table
in CRM_Core_DAO at line 462
array
table()
Get/set an associative array of table columns
in CRM_Core_DAO at line 485
CRM_Core_DAO
save(bool $hook = TRUE)
Save DAO object.
in CRM_Core_DAO at line 536
delete(bool $useWhere = FALSE)
Deletes items from table which match current objects variables.
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.
in CRM_Core_DAO at line 552
log(bool $created = FALSE)
in CRM_Core_DAO at line 587
bool
copyValues(array $params)
Given an associative array of name/value pairs, extract all the values that belong to this object and initialize the object with said values
in CRM_Core_DAO at line 628
static
storeValues(object $object, array $values)
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.
in CRM_Core_DAO at line 650
static array|null
makeAttribute(array $field)
Create an attribute for this specific field. We only do this for strings and text
in CRM_Core_DAO at line 703
static array
getAttribute(string $class, string $fieldName = NULL)
Get the size and maxLength attributes for this text field.
(or for all text fields) in the DAO object.
in CRM_Core_DAO at line 731
static
transaction($type)
in CRM_Core_DAO at line 754
static bool
objectExists(string $value, string $daoName, string $daoID, string $fieldName = 'name', string $domainID = NULL)
Check if there is a record with the same name in the db.
in CRM_Core_DAO at line 780
static bool
checkFieldExists(string $tableName, string $columnName, bool $i18nRewrite = TRUE)
Check if there is a given column in a specific table.
in CRM_Core_DAO at line 798
static array
getTableNames()
Scans all the tables using a slow query and table name.
in CRM_Core_DAO at line 820
static bool
isDBMyISAM(int $maxTablesToCheck = 10)
in CRM_Core_DAO at line 837
static string
getDatabaseName()
Get the name of the CiviCRM database.
in CRM_Core_DAO at line 851
static bool
checkConstraintExists(string $tableName, string $constraint)
Checks if a constraint exists for a specified table.
in CRM_Core_DAO at line 879
static bool
schemaRequiresRebuilding(array $tables = array("civicrm_contact"))
Checks if CONSTRAINT keyword exists for a specified table.
in CRM_Core_DAO at line 915
static bool
checkFKConstraintInFormat(string $tableName, string $columnName)
Checks if the FK constraint name is in the format 'FK_tableName_columnName' for a specified column of a table.
in CRM_Core_DAO at line 944
static bool
checkFieldHasAlwaysValue(string $tableName, string $columnName, string $columnValue)
Check whether a specific column in a specific table has always the same value.
in CRM_Core_DAO at line 961
static bool
checkFieldIsAlwaysNull(string $tableName, string $columnName)
Check whether a specific column in a specific table is always NULL.
in CRM_Core_DAO at line 977
static bool
checkTableExists(string $tableName)
Check if there is a given table in the database.
in CRM_Core_DAO at line 995
bool
checkVersion($version)
in CRM_Core_DAO at line 1013
static object
findById(int $id)
Find a DAO object for the given ID and return it.
in CRM_Core_DAO at line 1027
array
fetchAll()
Returns all results as array-encoded records.
in CRM_Core_DAO at line 1045
array
fetchMap(string $keyColumn, string $valueColumn)
Get all the result records as mapping between columns.
in CRM_Core_DAO at line 1070
static string|null
getFieldValue(string $daoName, int $searchValue, string $returnColumn = 'name', string $searchColumn = 'id', bool $force = FALSE)
Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
in CRM_Core_DAO at line 1120
static bool
setFieldValue(string $daoName, int $searchValue, string $setColumn, string $setValue, string $searchColumn = 'id')
Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
in CRM_Core_DAO at line 1146
static string
getSortString(array|object $sort, string $default = NULL)
Get sort string.
in CRM_Core_DAO at line 1177
static object
commonRetrieve(string $daoName, array $params, array $defaults, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1202
static
deleteEntityContact(string $daoName, int $contactId)
Delete the object records that are associated with this contact.
in CRM_Core_DAO at line 1227
static CRM_Core_DAO
executeUnbufferedQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)
Execute an unbuffered query.
This is a wrapper around new functionality exposed with CRM-17748.
in CRM_Core_DAO at line 1293
static CRM_Core_DAO|object
executeQuery(string $query, array $params = array(), bool $abort = TRUE, null $daoName = NULL, bool $freeDAO = FALSE, bool $i18nRewrite = TRUE, bool $trapException = FALSE)
Execute a query.
in CRM_Core_DAO at line 1343
static string|null
singleValueQuery(string $query, array $params = array(), bool $abort = TRUE, bool $i18nRewrite = TRUE)
Execute a query and get the single result.
in CRM_Core_DAO at line 1381
static string
composeQuery(string $query, array $params, bool $abort = TRUE)
Compose the query by merging the parameters into it.
in CRM_Core_DAO at line 1428
static
freeResult(null $ids = NULL)
in CRM_Core_DAO at line 1474
static CRM_Core_DAO
copyGeneric(string $daoName, array $criteria, array $newData = NULL, string $fieldsFix = NULL, string $blockCopyOfDependencies = NULL)
make a shallow copy of an object.
and all the fields in the object
in CRM_Core_DAO at line 1557
static CRM_Core_DAO|null
cascadeUpdate(string $daoName, $fromId, $toId, array $newData = array())
Cascade update through related entities.
in CRM_Core_DAO at line 1601
static array
getContactIDsFromComponent($componentIDs, string $tableName)
Given the component id, compute the contact id since its used for things like send email
in CRM_Core_DAO at line 1636
static object
commonRetrieveAll(string $daoName, string $fieldIdName = 'id', int $fieldId, $details, array $returnProperities = NULL)
Fetch object based on array of properties.
in CRM_Core_DAO at line 1658
static
dropAllTables()
in CRM_Core_DAO at line 1680
static string
escapeString($string)
in CRM_Core_DAO at line 1709
static string
escapeStrings(array $strings, string $default = NULL)
Escape a list of strings for use with "WHERE X IN (.
..)" queries.
in CRM_Core_DAO at line 1728
static string
escapeWildCardString($string)
in CRM_Core_DAO at line 1756
static object|array|NULL
createTestObject(string $daoName, array $params = array(), int $numObjects = 1, bool $createOnly = FALSE)
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
in CRM_Core_DAO at line 1839
static
deleteTestObjects(string $daoName, array $params = array())
Deletes the this object plus any dependent objects that are associated with it.
ONLY USE FOR TESTING
in CRM_Core_DAO at line 1885
static
setCreateDefaults(array $params, $defaults)
Set defaults when creating new entity.
(don't call this set defaults as already in use with different signature in some places)
in CRM_Core_DAO at line 1903
static string
createTempTableName(string $prefix = 'civicrm', bool $addRandomString = TRUE, null $string = NULL)
in CRM_Core_DAO at line 1923
static bool
checkTriggerViewPermission(bool $view = TRUE, bool $trigger = TRUE)
in CRM_Core_DAO at line 1971
static
debugPrint(null $message = NULL, bool $printDAO = TRUE)
in CRM_Core_DAO at line 1995
static
triggerRebuild(string $tableName = NULL, bool $force = FALSE)
deprecated
deprecated
Build a list of triggers via hook and add them to (err, reconcile them with) the database.
in CRM_Core_DAO at line 2006
static
checkSqlFunctionsExist()
Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
in CRM_Core_DAO at line 2023
static
dropTriggers(string $tableName = NULL)
deprecated
deprecated
Wrapper function to drop triggers.
in CRM_Core_DAO at line 2034
static
createTriggers(array $info, string $onlyTableName = NULL)
deprecated
deprecated
in CRM_Core_DAO at line 2045
static array
createReferenceColumns(string $className)
Given a list of fields, create a list of references.
in CRM_Core_DAO at line 2068
array
findReferences()
Find all records which refer to this entity.
in CRM_Core_DAO at line 2097
array
getReferenceCounts()
in CRM_Core_DAO at line 2134
static array
getReferencesToTable(string $tableName)
List all tables which have hard foreign keys to this table.
For now, this returns a description of every entity_id/entity_table reference. TODO: filter dynamic entity references on the $tableName, based on schema metadata in dynamicForeignKey which enumerates a restricted set of possible entity_table's.
in CRM_Core_DAO at line 2158
static mixed
getGlobalSetting(string $name, mixed $default = NULL)
Lookup the value of a MySQL global configuration variable.
in CRM_Core_DAO at line 2183
static protected
appendPseudoConstantsToFields(array $fields)
Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
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 for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.
in CRM_Core_DAO at line 2209
static array|bool
buildOptions(string $fieldName, string $context = NULL, array $props = array())
Get options for the called BAO object's field.
This function can be overridden by each BAO to add more logic related to context. The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
in CRM_Core_DAO at line 2220
getOptionLabels()
Populate option labels for this object's fields.
in CRM_Core_DAO at line 2246
static array
buildOptionsContext(string $context = NULL)
Provides documentation and validation for the buildOptions $context param
in CRM_Core_DAO at line 2266
bool|array
getFieldSpec(string $fieldName)
in CRM_Core_DAO at line 2309
static NULL|string|array
createSQLFilter(string $fieldName, array $filter, string $type = NULL, string $alias = NULL, bool $returnSanitisedArray = FALSE)
Get SQL where clause for SQL filter syntax input parameters.
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
in CRM_Core_DAO at line 2372
static array
acceptedSQLOperators()
in CRM_Core_DAO at line 2409
static string
shortenSQLName(string $string, int $length = 60, bool $makeRandom = FALSE)
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.
in CRM_Core_DAO at line 2435
setOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 Sets the internal options to be used on a query
in CRM_Core_DAO at line 2448
protected
_setDBOptions(array $options)
https://issues.civicrm.org/jira/browse/CRM-17748 wrapper to pass internal DAO options down to DB_mysql/DB_Common level
in CRM_Core_DAO at line 2463
setApiFilter(array $params)
deprecated
deprecated
in CRM_Core_DAO at line 2480
array
addSelectWhereClause()
Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
Return format is in the form of fieldname => clauses starting with an operator. e.g.:
in CRM_Core_DAO at line 2521
static array
getSelectWhereClause(string $tableAlias = NULL)
This returns the final permissioned query string for this entity
With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
in CRM_Core_DAO at line 2544
static bool
requireSafeDBName($database)
ensure database name is 'safe', i.e. only contains word characters (includes underscores) and dashes, and contains at least one [a-z] case insenstive.
in CRM_Core_DAO_CustomField at line 620
static array
fieldKeys()
Return a mapping from field-name to the corresponding key (as used in fields()).
in CRM_Core_DAO_CustomField at line 639
boolean
getLog()
Returns if this table needs to be logged
in CRM_Core_DAO_CustomField at line 649
static array
import(bool $prefix = false)
Returns the list of fields that can be imported
in CRM_Core_DAO_CustomField at line 660
static array
export(bool $prefix = false)
Returns the list of fields that can be exported
in CRM_Core_DAO_CustomField at line 667
static
indices($localize = TRUE)
Returns the list of indices
at line 66
static array
dataType()
Build and retrieve the list of data types and descriptions.
at line 93
static array
dataToHtml()
Get data to html array.
(Does this caching achieve anything?)
at line 131
static CRM_Core_DAO_CustomField
create(array $params)
Takes an associative array and creates a custom field object.
This function is invoked from within the web form layer and also from the api layer
at line 335
static CRM_Core_DAO_CustomField
retrieve(array $params, array $defaults)
Fetch object based on array of properties.
at line 350
static Object
setIsActive(int $id, bool $is_active)
Update the is_active flag in the db.
at line 368
static string
getTitle(int $id)
Get the field title.
at line 376
array|bool
getOptions(string $context = NULL)
at line 436
static array
getFields(string $customDataType = 'Individual', bool $showAll = FALSE, bool $inline = FALSE, int $customDataSubType = NULL, int $customDataSubName = NULL, bool $onlyParent = FALSE, bool $onlySubType = FALSE, bool $checkPermission = TRUE)
Store and return an array of all active custom fields.
at line 665
static array
getFieldsForImport(int|string $contactType = 'Individual', bool $showAll = FALSE, bool $onlyParent = FALSE, bool $search = FALSE, bool $checkPermission = TRUE, bool $withMultiple = FALSE)
Return the field ids and names (with groups) for import purpose.
at line 733
static int|null
getKeyID(string $key, bool $all = FALSE)
Get the field id from an import key.
at line 758
static CRM_Core_BAO_CustomField
getFieldObject(int $fieldID)
Use the cache to get all values of a specific custom field.
at line 800
static HTML_QuickForm_Element|null
addQuickFormElement(CRM_Core_Form $qf, string $elementName, int $fieldId, bool $useRequired = TRUE, bool $search = FALSE, string $label = NULL)
Add a custom field to an existing form.
at line 1121
static
deleteField(object $field)
Delete the Custom Field.
at line 1149
static string
displayValue(string|int|array|null $value, CRM_Core_BAO_CustomField|int|array|string $field, $contactId = NULL)
at line 1303
static
setProfileDefaults(int $customFieldId, string $elementName, array $defaults, int $contactId = NULL, int $mode = NULL, mixed $value = NULL)
Set default values for custom data used in profile.
at line 1404
static array
getFileURL(int $contactID, int $cfID, int $fileID = NULL, bool $absolute = FALSE, string $multiRecordWhereClause = NULL)
Get file url.
at line 1497
static array|NULL
formatCustomField(int $customFieldId, array $customFormatted, mixed $value, string $customFieldExtend, int $customValueId = NULL, int $entityId = NULL, bool $inline = FALSE, bool $checkPermission = TRUE, bool $includeViewOnly = FALSE)
Format custom fields before inserting.
at line 1741
static array
defaultCustomTableSchema(array $params)
Get default custom table schema.
at line 1787
static
createField(CRM_Core_DAO_CustomField $field, string $operation, bool $indexExist = FALSE, bool $triggerRebuild = TRUE)
Create custom field.
at line 1857
static array
_moveFieldValidate(int $fieldID, int $newGroupID)
Determine whether it would be safe to move a field.
at line 1941
static
moveField(int $fieldID, int $newGroupID)
Move a custom data field from one group (table) to another.
at line 1988
static array
getTableColumnGroup(int $fieldID, bool $force = FALSE)
Get the database table name and column name for a custom field.
at line 2023
static mixed
customOptionGroup(array $includeFieldIds = NULL)
Get custom option groups.
at line 2065
static
fixOptionGroups(int $customFieldId, int $optionGroupId)
Fix orphan groups.
at line 2088
static
checkOptionGroup(int $optionGroupId)
Check if option group is related to more than one custom field.
at line 2110
static null|string
getOptionGroupDefault(int $optionGroupId, string $htmlType)
Get option group default.
at line 2162
static array
postProcess(array $params, int $entityID, string $customFieldExtends, bool $inline = FALSE, bool $checkPermissions = TRUE)
Post process function.
at line 2210
static int|null
getCustomFieldID(string $fieldLabel, null $groupTitle = NULL)
Get custom field ID.
at line 2248
static array
getNameFromID(array $ids)
Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
at line 2281
static array
validateCustomData(array $params)
Validate custom data.
at line 2384
static bool
isMultiRecordField(int $customId)
Is this field a multi record field.
at line 2414
static bool
isSerialized(array $field)
Does this field store a serialized string?
at line 2426
string
getEntity()
Get api entity for this field