CRM/Core/DAO/OpenID.php

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