[civicrm-core.git] / CRM / Financial / DAO / FinancialTrxn.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/Financial/FinancialTrxn.xml
 * DO NOT EDIT.  Generated by CRM_Core_CodeGen
 * (GenCodeChecksum:2c30f842e4a913eaac8e180219bc522e)
 */
require_once 'CRM/Core/DAO.php';
require_once 'CRM/Utils/Type.php';
/**
 * CRM_Financial_DAO_FinancialTrxn constructor.
 */
class CRM_Financial_DAO_FinancialTrxn extends CRM_Core_DAO {
  /**
   * Static instance to hold the table name.
   *
   * @var string
   */
  static $_tableName = 'civicrm_financial_trxn';
  /**
   * Should CiviCRM log any modifications to this table in the civicrm_log table.
   *
   * @var boolean
   */
  static $_log = true;
  /**
   *
   * @var int unsigned
   */
  public $id;
  /**
   * FK to financial_account table.
   *
   * @var int unsigned
   */
  public $from_financial_account_id;
  /**
   * FK to financial_financial_account table.
   *
   * @var int unsigned
   */
  public $to_financial_account_id;
  /**
   * date transaction occurred
   *
   * @var datetime
   */
  public $trxn_date;
  /**
   * amount of transaction
   *
   * @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;
  /**
   * 3 character string, value from config setting or input via user.
   *
   * @var string
   */
  public $currency;
  /**
   * Is this entry either a payment or a reversal of a payment?
   *
   * @var boolean
   */
  public $is_payment;
  /**
   * Transaction id supplied by external processor. This may not be unique.
   *
   * @var string
   */
  public $trxn_id;
  /**
   * processor result code
   *
   * @var string
   */
  public $trxn_result_code;
  /**
   * pseudo FK to civicrm_option_value of contribution_status_id option_group
   *
   * @var int unsigned
   */
  public $status_id;
  /**
   * Payment Processor for this financial transaction
   *
   * @var int unsigned
   */
  public $payment_processor_id;
  /**
   * FK to payment_instrument option group values
   *
   * @var int unsigned
   */
  public $payment_instrument_id;
  /**
   * FK to accept_creditcard option group values
   *
   * @var int unsigned
   */
  public $card_type_id;
  /**
   * Check number
   *
   * @var string
   */
  public $check_number;
  /**
   * Last 4 digits of credit card
   *
   * @var int unsigned
   */
  public $pan_truncation;
  /**
   * Class constructor.
   */
  function __construct() {
    $this->__table = 'civicrm_financial_trxn';
    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() , 'from_financial_account_id', 'civicrm_financial_account', 'id');
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'to_financial_account_id', 'civicrm_financial_account', 'id');
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'payment_processor_id', 'civicrm_payment_processor', '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(
        'id' => array(
          'name' => 'id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Financial Transaction ID') ,
          'required' => true,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'from_financial_account_id' => array(
          'name' => 'from_financial_account_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Financial Transaction From Account') ,
          'description' => 'FK to financial_account table.',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
          'html' => array(
            'type' => 'Select',
          ) ,
          'pseudoconstant' => array(
            'table' => 'civicrm_financial_account',
            'keyColumn' => 'id',
            'labelColumn' => 'name',
          )
        ) ,
        'to_financial_account_id' => array(
          'name' => 'to_financial_account_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Financial Transaction To Account') ,
          'description' => 'FK to financial_financial_account table.',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
          'html' => array(
            'type' => 'Select',
          ) ,
          'pseudoconstant' => array(
            'table' => 'civicrm_financial_account',
            'keyColumn' => 'id',
            'labelColumn' => 'name',
          )
        ) ,
        'trxn_date' => array(
          'name' => 'trxn_date',
          'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
          'title' => ts('Financial Transaction Date') ,
          'description' => 'date transaction occurred',
          'default' => 'NULL',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Select Date',
            'formatType' => 'activityDateTime',
          ) ,
        ) ,
        'total_amount' => array(
          'name' => 'total_amount',
          'type' => CRM_Utils_Type::T_MONEY,
          'title' => ts('Financial Total Amount') ,
          'description' => 'amount of transaction',
          'required' => true,
          'precision' => array(
            20,
            2
          ) ,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'fee_amount' => array(
          'name' => 'fee_amount',
          'type' => CRM_Utils_Type::T_MONEY,
          'title' => ts('Financial Fee Amount') ,
          'description' => 'actual processor fee if known - may be 0.',
          'precision' => array(
            20,
            2
          ) ,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'net_amount' => array(
          'name' => 'net_amount',
          'type' => CRM_Utils_Type::T_MONEY,
          'title' => ts('Financial 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
          ) ,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'currency' => array(
          'name' => 'currency',
          'type' => CRM_Utils_Type::T_STRING,
          'title' => ts('Financial Currency') ,
          'description' => '3 character string, value from config setting or input via user.',
          'maxlength' => 3,
          'size' => CRM_Utils_Type::FOUR,
          'import' => true,
          'where' => 'civicrm_financial_trxn.currency',
          'headerPattern' => '/cur(rency)?/i',
          'dataPattern' => '/^[A-Z]{3}$/',
          'export' => true,
          'default' => 'NULL',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Select',
          ) ,
          'pseudoconstant' => array(
            'table' => 'civicrm_currency',
            'keyColumn' => 'name',
            'labelColumn' => 'full_name',
            'nameColumn' => 'name',
          )
        ) ,
        'is_payment' => array(
          'name' => 'is_payment',
          'type' => CRM_Utils_Type::T_BOOLEAN,
          'title' => ts('Is Payment?') ,
          'description' => 'Is this entry either a payment or a reversal of a payment?',
          'import' => true,
          'where' => 'civicrm_financial_trxn.is_payment',
          'headerPattern' => '',
          'dataPattern' => '',
          'export' => true,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'trxn_id' => array(
          'name' => 'trxn_id',
          'type' => CRM_Utils_Type::T_STRING,
          'title' => ts('Transaction ID') ,
          'description' => 'Transaction id supplied by external processor. This may not be unique.',
          'maxlength' => 255,
          'size' => CRM_Utils_Type::HUGE,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'trxn_result_code' => array(
          'name' => 'trxn_result_code',
          'type' => CRM_Utils_Type::T_STRING,
          'title' => ts('Transaction Result Code') ,
          'description' => 'processor result code',
          'maxlength' => 255,
          'size' => CRM_Utils_Type::HUGE,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
        ) ,
        'status_id' => array(
          'name' => 'status_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Financial Transaction Status Id') ,
          'description' => 'pseudo FK to civicrm_option_value of contribution_status_id option_group',
          'import' => true,
          'where' => 'civicrm_financial_trxn.status_id',
          'headerPattern' => '/status/i',
          'dataPattern' => '',
          'export' => true,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'pseudoconstant' => array(
            'optionGroupName' => 'contribution_status',
            'optionEditPath' => 'civicrm/admin/options/contribution_status',
          )
        ) ,
        'payment_processor_id' => array(
          'name' => 'payment_processor_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Payment Processor') ,
          'description' => 'Payment Processor for this financial transaction',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor',
        ) ,
        'financial_trxn_payment_instrument_id' => array(
          'name' => 'payment_instrument_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Payment Method') ,
          'description' => 'FK to payment_instrument option group values',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Select',
          ) ,
          'pseudoconstant' => array(
            'optionGroupName' => 'payment_instrument',
            'optionEditPath' => 'civicrm/admin/options/payment_instrument',
          )
        ) ,
        'financial_trxn_card_type_id' => array(
          'name' => 'card_type_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Card Type ID') ,
          'description' => 'FK to accept_creditcard option group values',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Select',
          ) ,
          'pseudoconstant' => array(
            'optionGroupName' => 'accept_creditcard',
            'optionEditPath' => 'civicrm/admin/options/accept_creditcard',
          )
        ) ,
        'financial_trxn_check_number' => array(
          'name' => 'check_number',
          'type' => CRM_Utils_Type::T_STRING,
          'title' => ts('Check Number') ,
          'description' => 'Check number',
          'maxlength' => 255,
          'size' => 6,
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Text',
          ) ,
        ) ,
        'financial_trxn_pan_truncation' => array(
          'name' => 'pan_truncation',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Pan Truncation') ,
          'description' => 'Last 4 digits of credit card',
          'table_name' => 'civicrm_financial_trxn',
          'entity' => 'FinancialTrxn',
          'bao' => 'CRM_Financial_DAO_FinancialTrxn',
          'localizable' => 0,
          'html' => array(
            'type' => 'Text',
          ) ,
        ) ,
      );
      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__, 'financial_trxn', $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__, 'financial_trxn', $prefix, array());
    return $r;
  }
  /**
   * Returns the list of indices
   */
  public static function indices($localize = TRUE) {
    $indices = array(
      'UI_ftrxn_trxn_id' => array(
        'name' => 'UI_ftrxn_trxn_id',
        'field' => array(
          0 => 'trxn_id',
        ) ,
        'localizable' => false,
        'sig' => 'civicrm_financial_trxn::0::trxn_id',
      ) ,
      'UI_ftrxn_payment_instrument_id' => array(
        'name' => 'UI_ftrxn_payment_instrument_id',
        'field' => array(
          0 => 'payment_instrument_id',
        ) ,
        'localizable' => false,
        'sig' => 'civicrm_financial_trxn::0::payment_instrument_id',
      ) ,
      'UI_ftrxn_check_number' => array(
        'name' => 'UI_ftrxn_check_number',
        'field' => array(
          0 => 'check_number',
        ) ,
        'localizable' => false,
        'sig' => 'civicrm_financial_trxn::0::check_number',
      ) ,
    );
    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
  }
}
Commit	Line	Data
e501603b TO	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
	4	\| CiviCRM version 4.7 \|
	5	+--------------------------------------------------------------------+
