summaryrefslogtreecommitdiff
path: root/includes/AuthPlugin.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/AuthPlugin.php')
-rw-r--r--includes/AuthPlugin.php82
1 files changed, 52 insertions, 30 deletions
diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php
index 7717e001..b29e13f2 100644
--- a/includes/AuthPlugin.php
+++ b/includes/AuthPlugin.php
@@ -38,9 +38,8 @@ class AuthPlugin {
*
* @param $username String: username.
* @return bool
- * @public
*/
- function userExists( $username ) {
+ public function userExists( $username ) {
# Override this!
return false;
}
@@ -54,9 +53,8 @@ class AuthPlugin {
* @param $username String: username.
* @param $password String: user password.
* @return bool
- * @public
*/
- function authenticate( $username, $password ) {
+ public function authenticate( $username, $password ) {
# Override this!
return false;
}
@@ -65,9 +63,8 @@ class AuthPlugin {
* Modify options in the login template.
*
* @param $template UserLoginTemplate object.
- * @public
*/
- function modifyUITemplate( &$template ) {
+ public function modifyUITemplate( &$template ) {
# Override this!
$template->set( 'usedomain', false );
}
@@ -76,9 +73,8 @@ class AuthPlugin {
* Set the domain this plugin is supposed to use when authenticating.
*
* @param $domain String: authentication domain.
- * @public
*/
- function setDomain( $domain ) {
+ public function setDomain( $domain ) {
$this->domain = $domain;
}
@@ -87,9 +83,8 @@ class AuthPlugin {
*
* @param $domain String: authentication domain.
* @return bool
- * @public
*/
- function validDomain( $domain ) {
+ public function validDomain( $domain ) {
# Override this!
return true;
}
@@ -103,9 +98,8 @@ class AuthPlugin {
* forget the & on your function declaration.
*
* @param User $user
- * @public
*/
- function updateUser( &$user ) {
+ public function updateUser( &$user ) {
# Override this and do something
return true;
}
@@ -123,9 +117,8 @@ class AuthPlugin {
* This is just a question, and shouldn't perform any actions.
*
* @return bool
- * @public
*/
- function autoCreate() {
+ public function autoCreate() {
return false;
}
@@ -134,7 +127,7 @@ class AuthPlugin {
*
* @return bool
*/
- function allowPasswordChange() {
+ public function allowPasswordChange() {
return true;
}
@@ -149,9 +142,8 @@ class AuthPlugin {
* @param $user User object.
* @param $password String: password.
* @return bool
- * @public
*/
- function setPassword( $user, $password ) {
+ public function setPassword( $user, $password ) {
return true;
}
@@ -161,9 +153,8 @@ class AuthPlugin {
*
* @param $user User object.
* @return bool
- * @public
*/
- function updateExternalDB( $user ) {
+ public function updateExternalDB( $user ) {
return true;
}
@@ -171,9 +162,8 @@ class AuthPlugin {
* Check to see if external accounts can be created.
* Return true if external accounts can be created.
* @return bool
- * @public
*/
- function canCreateAccounts() {
+ public function canCreateAccounts() {
return false;
}
@@ -186,9 +176,8 @@ class AuthPlugin {
* @param string $email
* @param string $realname
* @return bool
- * @public
*/
- function addUser( $user, $password, $email='', $realname='' ) {
+ public function addUser( $user, $password, $email='', $realname='' ) {
return true;
}
@@ -200,9 +189,8 @@ class AuthPlugin {
* This is just a question, and shouldn't perform any actions.
*
* @return bool
- * @public
*/
- function strict() {
+ public function strict() {
return false;
}
@@ -212,9 +200,8 @@ class AuthPlugin {
*
* @param $username String: username.
* @return bool
- * @public
*/
- function strictUserAuth( $username ) {
+ public function strictUserAuth( $username ) {
return false;
}
@@ -228,9 +215,8 @@ class AuthPlugin {
*
* @param $user User object.
* @param $autocreate bool True if user is being autocreated on login
- * @public
*/
- function initUser( &$user, $autocreate=false ) {
+ public function initUser( &$user, $autocreate=false ) {
# Override this to do something.
}
@@ -238,7 +224,43 @@ class AuthPlugin {
* If you want to munge the case of an account name before the final
* check, now is your chance.
*/
- function getCanonicalName( $username ) {
+ public function getCanonicalName( $username ) {
return $username;
}
+
+ /**
+ * Get an instance of a User object
+ *
+ * @param $user User
+ * @public
+ */
+ public function getUserInstance( User &$user ) {
+ return new AuthPluginUser( $user );
+ }
+}
+
+class AuthPluginUser {
+ function __construct( $user ) {
+ # Override this!
+ }
+
+ public function getId() {
+ # Override this!
+ return -1;
+ }
+
+ public function isLocked() {
+ # Override this!
+ return false;
+ }
+
+ public function isHidden() {
+ # Override this!
+ return false;
+ }
+
+ public function resetAuthToken() {
+ # Override this!
+ return true;
+ }
}