Documentation

CRM_Case_BAO_Case extends CRM_Case_DAO_Case
in package

CRM

implements HookInterface

This class contains the functions for Case Management.

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
$_exportableFields : array<string|int, mixed>: Static field for all the case information that we can potentially export.
$_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
$case_type_id : int|string
$created_date : string
$details : string|null
$end_date : string|null
$id : int|string|null
$is_deleted : bool|string
$modified_date : string
$start_date : string|null
$status_id : int|string
$subject : string|null
$_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>
accessCase() : bool: Verify user has permission to access a case.
accessCiviCase() : mixed: Since we drop 'access CiviCase', allow access if user has 'access my cases and activities' or 'access all cases and activities'
add() : CRM_Case_DAO_Case: Create a case object.
addCaseRelationships() : mixed: Add/copy relationships, when new client is added for a case
addSelectWhereClause() : array<string|int, mixed>: Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
alterStatusOptions() : mixed: Pseudoconstant condition_provider for status_id field.
appendPseudoConstantsToFields() : mixed: Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
buildOptions() : array<string|int, mixed>|bool: Legacy option getter
buildOptionsContext() : array<string|int, mixed>: Provides documentation and validation for the buildOptions $context param
buildPermissionLinks() : mixed: Validate contact permission for edit/view on activity record and build links.
cascadeUpdate() : CRM_Core_DAO|null: Cascade update through related entities.
caseCount() : int
checkConstraintExists() : bool: Checks if a constraint exists for a specified table.
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.
checkPermission() : bool: Validate contact permission for given operation on activity record.
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_Case_DAO_Case: Takes an associative array and creates a case object.
createCaseRoleActivity() : mixed: Create activities when Case or Other roles assigned/modified/deleted.
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.
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
debugPrint() : mixed
del() : bool
delete() : int|false: Deletes items from table which match current objects variables.
deleteCase() : bool: Delete the record that are associated with this case.
deleteEntityContact() : mixed: Unused function.
deleteRecord() : static: 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.
enabled() : bool: Is CiviCase enabled?
enableDisableCaseRelationships() : mixed: Enable disable case related relationships.
endCaseRole() : mixed
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
exportableFields() : array<string|int, mixed>: Combine all the exportable fields from the lower levels object.
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.
freeResult() : mixed
getAttribute() : array<string|int, mixed>: Get the size and maxLength attributes for this text field.
getCaseActivity() : array<string|int, mixed>: Get Case Activities.
getCaseActivityCount() : array<string|int, mixed>: Retrieve count of activities having a particular type, and associated with a particular case.
getCaseActivityCountQuery() : string
getCaseActivityDates() : array<string|int, mixed>: Get Case ActivitiesDueDates with given criteria.
getCaseActivityQuery() : string
getCaseClients() : array<string|int, mixed>: Get the list of clients for a case.
getCaseIdByActivityId() : array<string|int, mixed>|int|null: Look up a case using an activity ID.
getCaseManagerContact() : string: Get case manger contact which is assigned a case role of case manager.
getCaseRoleDirection() : mixed: Fetch Case Role direction from Case Type
getCaseRoles() : array<string|int, mixed>: Get Case roles.
getCases() : array<string|int, mixed>: Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
getCasesSummary() : array<string|int, mixed>: Get the summary of cases counts by type and status.
getCaseSubject() : string|null: Get the case subject for Activity.
getCaseType() : string: Get the case type.
getConnection() : DB_common
getContactIDsFromComponent() : array<string|int, mixed>: Given the component id, compute the contact id since its used for things like send email
getContactNames() : array<string|int, mixed>: Retrieve contact names by caseId.
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.
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.
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
getGlobalContacts() : array<string|int, mixed>
getGlobalSetting() : mixed: Lookup the value of a MySQL global configuration variable.
getLabelField() : string|null
getLocaleTableName() : string: Get localized name of this table, if applicable.
getLog() : bool: Returns if this table needs to be logged
getNextScheduledActivity() : array<string|int, mixed>: Retrieve the scheduled activity type and date.
getOptionLabels() : mixed: Populate option labels for this object's fields.
getReceiptFrom() : mixed: CRM-20308: Method to get the contact id to use as from contact for email copy 1. Activity Added by Contact's email address 2. System Default From Address 3. Default Organization Contact email address 4. Logged in user
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.
getRelatedAndGlobalContacts() : array<string|int, mixed>: Convenience function to get both case contacts and global in one array.
getRelatedCaseIds() : array<string|int, mixed>: Retrieve related case ids for given case.
getRelatedCases() : array<string|int, mixed>: Retrieve related case details for given case.
getRelatedContacts() : array<string|int, mixed>: Get Case Related Contacts.
getSelectWhereClause() : array<string|int, mixed>: This returns the final permissioned query string for this entity
getSortString() : mixed: Unused function.
getSupportedFields() : array<string|int, mixed>: Returns all usable fields, indexed by name.
getTableName() : string: Returns the name of this table
getTableNames() : array<string|int, mixed>: Gets the names of all enabled schema tables.
getUsedCaseStatuses() : array<string|int, mixed>: Get all the case status ids currently in use.
getUsedCaseType() : array<string|int, mixed>: Get all the case type ids currently in use.
getUsedEncounterMediums() : array<string|int, mixed>: Get all the encounter medium ids currently in use.
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.
isCaseActivity() : bool: Check whether activity is a case Activity.
isCaseConfigured() : array<string|int, mixed>: Check case configuration.
isComponentEnabled() : bool: Check if component is enabled for this DAO class
isDBMyISAM() : bool
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
mergeCases() : int|null: Function perform two task.
mergeContacts() : mixed: Merge two duplicate contacts' cases - follow CRM-5758 rules.
objectExists() : bool: Check if there is a record with the same name in the db.
on_hook_civicrm_post() : void
processCaseActivity() : void: Add a CaseActivity record (skip if already exists).
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.
restoreCase() : bool: Restore the record that are associated with this case.
retrieveCaseIdsByContactId() : array<string|int, mixed>: Retrieve case_id by contact_id.
retrieveContactIdsByCaseId() : array<string|int, mixed>: Retrieve contact_id by case_id.
save() : CRM_Core_DAO: Save DAO object.
schemaRequiresRebuilding() : mixed: Checks if CONSTRAINT keyword exists for a specified table.
sendActivityCopy() : bool|array<string|int, mixed>: Send e-mail copy of activity
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.
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
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.
updateCaseActivity() : void: Associate an activity with 0 or more cases.
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
getTableAddVersion() : string
clearDbColumnValueCache() : mixed: Remove item from static cache during update/delete operations
formatContactLink() : string: Helper function to generate a formatted contact link/name for display in the Case activities tab
getAccessMyCasesClause() : string
getEntityDefinition() : array<string|int, mixed>
getEntityInfo() : array<string|int, mixed>
getFieldLength() : string|null
getSchemaFields() : array<string|int, mixed>
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

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