0f03f337	6	\| Copyright CiviCRM LLC (c) 2004-2017 \|
e501603b TO	7	+--------------------------------------------------------------------+
	8	\| This file is a part of CiviCRM. \|
	9	\| \|
	10	\| CiviCRM is free software; you can copy, modify, and distribute it \|
	11	\| under the terms of the GNU Affero General Public License \|
	12	\| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. \|
	13	\| \|
	14	\| CiviCRM is distributed in the hope that it will be useful, but \|
	15	\| WITHOUT ANY WARRANTY; without even the implied warranty of \|
	16	\| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \|
	17	\| See the GNU Affero General Public License for more details. \|
	18	\| \|
	19	\| You should have received a copy of the GNU Affero General Public \|
	20	\| License and the CiviCRM Licensing Exception along \|
	21	\| with this program; if not, contact CiviCRM LLC \|
	22	\| at info[AT]civicrm[DOT]org. If you have questions about the \|
	23	\| GNU Affero General Public License or the licensing of CiviCRM, \|
	24	\| see the CiviCRM license FAQ at http://civicrm.org/licensing \|
	25	+--------------------------------------------------------------------+
	26	*/
	27	/**
	28	* @package CRM
0f03f337	29	* @copyright CiviCRM LLC (c) 2004-2017
e501603b TO	30	*
	31	* Generated from xml/schema/CRM/Financial/FinancialTrxn.xml
	32	* DO NOT EDIT. Generated by CRM_Core_CodeGen
5e0343e8	33	* (GenCodeChecksum:2c30f842e4a913eaac8e180219bc522e)
e501603b TO	34	*/
	35	require_once 'CRM/Core/DAO.php';
	36	require_once 'CRM/Utils/Type.php';
