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:8cf9dbd2493448f02e1173d686b98fbb)
  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           'localizable' => 0,
 108         ) ,
 109         'name' => array(
 110           'name' => 'name',
 111           'type' => CRM_Utils_Type::T_STRING,
 112           'title' => ts('Currency') ,
 113           'description' => 'Currency Name',
 114           'maxlength' => 64,
 115           'size' => CRM_Utils_Type::BIG,
 116           'import' => true,
 117           'where' => 'civicrm_currency.name',
 118           'headerPattern' => '',
 119           'dataPattern' => '',
 120           'export' => true,
 121           'table_name' => 'civicrm_currency',
 122           'entity' => 'Currency',
 123           'bao' => 'CRM_Financial_DAO_Currency',
 124           'localizable' => 0,
 125           'html' => array(
 126             'type' => 'Text',
 127           ) ,
 128         ) ,
 129         'symbol' => array(
 130           'name' => 'symbol',
 131           'type' => CRM_Utils_Type::T_STRING,
 132           'title' => ts('Currency Symbol') ,
 133           'description' => 'Currency Symbol',
 134           'maxlength' => 8,
 135           'size' => CRM_Utils_Type::EIGHT,
 136           'table_name' => 'civicrm_currency',
 137           'entity' => 'Currency',
 138           'bao' => 'CRM_Financial_DAO_Currency',
 139           'localizable' => 0,
 140           'html' => array(
 141             'type' => 'Text',
 142           ) ,
 143         ) ,
 144         'numeric_code' => array(
 145           'name' => 'numeric_code',
 146           'type' => CRM_Utils_Type::T_STRING,
 147           'title' => ts('Currency Numeric Code') ,
 148           'description' => 'Numeric currency code',
 149           'maxlength' => 3,
 150           'size' => CRM_Utils_Type::FOUR,
 151           'import' => true,
 152           'where' => 'civicrm_currency.numeric_code',
 153           'headerPattern' => '',
 154           'dataPattern' => '',
 155           'export' => true,
 156           'table_name' => 'civicrm_currency',
 157           'entity' => 'Currency',
 158           'bao' => 'CRM_Financial_DAO_Currency',
 159           'localizable' => 0,
 160         ) ,
 161         'full_name' => array(
 162           'name' => 'full_name',
 163           'type' => CRM_Utils_Type::T_STRING,
 164           'title' => ts('Full Currency Name') ,
 165           'description' => 'Full currency name',
 166           'maxlength' => 64,
 167           'size' => CRM_Utils_Type::BIG,
 168           'table_name' => 'civicrm_currency',
 169           'entity' => 'Currency',
 170           'bao' => 'CRM_Financial_DAO_Currency',
 171           'localizable' => 0,
 172           'html' => array(
 173             'type' => 'Text',
 174           ) ,
 175         ) ,
 176       );
 177       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 178     }
 179     return Civi::$statics[__CLASS__]['fields'];
 180   }
 181   /**
 182    * Return a mapping from field-name to the corresponding key (as used in fields()).
 183    *
 184    * @return array
 185    *   Array(string $name => string $uniqueName).
 186    */
 187   static function &fieldKeys() {
 188     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 189       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 190     }
 191     return Civi::$statics[__CLASS__]['fieldKeys'];
 192   }
 193   /**
 194    * Returns the names of this table
 195    *
 196    * @return string
 197    */
 198   static function getTableName() {
 199     return self::$_tableName;
 200   }
 201   /**
 202    * Returns if this table needs to be logged
 203    *
 204    * @return boolean
 205    */
 206   function getLog() {
 207     return self::$_log;
 208   }
 209   /**
 210    * Returns the list of fields that can be imported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   static function &import($prefix = false) {
 217     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'currency', $prefix, array());
 218     return $r;
 219   }
 220   /**
 221    * Returns the list of fields that can be exported
 222    *
 223    * @param bool $prefix
 224    *
 225    * @return array
 226    */
 227   static function &export($prefix = false) {
 228     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'currency', $prefix, array());
 229     return $r;
 230   }
 231   /**
 232    * Returns the list of indices
 233    */
 234   public static function indices($localize = TRUE) {
 235     $indices = array();
 236     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 237   }
 238 }