CRM/Financial/DAO/EntityFinancialTrxn.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   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
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Financial/EntityFinancialTrxn.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:42848b82aaf63e76e1848ea1a6dbd4b2)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Financial_DAO_EntityFinancialTrxn extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_entity_financial_trxn';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    * ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * May contain civicrm_financial_item, civicrm_contribution, civicrm_financial_trxn, civicrm_grant, etc
  59    *
  60    * @var string
  61    */
  62   public $entity_table;
  63   /**
  64    *
  65    * @var int unsigned
  66    */
  67   public $entity_id;
  68   /**
  69    *
  70    * @var int unsigned
  71    */
  72   public $financial_trxn_id;
  73   /**
  74    * allocated amount of transaction to this entity
  75    *
  76    * @var float
  77    */
  78   public $amount;
  79   /**
  80    * class constructor
  81    *
  82    * @return civicrm_entity_financial_trxn
  83    */
  84   function __construct() {
  85     $this->__table = 'civicrm_entity_financial_trxn';
  86     parent::__construct();
  87   }
  88   /**
  89    * Returns foreign keys and entity references
  90    *
  91    * @return array
  92    *   [CRM_Core_Reference_Interface]
  93    */
  94   static function getReferenceColumns() {
  95     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  96       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  97       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_trxn_id', 'civicrm_financial_trxn', 'id');
  98       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
  99       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 100     }
 101     return Civi::$statics[__CLASS__]['links'];
 102   }
 103   /**
 104    * Returns all the column names of this table
 105    *
 106    * @return array
 107    */
 108   static function &fields() {
 109     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 110       Civi::$statics[__CLASS__]['fields'] = array(
 111         'id' => array(
 112           'name' => 'id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Entity Financial Transaction ID') ,
 115           'description' => 'ID',
 116           'required' => true,
 117         ) ,
 118         'entity_table' => array(
 119           'name' => 'entity_table',
 120           'type' => CRM_Utils_Type::T_STRING,
 121           'title' => ts('Entity Table') ,
 122           'description' => 'May contain civicrm_financial_item, civicrm_contribution, civicrm_financial_trxn, civicrm_grant, etc',
 123           'required' => true,
 124           'maxlength' => 64,
 125           'size' => CRM_Utils_Type::BIG,
 126           'import' => true,
 127           'where' => 'civicrm_entity_financial_trxn.entity_table',
 128           'headerPattern' => '',
 129           'dataPattern' => '',
 130           'export' => true,
 131         ) ,
 132         'entity_id' => array(
 133           'name' => 'entity_id',
 134           'type' => CRM_Utils_Type::T_INT,
 135           'title' => ts('Entity ID') ,
 136           'required' => true,
 137         ) ,
 138         'financial_trxn_id' => array(
 139           'name' => 'financial_trxn_id',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Financial Transaction Id') ,
 142           'FKClassName' => 'CRM_Financial_DAO_FinancialTrxn',
 143         ) ,
 144         'amount' => array(
 145           'name' => 'amount',
 146           'type' => CRM_Utils_Type::T_MONEY,
 147           'title' => ts('Amount') ,
 148           'description' => 'allocated amount of transaction to this entity',
 149           'required' => true,
 150           'precision' => array(
 151             20,
 152             2
 153           ) ,
 154           'import' => true,
 155           'where' => 'civicrm_entity_financial_trxn.amount',
 156           'headerPattern' => '/amount/i',
 157           'dataPattern' => '/^\d+(\.\d{2})?$/',
 158           'export' => true,
 159         ) ,
 160       );
 161       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 162     }
 163     return Civi::$statics[__CLASS__]['fields'];
 164   }
 165   /**
 166    * Return a mapping from field-name to the corresponding key (as used in fields()).
 167    *
 168    * @return array
 169    *   Array(string $name => string $uniqueName).
 170    */
 171   static function &fieldKeys() {
 172     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 173       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 174     }
 175     return Civi::$statics[__CLASS__]['fieldKeys'];
 176   }
 177   /**
 178    * Returns the names of this table
 179    *
 180    * @return string
 181    */
 182   static function getTableName() {
 183     return self::$_tableName;
 184   }
 185   /**
 186    * Returns if this table needs to be logged
 187    *
 188    * @return boolean
 189    */
 190   function getLog() {
 191     return self::$_log;
 192   }
 193   /**
 194    * Returns the list of fields that can be imported
 195    *
 196    * @param bool $prefix
 197    *
 198    * @return array
 199    */
 200   static function &import($prefix = false) {
 201     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_financial_trxn', $prefix, array());
 202     return $r;
 203   }
 204   /**
 205    * Returns the list of fields that can be exported
 206    *
 207    * @param bool $prefix
 208    *
 209    * @return array
 210    */
 211   static function &export($prefix = false) {
 212     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_financial_trxn', $prefix, array());
 213     return $r;
 214   }
 215 }