CRM/Core/DAO/OpenID.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2016
  30  *
  31  * Generated from xml/schema/CRM/Core/OpenID.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:3efcaf2616702a4f0de774761beea36b)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_OpenID extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_openid';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    * Unique OpenID ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * FK to Contact ID
  59    *
  60    * @var int unsigned
  61    */
  62   public $contact_id;
  63   /**
  64    * Which Location does this email belong to.
  65    *
  66    * @var int unsigned
  67    */
  68   public $location_type_id;
  69   /**
  70    * the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM
  71    *
  72    * @var string
  73    */
  74   public $openid;
  75   /**
  76    * Whether or not this user is allowed to login
  77    *
  78    * @var boolean
  79    */
  80   public $allowed_to_login;
  81   /**
  82    * Is this the primary email for this contact and location.
  83    *
  84    * @var boolean
  85    */
  86   public $is_primary;
  87   /**
  88    * class constructor
  89    *
  90    * @return civicrm_openid
  91    */
  92   function __construct() {
  93     $this->__table = 'civicrm_openid';
  94     parent::__construct();
  95   }
  96   /**
  97    * Returns foreign keys and entity references
  98    *
  99    * @return array
 100    *   [CRM_Core_Reference_Interface]
 101    */
 102   static function getReferenceColumns() {
 103     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 104       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 105       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 106       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 107     }
 108     return Civi::$statics[__CLASS__]['links'];
 109   }
 110   /**
 111    * Returns all the column names of this table
 112    *
 113    * @return array
 114    */
 115   static function &fields() {
 116     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 117       Civi::$statics[__CLASS__]['fields'] = array(
 118         'id' => array(
 119           'name' => 'id',
 120           'type' => CRM_Utils_Type::T_INT,
 121           'title' => ts('Open ID identifier') ,
 122           'description' => 'Unique OpenID ID',
 123           'required' => true,
 124         ) ,
 125         'contact_id' => array(
 126           'name' => 'contact_id',
 127           'type' => CRM_Utils_Type::T_INT,
 128           'title' => ts('OpenID Contact') ,
 129           'description' => 'FK to Contact ID',
 130           'FKClassName' => 'CRM_Contact_DAO_Contact',
 131         ) ,
 132         'location_type_id' => array(
 133           'name' => 'location_type_id',
 134           'type' => CRM_Utils_Type::T_INT,
 135           'title' => ts('OpenID Location Type') ,
 136           'description' => 'Which Location does this email belong to.',
 137         ) ,
 138         'openid' => array(
 139           'name' => 'openid',
 140           'type' => CRM_Utils_Type::T_STRING,
 141           'title' => ts('OpenID') ,
 142           'description' => 'the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM',
 143           'maxlength' => 255,
 144           'size' => CRM_Utils_Type::HUGE,
 145           'import' => true,
 146           'where' => 'civicrm_openid.openid',
 147           'headerPattern' => '/^Open.?ID|u(niq\w*)?.?ID/i',
 148           'dataPattern' => '/^[\w\/\:\.]+$/',
 149           'export' => true,
 150           'rule' => 'url',
 151         ) ,
 152         'allowed_to_login' => array(
 153           'name' => 'allowed_to_login',
 154           'type' => CRM_Utils_Type::T_BOOLEAN,
 155           'title' => ts('Allowed to login?') ,
 156           'description' => 'Whether or not this user is allowed to login',
 157           'required' => true,
 158         ) ,
 159         'is_primary' => array(
 160           'name' => 'is_primary',
 161           'type' => CRM_Utils_Type::T_BOOLEAN,
 162           'title' => ts('Is OpenID Primary?') ,
 163           'description' => 'Is this the primary email for this contact and location.',
 164         ) ,
 165       );
 166       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 167     }
 168     return Civi::$statics[__CLASS__]['fields'];
 169   }
 170   /**
 171    * Return a mapping from field-name to the corresponding key (as used in fields()).
 172    *
 173    * @return array
 174    *   Array(string $name => string $uniqueName).
 175    */
 176   static function &fieldKeys() {
 177     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 178       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 179     }
 180     return Civi::$statics[__CLASS__]['fieldKeys'];
 181   }
 182   /**
 183    * Returns the names of this table
 184    *
 185    * @return string
 186    */
 187   static function getTableName() {
 188     return self::$_tableName;
 189   }
 190   /**
 191    * Returns if this table needs to be logged
 192    *
 193    * @return boolean
 194    */
 195   function getLog() {
 196     return self::$_log;
 197   }
 198   /**
 199    * Returns the list of fields that can be imported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   static function &import($prefix = false) {
 206     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'openid', $prefix, array());
 207     return $r;
 208   }
 209   /**
 210    * Returns the list of fields that can be exported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   static function &export($prefix = false) {
 217     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'openid', $prefix, array());
 218     return $r;
 219   }
 220 }