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