CRM/Financial/DAO/EntityFinancialAccount.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/EntityFinancialAccount.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:46b680193ab75e97679a2521282b1cc0)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Financial_DAO_EntityFinancialAccount constructor.
  39  */
  40 class CRM_Financial_DAO_EntityFinancialAccount extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_entity_financial_account';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Links to an entity_table like civicrm_financial_type
  61    *
  62    * @var string
  63    */
  64   public $entity_table;
  65   /**
  66    * Links to an id in the entity_table, such as vid in civicrm_financial_type
  67    *
  68    * @var int unsigned
  69    */
  70   public $entity_id;
  71   /**
  72    * FK to a new civicrm_option_value (account_relationship)
  73    *
  74    * @var int unsigned
  75    */
  76   public $account_relationship;
  77   /**
  78    * FK to the financial_account_id
  79    *
  80    * @var int unsigned
  81    */
  82   public $financial_account_id;
  83   /**
  84    * Class constructor.
  85    */
  86   function __construct() {
  87     $this->__table = 'civicrm_entity_financial_account';
  88     parent::__construct();
  89   }
  90   /**
  91    * Returns foreign keys and entity references.
  92    *
  93    * @return array
  94    *   [CRM_Core_Reference_Interface]
  95    */
  96   static function getReferenceColumns() {
  97     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  98       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  99       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_account_id', 'civicrm_financial_account', 'id');
 100       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
 101       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 102     }
 103     return Civi::$statics[__CLASS__]['links'];
 104   }
 105   /**
 106    * Returns all the column names of this table
 107    *
 108    * @return array
 109    */
 110   static function &fields() {
 111     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 112       Civi::$statics[__CLASS__]['fields'] = array(
 113         'id' => array(
 114           'name' => 'id',
 115           'type' => CRM_Utils_Type::T_INT,
 116           'title' => ts('Entity Financial Account ID') ,
 117           'description' => 'ID',
 118           'required' => true,
 119           'table_name' => 'civicrm_entity_financial_account',
 120           'entity' => 'EntityFinancialAccount',
 121           'bao' => 'CRM_Financial_DAO_EntityFinancialAccount',
 122         ) ,
 123         'entity_table' => array(
 124           'name' => 'entity_table',
 125           'type' => CRM_Utils_Type::T_STRING,
 126           'title' => ts('Entity Table') ,
 127           'description' => 'Links to an entity_table like civicrm_financial_type',
 128           'required' => true,
 129           'maxlength' => 64,
 130           'size' => CRM_Utils_Type::BIG,
 131           'import' => true,
 132           'where' => 'civicrm_entity_financial_account.entity_table',
 133           'headerPattern' => '',
 134           'dataPattern' => '',
 135           'export' => true,
 136           'table_name' => 'civicrm_entity_financial_account',
 137           'entity' => 'EntityFinancialAccount',
 138           'bao' => 'CRM_Financial_DAO_EntityFinancialAccount',
 139         ) ,
 140         'entity_id' => array(
 141           'name' => 'entity_id',
 142           'type' => CRM_Utils_Type::T_INT,
 143           'title' => ts('Entity ID') ,
 144           'description' => 'Links to an id in the entity_table, such as vid in civicrm_financial_type',
 145           'required' => true,
 146           'table_name' => 'civicrm_entity_financial_account',
 147           'entity' => 'EntityFinancialAccount',
 148           'bao' => 'CRM_Financial_DAO_EntityFinancialAccount',
 149         ) ,
 150         'account_relationship' => array(
 151           'name' => 'account_relationship',
 152           'type' => CRM_Utils_Type::T_INT,
 153           'title' => ts('Account Relationship') ,
 154           'description' => 'FK to a new civicrm_option_value (account_relationship)',
 155           'required' => true,
 156           'table_name' => 'civicrm_entity_financial_account',
 157           'entity' => 'EntityFinancialAccount',
 158           'bao' => 'CRM_Financial_DAO_EntityFinancialAccount',
 159           'html' => array(
 160             'type' => 'Select',
 161           ) ,
 162           'pseudoconstant' => array(
 163             'optionGroupName' => 'account_relationship',
 164             'optionEditPath' => 'civicrm/admin/options/account_relationship',
 165           )
 166         ) ,
 167         'financial_account_id' => array(
 168           'name' => 'financial_account_id',
 169           'type' => CRM_Utils_Type::T_INT,
 170           'title' => ts('Financial Account') ,
 171           'description' => 'FK to the financial_account_id',
 172           'required' => true,
 173           'table_name' => 'civicrm_entity_financial_account',
 174           'entity' => 'EntityFinancialAccount',
 175           'bao' => 'CRM_Financial_DAO_EntityFinancialAccount',
 176           'FKClassName' => 'CRM_Financial_DAO_FinancialAccount',
 177           'html' => array(
 178             'type' => 'Select',
 179           ) ,
 180           'pseudoconstant' => array(
 181             'table' => 'civicrm_financial_account',
 182             'keyColumn' => 'id',
 183             'labelColumn' => 'name',
 184           )
 185         ) ,
 186       );
 187       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 188     }
 189     return Civi::$statics[__CLASS__]['fields'];
 190   }
 191   /**
 192    * Return a mapping from field-name to the corresponding key (as used in fields()).
 193    *
 194    * @return array
 195    *   Array(string $name => string $uniqueName).
 196    */
 197   static function &fieldKeys() {
 198     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 199       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 200     }
 201     return Civi::$statics[__CLASS__]['fieldKeys'];
 202   }
 203   /**
 204    * Returns the names of this table
 205    *
 206    * @return string
 207    */
 208   static function getTableName() {
 209     return self::$_tableName;
 210   }
 211   /**
 212    * Returns if this table needs to be logged
 213    *
 214    * @return boolean
 215    */
 216   function getLog() {
 217     return self::$_log;
 218   }
 219   /**
 220    * Returns the list of fields that can be imported
 221    *
 222    * @param bool $prefix
 223    *
 224    * @return array
 225    */
 226   static function &import($prefix = false) {
 227     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_financial_account', $prefix, array());
 228     return $r;
 229   }
 230   /**
 231    * Returns the list of fields that can be exported
 232    *
 233    * @param bool $prefix
 234    *
 235    * @return array
 236    */
 237   static function &export($prefix = false) {
 238     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_financial_account', $prefix, array());
 239     return $r;
 240   }
 241 }