1000 lines
34 KiB
PHP
1000 lines
34 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
/**
|
|
* @package CRM
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
|
*
|
|
* Generated from xml/schema/CRM/Contribute/Contribution.xml
|
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
|
* (GenCodeChecksum:45a20d00d01766a61687cbac5cef1482)
|
|
*/
|
|
require_once 'CRM/Core/DAO.php';
|
|
require_once 'CRM/Utils/Type.php';
|
|
/**
|
|
* CRM_Contribute_DAO_Contribution constructor.
|
|
*/
|
|
class CRM_Contribute_DAO_Contribution extends CRM_Core_DAO {
|
|
/**
|
|
* Static instance to hold the table name.
|
|
*
|
|
* @var string
|
|
*/
|
|
static $_tableName = 'civicrm_contribution';
|
|
/**
|
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
static $_log = true;
|
|
/**
|
|
* Contribution ID
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $id;
|
|
/**
|
|
* FK to Contact ID
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contact_id;
|
|
/**
|
|
* FK to Financial Type for (total_amount - non_deductible_amount).
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $financial_type_id;
|
|
/**
|
|
* The Contribution Page which triggered this contribution
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contribution_page_id;
|
|
/**
|
|
* FK to Payment Instrument
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $payment_instrument_id;
|
|
/**
|
|
* Date contribution was received - not necessarily the creation date of the record
|
|
*
|
|
* @var datetime
|
|
*/
|
|
public $receive_date;
|
|
/**
|
|
* Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types.
|
|
*
|
|
* @var float
|
|
*/
|
|
public $non_deductible_amount;
|
|
/**
|
|
* Total amount of this contribution. Use market value for non-monetary gifts.
|
|
*
|
|
* @var float
|
|
*/
|
|
public $total_amount;
|
|
/**
|
|
* actual processor fee if known - may be 0.
|
|
*
|
|
* @var float
|
|
*/
|
|
public $fee_amount;
|
|
/**
|
|
* actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.
|
|
*
|
|
* @var float
|
|
*/
|
|
public $net_amount;
|
|
/**
|
|
* unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method
|
|
*
|
|
* @var string
|
|
*/
|
|
public $trxn_id;
|
|
/**
|
|
* unique invoice id, system generated or passed in
|
|
*
|
|
* @var string
|
|
*/
|
|
public $invoice_id;
|
|
/**
|
|
* Human readable invoice number
|
|
*
|
|
* @var string
|
|
*/
|
|
public $invoice_number;
|
|
/**
|
|
* 3 character string, value from config setting or input via user.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $currency;
|
|
/**
|
|
* when was gift cancelled
|
|
*
|
|
* @var datetime
|
|
*/
|
|
public $cancel_date;
|
|
/**
|
|
*
|
|
* @var text
|
|
*/
|
|
public $cancel_reason;
|
|
/**
|
|
* when (if) receipt was sent. populated automatically for online donations w/ automatic receipting
|
|
*
|
|
* @var datetime
|
|
*/
|
|
public $receipt_date;
|
|
/**
|
|
* when (if) was donor thanked
|
|
*
|
|
* @var datetime
|
|
*/
|
|
public $thankyou_date;
|
|
/**
|
|
* Origin of this Contribution.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $source;
|
|
/**
|
|
*
|
|
* @var text
|
|
*/
|
|
public $amount_level;
|
|
/**
|
|
* Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contribution_recur_id;
|
|
/**
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_test;
|
|
/**
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_pay_later;
|
|
/**
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contribution_status_id;
|
|
/**
|
|
* Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $address_id;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $check_number;
|
|
/**
|
|
* The campaign for which this contribution has been triggered.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $campaign_id;
|
|
/**
|
|
* unique credit note id, system generated or passed in
|
|
*
|
|
* @var string
|
|
*/
|
|
public $creditnote_id;
|
|
/**
|
|
* Total tax amount of this contribution.
|
|
*
|
|
* @var float
|
|
*/
|
|
public $tax_amount;
|
|
/**
|
|
* Stores the date when revenue should be recognized.
|
|
*
|
|
* @var datetime
|
|
*/
|
|
public $revenue_recognition_date;
|
|
/**
|
|
* Class constructor.
|
|
*/
|
|
function __construct() {
|
|
$this->__table = 'civicrm_contribution';
|
|
parent::__construct();
|
|
}
|
|
/**
|
|
* Returns foreign keys and entity references.
|
|
*
|
|
* @return array
|
|
* [CRM_Core_Reference_Interface]
|
|
*/
|
|
static function getReferenceColumns() {
|
|
if (!isset(Civi::$statics[__CLASS__]['links'])) {
|
|
Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_type_id', 'civicrm_financial_type', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contribution_page_id', 'civicrm_contribution_page', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contribution_recur_id', 'civicrm_contribution_recur', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'address_id', 'civicrm_address', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'campaign_id', 'civicrm_campaign', 'id');
|
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
|
|
}
|
|
return Civi::$statics[__CLASS__]['links'];
|
|
}
|
|
/**
|
|
* Returns all the column names of this table
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &fields() {
|
|
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
|
|
Civi::$statics[__CLASS__]['fields'] = array(
|
|
'contribution_id' => array(
|
|
'name' => 'id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contribution ID') ,
|
|
'description' => 'Contribution ID',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
) ,
|
|
'contribution_contact_id' => array(
|
|
'name' => 'contact_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contact ID') ,
|
|
'description' => 'FK to Contact ID',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.contact_id',
|
|
'headerPattern' => '/contact(.?id)?/i',
|
|
'dataPattern' => '/^\d+$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Contact_DAO_Contact',
|
|
'html' => array(
|
|
'type' => 'EntityRef',
|
|
) ,
|
|
) ,
|
|
'financial_type_id' => array(
|
|
'name' => 'financial_type_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Financial Type') ,
|
|
'description' => 'FK to Financial Type for (total_amount - non_deductible_amount).',
|
|
'export' => true,
|
|
'where' => 'civicrm_contribution.financial_type_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Financial_DAO_FinancialType',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_financial_type',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'name',
|
|
)
|
|
) ,
|
|
'contribution_page_id' => array(
|
|
'name' => 'contribution_page_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contribution Page ID') ,
|
|
'description' => 'The Contribution Page which triggered this contribution',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.contribution_page_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Contribute_DAO_ContributionPage',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_contribution_page',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'title',
|
|
)
|
|
) ,
|
|
'payment_instrument_id' => array(
|
|
'name' => 'payment_instrument_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Method ID') ,
|
|
'description' => 'FK to Payment Instrument',
|
|
'export' => true,
|
|
'where' => 'civicrm_contribution.payment_instrument_id',
|
|
'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
|
|
'dataPattern' => '',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'optionGroupName' => 'payment_instrument',
|
|
'optionEditPath' => 'civicrm/admin/options/payment_instrument',
|
|
)
|
|
) ,
|
|
'receive_date' => array(
|
|
'name' => 'receive_date',
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
|
'title' => ts('Date Received') ,
|
|
'description' => 'Date contribution was received - not necessarily the creation date of the record',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.receive_date',
|
|
'headerPattern' => '/receive(.?date)?/i',
|
|
'dataPattern' => '/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDateTime',
|
|
) ,
|
|
) ,
|
|
'non_deductible_amount' => array(
|
|
'name' => 'non_deductible_amount',
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
|
'title' => ts('Non-deductible Amount') ,
|
|
'description' => 'Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types.',
|
|
'precision' => array(
|
|
20,
|
|
2
|
|
) ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.non_deductible_amount',
|
|
'headerPattern' => '/non?.?deduct/i',
|
|
'dataPattern' => '/^\d+(\.\d{2})?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'total_amount' => array(
|
|
'name' => 'total_amount',
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
|
'title' => ts('Total Amount') ,
|
|
'description' => 'Total amount of this contribution. Use market value for non-monetary gifts.',
|
|
'required' => true,
|
|
'precision' => array(
|
|
20,
|
|
2
|
|
) ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.total_amount',
|
|
'headerPattern' => '/^total|(.?^am(ou)?nt)/i',
|
|
'dataPattern' => '/^\d+(\.\d{2})?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'fee_amount' => array(
|
|
'name' => 'fee_amount',
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
|
'title' => ts('Fee Amount') ,
|
|
'description' => 'actual processor fee if known - may be 0.',
|
|
'precision' => array(
|
|
20,
|
|
2
|
|
) ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.fee_amount',
|
|
'headerPattern' => '/fee(.?am(ou)?nt)?/i',
|
|
'dataPattern' => '/^\d+(\.\d{2})?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'net_amount' => array(
|
|
'name' => 'net_amount',
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
|
'title' => ts('Net Amount') ,
|
|
'description' => 'actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.',
|
|
'precision' => array(
|
|
20,
|
|
2
|
|
) ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.net_amount',
|
|
'headerPattern' => '/net(.?am(ou)?nt)?/i',
|
|
'dataPattern' => '/^\d+(\.\d{2})?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'trxn_id' => array(
|
|
'name' => 'trxn_id',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Transaction ID') ,
|
|
'description' => 'unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.trxn_id',
|
|
'headerPattern' => '/tr(ansactio|x)n(.?id)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'invoice_id' => array(
|
|
'name' => 'invoice_id',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Invoice Reference') ,
|
|
'description' => 'unique invoice id, system generated or passed in',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.invoice_id',
|
|
'headerPattern' => '/invoice(.?id)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'invoice_number' => array(
|
|
'name' => 'invoice_number',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Invoice Number') ,
|
|
'description' => 'Human readable invoice number',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.invoice_number',
|
|
'headerPattern' => '/invoice(.?number)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'currency' => array(
|
|
'name' => 'currency',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Currency') ,
|
|
'description' => '3 character string, value from config setting or input via user.',
|
|
'maxlength' => 3,
|
|
'size' => CRM_Utils_Type::FOUR,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.currency',
|
|
'headerPattern' => '/cur(rency)?/i',
|
|
'dataPattern' => '/^[A-Z]{3}$/i',
|
|
'export' => true,
|
|
'default' => 'NULL',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_currency',
|
|
'keyColumn' => 'name',
|
|
'labelColumn' => 'full_name',
|
|
'nameColumn' => 'name',
|
|
)
|
|
) ,
|
|
'cancel_date' => array(
|
|
'name' => 'cancel_date',
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
|
'title' => ts('Cancel Date') ,
|
|
'description' => 'when was gift cancelled',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.cancel_date',
|
|
'headerPattern' => '/cancel(.?date)?/i',
|
|
'dataPattern' => '/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDateTime',
|
|
) ,
|
|
) ,
|
|
'cancel_reason' => array(
|
|
'name' => 'cancel_reason',
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
|
'title' => ts('Cancel Reason') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.cancel_reason',
|
|
'headerPattern' => '/(cancel.?)?reason/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'receipt_date' => array(
|
|
'name' => 'receipt_date',
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
|
'title' => ts('Receipt Date') ,
|
|
'description' => 'when (if) receipt was sent. populated automatically for online donations w/ automatic receipting',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.receipt_date',
|
|
'headerPattern' => '/receipt(.?date)?/i',
|
|
'dataPattern' => '/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDateTime',
|
|
) ,
|
|
) ,
|
|
'thankyou_date' => array(
|
|
'name' => 'thankyou_date',
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
|
'title' => ts('Thank-you Date') ,
|
|
'description' => 'when (if) was donor thanked',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.thankyou_date',
|
|
'headerPattern' => '/thank(s|(.?you))?(.?date)?/i',
|
|
'dataPattern' => '/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDateTime',
|
|
) ,
|
|
) ,
|
|
'contribution_source' => array(
|
|
'name' => 'source',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Contribution Source') ,
|
|
'description' => 'Origin of this Contribution.',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.source',
|
|
'headerPattern' => '/source/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'amount_level' => array(
|
|
'name' => 'amount_level',
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
|
'title' => ts('Amount Label') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.amount_level',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'contribution_recur_id' => array(
|
|
'name' => 'contribution_recur_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Recurring Contribution ID') ,
|
|
'description' => 'Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.',
|
|
'export' => true,
|
|
'where' => 'civicrm_contribution.contribution_recur_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur',
|
|
) ,
|
|
'is_test' => array(
|
|
'name' => 'is_test',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Test') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.is_test',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'CheckBox',
|
|
) ,
|
|
) ,
|
|
'is_pay_later' => array(
|
|
'name' => 'is_pay_later',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Is Pay Later') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.is_pay_later',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'CheckBox',
|
|
) ,
|
|
) ,
|
|
'contribution_status_id' => array(
|
|
'name' => 'contribution_status_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contribution Status ID') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.contribution_status_id',
|
|
'headerPattern' => '/status/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'default' => '1',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'optionGroupName' => 'contribution_status',
|
|
'optionEditPath' => 'civicrm/admin/options/contribution_status',
|
|
)
|
|
) ,
|
|
'contribution_address_id' => array(
|
|
'name' => 'address_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contribution Address') ,
|
|
'description' => 'Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data.',
|
|
'export' => true,
|
|
'where' => 'civicrm_contribution.address_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Core_DAO_Address',
|
|
) ,
|
|
'contribution_check_number' => array(
|
|
'name' => 'check_number',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Check Number') ,
|
|
'maxlength' => 255,
|
|
'size' => 6,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.check_number',
|
|
'headerPattern' => '/check(.?number)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'contribution_campaign_id' => array(
|
|
'name' => 'campaign_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Campaign') ,
|
|
'description' => 'The campaign for which this contribution has been triggered.',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.campaign_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Campaign_DAO_Campaign',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_campaign',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'title',
|
|
)
|
|
) ,
|
|
'creditnote_id' => array(
|
|
'name' => 'creditnote_id',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Credit Note ID') ,
|
|
'description' => 'unique credit note id, system generated or passed in',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.creditnote_id',
|
|
'headerPattern' => '/creditnote(.?id)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'tax_amount' => array(
|
|
'name' => 'tax_amount',
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
|
'title' => ts('Tax Amount') ,
|
|
'description' => 'Total tax amount of this contribution.',
|
|
'precision' => array(
|
|
20,
|
|
2
|
|
) ,
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.tax_amount',
|
|
'headerPattern' => '/tax(.?am(ou)?nt)?/i',
|
|
'dataPattern' => '/^\d+(\.\d{2})?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'revenue_recognition_date' => array(
|
|
'name' => 'revenue_recognition_date',
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
|
'title' => ts('Revenue Recognition Date') ,
|
|
'description' => 'Stores the date when revenue should be recognized.',
|
|
'import' => true,
|
|
'where' => 'civicrm_contribution.revenue_recognition_date',
|
|
'headerPattern' => '/revenue(.?date)?/i',
|
|
'dataPattern' => '/^\d{4}-?\d{2}-?\d{2} ?(\d{2}:?\d{2}:?(\d{2})?)?$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_contribution',
|
|
'entity' => 'Contribution',
|
|
'bao' => 'CRM_Contribute_BAO_Contribution',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDateTime',
|
|
) ,
|
|
) ,
|
|
);
|
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
|
|
}
|
|
return Civi::$statics[__CLASS__]['fields'];
|
|
}
|
|
/**
|
|
* Return a mapping from field-name to the corresponding key (as used in fields()).
|
|
*
|
|
* @return array
|
|
* Array(string $name => string $uniqueName).
|
|
*/
|
|
static function &fieldKeys() {
|
|
if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
|
|
Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
|
|
}
|
|
return Civi::$statics[__CLASS__]['fieldKeys'];
|
|
}
|
|
/**
|
|
* Returns the names of this table
|
|
*
|
|
* @return string
|
|
*/
|
|
static function getTableName() {
|
|
return self::$_tableName;
|
|
}
|
|
/**
|
|
* Returns if this table needs to be logged
|
|
*
|
|
* @return boolean
|
|
*/
|
|
function getLog() {
|
|
return self::$_log;
|
|
}
|
|
/**
|
|
* Returns the list of fields that can be imported
|
|
*
|
|
* @param bool $prefix
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &import($prefix = false) {
|
|
$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution', $prefix, array());
|
|
return $r;
|
|
}
|
|
/**
|
|
* Returns the list of fields that can be exported
|
|
*
|
|
* @param bool $prefix
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &export($prefix = false) {
|
|
$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution', $prefix, array());
|
|
return $r;
|
|
}
|
|
/**
|
|
* Returns the list of indices
|
|
*/
|
|
public static function indices($localize = TRUE) {
|
|
$indices = array(
|
|
'UI_contrib_payment_instrument_id' => array(
|
|
'name' => 'UI_contrib_payment_instrument_id',
|
|
'field' => array(
|
|
0 => 'payment_instrument_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::payment_instrument_id',
|
|
) ,
|
|
'index_total_amount_receive_date' => array(
|
|
'name' => 'index_total_amount_receive_date',
|
|
'field' => array(
|
|
0 => 'total_amount',
|
|
1 => 'receive_date',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::total_amount::receive_date',
|
|
) ,
|
|
'index_source' => array(
|
|
'name' => 'index_source',
|
|
'field' => array(
|
|
0 => 'source',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::source',
|
|
) ,
|
|
'UI_contrib_trxn_id' => array(
|
|
'name' => 'UI_contrib_trxn_id',
|
|
'field' => array(
|
|
0 => 'trxn_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'unique' => true,
|
|
'sig' => 'civicrm_contribution::1::trxn_id',
|
|
) ,
|
|
'UI_contrib_invoice_id' => array(
|
|
'name' => 'UI_contrib_invoice_id',
|
|
'field' => array(
|
|
0 => 'invoice_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'unique' => true,
|
|
'sig' => 'civicrm_contribution::1::invoice_id',
|
|
) ,
|
|
'index_contribution_status' => array(
|
|
'name' => 'index_contribution_status',
|
|
'field' => array(
|
|
0 => 'contribution_status_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::contribution_status_id',
|
|
) ,
|
|
'received_date' => array(
|
|
'name' => 'received_date',
|
|
'field' => array(
|
|
0 => 'receive_date',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::receive_date',
|
|
) ,
|
|
'check_number' => array(
|
|
'name' => 'check_number',
|
|
'field' => array(
|
|
0 => 'check_number',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::check_number',
|
|
) ,
|
|
'index_creditnote_id' => array(
|
|
'name' => 'index_creditnote_id',
|
|
'field' => array(
|
|
0 => 'creditnote_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_contribution::0::creditnote_id',
|
|
) ,
|
|
);
|
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
|
}
|
|
}
|