This class supports the proprietary vBulletin forum system <http://www.vbulletin.com>, versions 3.5 and up. More...
Public Member Functions | |
| authenticate ($password) | |
| Is the given password valid for the external user? The password is provided in plaintext. | |
| getGroups () | |
| Return an array of identifiers for all the foreign groups that this user has. | |
| getId () | |
| This must return some identifier that stably, uniquely identifies the user. | |
| getName () | |
| This must return the name that the user would normally use for login to the external database. | |
| getPref ($pref) | |
| Retrieve the value corresponding to the given preference key. | |
Protected Member Functions | |
| initFromCookie () | |
| Try to magically initialize the user from cookies or similar information so he or she can be logged in on just viewing the wiki. | |
| initFromId ($id) | |
| Given an id, which was at some previous point in history returned by getId(), initialize this object to be the corresponding ExternalUser. | |
| initFromName ($name) | |
| Given a name, which is a string exactly as input by the user in the login form but with whitespace stripped, initialize this object to be the corresponding ExternalUser. | |
Private Member Functions | |
| getDb () | |
| getFields () | |
| initFromCond ($cond) | |
Private Attributes | |
| $mRow | |
Detailed Description
This class supports the proprietary vBulletin forum system <http://www.vbulletin.com>, versions 3.5 and up.
It calls no functions or code, only reads from the database. Example lines to put in LocalSettings.php:
$wgExternalAuthType = 'ExternalUser_vB'; $wgExternalAuthConf = array( 'server' => 'localhost', 'username' => 'forum', 'password' => 'udE,jSqDJ<""p=fI.K9', 'dbname' => 'forum', 'tablePrefix' => '', 'cookieprefix' => 'bb' );
Member Function Documentation
| ExternalUser_vB::authenticate | ( | $ | password | ) |
Is the given password valid for the external user? The password is provided in plaintext.
- Parameters:
-
$password string
- Returns:
- bool
Reimplemented from ExternalUser.
| ExternalUser_vB::getDb | ( | ) | [private] |
Definition at line 104 of file vB.php.
References $wgExternalAuthConf, and DatabaseBase\factory().
Referenced by initFromCond(), and initFromCookie().
| ExternalUser_vB::getFields | ( | ) | [private] |
Definition at line 117 of file vB.php.
Referenced by initFromCond(), and initFromCookie().
Return an array of identifiers for all the foreign groups that this user has.
The identifiers are opaque objects that only need to be specifiable by the administrator in LocalSettings.php when configuring $wgAutopromote. They may be, for instance, strings or integers.
TODO: Support this in $wgAutopromote.
- Returns:
- array
Reimplemented from ExternalUser.
This must return some identifier that stably, uniquely identifies the user.
In a typical web application, this could be an integer representing the "user id". In other cases, it might be a string. In any event, the return value should be a string between 1 and 255 characters in length; must uniquely identify the user in the foreign database; and, if at all possible, should be permanent.
This will only ever be used to reconstruct this ExternalUser object via newFromId(). The resulting object in that case should correspond to the same user, even if details have changed in the interim (e.g., renames or preference changes).
- Returns:
- string
Reimplemented from ExternalUser.
This must return the name that the user would normally use for login to the external database.
It is subject to no particular restrictions beyond rudimentary sanity, and in particular may be invalid as a MediaWiki username. It's used to auto-generate an account name that *is* valid for MediaWiki, either with or without user input, but basically is only a hint.
- Returns:
- string
Reimplemented from ExternalUser.
| ExternalUser_vB::getPref | ( | $ | pref | ) |
Retrieve the value corresponding to the given preference key.
The most important values are:
- emailaddress
- language
The value must meet MediaWiki's requirements for values of this type, and will be checked for validity before use. If the preference makes no sense for the backend, or it makes sense but is unset for this user, or is unrecognized, return null.
$pref will never equal 'password', since passwords are usually hashed and cannot be directly retrieved. authenticate() is used for this instead.
TODO: Currently this is only called for 'emailaddress'; generalize! Add some config option to decide which values are grabbed on user initialization.
- Parameters:
-
$pref string
- Returns:
- mixed
Reimplemented from ExternalUser.
| ExternalUser_vB::initFromCond | ( | $ | cond | ) | [private] |
Definition at line 87 of file vB.php.
References getDb(), and getFields().
Referenced by initFromId(), and initFromName().
| ExternalUser_vB::initFromCookie | ( | ) | [protected] |
Try to magically initialize the user from cookies or similar information so he or she can be logged in on just viewing the wiki.
If this is impossible to do, just return false.
TODO: Actually use this.
- Returns:
- bool Success?
Reimplemented from ExternalUser.
Definition at line 54 of file vB.php.
References $wgExternalAuthConf, getDb(), and getFields().
| ExternalUser_vB::initFromId | ( | $ | id | ) | [protected] |
Given an id, which was at some previous point in history returned by getId(), initialize this object to be the corresponding ExternalUser.
Return true if successful, false otherwise.
- Parameters:
-
$id string
- Returns:
- bool Success?
Reimplemented from ExternalUser.
Definition at line 50 of file vB.php.
References initFromCond().
| ExternalUser_vB::initFromName | ( | $ | name | ) | [protected] |
Given a name, which is a string exactly as input by the user in the login form but with whitespace stripped, initialize this object to be the corresponding ExternalUser.
Return true if successful, otherwise false.
- Parameters:
-
$name string
- Returns:
- bool Success?
Reimplemented from ExternalUser.
Definition at line 46 of file vB.php.
References initFromCond().
Member Data Documentation
The documentation for this class was generated from the following file:
- includes/extauth/vB.php
