CRM/Financial/DAO/EntityFinancialTrxn.php

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