CRM/Financial/DAO/FinancialItem.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Financial/FinancialItem.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:95e199969f4ff93ccae635fb7e0d30f2)
  10  */
  11
  12 /**
  13  * Database access object for the FinancialItem entity.
  14  */
  15 class CRM_Financial_DAO_FinancialItem extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_financial_item';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   static $_log = TRUE;
  30
  31   /**
  32    * @var int unsigned
  33    */
  34   public $id;
  35
  36   /**
  37    * Date and time the item was created
  38    *
  39    * @var timestamp
  40    */
  41   public $created_date;
  42
  43   /**
  44    * Date and time of the source transaction
  45    *
  46    * @var datetime
  47    */
  48   public $transaction_date;
  49
  50   /**
  51    * FK to Contact ID of contact the item is from
  52    *
  53    * @var int unsigned
  54    */
  55   public $contact_id;
  56
  57   /**
  58    * Human readable description of this item, to ease display without lookup of source item.
  59    *
  60    * @var string
  61    */
  62   public $description;
  63
  64   /**
  65    * Total amount of this item
  66    *
  67    * @var float
  68    */
  69   public $amount;
  70
  71   /**
  72    * Currency for the amount
  73    *
  74    * @var string
  75    */
  76   public $currency;
  77
  78   /**
  79    * FK to civicrm_financial_account
  80    *
  81    * @var int unsigned
  82    */
  83   public $financial_account_id;
  84
  85   /**
  86    * Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)
  87    *
  88    * @var int unsigned
  89    */
  90   public $status_id;
  91
  92   /**
  93    * The table providing the source of this item such as civicrm_line_item
  94    *
  95    * @var string
  96    */
  97   public $entity_table;
  98
  99   /**
 100    * The specific source item that is responsible for the creation of this financial_item
 101    *
 102    * @var int unsigned
 103    */
 104   public $entity_id;
 105
 106   /**
 107    * Class constructor.
 108    */
 109   public function __construct() {
 110     $this->__table = 'civicrm_financial_item';
 111     parent::__construct();
 112   }
 113
 114   /**
 115    * Returns foreign keys and entity references.
 116    *
 117    * @return array
 118    *   [CRM_Core_Reference_Interface]
 119    */
 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']);
 127     }
 128     return Civi::$statics[__CLASS__]['links'];
 129   }
 130
 131   /**
 132    * Returns all the column names of this table
 133    *
 134    * @return array
 135    */
 136   public static function &fields() {
 137     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 138       Civi::$statics[__CLASS__]['fields'] = [
 139         'id' => [
 140           'name' => 'id',
 141           'type' => CRM_Utils_Type::T_INT,
 142           'title' => ts('Financial Item ID'),
 143           'required' => TRUE,
 144           'table_name' => 'civicrm_financial_item',
 145           'entity' => 'FinancialItem',
 146           'bao' => 'CRM_Financial_BAO_FinancialItem',
 147           'localizable' => 0,
 148         ],
 149         'created_date' => [
 150           'name' => 'created_date',
 151           'type' => CRM_Utils_Type::T_TIMESTAMP,
 152           'title' => ts('Financial Item Created Date'),
 153           'description' => 'Date and time the item was created',
 154           'required' => TRUE,
 155           'default' => 'CURRENT_TIMESTAMP',
 156           'table_name' => 'civicrm_financial_item',
 157           'entity' => 'FinancialItem',
 158           'bao' => 'CRM_Financial_BAO_FinancialItem',
 159           'localizable' => 0,
 160         ],
 161         'transaction_date' => [
 162           'name' => 'transaction_date',
 163           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 164           'title' => ts('Financial Item Transaction Date'),
 165           'description' => 'Date and time of the source transaction',
 166           'required' => TRUE,
 167           'table_name' => 'civicrm_financial_item',
 168           'entity' => 'FinancialItem',
 169           'bao' => 'CRM_Financial_BAO_FinancialItem',
 170           'localizable' => 0,
 171         ],
 172         'contact_id' => [
 173           'name' => 'contact_id',
 174           'type' => CRM_Utils_Type::T_INT,
 175           'title' => ts('Financial Item Contact ID'),
 176           'description' => 'FK to Contact ID of contact the item is from',
 177           'required' => TRUE,
 178           'export' => TRUE,
 179           'where' => 'civicrm_financial_item.contact_id',
 180           'headerPattern' => '',
 181           'dataPattern' => '',
 182           'table_name' => 'civicrm_financial_item',
 183           'entity' => 'FinancialItem',
 184           'bao' => 'CRM_Financial_BAO_FinancialItem',
 185           'localizable' => 0,
 186           'FKClassName' => 'CRM_Contact_DAO_Contact',
 187         ],
 188         'description' => [
 189           'name' => 'description',
 190           'type' => CRM_Utils_Type::T_STRING,
 191           'title' => ts('Financial Item Description'),
 192           'description' => 'Human readable description of this item, to ease display without lookup of source item.',
 193           'maxlength' => 255,
 194           'size' => CRM_Utils_Type::HUGE,
 195           'table_name' => 'civicrm_financial_item',
 196           'entity' => 'FinancialItem',
 197           'bao' => 'CRM_Financial_BAO_FinancialItem',
 198           'localizable' => 0,
 199         ],
 200         'amount' => [
 201           'name' => 'amount',
 202           'type' => CRM_Utils_Type::T_MONEY,
 203           'title' => ts('Amount'),
 204           'description' => 'Total amount of this item',
 205           'required' => TRUE,
 206           'precision' => [
 207             20,
 208             2
 209           ],
 210           'table_name' => 'civicrm_financial_item',
 211           'entity' => 'FinancialItem',
 212           'bao' => 'CRM_Financial_BAO_FinancialItem',
 213           'localizable' => 0,
 214         ],
 215         'currency' => [
 216           'name' => 'currency',
 217           'type' => CRM_Utils_Type::T_STRING,
 218           'title' => ts('Financial Item Currency'),
 219           'description' => 'Currency for the amount',
 220           'maxlength' => 3,
 221           'size' => CRM_Utils_Type::FOUR,
 222           'export' => TRUE,
 223           'where' => 'civicrm_financial_item.currency',
 224           'headerPattern' => '',
 225           'dataPattern' => '',
 226           'table_name' => 'civicrm_financial_item',
 227           'entity' => 'FinancialItem',
 228           'bao' => 'CRM_Financial_BAO_FinancialItem',
 229           'localizable' => 0,
 230           'html' => [
 231             'type' => 'Select',
 232           ],
 233           'pseudoconstant' => [
 234             'table' => 'civicrm_currency',
 235             'keyColumn' => 'name',
 236             'labelColumn' => 'full_name',
 237             'nameColumn' => 'name',
 238           ]
 239         ],
 240         'financial_account_id' => [
 241           'name' => 'financial_account_id',
 242           'type' => CRM_Utils_Type::T_INT,
 243           'title' => ts('Financial Account ID'),
 244           'description' => 'FK to civicrm_financial_account',
 245           'table_name' => 'civicrm_financial_item',
 246           'entity' => 'FinancialItem',
 247           'bao' => 'CRM_Financial_BAO_FinancialItem',
 248           'localizable' => 0,
 249           'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
 250           'html' => [
 251             'type' => 'Select',
 252           ],
 253           'pseudoconstant' => [
 254             'table' => 'civicrm_financial_account',
 255             'keyColumn' => 'id',
 256             'labelColumn' => 'name',
 257           ]
 258         ],
 259         'status_id' => [
 260           'name' => 'status_id',
 261           'type' => CRM_Utils_Type::T_INT,
 262           'title' => ts('Financial Item Status ID'),
 263           'description' => 'Payment status: test, paid, part_paid, unpaid (if empty assume unpaid)',
 264           'export' => TRUE,
 265           'where' => 'civicrm_financial_item.status_id',
 266           'headerPattern' => '',
 267           'dataPattern' => '',
 268           'table_name' => 'civicrm_financial_item',
 269           'entity' => 'FinancialItem',
 270           'bao' => 'CRM_Financial_BAO_FinancialItem',
 271           'localizable' => 0,
 272           'html' => [
 273             'type' => 'Select',
 274           ],
 275           'pseudoconstant' => [
 276             'optionGroupName' => 'financial_item_status',
 277             'optionEditPath' => 'civicrm/admin/options/financial_item_status',
 278           ]
 279         ],
 280         'entity_table' => [
 281           'name' => 'entity_table',
 282           'type' => CRM_Utils_Type::T_STRING,
 283           'title' => ts('Entity Table'),
 284           'description' => 'The table providing the source of this item such as civicrm_line_item',
 285           'maxlength' => 64,
 286           'size' => CRM_Utils_Type::BIG,
 287           'table_name' => 'civicrm_financial_item',
 288           'entity' => 'FinancialItem',
 289           'bao' => 'CRM_Financial_BAO_FinancialItem',
 290           'localizable' => 0,
 291         ],
 292         'entity_id' => [
 293           'name' => 'entity_id',
 294           'type' => CRM_Utils_Type::T_INT,
 295           'title' => ts('Entity ID'),
 296           'description' => 'The specific source item that is responsible for the creation of this financial_item',
 297           'table_name' => 'civicrm_financial_item',
 298           'entity' => 'FinancialItem',
 299           'bao' => 'CRM_Financial_BAO_FinancialItem',
 300           'localizable' => 0,
 301         ],
 302       ];
 303       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 304     }
 305     return Civi::$statics[__CLASS__]['fields'];
 306   }
 307
 308   /**
 309    * Return a mapping from field-name to the corresponding key (as used in fields()).
 310    *
 311    * @return array
 312    *   Array(string $name => string $uniqueName).
 313    */
 314   public static function &fieldKeys() {
 315     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 316       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 317     }
 318     return Civi::$statics[__CLASS__]['fieldKeys'];
 319   }
 320
 321   /**
 322    * Returns the names of this table
 323    *
 324    * @return string
 325    */
 326   public static function getTableName() {
 327     return self::$_tableName;
 328   }
 329
 330   /**
 331    * Returns if this table needs to be logged
 332    *
 333    * @return bool
 334    */
 335   public function getLog() {
 336     return self::$_log;
 337   }
 338
 339   /**
 340    * Returns the list of fields that can be imported
 341    *
 342    * @param bool $prefix
 343    *
 344    * @return array
 345    */
 346   public static function &import($prefix = FALSE) {
 347     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'financial_item', $prefix, []);
 348     return $r;
 349   }
 350
 351   /**
 352    * Returns the list of fields that can be exported
 353    *
 354    * @param bool $prefix
 355    *
 356    * @return array
 357    */
 358   public static function &export($prefix = FALSE) {
 359     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'financial_item', $prefix, []);
 360     return $r;
 361   }
 362
 363   /**
 364    * Returns the list of indices
 365    *
 366    * @param bool $localize
 367    *
 368    * @return array
 369    */
 370   public static function indices($localize = TRUE) {
 371     $indices = [
 372       'IX_created_date' => [
 373         'name' => 'IX_created_date',
 374         'field' => [
 375           0 => 'created_date',
 376         ],
 377         'localizable' => FALSE,
 378         'sig' => 'civicrm_financial_item::0::created_date',
 379       ],
 380       'IX_transaction_date' => [
 381         'name' => 'IX_transaction_date',
 382         'field' => [
 383           0 => 'transaction_date',
 384         ],
 385         'localizable' => FALSE,
 386         'sig' => 'civicrm_financial_item::0::transaction_date',
 387       ],
 388       'index_entity_id_entity_table' => [
 389         'name' => 'index_entity_id_entity_table',
 390         'field' => [
 391           0 => 'entity_id',
 392           1 => 'entity_table',
 393         ],
 394         'localizable' => FALSE,
 395         'sig' => 'civicrm_financial_item::0::entity_id::entity_table',
 396       ],
 397     ];
 398     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 399   }
 400
 401 }