$_exportableFields

Static field for all the case information that we can potentially export.


    public
    static    array<string|int, mixed>
    $_exportableFields
     = \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
     = []

$case_type_id


    public
        int|string
    $case_type_id

$created_date


    public
        string
    $created_date

$details


    public
        string|null
    $details

$end_date


    public
        string|null
    $end_date

$id


    public
        int|string|null
    $id

$is_deleted


    public
        bool|string
    $is_deleted

$modified_date


    public
        string
    $modified_date

$start_date


    public
        string|null
    $start_date

$status_id


    public
        int|string
    $status_id

$subject


    public
        string|null
    $subject

$_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>

accessCase()

Verify user has permission to access a case.


    public
            static        accessCase(int $caseId[, bool $denyClosed = TRUE ]) : bool

Parameters

$caseId : int
$denyClosed : bool = TRUE: Set TRUE if one wants closed cases to be treated as inaccessible.

Return values

bool

accessCiviCase()

Since we drop 'access CiviCase', allow access if user has 'access my cases and activities' or 'access all cases and activities'


    public
            static        accessCiviCase() : mixed

add()

Create a case object.


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

The function extracts all the params it needs to initialize the create a case object. the params array could contain additional unused name/value pairs

Parameters

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

Return values

CRM_Case_DAO_Case