f41f0342	37	/**
	38	* CRM_Financial_DAO_FinancialTrxn constructor.
	39	*/
e501603b TO	40	class CRM_Financial_DAO_FinancialTrxn extends CRM_Core_DAO {
e501603b TO	41	/**
f41f0342	42	* Static instance to hold the table name.
e501603b TO	43	*
	44	* @var string
	45	*/
	46	static $_tableName = 'civicrm_financial_trxn';
e501603b	47	/**
f41f0342	48	* Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b TO	49	*
	50	* @var boolean
	51	*/
	52	static $_log = true;
	53	/**
	54	*
	55	* @var int unsigned
	56	*/
	57	public $id;
	58	/**
	59	* FK to financial_account table.
	60	*
	61	* @var int unsigned
	62	*/
	63	public $from_financial_account_id;
	64	/**
	65	* FK to financial_financial_account table.
	66	*
	67	* @var int unsigned
	68	*/
	69	public $to_financial_account_id;
	70	/**
	71	* date transaction occurred
	72	*
	73	* @var datetime
	74	*/
	75	public $trxn_date;
	76	/**
	77	* amount of transaction
	78	*
	79	* @var float
	80	*/
	81	public $total_amount;
	82	/**
	83	* actual processor fee if known - may be 0.
	84	*
	85	* @var float
	86	*/
	87	public $fee_amount;
	88	/**
	89	* actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.
	90	*
	91	* @var float
	92	*/
	93	public $net_amount;
	94	/**
	95	* 3 character string, value from config setting or input via user.
	96	*
	97	* @var string
	98	*/
	99	public $currency;
	100	/**
	101	* Is this entry either a payment or a reversal of a payment?
	102	*
	103	* @var boolean
	104	*/
	105	public $is_payment;
	106	/**
	107	* Transaction id supplied by external processor. This may not be unique.
	108	*
	109	* @var string
	110	*/
	111	public $trxn_id;
	112	/**
113	* processor result code
114	*
115	* @var string
116	*/
117	public $trxn_result_code;
118	/**
119	* pseudo FK to civicrm_option_value of contribution_status_id option_group
120	*
121	* @var int unsigned
122	*/
123	public $status_id;
124	/**
125	* Payment Processor for this financial transaction
126	*
127	* @var int unsigned
128	*/
129	public $payment_processor_id;
130	/**
131	* FK to payment_instrument option group values
132	*
133	* @var int unsigned
134	*/
135	public $payment_instrument_id;
ea927522 PN	136	/**
	137	* FK to accept_creditcard option group values
	138	*
	139	* @var int unsigned
	140	*/
5e0343e8	141	public $card_type_id;
e501603b TO	142	/**
	143	* Check number
	144	*
	145	* @var string
	146	*/
	147	public $check_number;
ea927522 PN	148	/**
	149	* Last 4 digits of credit card
	150	*
	151	* @var int unsigned
	152	*/
	153	public $pan_truncation;
e501603b	154	/**
f41f0342	155	* Class constructor.
e501603b TO	156	*/
	157	function __construct() {
	158	$this->__table = 'civicrm_financial_trxn';
	159	parent::__construct();
	160	}
	161	/**
f41f0342	162	* Returns foreign keys and entity references.
e501603b TO	163	*
	164	* @return array
	165	* [CRM_Core_Reference_Interface]
	166	*/
	167	static function getReferenceColumns() {
346aaaba TO	168	if (!isset(Civi::$statics[__CLASS__]['links'])) {
	169	Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
	170	Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'from_financial_account_id', 'civicrm_financial_account', 'id');
	171	Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'to_financial_account_id', 'civicrm_financial_account', 'id');
	172	Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'payment_processor_id', 'civicrm_payment_processor', 'id');
	173	CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
