5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Financial/FinancialItem.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:89451392c63f3412435530a1d0deae5d)
13 * Database access object for the FinancialItem entity.
15 class CRM_Financial_DAO_FinancialItem
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_financial_item';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
37 * Date and time the item was created
44 * Date and time of the source transaction
48 public $transaction_date;
51 * FK to Contact ID of contact the item is from
58 * Human readable description of this item, to ease display without lookup of source item.
65 * Total amount of this item
72 * Currency for the amount
79 * FK to civicrm_financial_account
83 public $financial_account_id;
86 * Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)
93 * The table providing the source of this item such as civicrm_line_item
100 * The specific source item that is responsible for the creation of this financial_item
109 public function __construct() {
110 $this->__table
= 'civicrm_financial_item';
111 parent
::__construct();
115 * Returns foreign keys and entity references.
118 * [CRM_Core_Reference_Interface]
120 public static function getReferenceColumns() {
121 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
122 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
123 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
124 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'financial_account_id', 'civicrm_financial_account', 'id');
125 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
126 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
128 return Civi
::$statics[__CLASS__
]['links'];
132 * Returns all the column names of this table
136 public static function &fields() {
137 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
138 Civi
::$statics[__CLASS__
]['fields'] = [
141 'type' => CRM_Utils_Type
::T_INT
,
142 'title' => ts('Financial Item ID'),
144 'where' => 'civicrm_financial_item.id',
145 'table_name' => 'civicrm_financial_item',
146 'entity' => 'FinancialItem',
147 'bao' => 'CRM_Financial_BAO_FinancialItem',
151 'name' => 'created_date',
152 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
153 'title' => ts('Financial Item Created Date'),
154 'description' => ts('Date and time the item was created'),
156 'where' => 'civicrm_financial_item.created_date',
157 'default' => 'CURRENT_TIMESTAMP',
158 'table_name' => 'civicrm_financial_item',
159 'entity' => 'FinancialItem',
160 'bao' => 'CRM_Financial_BAO_FinancialItem',
163 'transaction_date' => [
164 'name' => 'transaction_date',
165 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
166 'title' => ts('Financial Item Transaction Date'),
167 'description' => ts('Date and time of the source transaction'),
169 'where' => 'civicrm_financial_item.transaction_date',
170 'table_name' => 'civicrm_financial_item',
171 'entity' => 'FinancialItem',
172 'bao' => 'CRM_Financial_BAO_FinancialItem',
176 'name' => 'contact_id',
177 'type' => CRM_Utils_Type
::T_INT
,
178 'title' => ts('Financial Item Contact ID'),
179 'description' => ts('FK to Contact ID of contact the item is from'),
181 'where' => 'civicrm_financial_item.contact_id',
183 'table_name' => 'civicrm_financial_item',
184 'entity' => 'FinancialItem',
185 'bao' => 'CRM_Financial_BAO_FinancialItem',
187 'FKClassName' => 'CRM_Contact_DAO_Contact',
190 'name' => 'description',
191 'type' => CRM_Utils_Type
::T_STRING
,
192 'title' => ts('Financial Item Description'),
193 'description' => ts('Human readable description of this item, to ease display without lookup of source item.'),
195 'size' => CRM_Utils_Type
::HUGE
,
196 'where' => 'civicrm_financial_item.description',
197 'table_name' => 'civicrm_financial_item',
198 'entity' => 'FinancialItem',
199 'bao' => 'CRM_Financial_BAO_FinancialItem',
204 'type' => CRM_Utils_Type
::T_MONEY
,
205 'title' => ts('Amount'),
206 'description' => ts('Total amount of this item'),
212 'where' => 'civicrm_financial_item.amount',
213 'headerPattern' => '/unit?.?amoun/i',
214 'dataPattern' => '/^\d+(\.\d{2})?$/',
216 'table_name' => 'civicrm_financial_item',
217 'entity' => 'FinancialItem',
218 'bao' => 'CRM_Financial_BAO_FinancialItem',
222 'name' => 'currency',
223 'type' => CRM_Utils_Type
::T_STRING
,
224 'title' => ts('Financial Item Currency'),
225 'description' => ts('Currency for the amount'),
227 'size' => CRM_Utils_Type
::FOUR
,
228 'where' => 'civicrm_financial_item.currency',
230 'table_name' => 'civicrm_financial_item',
231 'entity' => 'FinancialItem',
232 'bao' => 'CRM_Financial_BAO_FinancialItem',
237 'pseudoconstant' => [
238 'table' => 'civicrm_currency',
239 'keyColumn' => 'name',
240 'labelColumn' => 'full_name',
241 'nameColumn' => 'name',
244 'financial_account_id' => [
245 'name' => 'financial_account_id',
246 'type' => CRM_Utils_Type
::T_INT
,
247 'title' => ts('Financial Account ID'),
248 'description' => ts('FK to civicrm_financial_account'),
249 'where' => 'civicrm_financial_item.financial_account_id',
250 'table_name' => 'civicrm_financial_item',
251 'entity' => 'FinancialItem',
252 'bao' => 'CRM_Financial_BAO_FinancialItem',
254 'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
258 'pseudoconstant' => [
259 'table' => 'civicrm_financial_account',
261 'labelColumn' => 'name',
265 'name' => 'status_id',
266 'type' => CRM_Utils_Type
::T_INT
,
267 'title' => ts('Financial Item Status ID'),
268 'description' => ts('Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)'),
269 'where' => 'civicrm_financial_item.status_id',
271 'table_name' => 'civicrm_financial_item',
272 'entity' => 'FinancialItem',
273 'bao' => 'CRM_Financial_BAO_FinancialItem',
278 'pseudoconstant' => [
279 'optionGroupName' => 'financial_item_status',
280 'optionEditPath' => 'civicrm/admin/options/financial_item_status',
284 'name' => 'entity_table',
285 'type' => CRM_Utils_Type
::T_STRING
,
286 'title' => ts('Entity Table'),
287 'description' => ts('The table providing the source of this item such as civicrm_line_item'),
289 'size' => CRM_Utils_Type
::BIG
,
290 'where' => 'civicrm_financial_item.entity_table',
291 'table_name' => 'civicrm_financial_item',
292 'entity' => 'FinancialItem',
293 'bao' => 'CRM_Financial_BAO_FinancialItem',
297 'name' => 'entity_id',
298 'type' => CRM_Utils_Type
::T_INT
,
299 'title' => ts('Entity ID'),
300 'description' => ts('The specific source item that is responsible for the creation of this financial_item'),
301 'where' => 'civicrm_financial_item.entity_id',
302 'table_name' => 'civicrm_financial_item',
303 'entity' => 'FinancialItem',
304 'bao' => 'CRM_Financial_BAO_FinancialItem',
308 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
310 return Civi
::$statics[__CLASS__
]['fields'];
314 * Return a mapping from field-name to the corresponding key (as used in fields()).
317 * Array(string $name => string $uniqueName).
319 public static function &fieldKeys() {
320 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
321 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
323 return Civi
::$statics[__CLASS__
]['fieldKeys'];
327 * Returns the names of this table
331 public static function getTableName() {
332 return self
::$_tableName;
336 * Returns if this table needs to be logged
340 public function getLog() {
345 * Returns the list of fields that can be imported
347 * @param bool $prefix
351 public static function &import($prefix = FALSE) {
352 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'financial_item', $prefix, []);
357 * Returns the list of fields that can be exported
359 * @param bool $prefix
363 public static function &export($prefix = FALSE) {
364 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'financial_item', $prefix, []);
369 * Returns the list of indices
371 * @param bool $localize
375 public static function indices($localize = TRUE) {
377 'IX_created_date' => [
378 'name' => 'IX_created_date',
382 'localizable' => FALSE,
383 'sig' => 'civicrm_financial_item::0::created_date',
385 'IX_transaction_date' => [
386 'name' => 'IX_transaction_date',
388 0 => 'transaction_date',
390 'localizable' => FALSE,
391 'sig' => 'civicrm_financial_item::0::transaction_date',
393 'index_entity_id_entity_table' => [
394 'name' => 'index_entity_id_entity_table',
399 'localizable' => FALSE,
400 'sig' => 'civicrm_financial_item::0::entity_id::entity_table',
403 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;