addCaseRelationships()

Add/copy relationships, when new client is added for a case


    public
            static        addCaseRelationships(int $caseId, int $contactId) : mixed

Parameters

$caseId : int: Case id.
$contactId : int: Contact id / new client id.

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>

Parameters

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

Return values

array<string|int, mixed>

alterStatusOptions()

Pseudoconstant condition_provider for status_id field.


    public
            static        alterStatusOptions(string $fieldName, CRM_Utils_SQL_Select $conditions, mixed $params) : mixed

Parameters

$fieldName : string
$conditions : CRM_Utils_SQL_Select
$params : 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>

buildOptions()

Legacy option getter


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

Parameters

$fieldName : mixed
$context : mixed = NULL
$props : mixed = []

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>

buildPermissionLinks()

Validate contact permission for edit/view on activity record and build links.


    public
            static        buildPermissionLinks(array<string|int, mixed> &$tplParams, array<string|int, mixed> $activityParams) : mixed

Parameters

$tplParams : array<string|int, mixed>: Params to be sent to template for sending email.
$activityParams : array<string|int, mixed>: Info of the activity.

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

caseCount()


    public
            static        caseCount([int $contactId = NULL ][, bool $excludeDeleted = TRUE ]) : int

Parameters

$contactId : int = NULL
$excludeDeleted : bool = TRUE

Return values

int

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

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

checkPermission()

Validate contact permission for given operation on activity record.


    public
            static        checkPermission(int $activityId, string $operation[, int $actTypeId = NULL ][, int $contactId = NULL ][, bool $checkComponent = TRUE ]) : bool

Parameters

$activityId : int: Activity record id.
$operation : string: User operation.
$actTypeId : int = NULL: Activity type id.
$contactId : int = NULL: Contact id/if not pass consider logged in.
$checkComponent : bool = TRUE: Do we need to check component enabled.

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()

Takes an associative array and creates a case object.


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

Parameters

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

Return values

CRM_Case_DAO_Case

createCaseRoleActivity()

Create activities when Case or Other roles assigned/modified/deleted.


    public
            static        createCaseRoleActivity(int $caseId, int $relationshipId[, int $relContactId = NULL ][, int $contactId = NULL ]) : mixed

Parameters

$caseId : int
$relationshipId : int: Relationship id.
$relContactId : int = NULL: Case role assignee contactId.
$contactId : int = NULL

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

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.

debugPrint()


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

Parameters

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

del()


    public
            static        del(int $id) : bool

Parameters

$id : int

Return values

bool

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

deleteCase()

Delete the record that are associated with this case.


    public
            static        deleteCase(int $caseId[, bool $moveToTrash = FALSE ]) : bool

record are deleted from case

Parameters

$caseId : int: Id of the case to delete.
$moveToTrash : bool = FALSE

Return values

bool —

is successful

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

deleteRecord()

Delete a record from supplied params.


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

Parameters

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

Return values

static

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.

enabled()

Is CiviCase enabled?


    public
            static        enabled() : bool

Return values

bool

enableDisableCaseRelationships()

Enable disable case related relationships.


    public
            static        enableDisableCaseRelationships(int $caseId, bool $enable) : mixed

Parameters

$caseId : int: Case id.
$enable : bool: Action.

endCaseRole()


    public
            static        endCaseRole(int $caseId, string $direction, int $cid, int $relTypeId) : mixed

Parameters

$caseId : int
$direction : string
$cid : int
$relTypeId : int

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>

exportableFields()

Combine all the exportable fields from the lower levels object.


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

Return values

array<string|int, mixed> —

array of exportable Fields

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>

freeResult()


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

Parameters

$ids : null = NULL

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

getCaseActivity()

Get Case Activities.


    public
            static        getCaseActivity(int $caseID, array<string|int, mixed> &$params, int $contactID[, null $context = NULL ][, int $userID = NULL ][, null $type = NULL ]) : array<string|int, mixed>

Parameters

$caseID : int: Case id.
$params : array<string|int, mixed>: Posted params.
$contactID : int: Contact id.
$context : null = NULL
$userID : int = NULL
$type : null = NULL: (deprecated)

