CRM/Core/DAO/OpenID.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/OpenID.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:0e8f41d1f528dfadc08d7f53610948ca)
  10  */
  11
  12 /**
  13  * Database access object for the OpenID entity.
  14  */
  15 class CRM_Core_DAO_OpenID extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '2.0';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_openid';
  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    * Unique OpenID ID
  35    *
  36    * @var int|string|null
  37    *   (SQL type: int unsigned)
  38    *   Note that values will be retrieved from the database as a string.
  39    */
  40   public $id;
  41
  42   /**
  43    * FK to Contact ID
  44    *
  45    * @var int|string|null
  46    *   (SQL type: int unsigned)
  47    *   Note that values will be retrieved from the database as a string.
  48    */
  49   public $contact_id;
  50
  51   /**
  52    * Which Location does this email belong to.
  53    *
  54    * @var int|string|null
  55    *   (SQL type: int unsigned)
  56    *   Note that values will be retrieved from the database as a string.
  57    */
  58   public $location_type_id;
  59
  60   /**
  61    * the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM
  62    *
  63    * @var string|null
  64    *   (SQL type: varchar(255))
  65    *   Note that values will be retrieved from the database as a string.
  66    */
  67   public $openid;
  68
  69   /**
  70    * Whether or not this user is allowed to login
  71    *
  72    * @var bool|string
  73    *   (SQL type: tinyint)
  74    *   Note that values will be retrieved from the database as a string.
  75    */
  76   public $allowed_to_login;
  77
  78   /**
  79    * Is this the primary email for this contact and location.
  80    *
  81    * @var bool|string|null
  82    *   (SQL type: tinyint)
  83    *   Note that values will be retrieved from the database as a string.
  84    */
  85   public $is_primary;
  86
  87   /**
  88    * Class constructor.
  89    */
  90   public function __construct() {
  91     $this->__table = 'civicrm_openid';
  92     parent::__construct();
  93   }
  94
  95   /**
  96    * Returns localized title of this entity.
  97    *
  98    * @param bool $plural
  99    *   Whether to return the plural version of the title.
 100    */
 101   public static function getEntityTitle($plural = FALSE) {
 102     return $plural ? ts('Open IDs') : ts('Open ID');
 103   }
 104
 105   /**
 106    * Returns foreign keys and entity references.
 107    *
 108    * @return array
 109    *   [CRM_Core_Reference_Interface]
 110    */
 111   public static function getReferenceColumns() {
 112     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 113       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 114       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
 115       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 116     }
 117     return Civi::$statics[__CLASS__]['links'];
 118   }
 119
 120   /**
 121    * Returns all the column names of this table
 122    *
 123    * @return array
 124    */
 125   public static function &fields() {
 126     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 127       Civi::$statics[__CLASS__]['fields'] = [
 128         'id' => [
 129           'name' => 'id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Open ID identifier'),
 132           'description' => ts('Unique OpenID ID'),
 133           'required' => TRUE,
 134           'where' => 'civicrm_openid.id',
 135           'table_name' => 'civicrm_openid',
 136           'entity' => 'OpenID',
 137           'bao' => 'CRM_Core_BAO_OpenID',
 138           'localizable' => 0,
 139           'html' => [
 140             'type' => 'Number',
 141           ],
 142           'readonly' => TRUE,
 143           'add' => '2.0',
 144         ],
 145         'contact_id' => [
 146           'name' => 'contact_id',
 147           'type' => CRM_Utils_Type::T_INT,
 148           'title' => ts('Contact ID'),
 149           'description' => ts('FK to Contact ID'),
 150           'where' => 'civicrm_openid.contact_id',
 151           'table_name' => 'civicrm_openid',
 152           'entity' => 'OpenID',
 153           'bao' => 'CRM_Core_BAO_OpenID',
 154           'localizable' => 0,
 155           'FKClassName' => 'CRM_Contact_DAO_Contact',
 156           'html' => [
 157             'label' => ts("Contact"),
 158           ],
 159           'add' => '2.0',
 160         ],
 161         'location_type_id' => [
 162           'name' => 'location_type_id',
 163           'type' => CRM_Utils_Type::T_INT,
 164           'title' => ts('OpenID Location Type'),
 165           'description' => ts('Which Location does this email belong to.'),
 166           'where' => 'civicrm_openid.location_type_id',
 167           'table_name' => 'civicrm_openid',
 168           'entity' => 'OpenID',
 169           'bao' => 'CRM_Core_BAO_OpenID',
 170           'localizable' => 0,
 171           'pseudoconstant' => [
 172             'table' => 'civicrm_location_type',
 173             'keyColumn' => 'id',
 174             'labelColumn' => 'display_name',
 175           ],
 176           'add' => '2.0',
 177         ],
 178         'openid' => [
 179           'name' => 'openid',
 180           'type' => CRM_Utils_Type::T_STRING,
 181           'title' => ts('OpenID'),
 182           'description' => ts('the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM'),
 183           'maxlength' => 255,
 184           'size' => CRM_Utils_Type::HUGE,
 185           'import' => TRUE,
 186           'where' => 'civicrm_openid.openid',
 187           'headerPattern' => '/^Open.?ID|u(niq\w*)?.?ID/i',
 188           'dataPattern' => '/^[\w\/\:\.]+$/',
 189           'export' => TRUE,
 190           'rule' => 'url',
 191           'table_name' => 'civicrm_openid',
 192           'entity' => 'OpenID',
 193           'bao' => 'CRM_Core_BAO_OpenID',
 194           'localizable' => 0,
 195           'add' => '2.0',
 196         ],
 197         'allowed_to_login' => [
 198           'name' => 'allowed_to_login',
 199           'type' => CRM_Utils_Type::T_BOOLEAN,
 200           'title' => ts('Allowed to login?'),
 201           'description' => ts('Whether or not this user is allowed to login'),
 202           'required' => TRUE,
 203           'where' => 'civicrm_openid.allowed_to_login',
 204           'default' => '0',
 205           'table_name' => 'civicrm_openid',
 206           'entity' => 'OpenID',
 207           'bao' => 'CRM_Core_BAO_OpenID',
 208           'localizable' => 0,
 209           'add' => '2.0',
 210         ],
 211         'is_primary' => [
 212           'name' => 'is_primary',
 213           'type' => CRM_Utils_Type::T_BOOLEAN,
 214           'title' => ts('Primary ID'),
 215           'description' => ts('Is this the primary email for this contact and location.'),
 216           'where' => 'civicrm_openid.is_primary',
 217           'default' => '0',
 218           'table_name' => 'civicrm_openid',
 219           'entity' => 'OpenID',
 220           'bao' => 'CRM_Core_BAO_OpenID',
 221           'localizable' => 0,
 222           'html' => [
 223             'type' => 'Radio',
 224           ],
 225           'add' => '2.0',
 226         ],
 227       ];
 228       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 229     }
 230     return Civi::$statics[__CLASS__]['fields'];
 231   }
 232
 233   /**
 234    * Return a mapping from field-name to the corresponding key (as used in fields()).
 235    *
 236    * @return array
 237    *   Array(string $name => string $uniqueName).
 238    */
 239   public static function &fieldKeys() {
 240     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 241       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 242     }
 243     return Civi::$statics[__CLASS__]['fieldKeys'];
 244   }
 245
 246   /**
 247    * Returns the names of this table
 248    *
 249    * @return string
 250    */
 251   public static function getTableName() {
 252     return self::$_tableName;
 253   }
 254
 255   /**
 256    * Returns if this table needs to be logged
 257    *
 258    * @return bool
 259    */
 260   public function getLog() {
 261     return self::$_log;
 262   }
 263
 264   /**
 265    * Returns the list of fields that can be imported
 266    *
 267    * @param bool $prefix
 268    *
 269    * @return array
 270    */
 271   public static function &import($prefix = FALSE) {
 272     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'openid', $prefix, []);
 273     return $r;
 274   }
 275
 276   /**
 277    * Returns the list of fields that can be exported
 278    *
 279    * @param bool $prefix
 280    *
 281    * @return array
 282    */
 283   public static function &export($prefix = FALSE) {
 284     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'openid', $prefix, []);
 285     return $r;
 286   }
 287
 288   /**
 289    * Returns the list of indices
 290    *
 291    * @param bool $localize
 292    *
 293    * @return array
 294    */
 295   public static function indices($localize = TRUE) {
 296     $indices = [
 297       'index_location_type' => [
 298         'name' => 'index_location_type',
 299         'field' => [
 300           0 => 'location_type_id',
 301         ],
 302         'localizable' => FALSE,
 303         'sig' => 'civicrm_openid::0::location_type_id',
 304       ],
 305       'UI_openid' => [
 306         'name' => 'UI_openid',
 307         'field' => [
 308           0 => 'openid',
 309         ],
 310         'localizable' => FALSE,
 311         'unique' => TRUE,
 312         'sig' => 'civicrm_openid::1::openid',
 313       ],
 314     ];
 315     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 316   }
 317
 318 }