CRM_Contribute_BAO_Contribution

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.

.

Assign Test Value.

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

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

Is this contribution updating an existing recurring contribution.

We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial pending payment is being confirmed (or failing).

Get defaults for new entity.

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

Get the values and resolve the most common mappings.

Since contribution status is resolved in almost every function that calls getValues it makes sense to have an extra function to resolve it rather than repeat the code.

Think carefully before adding more mappings to be resolved as there could be performance implications if this function starts to be called from more iterative functions.

Calculate net_amount & fee_amount if they are not set.

Net amount should be total - fee. This should only be called for new contributions.

Get address params ready to be passed to the payment processor.

We need address params in a couple of formats. For the payment processor we wan state_province_id-5. To create an address we need state_province_id.

Get the number of terms for this contribution for a given membership type based on querying the line item table and relevant price field values Note that any one contribution should only be able to have one line item relating to a particular membership type

Takes an associative array and creates a contribution object.

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

Convert associative array names to values and vice-versa.

This function is used by both the web form layer and the api. Note that the api needs the name => value conversion, also the view layer typically requires value => name conversion

Retrieve DB object based on input parameters.

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

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 and should be done in the next week or so, before this can be called complete.

Combine all the exportable fields from the lower level objects.

Record an activity when a payment is received.

Get the value for the To Financial Account.

Get memberships realted to the contribution.

Cancel contribution.

This function should only be called from transitioncomponents - it is an interim step in refactoring.

It is possible to override the membership id that is updated from the payment processor.

Historically Paypal does this & it still does if it determines data is messed up - see https://lab.civicrm.org/dev/membership/issues/13

Read the comment block on repeattransaction for more information about how things should work.

Delete the indirect records associated with this contribution first.

React to a financial transaction (payment) failure.

Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted payments is important for forensic and outreach reasons.

Check if there is a contribution with the same trxn_id or invoice_id.

Takes an associative array and creates a contribution_product object.

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

Get list of contribution fields for profile.

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

Add extra fields specific to contribution.

Get list of contributions which credit the passed in contact ID.

The returned array provides details about the original contribution & donor.

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

Generate summary of amount received in the current fiscal year to date from the contact or contacts.

Check if there is a contribution with the params passed in.

Used for trxn_id,invoice_id and contribution_id

Get the contribution details for component export.

Create address associated with contribution record.

As long as there is one or more billing field in the parameters we will create the address.

(historically the decision to create or not was based on the payment 'type' but these lines are greyer than once thought).

Delete billing address record related contribution.

This function check online pending contribution associated w/ Online Event Registration or Online Membership signup.

Update contribution as well as related objects.

This function by-passes hooks - to address this - don't use this function.

Returns all contribution related object ids.

Repeat a transaction as part of a recurring series.

The ideal flow is 1) Processor calls contribution.repeattransaction with contribution_status_id = Pending 2) The repeattransaction loads the 'template contribution' and calls a hook to allow altering of it . 3) Repeat transaction calls order.create to create the pending contribution with correct line items and associated entities. 4) The calling code calls Payment.create which in turn calls CompleteOrder (if completing) which updates the various entities and sends appropriate emails.

Gaps in the above (@todo) 1) many processors still call repeattransaction with contribution_status_id = Completed 2) repeattransaction code is current munged into completeTransaction code for historical bad coding reasons 3) Repeat transaction duplicates rather than calls Order.create 4) Use of payment.create still limited - completetransaction is more common. 5) the template transaction is tricky - historically we used the first contribution linked to a recurring contribution. More recently that was changed to be the most recent. Ideally it would be an actual template - not a contribution used as a template which would give more appropriate flexibility. Note line_items have an entity so that table could be used for the line item template - the difficulty is the custom fields... 6) the determination of the membership to be linked is tricksy. The prioritised method is to load the membership(s) referred to via line items in the template transactions. Any other method is likely to lead to incorrect line items & related entities being created (as the line_item link is a required part of 'correct data'). However there are 3 other methods to determine it - membership_payment record - civicrm_membership.contribution_recur_id - input override. Passing in an input override WILL ensure the membership is extended to prevent regressions of historical processors since this has been handled 'forever' - specifically for paypal. albeit by an even nastier mechanism than the current input override. The count is out on how correct related entities wind up in this case.

