CRM/Core/DAO/County.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/County.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:5620d2136c764c786eef1c15853eaf9b)
  10  */
  11
  12 /**
  13  * Database access object for the County entity.
  14  */
  15 class CRM_Core_DAO_County extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.1';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_county';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * County ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Name of County
  42    *
  43    * @var string
  44    */
  45   public $name;
  46
  47   /**
  48    * 2-4 Character Abbreviation of County
  49    *
  50    * @var string
  51    */
  52   public $abbreviation;
  53
  54   /**
  55    * ID of State/Province that County belongs
  56    *
  57    * @var int
  58    */
  59   public $state_province_id;
  60
  61   /**
  62    * Class constructor.
  63    */
  64   public function __construct() {
  65     $this->__table = 'civicrm_county';
  66     parent::__construct();
  67   }
  68
  69   /**
  70    * Returns localized title of this entity.
  71    *
  72    * @param bool $plural
  73    *   Whether to return the plural version of the title.
  74    */
  75   public static function getEntityTitle($plural = FALSE) {
  76     return $plural ? ts('Counties') : ts('County');
  77   }
  78
  79   /**
  80    * Returns foreign keys and entity references.
  81    *
  82    * @return array
  83    *   [CRM_Core_Reference_Interface]
  84    */
  85   public static function getReferenceColumns() {
  86     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  87       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'state_province_id', 'civicrm_state_province', 'id');
  89       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  90     }
  91     return Civi::$statics[__CLASS__]['links'];
  92   }
  93
  94   /**
  95    * Returns all the column names of this table
  96    *
  97    * @return array
  98    */
  99   public static function &fields() {
 100     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 101       Civi::$statics[__CLASS__]['fields'] = [
 102         'id' => [
 103           'name' => 'id',
 104           'type' => CRM_Utils_Type::T_INT,
 105           'title' => ts('County ID'),
 106           'description' => ts('County ID'),
 107           'required' => TRUE,
 108           'where' => 'civicrm_county.id',
 109           'table_name' => 'civicrm_county',
 110           'entity' => 'County',
 111           'bao' => 'CRM_Core_DAO_County',
 112           'localizable' => 0,
 113           'add' => '1.1',
 114         ],
 115         'name' => [
 116           'name' => 'name',
 117           'type' => CRM_Utils_Type::T_STRING,
 118           'title' => ts('County'),
 119           'description' => ts('Name of County'),
 120           'maxlength' => 64,
 121           'size' => CRM_Utils_Type::BIG,
 122           'import' => TRUE,
 123           'where' => 'civicrm_county.name',
 124           'headerPattern' => '/county/i',
 125           'dataPattern' => '/[A-Z]{2}/',
 126           'export' => TRUE,
 127           'table_name' => 'civicrm_county',
 128           'entity' => 'County',
 129           'bao' => 'CRM_Core_DAO_County',
 130           'localizable' => 0,
 131           'add' => '1.1',
 132         ],
 133         'abbreviation' => [
 134           'name' => 'abbreviation',
 135           'type' => CRM_Utils_Type::T_STRING,
 136           'title' => ts('County Abbreviation'),
 137           'description' => ts('2-4 Character Abbreviation of County'),
 138           'maxlength' => 4,
 139           'size' => CRM_Utils_Type::FOUR,
 140           'where' => 'civicrm_county.abbreviation',
 141           'table_name' => 'civicrm_county',
 142           'entity' => 'County',
 143           'bao' => 'CRM_Core_DAO_County',
 144           'localizable' => 0,
 145           'add' => '1.1',
 146         ],
 147         'state_province_id' => [
 148           'name' => 'state_province_id',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('State'),
 151           'description' => ts('ID of State/Province that County belongs'),
 152           'required' => TRUE,
 153           'where' => 'civicrm_county.state_province_id',
 154           'table_name' => 'civicrm_county',
 155           'entity' => 'County',
 156           'bao' => 'CRM_Core_DAO_County',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Core_DAO_StateProvince',
 159           'pseudoconstant' => [
 160             'table' => 'civicrm_state_province',
 161             'keyColumn' => 'id',
 162             'labelColumn' => 'name',
 163           ],
 164           'add' => '1.1',
 165         ],
 166       ];
 167       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 168     }
 169     return Civi::$statics[__CLASS__]['fields'];
 170   }
 171
 172   /**
 173    * Return a mapping from field-name to the corresponding key (as used in fields()).
 174    *
 175    * @return array
 176    *   Array(string $name => string $uniqueName).
 177    */
 178   public static function &fieldKeys() {
 179     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 180       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 181     }
 182     return Civi::$statics[__CLASS__]['fieldKeys'];
 183   }
 184
 185   /**
 186    * Returns the names of this table
 187    *
 188    * @return string
 189    */
 190   public static function getTableName() {
 191     return self::$_tableName;
 192   }
 193
 194   /**
 195    * Returns if this table needs to be logged
 196    *
 197    * @return bool
 198    */
 199   public function getLog() {
 200     return self::$_log;
 201   }
 202
 203   /**
 204    * Returns the list of fields that can be imported
 205    *
 206    * @param bool $prefix
 207    *
 208    * @return array
 209    */
 210   public static function &import($prefix = FALSE) {
 211     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'county', $prefix, []);
 212     return $r;
 213   }
 214
 215   /**
 216    * Returns the list of fields that can be exported
 217    *
 218    * @param bool $prefix
 219    *
 220    * @return array
 221    */
 222   public static function &export($prefix = FALSE) {
 223     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'county', $prefix, []);
 224     return $r;
 225   }
 226
 227   /**
 228    * Returns the list of indices
 229    *
 230    * @param bool $localize
 231    *
 232    * @return array
 233    */
 234   public static function indices($localize = TRUE) {
 235     $indices = [
 236       'UI_name_state_id' => [
 237         'name' => 'UI_name_state_id',
 238         'field' => [
 239           0 => 'name',
 240           1 => 'state_province_id',
 241         ],
 242         'localizable' => FALSE,
 243         'unique' => TRUE,
 244         'sig' => 'civicrm_county::1::name::state_province_id',
 245       ],
 246     ];
 247     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 248   }
 249
 250 }