Return values

array<string|int, mixed> —

Array of case activities

getCaseActivityCount()

Retrieve count of activities having a particular type, and associated with a particular case.


    public
            static        getCaseActivityCount(int $caseId, int $activityTypeId) : array<string|int, mixed>

Parameters

$caseId : int: ID of the case.
$activityTypeId : int: ID of the activity type.

Return values

array<string|int, mixed>

getCaseActivityCountQuery()


    public
            static        getCaseActivityCountQuery(string $type, int $userID[, string $condition = NULL ]) : string

Parameters

$type : string
$userID : int
$condition : string = NULL

Return values

string

getCaseActivityDates()

Get Case ActivitiesDueDates with given criteria.


    public
            static        getCaseActivityDates(int $caseID[, array<string|int, mixed> $criteriaParams = [] ][, bool $latestDate = FALSE ]) : array<string|int, mixed>

Parameters

$caseID : int: Case id.
$criteriaParams : array<string|int, mixed> = []: Given criteria.
$latestDate : bool = FALSE: If set newest or oldest date is selected.

Return values

array<string|int, mixed> —

case activities due dates

getCaseActivityQuery()


    public
            static        getCaseActivityQuery(string $type, int $userID[, string $condition = NULL ][, string $limit = NULL ][, string $order = NULL ]) : string

Parameters

$type : string
$userID : int
$condition : string = NULL
$limit : string = NULL
$order : string = NULL

Return values

string

getCaseClients()

Get the list of clients for a case.


    public
            static        getCaseClients(int $caseId) : array<string|int, mixed>

Parameters

$caseId : int

Return values

array<string|int, mixed> —

associated array with client ids

getCaseIdByActivityId()

Look up a case using an activity ID.


    public
            static        getCaseIdByActivityId(int $activityId[, bool $getSingle = TRUE ]) : array<string|int, mixed>|int|null

Parameters

$activityId : int
$getSingle : bool = TRUE

Return values

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

getCaseManagerContact()

Get case manger contact which is assigned a case role of case manager.


    public
            static        getCaseManagerContact(int $caseType, int $caseId) : string

Parameters

$caseType : int: Case type.
$caseId : int: Case id.

Return values

string —

html hyperlink of manager contact view page

getCaseRoleDirection()

Fetch Case Role direction from Case Type


    public
            static        getCaseRoleDirection(mixed $caseId[, mixed $roleTypeId = NULL ]) : mixed

Parameters

$caseId : mixed
$roleTypeId : mixed = NULL

getCaseRoles()

Get Case roles.


    public
            static        getCaseRoles(int $contactID, int $caseID[, int $relationshipID = NULL ][, bool $activeOnly = TRUE ]) : array<string|int, mixed>

Parameters

$contactID : int: Contact id.
$caseID : int: Case id.
$relationshipID : int = NULL
$activeOnly : bool = TRUE

Return values

array<string|int, mixed> —

case role / relationships

getCases()

Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.


    public
            static        getCases([bool $allCases = TRUE ][, array<string|int, mixed> $params = [] ][, string $context = 'dashboard' ][, bool $getCount = FALSE ]) : array<string|int, mixed>

Parameters

$allCases : bool = TRUE
$params : array<string|int, mixed> = []
$context : string = 'dashboard'
$getCount : bool = FALSE

Return values

array<string|int, mixed> —

Array of Cases

getCasesSummary()

Get the summary of cases counts by type and status.


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

Parameters

$allCases : bool = TRUE

Return values

array<string|int, mixed>

getCaseSubject()

Get the case subject for Activity.


    public
            static        getCaseSubject(int $activityId) : string|null

Parameters

$activityId : int: Activity id.

Return values

string|null

getCaseType()

Get the case type.


    public
            static        getCaseType(int $caseId[, string $colName = 'title' ]) : string

Parameters

$caseId : int
$colName : string = 'title'

Return values

string —

case type

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>

getContactNames()

Retrieve contact names by caseId.


    public
            static        getContactNames(int $caseId) : array<string|int, mixed>

Parameters

