401 lines
14 KiB
PHP
401 lines
14 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/Financial/FinancialItem.xml
|
||
|
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
||
|
|
* (GenCodeChecksum:95e199969f4ff93ccae635fb7e0d30f2)
|
||
|
|
*/
|
||
|
|
require_once 'CRM/Core/DAO.php';
|
||
|
|
require_once 'CRM/Utils/Type.php';
|
||
|
|
/**
|
||
|
|
* CRM_Financial_DAO_FinancialItem constructor.
|
||
|
|
*/
|
||
|
|
class CRM_Financial_DAO_FinancialItem extends CRM_Core_DAO {
|
||
|
|
/**
|
||
|
|
* Static instance to hold the table name.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
static $_tableName = 'civicrm_financial_item';
|
||
|
|
/**
|
||
|
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
||
|
|
*
|
||
|
|
* @var boolean
|
||
|
|
*/
|
||
|
|
static $_log = true;
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $id;
|
||
|
|
/**
|
||
|
|
* Date and time the item was created
|
||
|
|
*
|
||
|
|
* @var timestamp
|
||
|
|
*/
|
||
|
|
public $created_date;
|
||
|
|
/**
|
||
|
|
* Date and time of the source transaction
|
||
|
|
*
|
||
|
|
* @var datetime
|
||
|
|
*/
|
||
|
|
public $transaction_date;
|
||
|
|
/**
|
||
|
|
* FK to Contact ID of contact the item is from
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $contact_id;
|
||
|
|
/**
|
||
|
|
* Human readable description of this item, to ease display without lookup of source item.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
public $description;
|
||
|
|
/**
|
||
|
|
* Total amount of this item
|
||
|
|
*
|
||
|
|
* @var float
|
||
|
|
*/
|
||
|
|
public $amount;
|
||
|
|
/**
|
||
|
|
* Currency for the amount
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
public $currency;
|
||
|
|
/**
|
||
|
|
* FK to civicrm_financial_account
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $financial_account_id;
|
||
|
|
/**
|
||
|
|
* Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $status_id;
|
||
|
|
/**
|
||
|
|
* The table providing the source of this item such as civicrm_line_item
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
public $entity_table;
|
||
|
|
/**
|
||
|
|
* The specific source item that is responsible for the creation of this financial_item
|
||
|
|
*
|
||
|
|
* @var int unsigned
|
||
|
|
*/
|
||
|
|
public $entity_id;
|
||
|
|
/**
|
||
|
|
* Class constructor.
|
||
|
|
*/
|
||
|
|
function __construct() {
|
||
|
|
$this->__table = 'civicrm_financial_item';
|
||
|
|
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_account_id', 'civicrm_financial_account', 'id');
|
||
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
|
||
|
|
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 Item ID') ,
|
||
|
|
'required' => true,
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'created_date' => array(
|
||
|
|
'name' => 'created_date',
|
||
|
|
'type' => CRM_Utils_Type::T_TIMESTAMP,
|
||
|
|
'title' => ts('Financial Item Created Date') ,
|
||
|
|
'description' => 'Date and time the item was created',
|
||
|
|
'required' => true,
|
||
|
|
'default' => 'CURRENT_TIMESTAMP',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'transaction_date' => array(
|
||
|
|
'name' => 'transaction_date',
|
||
|
|
'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
|
||
|
|
'title' => ts('Financial Item Transaction Date') ,
|
||
|
|
'description' => 'Date and time of the source transaction',
|
||
|
|
'required' => true,
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'contact_id' => array(
|
||
|
|
'name' => 'contact_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Financial Item Contact ID') ,
|
||
|
|
'description' => 'FK to Contact ID of contact the item is from',
|
||
|
|
'required' => true,
|
||
|
|
'export' => true,
|
||
|
|
'where' => 'civicrm_financial_item.contact_id',
|
||
|
|
'headerPattern' => '',
|
||
|
|
'dataPattern' => '',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
'FKClassName' => 'CRM_Contact_DAO_Contact',
|
||
|
|
) ,
|
||
|
|
'description' => array(
|
||
|
|
'name' => 'description',
|
||
|
|
'type' => CRM_Utils_Type::T_STRING,
|
||
|
|
'title' => ts('Financial Item Description') ,
|
||
|
|
'description' => 'Human readable description of this item, to ease display without lookup of source item.',
|
||
|
|
'maxlength' => 255,
|
||
|
|
'size' => CRM_Utils_Type::HUGE,
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'amount' => array(
|
||
|
|
'name' => 'amount',
|
||
|
|
'type' => CRM_Utils_Type::T_MONEY,
|
||
|
|
'title' => ts('Amount') ,
|
||
|
|
'description' => 'Total amount of this item',
|
||
|
|
'required' => true,
|
||
|
|
'precision' => array(
|
||
|
|
20,
|
||
|
|
2
|
||
|
|
) ,
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'currency' => array(
|
||
|
|
'name' => 'currency',
|
||
|
|
'type' => CRM_Utils_Type::T_STRING,
|
||
|
|
'title' => ts('Financial Item Currency') ,
|
||
|
|
'description' => 'Currency for the amount',
|
||
|
|
'maxlength' => 3,
|
||
|
|
'size' => CRM_Utils_Type::FOUR,
|
||
|
|
'export' => true,
|
||
|
|
'where' => 'civicrm_financial_item.currency',
|
||
|
|
'headerPattern' => '',
|
||
|
|
'dataPattern' => '',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
'html' => array(
|
||
|
|
'type' => 'Select',
|
||
|
|
) ,
|
||
|
|
'pseudoconstant' => array(
|
||
|
|
'table' => 'civicrm_currency',
|
||
|
|
'keyColumn' => 'name',
|
||
|
|
'labelColumn' => 'full_name',
|
||
|
|
'nameColumn' => 'name',
|
||
|
|
)
|
||
|
|
) ,
|
||
|
|
'financial_account_id' => array(
|
||
|
|
'name' => 'financial_account_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Financial Account ID') ,
|
||
|
|
'description' => 'FK to civicrm_financial_account',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
|
||
|
|
'html' => array(
|
||
|
|
'type' => 'Select',
|
||
|
|
) ,
|
||
|
|
'pseudoconstant' => array(
|
||
|
|
'table' => 'civicrm_financial_account',
|
||
|
|
'keyColumn' => 'id',
|
||
|
|
'labelColumn' => 'name',
|
||
|
|
)
|
||
|
|
) ,
|
||
|
|
'status_id' => array(
|
||
|
|
'name' => 'status_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Financial Item Status ID') ,
|
||
|
|
'description' => 'Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)',
|
||
|
|
'export' => true,
|
||
|
|
'where' => 'civicrm_financial_item.status_id',
|
||
|
|
'headerPattern' => '',
|
||
|
|
'dataPattern' => '',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
'html' => array(
|
||
|
|
'type' => 'Select',
|
||
|
|
) ,
|
||
|
|
'pseudoconstant' => array(
|
||
|
|
'optionGroupName' => 'financial_item_status',
|
||
|
|
'optionEditPath' => 'civicrm/admin/options/financial_item_status',
|
||
|
|
)
|
||
|
|
) ,
|
||
|
|
'entity_table' => array(
|
||
|
|
'name' => 'entity_table',
|
||
|
|
'type' => CRM_Utils_Type::T_STRING,
|
||
|
|
'title' => ts('Entity Table') ,
|
||
|
|
'description' => 'The table providing the source of this item such as civicrm_line_item',
|
||
|
|
'maxlength' => 64,
|
||
|
|
'size' => CRM_Utils_Type::BIG,
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
'entity_id' => array(
|
||
|
|
'name' => 'entity_id',
|
||
|
|
'type' => CRM_Utils_Type::T_INT,
|
||
|
|
'title' => ts('Entity ID') ,
|
||
|
|
'description' => 'The specific source item that is responsible for the creation of this financial_item',
|
||
|
|
'table_name' => 'civicrm_financial_item',
|
||
|
|
'entity' => 'FinancialItem',
|
||
|
|
'bao' => 'CRM_Financial_BAO_FinancialItem',
|
||
|
|
'localizable' => 0,
|
||
|
|
) ,
|
||
|
|
);
|
||
|
|
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_item', $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_item', $prefix, array());
|
||
|
|
return $r;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns the list of indices
|
||
|
|
*/
|
||
|
|
public static function indices($localize = TRUE) {
|
||
|
|
$indices = array(
|
||
|
|
'IX_created_date' => array(
|
||
|
|
'name' => 'IX_created_date',
|
||
|
|
'field' => array(
|
||
|
|
0 => 'created_date',
|
||
|
|
) ,
|
||
|
|
'localizable' => false,
|
||
|
|
'sig' => 'civicrm_financial_item::0::created_date',
|
||
|
|
) ,
|
||
|
|
'IX_transaction_date' => array(
|
||
|
|
'name' => 'IX_transaction_date',
|
||
|
|
'field' => array(
|
||
|
|
0 => 'transaction_date',
|
||
|
|
) ,
|
||
|
|
'localizable' => false,
|
||
|
|
'sig' => 'civicrm_financial_item::0::transaction_date',
|
||
|
|
) ,
|
||
|
|
'index_entity_id_entity_table' => array(
|
||
|
|
'name' => 'index_entity_id_entity_table',
|
||
|
|
'field' => array(
|
||
|
|
0 => 'entity_id',
|
||
|
|
1 => 'entity_table',
|
||
|
|
) ,
|
||
|
|
'localizable' => false,
|
||
|
|
'sig' => 'civicrm_financial_item::0::entity_id::entity_table',
|
||
|
|
) ,
|
||
|
|
);
|
||
|
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
||
|
|
}
|
||
|
|
}
|