CRM/Core/DAO/StateProvince.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/StateProvince.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:abd329da6e7801c901c3c97c1b09ef59)
  10  */
  11
  12 /**
  13  * Database access object for the StateProvince entity.
  14  */
  15 class CRM_Core_DAO_StateProvince 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_state_province';
  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    * State/Province ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Name of State/Province
  42    *
  43    * @var string
  44    */
  45   public $name;
  46
  47   /**
  48    * 2-4 Character Abbreviation of State/Province
  49    *
  50    * @var string
  51    */
  52   public $abbreviation;
  53
  54   /**
  55    * ID of Country that State/Province belong
  56    *
  57    * @var int
  58    */
  59   public $country_id;
  60
  61   /**
  62    * Class constructor.
  63    */
  64   public function __construct() {
  65     $this->__table = 'civicrm_state_province';
  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('States/Provinces') : ts('State/Province');
  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(), 'country_id', 'civicrm_country', '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('State ID'),
 106           'description' => ts('State/Province ID'),
 107           'required' => TRUE,
 108           'where' => 'civicrm_state_province.id',
 109           'table_name' => 'civicrm_state_province',
 110           'entity' => 'StateProvince',
 111           'bao' => 'CRM_Core_DAO_StateProvince',
 112           'localizable' => 0,
 113           'add' => '1.1',
 114         ],
 115         'name' => [
 116           'name' => 'name',
 117           'type' => CRM_Utils_Type::T_STRING,
 118           'title' => ts('State'),
 119           'description' => ts('Name of State/Province'),
 120           'maxlength' => 64,
 121           'size' => CRM_Utils_Type::BIG,
 122           'import' => TRUE,
 123           'where' => 'civicrm_state_province.name',
 124           'headerPattern' => '/state|prov(ince)?/i',
 125           'dataPattern' => '/[A-Z]{2}/',
 126           'export' => TRUE,
 127           'table_name' => 'civicrm_state_province',
 128           'entity' => 'StateProvince',
 129           'bao' => 'CRM_Core_DAO_StateProvince',
 130           'localizable' => 0,
 131           'add' => '1.1',
 132         ],
 133         'abbreviation' => [
 134           'name' => 'abbreviation',
 135           'type' => CRM_Utils_Type::T_STRING,
 136           'title' => ts('State Abbreviation'),
 137           'description' => ts('2-4 Character Abbreviation of State/Province'),
 138           'maxlength' => 4,
 139           'size' => CRM_Utils_Type::FOUR,
 140           'where' => 'civicrm_state_province.abbreviation',
 141           'table_name' => 'civicrm_state_province',
 142           'entity' => 'StateProvince',
 143           'bao' => 'CRM_Core_DAO_StateProvince',
 144           'localizable' => 0,
 145           'add' => '1.1',
 146         ],
 147         'country_id' => [
 148           'name' => 'country_id',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('Country'),
 151           'description' => ts('ID of Country that State/Province belong'),
 152           'required' => TRUE,
 153           'where' => 'civicrm_state_province.country_id',
 154           'table_name' => 'civicrm_state_province',
 155           'entity' => 'StateProvince',
 156           'bao' => 'CRM_Core_DAO_StateProvince',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Core_DAO_Country',
 159           'add' => '1.1',
 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   /**
 168    * Return a mapping from field-name to the corresponding key (as used in fields()).
 169    *
 170    * @return array
 171    *   Array(string $name => string $uniqueName).
 172    */
 173   public static function &fieldKeys() {
 174     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 175       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 176     }
 177     return Civi::$statics[__CLASS__]['fieldKeys'];
 178   }
 179
 180   /**
 181    * Returns the names of this table
 182    *
 183    * @return string
 184    */
 185   public static function getTableName() {
 186     return self::$_tableName;
 187   }
 188
 189   /**
 190    * Returns if this table needs to be logged
 191    *
 192    * @return bool
 193    */
 194   public function getLog() {
 195     return self::$_log;
 196   }
 197
 198   /**
 199    * Returns the list of fields that can be imported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   public static function &import($prefix = FALSE) {
 206     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'state_province', $prefix, []);
 207     return $r;
 208   }
 209
 210   /**
 211    * Returns the list of fields that can be exported
 212    *
 213    * @param bool $prefix
 214    *
 215    * @return array
 216    */
 217   public static function &export($prefix = FALSE) {
 218     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'state_province', $prefix, []);
 219     return $r;
 220   }
 221
 222   /**
 223    * Returns the list of indices
 224    *
 225    * @param bool $localize
 226    *
 227    * @return array
 228    */
 229   public static function indices($localize = TRUE) {
 230     $indices = [
 231       'UI_name_country_id' => [
 232         'name' => 'UI_name_country_id',
 233         'field' => [
 234           0 => 'name',
 235           1 => 'country_id',
 236         ],
 237         'localizable' => FALSE,
 238         'unique' => TRUE,
 239         'sig' => 'civicrm_state_province::1::name::country_id',
 240       ],
 241     ];
 242     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 243   }
 244
 245 }