AuthPlugin.php

Go to the documentation of this file.

<?php
class AuthPlugin {
        public function userExists( $username ) {
                # Override this!
                return false;
        }

        public function authenticate( $username, $password ) {
                # Override this!
                return false;
        }

        public function modifyUITemplate( &$template, &$type ) {
                # Override this!
                $template->set( 'usedomain', false );
        }

        public function setDomain( $domain ) {
                $this->domain = $domain;
        }

        public function validDomain( $domain ) {
                # Override this!
                return true;
        }

        public function updateUser( &$user ) {
                # Override this and do something
                return true;
        }

        public function autoCreate() {
                return false;
        }

        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;
                }
        }

        public function allowPasswordChange() {
                return true;
        }

        public function allowSetLocalPassword() {
                return true;
        }

        public function setPassword( $user, $password ) {
                return true;
        }

        public function updateExternalDB( $user ) {
                return true;
        }

        public function canCreateAccounts() {
                return false;
        }

        public function addUser( $user, $password, $email = '', $realname = '' ) {
                return true;
        }

        public function strict() {
                return false;
        }

        public function strictUserAuth( $username ) {
                return false;
        }

        public function initUser( &$user, $autocreate = false ) {
                # Override this to do something.
        }

        public function getCanonicalName( $username ) {
                return $username;
        }

        public function getUserInstance( User &$user ) {
                return new AuthPluginUser( $user );
        }

        public function domainList() {
                return array();
        }
}

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;
        }
}