CRM/Financial/DAO/Currency.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/Currency.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:901761be1a81c165e690e7cafe8fe419)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Financial_DAO_Currency constructor.
  39  */
  40 class CRM_Financial_DAO_Currency extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_currency';
  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    * Currency Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Currency Name
  61    *
  62    * @var string
  63    */
  64   public $name;
  65   /**
  66    * Currency Symbol
  67    *
  68    * @var string
  69    */
  70   public $symbol;
  71   /**
  72    * Numeric currency code
  73    *
  74    * @var string
  75    */
  76   public $numeric_code;
  77   /**
  78    * Full currency name
  79    *
  80    * @var string
  81    */
  82   public $full_name;
  83   /**
  84    * Class constructor.
  85    */
  86   function __construct() {
  87     $this->__table = 'civicrm_currency';
  88     parent::__construct();
  89   }
  90   /**
  91    * Returns all the column names of this table
  92    *
  93    * @return array
  94    */
  95   static function &fields() {
  96     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  97       Civi::$statics[__CLASS__]['fields'] = array(
  98         'id' => array(
  99           'name' => 'id',
 100           'type' => CRM_Utils_Type::T_INT,
 101           'title' => ts('Currency ID') ,
 102           'description' => 'Currency Id',
 103           'required' => true,
 104           'table_name' => 'civicrm_currency',
 105           'entity' => 'Currency',
 106           'bao' => 'CRM_Financial_DAO_Currency',
 107         ) ,
 108         'name' => array(
 109           'name' => 'name',
 110           'type' => CRM_Utils_Type::T_STRING,
 111           'title' => ts('Currency') ,
 112           'description' => 'Currency Name',
 113           'maxlength' => 64,
 114           'size' => CRM_Utils_Type::BIG,
 115           'import' => true,
 116           'where' => 'civicrm_currency.name',
 117           'headerPattern' => '',
 118           'dataPattern' => '',
 119           'export' => true,
 120           'table_name' => 'civicrm_currency',
 121           'entity' => 'Currency',
 122           'bao' => 'CRM_Financial_DAO_Currency',
 123           'html' => array(
 124             'type' => 'Text',
 125           ) ,
 126         ) ,
 127         'symbol' => array(
 128           'name' => 'symbol',
 129           'type' => CRM_Utils_Type::T_STRING,
 130           'title' => ts('Currency Symbol') ,
 131           'description' => 'Currency Symbol',
 132           'maxlength' => 8,
 133           'size' => CRM_Utils_Type::EIGHT,
 134           'table_name' => 'civicrm_currency',
 135           'entity' => 'Currency',
 136           'bao' => 'CRM_Financial_DAO_Currency',
 137           'html' => array(
 138             'type' => 'Text',
 139           ) ,
 140         ) ,
 141         'numeric_code' => array(
 142           'name' => 'numeric_code',
 143           'type' => CRM_Utils_Type::T_STRING,
 144           'title' => ts('Currency Numeric Code') ,
 145           'description' => 'Numeric currency code',
 146           'maxlength' => 3,
 147           'size' => CRM_Utils_Type::FOUR,
 148           'import' => true,
 149           'where' => 'civicrm_currency.numeric_code',
 150           'headerPattern' => '',
 151           'dataPattern' => '',
 152           'export' => true,
 153           'table_name' => 'civicrm_currency',
 154           'entity' => 'Currency',
 155           'bao' => 'CRM_Financial_DAO_Currency',
 156         ) ,
 157         'full_name' => array(
 158           'name' => 'full_name',
 159           'type' => CRM_Utils_Type::T_STRING,
 160           'title' => ts('Full Currency Name') ,
 161           'description' => 'Full currency name',
 162           'maxlength' => 64,
 163           'size' => CRM_Utils_Type::BIG,
 164           'table_name' => 'civicrm_currency',
 165           'entity' => 'Currency',
 166           'bao' => 'CRM_Financial_DAO_Currency',
 167           'html' => array(
 168             'type' => 'Text',
 169           ) ,
 170         ) ,
 171       );
 172       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 173     }
 174     return Civi::$statics[__CLASS__]['fields'];
 175   }
 176   /**
 177    * Return a mapping from field-name to the corresponding key (as used in fields()).
 178    *
 179    * @return array
 180    *   Array(string $name => string $uniqueName).
 181    */
 182   static function &fieldKeys() {
 183     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 184       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 185     }
 186     return Civi::$statics[__CLASS__]['fieldKeys'];
 187   }
 188   /**
 189    * Returns the names of this table
 190    *
 191    * @return string
 192    */
 193   static function getTableName() {
 194     return self::$_tableName;
 195   }
 196   /**
 197    * Returns if this table needs to be logged
 198    *
 199    * @return boolean
 200    */
 201   function getLog() {
 202     return self::$_log;
 203   }
 204   /**
 205    * Returns the list of fields that can be imported
 206    *
 207    * @param bool $prefix
 208    *
 209    * @return array
 210    */
 211   static function &import($prefix = false) {
 212     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'currency', $prefix, array());
 213     return $r;
 214   }
 215   /**
 216    * Returns the list of fields that can be exported
 217    *
 218    * @param bool $prefix
 219    *
 220    * @return array
 221    */
 222   static function &export($prefix = false) {
 223     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'currency', $prefix, array());
 224     return $r;
 225   }
 226 }