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