$caseId : int: ID of the case.

Return values

array<string|int, mixed>

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

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>

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

getGlobalContacts()


    public
            static        getGlobalContacts(array<string|int, mixed> &$groupInfo[, null $sort = NULL ][, bool $showLinks = FALSE ][, bool $returnOnlyCount = FALSE ][, int $offset = 0 ][, int $rowCount = 25 ]) : array<string|int, mixed>

Parameters

$groupInfo : array<string|int, mixed>
$sort : null = NULL
$showLinks : bool = FALSE
$returnOnlyCount : bool = FALSE
$offset : int = 0
$rowCount : int = 25

Return values

array<string|int, mixed>

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

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

getNextScheduledActivity()

Retrieve the scheduled activity type and date.


    public
            static        getNextScheduledActivity(array<string|int, mixed> $cases[, string $type = 'upcoming' ]) : array<string|int, mixed>

Parameters

$cases : array<string|int, mixed>: Array of contact and case id.
$type : string = 'upcoming'

Return values

array<string|int, mixed> —

Array of scheduled activity type and date

getOptionLabels()

Populate option labels for this object's fields.


    public
                    getOptionLabels() : mixed

getReceiptFrom()

CRM-20308: Method to get the contact id to use as from contact for email copy 1. Activity Added by Contact's email address 2. System Default From Address 3. Default Organization Contact email address 4. Logged in user


    public
            static        getReceiptFrom(int $activityID) : mixed

Parameters

$activityID : int

Return values

mixed —

$emailFromContactId

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.

getRelatedAndGlobalContacts()

Convenience function to get both case contacts and global in one array.


    public
            static        getRelatedAndGlobalContacts(int $caseId) : array<string|int, mixed>

Parameters

$caseId : int

Return values

array<string|int, mixed>

getRelatedCaseIds()

Retrieve related case ids for given case.


    public
            static        getRelatedCaseIds(int $caseId[, bool $excludeDeleted = TRUE ]) : array<string|int, mixed>

Parameters

$caseId : int
$excludeDeleted : bool = TRUE: Do not include deleted cases.

Return values

array<string|int, mixed>

getRelatedCases()

Retrieve related case details for given case.


    public
            static        getRelatedCases(int $caseId[, bool $excludeDeleted = TRUE ]) : array<string|int, mixed>

Parameters

$caseId : int
$excludeDeleted : bool = TRUE: Do not include deleted cases.

Return values

array<string|int, mixed>

getRelatedContacts()

Get Case Related Contacts.


    public
            static        getRelatedContacts(int $caseID[, bool $includeDetails = TRUE ]) : array<string|int, mixed>

Parameters

$caseID : int: Case id.
$includeDetails : bool = TRUE: If true include details of contacts.

Return values

array<string|int, mixed> —

array of return properties

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

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

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>

getUsedCaseStatuses()

Get all the case status ids currently in use.


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

Return values

array<string|int, mixed>

getUsedCaseType()

Get all the case type ids currently in use.


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

Return values

array<string|int, mixed>

getUsedEncounterMediums()

Get all the encounter medium ids currently in use.


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

Return values

array<string|int, mixed>

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

isCaseActivity()

Check whether activity is a case Activity.


    public
            static        isCaseActivity(int $activityID) : bool

Parameters

$activityID : int: Activity id.

Return values

bool

isCaseConfigured()

Check case configuration.


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

Parameters

$contactId : int = NULL

Return values

array<string|int, 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

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

mergeCases()

Function perform two task.


    public
            static        mergeCases(int $mainContactId[, int $mainCaseId = NULL ][, int $otherContactId = NULL ][, int $otherCaseId = NULL ][, bool $changeClient = FALSE ]) : int|null

Merge two duplicate contacts cases - follow CRM-5758 rules.
Merge two cases of same contact - follow CRM-5598 rules.

Parameters

$mainContactId : int: Contact id of main contact record.
$mainCaseId : int = NULL: Case id of main case record.
$otherContactId : int = NULL: Contact id of record which is going to merge.
$otherCaseId : int = NULL: Case id of record which is going to merge.
$changeClient : bool = FALSE

Return values

