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:d99e943649a1c2db96c2111d7feeeec2)
  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    * Field to show when displaying a record.
  28    *
  29    * @var string
  30    */
  31   public static $_labelField = 'name';
  32
  33   /**
  34    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  35    *
  36    * @var bool
  37    */
  38   public static $_log = FALSE;
  39
  40   /**
  41    * State/Province ID
  42    *
  43    * @var int
  44    */
  45   public $id;
  46
  47   /**
  48    * Name of State/Province
  49    *
  50    * @var string
  51    */
  52   public $name;
  53
  54   /**
  55    * 2-4 Character Abbreviation of State/Province
  56    *
  57    * @var string
  58    */
  59   public $abbreviation;
  60
  61   /**
  62    * ID of Country that State/Province belong
  63    *
  64    * @var int
  65    */
  66   public $country_id;
  67
  68   /**
  69    * Is this StateProvince active?
  70    *
  71    * @var bool
  72    */
  73   public $is_active;
  74
  75   /**
  76    * Class constructor.
  77    */
  78   public function __construct() {
  79     $this->__table = 'civicrm_state_province';
  80     parent::__construct();
  81   }
  82
  83   /**
  84    * Returns localized title of this entity.
  85    *
  86    * @param bool $plural
  87    *   Whether to return the plural version of the title.
  88    */
  89   public static function getEntityTitle($plural = FALSE) {
  90     return $plural ? ts('States/Provinces') : ts('State/Province');
  91   }
  92
  93   /**
  94    * Returns foreign keys and entity references.
  95    *
  96    * @return array
  97    *   [CRM_Core_Reference_Interface]
  98    */
  99   public static function getReferenceColumns() {
 100     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 101       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 102       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'country_id', 'civicrm_country', 'id');
 103       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 104     }
 105     return Civi::$statics[__CLASS__]['links'];
 106   }
 107
 108   /**
 109    * Returns all the column names of this table
 110    *
 111    * @return array
 112    */
 113   public static function &fields() {
 114     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 115       Civi::$statics[__CLASS__]['fields'] = [
 116         'id' => [
 117           'name' => 'id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('State ID'),
 120           'description' => ts('State/Province ID'),
 121           'required' => TRUE,
 122           'where' => 'civicrm_state_province.id',
 123           'table_name' => 'civicrm_state_province',
 124           'entity' => 'StateProvince',
 125           'bao' => 'CRM_Core_DAO_StateProvince',
 126           'localizable' => 0,
 127           'html' => [
 128             'type' => 'Number',
 129           ],
 130           'readonly' => TRUE,
 131           'add' => '1.1',
 132         ],
 133         'name' => [
 134           'name' => 'name',
 135           'type' => CRM_Utils_Type::T_STRING,
 136           'title' => ts('State'),
 137           'description' => ts('Name of State/Province'),
 138           'maxlength' => 64,
 139           'size' => CRM_Utils_Type::BIG,
 140           'import' => TRUE,
 141           'where' => 'civicrm_state_province.name',
 142           'headerPattern' => '/state|prov(ince)?/i',
 143           'dataPattern' => '/[A-Z]{2}/',
 144           'export' => TRUE,
 145           'table_name' => 'civicrm_state_province',
 146           'entity' => 'StateProvince',
 147           'bao' => 'CRM_Core_DAO_StateProvince',
 148           'localizable' => 0,
 149           'add' => '1.1',
 150         ],
 151         'abbreviation' => [
 152           'name' => 'abbreviation',
 153           'type' => CRM_Utils_Type::T_STRING,
 154           'title' => ts('State Abbreviation'),
 155           'description' => ts('2-4 Character Abbreviation of State/Province'),
 156           'maxlength' => 4,
 157           'size' => CRM_Utils_Type::FOUR,
 158           'where' => 'civicrm_state_province.abbreviation',
 159           'table_name' => 'civicrm_state_province',
 160           'entity' => 'StateProvince',
 161           'bao' => 'CRM_Core_DAO_StateProvince',
 162           'localizable' => 0,
 163           'add' => '1.1',
 164         ],
 165         'country_id' => [
 166           'name' => 'country_id',
 167           'type' => CRM_Utils_Type::T_INT,
 168           'title' => ts('Country ID'),
 169           'description' => ts('ID of Country that State/Province belong'),
 170           'required' => TRUE,
 171           'where' => 'civicrm_state_province.country_id',
 172           'table_name' => 'civicrm_state_province',
 173           'entity' => 'StateProvince',
 174           'bao' => 'CRM_Core_DAO_StateProvince',
 175           'localizable' => 0,
 176           'FKClassName' => 'CRM_Core_DAO_Country',
 177           'html' => [
 178             'label' => ts("Country"),
 179           ],
 180           'add' => '1.1',
 181         ],
 182         'is_active' => [
 183           'name' => 'is_active',
 184           'type' => CRM_Utils_Type::T_BOOLEAN,
 185           'title' => ts('StateProvince Is Active'),
 186           'description' => ts('Is this StateProvince active?'),
 187           'where' => 'civicrm_state_province.is_active',
 188           'default' => '1',
 189           'table_name' => 'civicrm_state_province',
 190           'entity' => 'StateProvince',
 191           'bao' => 'CRM_Core_DAO_StateProvince',
 192           'localizable' => 0,
 193           'add' => '5.35',
 194         ],
 195       ];
 196       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 197     }
 198     return Civi::$statics[__CLASS__]['fields'];
 199   }
 200
 201   /**
 202    * Return a mapping from field-name to the corresponding key (as used in fields()).
 203    *
 204    * @return array
 205    *   Array(string $name => string $uniqueName).
 206    */
 207   public static function &fieldKeys() {
 208     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 209       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 210     }
 211     return Civi::$statics[__CLASS__]['fieldKeys'];
 212   }
 213
 214   /**
 215    * Returns the names of this table
 216    *
 217    * @return string
 218    */
 219   public static function getTableName() {
 220     return self::$_tableName;
 221   }
 222
 223   /**
 224    * Returns if this table needs to be logged
 225    *
 226    * @return bool
 227    */
 228   public function getLog() {
 229     return self::$_log;
 230   }
 231
 232   /**
 233    * Returns the list of fields that can be imported
 234    *
 235    * @param bool $prefix
 236    *
 237    * @return array
 238    */
 239   public static function &import($prefix = FALSE) {
 240     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'state_province', $prefix, []);
 241     return $r;
 242   }
 243
 244   /**
 245    * Returns the list of fields that can be exported
 246    *
 247    * @param bool $prefix
 248    *
 249    * @return array
 250    */
 251   public static function &export($prefix = FALSE) {
 252     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'state_province', $prefix, []);
 253     return $r;
 254   }
 255
 256   /**
 257    * Returns the list of indices
 258    *
 259    * @param bool $localize
 260    *
 261    * @return array
 262    */
 263   public static function indices($localize = TRUE) {
 264     $indices = [
 265       'UI_name_country_id' => [
 266         'name' => 'UI_name_country_id',
 267         'field' => [
 268           0 => 'name',
 269           1 => 'country_id',
 270         ],
 271         'localizable' => FALSE,
 272         'unique' => TRUE,
 273         'sig' => 'civicrm_state_province::1::name::country_id',
 274       ],
 275     ];
 276     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 277   }
 278
 279 }