e501603b	174	}
346aaaba	175	return Civi::$statics[__CLASS__]['links'];
e501603b TO	176	}
	177	/**
	178	* Returns all the column names of this table
	179	*
	180	* @return array
	181	*/
	182	static function &fields() {
346aaaba TO	183	if (!isset(Civi::$statics[__CLASS__]['fields'])) {
346aaaba TO	184	Civi::$statics[__CLASS__]['fields'] = array(
e501603b TO	185	'id' => array(
	186	'name' => 'id',
	187	'type' => CRM_Utils_Type::T_INT,
	188	'title' => ts('Financial Transaction ID') ,
	189	'required' => true,
522a26c9	190	'table_name' => 'civicrm_financial_trxn',
	191	'entity' => 'FinancialTrxn',
	192	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	193	'localizable' => 0,
e501603b TO	194	) ,
	195	'from_financial_account_id' => array(
	196	'name' => 'from_financial_account_id',
	197	'type' => CRM_Utils_Type::T_INT,
	198	'title' => ts('Financial Transaction From Account') ,
	199	'description' => 'FK to financial_account table.',
522a26c9	200	'table_name' => 'civicrm_financial_trxn',
	201	'entity' => 'FinancialTrxn',
	202	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	203	'localizable' => 0,
e501603b TO	204	'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
	205	'html' => array(
	206	'type' => 'Select',
	207	) ,
	208	'pseudoconstant' => array(
	209	'table' => 'civicrm_financial_account',
	210	'keyColumn' => 'id',
	211	'labelColumn' => 'name',
	212	)
	213	) ,
	214	'to_financial_account_id' => array(
	215	'name' => 'to_financial_account_id',
	216	'type' => CRM_Utils_Type::T_INT,
	217	'title' => ts('Financial Transaction To Account') ,
	218	'description' => 'FK to financial_financial_account table.',
522a26c9	219	'table_name' => 'civicrm_financial_trxn',
	220	'entity' => 'FinancialTrxn',
	221	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	222	'localizable' => 0,
e501603b TO	223	'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
	224	'html' => array(
	225	'type' => 'Select',
	226	) ,
	227	'pseudoconstant' => array(
	228	'table' => 'civicrm_financial_account',
	229	'keyColumn' => 'id',
	230	'labelColumn' => 'name',
	231	)
	232	) ,
	233	'trxn_date' => array(
	234	'name' => 'trxn_date',
	235	'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
	236	'title' => ts('Financial Transaction Date') ,
	237	'description' => 'date transaction occurred',
	238	'default' => 'NULL',
522a26c9	239	'table_name' => 'civicrm_financial_trxn',
	240	'entity' => 'FinancialTrxn',
	241	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	242	'localizable' => 0,
f7fb5615	243	'html' => array(
	244	'type' => 'Select Date',
	245	'formatType' => 'activityDateTime',
	246	) ,
e501603b TO	247	) ,
	248	'total_amount' => array(
	249	'name' => 'total_amount',
	250	'type' => CRM_Utils_Type::T_MONEY,
	251	'title' => ts('Financial Total Amount') ,
	252	'description' => 'amount of transaction',
	253	'required' => true,
	254	'precision' => array(
	255	20,
	256	2
	257	) ,
522a26c9	258	'table_name' => 'civicrm_financial_trxn',
	259	'entity' => 'FinancialTrxn',
	260	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	261	'localizable' => 0,
e501603b TO	262	) ,
	263	'fee_amount' => array(
	264	'name' => 'fee_amount',
	265	'type' => CRM_Utils_Type::T_MONEY,
	266	'title' => ts('Financial Fee Amount') ,
	267	'description' => 'actual processor fee if known - may be 0.',
	268	'precision' => array(
	269	20,
	270	2
	271	) ,
522a26c9	272	'table_name' => 'civicrm_financial_trxn',
	273	'entity' => 'FinancialTrxn',
	274	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	275	'localizable' => 0,
e501603b TO	276	) ,
	277	'net_amount' => array(
	278	'name' => 'net_amount',
	279	'type' => CRM_Utils_Type::T_MONEY,
	280	'title' => ts('Financial Net Amount') ,
	281	'description' => 'actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.',
	282	'precision' => array(
	283	20,
	284	2
	285	) ,
522a26c9	286	'table_name' => 'civicrm_financial_trxn',
	287	'entity' => 'FinancialTrxn',
	288	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	289	'localizable' => 0,
e501603b TO	290	) ,
	291	'currency' => array(
	292	'name' => 'currency',
	293	'type' => CRM_Utils_Type::T_STRING,
	294	'title' => ts('Financial Currency') ,
	295	'description' => '3 character string, value from config setting or input via user.',
	296	'maxlength' => 3,
	297	'size' => CRM_Utils_Type::FOUR,
	298	'import' => true,
	299	'where' => 'civicrm_financial_trxn.currency',
	300	'headerPattern' => '/cur(rency)?/i',
	301	'dataPattern' => '/^[A-Z]{3}$/',
	302	'export' => true,
	303	'default' => 'NULL',
522a26c9	304	'table_name' => 'civicrm_financial_trxn',
	305	'entity' => 'FinancialTrxn',
	306	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	307	'localizable' => 0,
e501603b TO	308	'html' => array(
	309	'type' => 'Select',
	310	) ,
	311	'pseudoconstant' => array(
	312	'table' => 'civicrm_currency',
	313	'keyColumn' => 'name',
	314	'labelColumn' => 'full_name',
	315	'nameColumn' => 'name',
	316	)
	317	) ,
	318	'is_payment' => array(
	319	'name' => 'is_payment',
	320	'type' => CRM_Utils_Type::T_BOOLEAN,
	321	'title' => ts('Is Payment?') ,
	322	'description' => 'Is this entry either a payment or a reversal of a payment?',
	323	'import' => true,
	324	'where' => 'civicrm_financial_trxn.is_payment',
	325	'headerPattern' => '',
	326	'dataPattern' => '',
	327	'export' => true,
522a26c9	328	'table_name' => 'civicrm_financial_trxn',
	329	'entity' => 'FinancialTrxn',
	330	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	331	'localizable' => 0,
e501603b TO	332	) ,
	333	'trxn_id' => array(
	334	'name' => 'trxn_id',
	335	'type' => CRM_Utils_Type::T_STRING,
	336	'title' => ts('Transaction ID') ,
	337	'description' => 'Transaction id supplied by external processor. This may not be unique.',
	338	'maxlength' => 255,
	339	'size' => CRM_Utils_Type::HUGE,
522a26c9	340	'table_name' => 'civicrm_financial_trxn',
	341	'entity' => 'FinancialTrxn',
	342	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	343	'localizable' => 0,
e501603b TO	344	) ,
	345	'trxn_result_code' => array(
	346	'name' => 'trxn_result_code',
	347	'type' => CRM_Utils_Type::T_STRING,
	348	'title' => ts('Transaction Result Code') ,
	349	'description' => 'processor result code',
	350	'maxlength' => 255,
	351	'size' => CRM_Utils_Type::HUGE,
522a26c9	352	'table_name' => 'civicrm_financial_trxn',
	353	'entity' => 'FinancialTrxn',
	354	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	355	'localizable' => 0,
e501603b TO	356	) ,
	357	'status_id' => array(
	358	'name' => 'status_id',
	359	'type' => CRM_Utils_Type::T_INT,
	360	'title' => ts('Financial Transaction Status Id') ,
	361	'description' => 'pseudo FK to civicrm_option_value of contribution_status_id option_group',
	362	'import' => true,
	363	'where' => 'civicrm_financial_trxn.status_id',
	364	'headerPattern' => '/status/i',
	365	'dataPattern' => '',
	366	'export' => true,
522a26c9	367	'table_name' => 'civicrm_financial_trxn',
	368	'entity' => 'FinancialTrxn',
	369	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	370	'localizable' => 0,
e501603b TO	371	'pseudoconstant' => array(
	372	'optionGroupName' => 'contribution_status',
	373	'optionEditPath' => 'civicrm/admin/options/contribution_status',
	374	)
	375	) ,
	376	'payment_processor_id' => array(
	377	'name' => 'payment_processor_id',
	378	'type' => CRM_Utils_Type::T_INT,
	379	'title' => ts('Payment Processor') ,
	380	'description' => 'Payment Processor for this financial transaction',
522a26c9	381	'table_name' => 'civicrm_financial_trxn',
	382	'entity' => 'FinancialTrxn',
	383	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	384	'localizable' => 0,
e501603b TO	385	'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor',
	386	) ,
	387	'financial_trxn_payment_instrument_id' => array(
	388	'name' => 'payment_instrument_id',
	389	'type' => CRM_Utils_Type::T_INT,
	390	'title' => ts('Payment Method') ,
	391	'description' => 'FK to payment_instrument option group values',
522a26c9	392	'table_name' => 'civicrm_financial_trxn',
	393	'entity' => 'FinancialTrxn',
	394	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	395	'localizable' => 0,
e501603b TO	396	'html' => array(
	397	'type' => 'Select',
	398	) ,
	399	'pseudoconstant' => array(
	400	'optionGroupName' => 'payment_instrument',
	401	'optionEditPath' => 'civicrm/admin/options/payment_instrument',
	402	)
	403	) ,
5e0343e8	404	'financial_trxn_card_type_id' => array(
5e0343e8	405	'name' => 'card_type_id',
ea927522	406	'type' => CRM_Utils_Type::T_INT,
5e0343e8	407	'title' => ts('Card Type ID') ,
ea927522 PN	408	'description' => 'FK to accept_creditcard option group values',
	409	'table_name' => 'civicrm_financial_trxn',
	410	'entity' => 'FinancialTrxn',
	411	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	412	'localizable' => 0,
ea927522 PN	413	'html' => array(
	414	'type' => 'Select',
	415	) ,
	416	'pseudoconstant' => array(
	417	'optionGroupName' => 'accept_creditcard',
	418	'optionEditPath' => 'civicrm/admin/options/accept_creditcard',
	419	)
	420	) ,
e501603b TO	421	'financial_trxn_check_number' => array(
	422	'name' => 'check_number',
	423	'type' => CRM_Utils_Type::T_STRING,
	424	'title' => ts('Check Number') ,
	425	'description' => 'Check number',
	426	'maxlength' => 255,
	427	'size' => 6,
522a26c9	428	'table_name' => 'civicrm_financial_trxn',
	429	'entity' => 'FinancialTrxn',
	430	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	431	'localizable' => 0,
e501603b TO	432	'html' => array(
	433	'type' => 'Text',
	434	) ,
	435	) ,
ea927522 PN	436	'financial_trxn_pan_truncation' => array(
	437	'name' => 'pan_truncation',
	438	'type' => CRM_Utils_Type::T_INT,
	439	'title' => ts('Pan Truncation') ,
	440	'description' => 'Last 4 digits of credit card',
	441	'table_name' => 'civicrm_financial_trxn',
	442	'entity' => 'FinancialTrxn',
	443	'bao' => 'CRM_Financial_DAO_FinancialTrxn',
6a7e5e5d	444	'localizable' => 0,
ea927522 PN	445	'html' => array(
	446	'type' => 'Text',
	447	) ,
	448	) ,
e501603b	449	);
346aaaba	450	CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b	451	}
346aaaba	452	return Civi::$statics[__CLASS__]['fields'];
e501603b TO	453	}
e501603b TO	454	/**
bd8e0b14	455	* Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b TO	456	*
e501603b TO	457	* @return array
bd8e0b14	458	* Array(string $name => string $uniqueName).
e501603b TO	459	*/
e501603b TO	460	static function &fieldKeys() {
bd8e0b14 TO	461	if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
bd8e0b14 TO	462	Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b	463	}
bd8e0b14	464	return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b TO	465	}
	466	/**
	467	* Returns the names of this table
	468	*
	469	* @return string
	470	*/
	471	static function getTableName() {
	472	return self::$_tableName;
	473	}
	474	/**
	475	* Returns if this table needs to be logged
	476	*
	477	* @return boolean
	478	*/
	479	function getLog() {
	480	return self::$_log;
	481	}
	482	/**
	483	* Returns the list of fields that can be imported
	484	*
	485	* @param bool $prefix
	486	*
	487	* @return array
	488	*/
	489	static function &import($prefix = false) {
60808919 TO	490	$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'financial_trxn', $prefix, array());
60808919 TO	491	return $r;
e501603b TO	492	}
	493	/**
	494	* Returns the list of fields that can be exported
	495	*
	496	* @param bool $prefix
	497	*
	498	* @return array
	499	*/
	500	static function &export($prefix = false) {
60808919 TO	501	$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'financial_trxn', $prefix, array());
60808919 TO	502	return $r;
e501603b	503	}
e7a6b91a AS	504	/**
	505	* Returns the list of indices
	506	*/
	507	public static function indices($localize = TRUE) {
	508	$indices = array(
	509	'UI_ftrxn_trxn_id' => array(
	510	'name' => 'UI_ftrxn_trxn_id',
	511	'field' => array(
	512	0 => 'trxn_id',
	513	) ,
	514	'localizable' => false,
	515	'sig' => 'civicrm_financial_trxn::0::trxn_id',
	516	) ,
	517	'UI_ftrxn_payment_instrument_id' => array(
	518	'name' => 'UI_ftrxn_payment_instrument_id',
	519	'field' => array(
	520	0 => 'payment_instrument_id',
	521	) ,
	522	'localizable' => false,
	523	'sig' => 'civicrm_financial_trxn::0::payment_instrument_id',
	524	) ,
	525	'UI_ftrxn_check_number' => array(
	526	'name' => 'UI_ftrxn_check_number',
	527	'field' => array(
	528	0 => 'check_number',
	529	) ,
	530	'localizable' => false,
	531	'sig' => 'civicrm_financial_trxn::0::check_number',
	532	) ,
	533	);
	534	return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
	535	}
e501603b	536	}