CRM_Member_BAO_Membership

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

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 membership object.

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

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

Takes an associative array and creates a membership object.

Check the membership extended through relationship.

Retrieve DB object based on input parameters.

It also stores all the retrieved values in the default array.

Get membership status and membership type values.

Delete membership.

Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.

Delete membership.

Delete related memberships.

Obtain active/inactive memberships from the list of memberships passed to it.

Return Membership Block info in Contribution Pages.

Return a current membership of given contact.

NB: if more than one membership meets criteria, a randomly selected one is returned.

Combine all the importable fields from the lower levels object.

Get all exportable fields.

Get membership joins/renewals for a specified membership type.

Specifically, retrieves a count of memberships whose "Membership Signup" or "Membership Renewal" activity falls in the given date range. Dates match the pattern "yyyy-mm-dd".

Get a count of membership for a specified membership type, optionally for a specified date.

The date must have the form yyyy-mm-dd.

If $date is omitted, this function counts as a member anyone whose membership status_id indicates they're a current member. If $date is given, this function counts as a member anyone who: -- Has a start_date before $date and end_date after $date, or -- Has a start_date before $date and is currently a member, as indicated by the the membership's status_id. The second condition takes care of records that have no end_date. These are assumed to be lifetime memberships.

Function check the status of the membership before adding membership for a contact.

Method to fix membership status of stale membership.

This method first checks if the membership is stale. If it is, then status will be updated based on existing start and end dates and log will be added for the status change.

Get the contribution page id from the membership record.

Updated related memberships.

Get list of membership fields for profile.

For now we only allow custom membership fields to be in profile

Get the sort name of a contact for a particular membership.

Create memberships for related contacts, taking into account the maximum related memberships.

Delete the record that are associated with this Membership Payment.

Build an array of available membership types.

Get membership record count for a Contact.

Check whether payment processor supports cancellation of membership subscription.

Check whether subscription is already cancelled.

Get membership joins for a specified membership type.

Specifically, retrieves a count of still current memberships whose join_date and start_date are within a specified date range. Dates match the pattern "yyyy-mm-dd".

Get membership renewals for a specified membership type.

Specifically, retrieves a count of still current memberships whose join_date is before and start_date is within a specified date range. Dates match the pattern "yyyy-mm-dd".

Get line items representing the default price set.

Update the status of all deceased members to deceased.

Process price set and line items.

Retrieve the contribution id for the associated Membership id.

The function checks and updates the status of all membership records for a given domain using the calc_membership_status and update_contact_membership APIs.

IMPORTANT: Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.

Returns the membership types for a particular contact who has lifetime membership without end date.

Record contribution record associated with membership.

This will update an existing contribution if $params['contribution_id'] is passed in. This will create a MembershipPayment to link the contribution and membership

Get all Cancelled Membership(s) for a contact

Merges the memberships from otherContactID to mainContactID.

General idea is to merge memberships in regards to their type. We move the other contact’s contributions to the main contact’s membership which has the same type (if any) and then we update membership to avoid loosing join_date, end_date, and status_id. In this function, we don’t touch the contributions directly (CRM_Dedupe_Merger::moveContactBelongings() takes care of it).

This function adds new SQL queries to the $sqlQueries parameter.