summaryrefslogtreecommitdiff
path: root/includes/AuthPlugin.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/AuthPlugin.php')
-rw-r--r--includes/AuthPlugin.php47
1 files changed, 33 insertions, 14 deletions
diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php
index b29e13f2..87ac8adb 100644
--- a/includes/AuthPlugin.php
+++ b/includes/AuthPlugin.php
@@ -63,8 +63,9 @@ class AuthPlugin {
* Modify options in the login template.
*
* @param $template UserLoginTemplate object.
+ * @param $type String 'signup' or 'login'.
*/
- public function modifyUITemplate( &$template ) {
+ public function modifyUITemplate( &$template, &$type ) {
# Override this!
$template->set( 'usedomain', false );
}
@@ -97,7 +98,7 @@ class AuthPlugin {
* The User object is passed by reference so it can be modified; don't
* forget the & on your function declaration.
*
- * @param User $user
+ * @param $user User object
*/
public function updateUser( &$user ) {
# Override this and do something
@@ -116,13 +117,32 @@ class AuthPlugin {
*
* This is just a question, and shouldn't perform any actions.
*
- * @return bool
+ * @return Boolean
*/
public function autoCreate() {
return false;
}
/**
+ * Allow a property change? Properties are the same as preferences
+ * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
+ * all reference this.
+ *
+ * @return Boolean
+ */
+ public function allowPropChange( $prop = '' ) {
+ if( $prop == 'realname' && is_callable( array( $this, 'allowRealNameChange' ) ) ) {
+ return $this->allowRealNameChange();
+ } elseif( $prop == 'emailaddress' && is_callable( array( $this, 'allowEmailChange' ) ) ) {
+ return $this->allowEmailChange();
+ } elseif( $prop == 'nickname' && is_callable( array( $this, 'allowNickChange' ) ) ) {
+ return $this->allowNickChange();
+ } else {
+ return true;
+ }
+ }
+
+ /**
* Can users change their passwords?
*
* @return bool
@@ -152,7 +172,7 @@ class AuthPlugin {
* Return true if successful.
*
* @param $user User object.
- * @return bool
+ * @return Boolean
*/
public function updateExternalDB( $user ) {
return true;
@@ -161,7 +181,7 @@ class AuthPlugin {
/**
* Check to see if external accounts can be created.
* Return true if external accounts can be created.
- * @return bool
+ * @return Boolean
*/
public function canCreateAccounts() {
return false;
@@ -171,11 +191,11 @@ class AuthPlugin {
* Add a user to the external authentication database.
* Return true if successful.
*
- * @param User $user - only the name should be assumed valid at this point
- * @param string $password
- * @param string $email
- * @param string $realname
- * @return bool
+ * @param $user User: only the name should be assumed valid at this point
+ * @param $password String
+ * @param $email String
+ * @param $realname String
+ * @return Boolean
*/
public function addUser( $user, $password, $email='', $realname='' ) {
return true;
@@ -188,7 +208,7 @@ class AuthPlugin {
*
* This is just a question, and shouldn't perform any actions.
*
- * @return bool
+ * @return Boolean
*/
public function strict() {
return false;
@@ -199,7 +219,7 @@ class AuthPlugin {
* If either this or strict() returns true, local authentication is not used.
*
* @param $username String: username.
- * @return bool
+ * @return Boolean
*/
public function strictUserAuth( $username ) {
return false;
@@ -214,7 +234,7 @@ class AuthPlugin {
* forget the & on your function declaration.
*
* @param $user User object.
- * @param $autocreate bool True if user is being autocreated on login
+ * @param $autocreate Boolean: True if user is being autocreated on login
*/
public function initUser( &$user, $autocreate=false ) {
# Override this to do something.
@@ -232,7 +252,6 @@ class AuthPlugin {
* Get an instance of a User object
*
* @param $user User
- * @public
*/
public function getUserInstance( User &$user ) {
return new AuthPluginUser( $user );