Get individual id for onbehalf contribution.

Load objects relations to contribution object.

Objects are stored in the $_relatedObjects property In the first instance we are just moving functionality from BASEIpn -

Create array of message information - ie. return html version, txt version, to field

Gather values for contribution mail - this function has been created as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function Values related to the contribution in question are gathered

Assign message variables to template but try to break the habit.

In order to get away from leaky variables it is better to ensure variables are set in values and assign them from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing multiple recurring payments for processors like IATS that use tokens.

Apply variables for message to smarty template - this function is part of analysing what is in the huge function & breaking it down into manageable chunks. Eventually it will be refactored into something else Note we send directly from this function in some cases because it is only partly refactored.

Don't call this function directly as the signature will change.

Check whether payment processor supports cancellation of contribution subscription

Check whether subscription is already cancelled.

Create all financial accounts entry.

Update all financial accounts entry.

Is this contribution status a reversal.

If so we would expect to record a negative value in the financial_trxn table.

Check status validation on update of a contribution.

Delete contribution of contact.

CRM-12155

Validate financial type.

CRM-13231

Get list of payments displayed by Contribute_Page_PaymentInfo.

Get the outstanding balance on a contribution.

Get the tax amount (misnamed function).

Check financial type validation on update of a contribution.

Update related pledge payment payments.

This function has been refactored out of the back office contribution form and may still overlap with other functions.

Compute the stats values

Is there only one line item attached to the contribution.

Complete an order.

Do not call this directly - use the contribution.completetransaction api as this function is being refactored.

Currently overloaded to complete a transaction & repeat a transaction - fix!

Moving it out of the BaseIPN class is just the first step.

Send receipt from contribution.

Do not call this directly - it is being refactored. use contribution.sendmessage api call.

Note that the compose message part has been moved to contribution In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.

Generate From email and from name in an array values

Generate credit note id with next avaible number

Load related memberships.

This function is used to record partial payments for contribution

Get the description (source field) for the recurring contribution.

Function to add payments for contribution for Partially Paid status

Function use to store line item proportionally in in entity financial trxn table

Checks if line items total amounts match the contribution total amount.

Get the financial account for the item associated with the new transaction.

ContributionPage values were being imposed onto values.

I have made this explicit and removed the couple (is_recur, is_pay_later) we REALLY didn't want superimposed. The rest are left there in their overkill out of cautiousness.

The rationale for making this explicit is that it was a case of carefully set values being seemingly randonly overwritten without much care. In general I think array randomly setting variables en mass is risky.

Get values of CiviContribute Settings and check if its enabled or not.

Note: The CiviContribute settings are stored as single entry in civicrm_setting in serialized form. Usually this should be stored as flat settings for each form fields as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute settings we will live with an inconsistency because it's too hard to change for now. https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245

This function process contribution related objects.

Get the amount for the financial item row.

Helper function to start to break down recordFinancialTransactions for readability.

The logic is more historical than .. logical. Paths other than the deprecated one are tested.

Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts for historical reasons. Going forwards we can hope to add tests & improve readibility of that function

Get the multiplier for adjusting rows.

If we are dealing with a refund or cancellation then it will be a negative amount to reflect the negative transaction.

If we are changing Financial Type it will be a negative amount to adjust down the old type.

Does this transaction reflect a payment instrument change.

Update the memberships associated with a contribution if it has been completed.

Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just load them in this function. Code clean up would compensate for any minor performance implication.

Get payment links as they relate to a contribution.

If a payment can be made then include a payment link & if a refund is appropriate then a refund link.

Get a query to determine the amount donated by the contact/s in the current financial year.

Check if contribution has participant/membership payment.

Create Accounts Receivable financial trxn entry for Completed Contribution.

Calculate financial item amount when contribution is updated.

Retrieve Sales Tax Financial Accounts.

Create tax entry in civicrm_entity_financial_trxn table.

Create array of last financial item id's.

Create proportional entries in civicrm_entity_financial_trxn.

Load entities related to the contribution into $this->_relatedObjects.

Should an email receipt be sent for this contribution when complete.

Function to replace contribution tokens.

Get the contribution fields for $id and display labels where appropriate (if the token is present).

Get invoice_number for contribution.

Load the values needed for the event message.