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