CRM/Core/DAO/Timezone.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/Core/Timezone.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:0f44e0b7202cc3ace2ec6b7003fc941a)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_Timezone constructor.
  39  */
  40 class CRM_Core_DAO_Timezone extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_timezone';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    * Timezone Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Timezone full name
  61    *
  62    * @var string
  63    */
  64   public $name;
  65   /**
  66    * ISO Code for timezone abbreviation
  67    *
  68    * @var string
  69    */
  70   public $abbreviation;
  71   /**
  72    * GMT name of the timezone
  73    *
  74    * @var string
  75    */
  76   public $gmt;
  77   /**
  78    *
  79    * @var int
  80    */
  81   public $offset;
  82   /**
  83    * Country Id
  84    *
  85    * @var int unsigned
  86    */
  87   public $country_id;
  88   /**
  89    * Class constructor.
  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           'table_name' => 'civicrm_timezone',
 124           'entity' => 'Timezone',
 125           'bao' => 'CRM_Core_DAO_Timezone',
 126           'localizable' => 0,
 127         ) ,
 128         'name' => array(
 129           'name' => 'name',
 130           'type' => CRM_Utils_Type::T_STRING,
 131           'title' => ts('Timezone Name') ,
 132           'description' => 'Timezone full name',
 133           'maxlength' => 64,
 134           'size' => CRM_Utils_Type::BIG,
 135           'table_name' => 'civicrm_timezone',
 136           'entity' => 'Timezone',
 137           'bao' => 'CRM_Core_DAO_Timezone',
 138           'localizable' => 0,
 139         ) ,
 140         'abbreviation' => array(
 141           'name' => 'abbreviation',
 142           'type' => CRM_Utils_Type::T_STRING,
 143           'title' => ts('Timezone Abbreviation') ,
 144           'description' => 'ISO Code for timezone abbreviation',
 145           'maxlength' => 3,
 146           'size' => CRM_Utils_Type::FOUR,
 147           'table_name' => 'civicrm_timezone',
 148           'entity' => 'Timezone',
 149           'bao' => 'CRM_Core_DAO_Timezone',
 150           'localizable' => 0,
 151         ) ,
 152         'gmt' => array(
 153           'name' => 'gmt',
 154           'type' => CRM_Utils_Type::T_STRING,
 155           'title' => ts('GMT Name of Timezone') ,
 156           'description' => 'GMT name of the timezone',
 157           'maxlength' => 64,
 158           'size' => CRM_Utils_Type::BIG,
 159           'table_name' => 'civicrm_timezone',
 160           'entity' => 'Timezone',
 161           'bao' => 'CRM_Core_DAO_Timezone',
 162           'localizable' => 0,
 163         ) ,
 164         'offset' => array(
 165           'name' => 'offset',
 166           'type' => CRM_Utils_Type::T_INT,
 167           'title' => ts('GMT Offset') ,
 168           'table_name' => 'civicrm_timezone',
 169           'entity' => 'Timezone',
 170           'bao' => 'CRM_Core_DAO_Timezone',
 171           'localizable' => 0,
 172         ) ,
 173         'country_id' => array(
 174           'name' => 'country_id',
 175           'type' => CRM_Utils_Type::T_INT,
 176           'title' => ts('Country') ,
 177           'description' => 'Country Id',
 178           'required' => true,
 179           'table_name' => 'civicrm_timezone',
 180           'entity' => 'Timezone',
 181           'bao' => 'CRM_Core_DAO_Timezone',
 182           'localizable' => 0,
 183           'FKClassName' => 'CRM_Core_DAO_Country',
 184         ) ,
 185       );
 186       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 187     }
 188     return Civi::$statics[__CLASS__]['fields'];
 189   }
 190   /**
 191    * Return a mapping from field-name to the corresponding key (as used in fields()).
 192    *
 193    * @return array
 194    *   Array(string $name => string $uniqueName).
 195    */
 196   static function &fieldKeys() {
 197     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 198       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 199     }
 200     return Civi::$statics[__CLASS__]['fieldKeys'];
 201   }
 202   /**
 203    * Returns the names of this table
 204    *
 205    * @return string
 206    */
 207   static function getTableName() {
 208     return self::$_tableName;
 209   }
 210   /**
 211    * Returns if this table needs to be logged
 212    *
 213    * @return boolean
 214    */
 215   function getLog() {
 216     return self::$_log;
 217   }
 218   /**
 219    * Returns the list of fields that can be imported
 220    *
 221    * @param bool $prefix
 222    *
 223    * @return array
 224    */
 225   static function &import($prefix = false) {
 226     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'timezone', $prefix, array());
 227     return $r;
 228   }
 229   /**
 230    * Returns the list of fields that can be exported
 231    *
 232    * @param bool $prefix
 233    *
 234    * @return array
 235    */
 236   static function &export($prefix = false) {
 237     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'timezone', $prefix, array());
 238     return $r;
 239   }
 240   /**
 241    * Returns the list of indices
 242    */
 243   public static function indices($localize = TRUE) {
 244     $indices = array();
 245     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 246   }
 247 }