CRM_Contact_BAO_Relationship

Class constructor.

Returns the names of this table

Initialize the DAO object.

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.

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

Returns all results as array-encoded records.

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.

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

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

..)" 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.

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 for purposes keeping the scope of the change small, but is appropriate for other sorts of pseudoconstants.

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

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

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.:

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.

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

Create function - use the API instead.

Note that the previous create function has been renamed 'legacyCreateMultiple' and this is new in 4.6 All existing calls have been changed to legacyCreateMultiple except the api call - however, it is recommended that you call that as the end to end testing here is based on the api & refactoring may still be done.

Create multiple relationships for one contact.

The relationship details are the same for each relationship except the secondary contact id can be an array.

Takes an associative array and creates a relationship object.

This is the function that check/add if the relationship created is valid.

Add relationship to recent links.

Load contact ids and relationship type id when doing a create call if not provided.

There are are various checks done in create which require this information which is optional when using id.

Resolve passed in contact IDs to contact_id_a & contact_id_b.

Specify defaults for creating a relationship.

Check if there is data to create the object.

Get get list of relationship type based on the contact type.

Given a list of relationship types, return the list with duplicate types removed, being careful to retain only the duplicate which matches the given 'a_b' or 'b_a' suffix.

Delete current employer relationship.

Delete the relationship.

Disable/enable the relationship.

Delete the object records that are associated with this contact.

Get the other contact in a relationship.

Check if the relationship type selected between two contacts is correct.

This function does the validtion for valid relationship.

This function checks for duplicate relationship.

Update the is_active flag in the db.

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

Helper function to form the sql for relationship retrieval.

Get a list of relationships.

Get get list of relationship type based on the target contact type.

Create / update / delete membership for related contacts.

This function will create/update/delete membership for related contact based on 1) contact have active membership 2) that membership is is extedned by the same relationship type to that of the existing relationship.

Helper function to check whether the membership is expired or not.

Function takes a list of related membership types and if it is not also passed a relationship ID of that types evaluates whether the membership status should be changed to expired.

Get Current Employer for Contact.

Function to return list of permissioned contacts for a given contact and relationship type.

Merge relationships from otherContact to mainContact.

Called during contact merge operation

Set 'is_valid' field to false for all relationships whose end date is in the past, ie. are expired.

Function filters the query by possible relationships for the membership type.

It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal) and to add clauses to limit the return to those relationships which COULD inherit a membership type (as opposed to those who inherit a particular membership

Wrapper for contact relationship selector.