CRM_Contact_BAO_Contact

Class constructor.

Class destructor.

Returns the names of this table

Initialize the DAO object.

Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary

Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary.

.

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

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

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.

Defines the default key as 'id'.

Tells DB_DataObject which keys use autoincrement.

'id' is autoincrementing by default.

Returns foreign keys and entity references.

Returns all the column names of this table

Get/set an associative array of table columns

Save DAO object.

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.

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.

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

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.

Get the name of the CiviCRM database.

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.

Check if a given table has data.

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

Returns all results as array-encoded records.

Return the results as PHP generator.

Returns a singular value.

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.

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

Execute a query.

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

Execute a query and get the single result.

Compose the query by merging the parameters into it.

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

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

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.

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.

Drop all CiviCRM tables.

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

..)" queries.

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.

ONLY USE FOR TESTING

Set defaults when creating new entity.

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

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

Wrapper function to drop triggers.

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

Find all records which refer to this entity.

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.

Get all references to contact table.

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.

Add custom tables that extend contacts to the list of contact references.

CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish function to be sure all are retrieved & we don't miss subtypes or inactive or multiples - the down side is it is not cached.

Further changes should be include tests in the CRM_Core_MergerTest class to ensure that disabled, subtype, multiple etc groups are still captured.

Add custom ContactReference fields to the list of contact references

This includes active and inactive fields/groups

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.

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.

Get options for a given contact field.

Populate option labels for this object's fields.

Provides documentation and validation for the buildOptions $context param

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

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.

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

This returns the final permissioned query string for this entity

With acls from related entities + additional clauses from hook_civicrm_selectWhereClause

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

Transform an array to a serialized string for database storage.

Transform a serialized string from the database into an array.

Get exportable fields with pseudoconstants rendered as an extra field.

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

Returns if this table needs to be logged

Returns the list of fields that can be imported

Returns the list of fields that can be exported

Returns the list of indices

Takes an associative array and creates a contact object.

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

Create contact.

takes an associative array and creates a contact object and all the associated derived objects (i.e. individual, location, email, phone etc)

This function is invoked from within the web form layer and also from the api layer

Format the output of the create contact function

Ensure greeting parameters are set.

By always populating greetings here we can be sure they are set if required & avoid a call later. (ie. knowing we have definitely tried disambiguates between NULL & not loaded.)

Get the display name and image of a contact.

Add billing fields to the params if appropriate.

If we have ANY name fields then we want to ignore all the billing name fields. However, if we don't then we should set the name fields to the billing fields AND add the preserveDBName parameter (which will tell the BAO only to set those fields if none already exist.

We specifically don't want to set first name from billing and last name form an on-page field. Mixing & matching is best done by hipsters.

Resolve a state province string (UT or Utah) to an ID.

If country has been passed in we should select a state belonging to that country.

Alternatively we should choose from enabled countries, prioritising the default country.

Get the relevant location entity for the array key.

Based on the field name we determine which location entity we are dealing with. Apart from a few specific ones they are mostly 'address' (the default).

Create last viewed link to recently updated contact.

Get the values for pseudoconstants for name->value and reverse.

Fetch object based on array of properties.

Get the display name of a contact.

Delete a contact and all its associated records.

Action to update any caches relating to a recently update contact.

I was going to call this from delete as well as from create to ensure the delete is being done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission where the call involved a subquery that was locking the table.

Delete the image of a contact.

Return proportional height and width of the image.

Validate type of contact image.

Extract contact id from url for deleting contact image.

Function to set is_delete true or restore deleted contact.

Get contact type for a contact.

Get contact sub type for a contact.

Get pair of contact-type and sub-type for a contact.

Combine all the importable fields from the lower levels object.

The ordering is important, since currently we do not have a weight scheme. Adding weight is super important

Combine all the exportable fields from the lower levels object.

Currently we are using importable fields as exportable fields

Get the all contact details (Hierarchical).

Given a set of flat profile style field names, create a hierarchy.

This is for the query to use, create the right sql.

Return the primary location type of a contact.

$params int $contactId contact_id $params boolean $isPrimaryExist if true, return primary contact location type otherwise null $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null

Get the display name, primary email and location type of a contact.

Add/edit/register contacts through profile.

Format profile contact parameters.

Find the get contact details.

This function does not respect ACLs for now, which might need to be rectified at some stage based on how its used.

Find the contact details associated with an OpenID.

Get primary email of the contact.

Function to get primary OpenID of the contact.

Fetch the object and store the values in the values array.

Given the component name and returns the count of participation of contact.

Update contact greetings if an update has resulted in a custom field change.

Process greetings and cache.

Retrieve loc block ids w/ given condition.

Build context menu items.

Check if user has permissions to access items in action menu.

Retrieve display name of contact that address is shared.

This is based on $masterAddressId or $contactId .

Get the creation/modification times for a contact.

Get a list of triggers for the contact table.

Check if contact is being used in civicrm_domain based on $contactId.

Delete a contact-related object that has an 'is_primary' field.

Ensures that is_primary gets assigned to another object if available Also calls pre/post hooks

Get any existing duplicate contacts based on the input parameters.

Get the first duplicate contacts based on the input parameters.

Check if a field is associated with an entity that has a location type.

(ie. is an address, phone, email etc field).