int|null

mergeContacts()

Merge two duplicate contacts' cases - follow CRM-5758 rules.


    public
            static        mergeContacts(int $mainContactId, int $otherContactId) : mixed

Parameters

$mainContactId : int
$otherContactId : int

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

on_hook_civicrm_post()


    public
            static        on_hook_civicrm_post(PostEvent $e) : void

Parameters

$e : PostEvent

processCaseActivity()

Add a CaseActivity record (skip if already exists).


    public
            static        processCaseActivity(array{activity_id: int, case_id: int} $params) : void

Parameters

$params : array{activity_id: int, case_id: int}

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

restoreCase()

Restore the record that are associated with this case.


    public
            static        restoreCase(int $caseId) : bool

Parameters

$caseId : int: Id of the case to restore.

Return values

bool

retrieveCaseIdsByContactId()

Retrieve case_id by contact_id.


    public
            static        retrieveCaseIdsByContactId(int $contactID[, bool $includeDeleted = FALSE ][, null $caseType = NULL ]) : array<string|int, mixed>

Parameters

$contactID : int
$includeDeleted : bool = FALSE: Include the deleted cases in result.
$caseType : null = NULL

Return values

array<string|int, mixed>

retrieveContactIdsByCaseId()

Retrieve contact_id by case_id.


    public
            static        retrieveContactIdsByCaseId(int $caseId[, int $contactID = NULL ][, int $startArrayAt = 0 ]) : array<string|int, mixed>

Parameters

$caseId : int: ID of the case.
$contactID : int = NULL
$startArrayAt : int = 0: This is to support legacy calls to Case.Get API which may rely on the first array index being set to 1

Return values

array<string|int, mixed>

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"]

sendActivityCopy()

Send e-mail copy of activity


    public
            static        sendActivityCopy(int $clientId, int $activityId, array<string|int, mixed> $contacts, null $attachments, int $caseId) : bool|array<string|int, mixed>

Parameters

$clientId : int
$activityId : int: Activity Id.
$contacts : array<string|int, mixed>: Array of related contact.
$attachments : null
$caseId : int

Return values

bool|array<string|int, mixed>

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

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

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

updateCaseActivity()

Associate an activity with 0 or more cases.


    public
            static        updateCaseActivity(int $activityId, array<string|int, mixed>|int $caseIds) : void

Parameters

$activityId : int
$caseIds : array<string|int, mixed>|int

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

getTableAddVersion()


    protected
            static        getTableAddVersion() : string

Return values

string —

Version in which table was added

clearDbColumnValueCache()

Remove item from static cache during update/delete operations


    private
                    clearDbColumnValueCache() : mixed

formatContactLink()

Helper function to generate a formatted contact link/name for display in the Case activities tab


    private
            static        formatContactLink(int $contactId, string $contactName) : string

Parameters

$contactId : int
$contactName : string

Return values

string

getAccessMyCasesClause()


    private
            static        getAccessMyCasesClause([int|null $userId = NULL ]) : string

Parameters

$userId : int|null = NULL

Return values

string

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>

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

CRM_Case_BAO_Case extends CRM_Case_DAO_Case 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

$_exportableFields

$_icon

$_labelField

$_nullArray

$_nullObject

$_primaryKey

$_testEntitiesToSkip

$case_type_id

$created_date

$details

$end_date

$id

$is_deleted

$modified_date

$start_date

$status_id

$subject

$_options

$resultCopies

Methods

__clone()

__construct()

Return values

__destruct()

acceptedSQLOperators()

Tags

Return values

accessCase()

Parameters

Return values

accessCiviCase()

add()

Parameters

Return values

addCaseRelationships()

Parameters

addSelectWhereClause()

Parameters

Tags

Return values

alterStatusOptions()

Parameters

Tags

appendPseudoConstantsToFields()

Parameters

buildOptions()

Parameters

Tags

Return values

buildOptionsContext()

Parameters

Tags

Return values

buildPermissionLinks()

Parameters

cascadeUpdate()

Parameters

CRM_Case_BAO_Case extends CRM_Case_DAO_Case
in package

CRM

implements HookInterface