CRM/Core/DAO/Worldregion.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/Worldregion.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:710a568363468092ddc0fc7d1b14abd1)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_Worldregion extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_worldregion';
  44   /**
  45    * static instance to hold the field values
  46    *
  47    * @var array
  48    */
  49   static $_fields = null;
  50   /**
  51    * static instance to hold the FK relationships
  52    *
  53    * @var string
  54    */
  55   static $_links = null;
  56   /**
  57    * static value to see if we should log any modifications to
  58    * this table in the civicrm_log table
  59    *
  60    * @var boolean
  61    */
  62   static $_log = false;
  63   /**
  64    * Country Id
  65    *
  66    * @var int unsigned
  67    */
  68   public $id;
  69   /**
  70    * Region name to be associated with countries
  71    *
  72    * @var string
  73    */
  74   public $name;
  75   /**
  76    * class constructor
  77    *
  78    * @return civicrm_worldregion
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_worldregion';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns all the column names of this table
  86    *
  87    * @return array
  88    */
  89   static function &fields() {
  90     if (!(self::$_fields)) {
  91       self::$_fields = array(
  92         'id' => array(
  93           'name' => 'id',
  94           'type' => CRM_Utils_Type::T_INT,
  95           'title' => ts('World Region ID') ,
  96           'description' => 'Country Id',
  97           'required' => true,
  98         ) ,
  99         'world_region' => array(
 100           'name' => 'name',
 101           'type' => CRM_Utils_Type::T_STRING,
 102           'title' => ts('World Region') ,
 103           'description' => 'Region name to be associated with countries',
 104           'maxlength' => 128,
 105           'size' => CRM_Utils_Type::HUGE,
 106           'export' => true,
 107           'where' => 'civicrm_worldregion.name',
 108           'headerPattern' => '',
 109           'dataPattern' => '',
 110         ) ,
 111       );
 112     }
 113     return self::$_fields;
 114   }
 115   /**
 116    * Return a mapping from field-name to the corresponding key (as used in fields()).
 117    *
 118    * @return array
 119    *   Array(string $name => string $uniqueName).
 120    */
 121   static function &fieldKeys() {
 122     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 123       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 124     }
 125     return Civi::$statics[__CLASS__]['fieldKeys'];
 126   }
 127   /**
 128    * Returns the names of this table
 129    *
 130    * @return string
 131    */
 132   static function getTableName() {
 133     return self::$_tableName;
 134   }
 135   /**
 136    * Returns if this table needs to be logged
 137    *
 138    * @return boolean
 139    */
 140   function getLog() {
 141     return self::$_log;
 142   }
 143   /**
 144    * Returns the list of fields that can be imported
 145    *
 146    * @param bool $prefix
 147    *
 148    * @return array
 149    */
 150   static function &import($prefix = false) {
 151     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'worldregion', $prefix, array());
 152     return $r;
 153   }
 154   /**
 155    * Returns the list of fields that can be exported
 156    *
 157    * @param bool $prefix
 158    *
 159    * @return array
 160    */
 161   static function &export($prefix = false) {
 162     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'worldregion', $prefix, array());
 163     return $r;
 164   }
 165 }