auth_ldap

Files
file	admin_setting_special_contexts_configtext.php
	Special setting for auth_ldap that cleans up context values on save.
file	admin_setting_special_lowercase_configtext.php
	Special setting for auth_ldap that lowercases values on save.
file	admin_setting_special_ntlm_configtext.php
	Special admin setting for auth_ldap that validates ntlm usernames.
file	auth.php
	Authentication Plugin: LDAP Authentication Authentication using LDAP (Lightweight Directory Access Protocol).
file	locallib.php
	Internal library of functions for module auth_ldap.
file	provider.php
	Privacy Subsystem implementation for auth_ldap.
file	settings.php
	Admin settings and defaults.
file	sync_roles.php
	A scheduled task for LDAP roles sync.
file	sync_task.php
	A scheduled task for LDAP user sync.
file	tasks.php
	Definition of auth_ldap tasks.
file	upgrade.php
	LDAP authentication plugin upgrade code.
file	version.php
	Version details.

Namespaces
namespace	auth_ldap\privacy
namespace	auth_ldap\task

Classes
class	auth_ldap\privacy\provider
	Privacy Subsystem for auth_ldap implementing null_provider. More...
class	auth_ldap\task\sync_roles
	A scheduled task class for LDAP roles sync. More...
class	auth_ldap\task\sync_task
	A scheduled task class for LDAP user sync. More...
class	auth_ldap_admin_setting_special_contexts_configtext
	Special setting for auth_ldap that cleans up context values on save. More...
class	auth_ldap_admin_setting_special_lowercase_configtext
	Special setting for auth_ldap that lowercases values on save. More...
class	auth_ldap_admin_setting_special_ntlm_configtext
	Special admin setting for auth_ldap that validates ntlm usernames. More...
class	auth_plugin_ldap
	LDAP authentication plugin. More...

Functions
	get_ldap_assignable_role_names ($user=null)
	Get a list of system roles assignable by the current or a specified user, including their localised names. More...
	xmldb_auth_ldap_upgrade ($oldversion)
	Function to upgrade auth_ldap. More...

Variables
	$plugin = 2020060900
	$tasks
$plugin	component = 'auth_ldap'
if(!defined('AUTH_AD_ACCOUNTDISABLE')) if(!defined( 'AUTH_AD_NORMAL_ACCOUNT')) if(!defined('AUTH_NTLMTIMEOUT')) if(!defined( 'UF_DONT_EXPIRE_PASSWD')) if(!defined('AUTH_UID_NOBODY')) if(!defined( 'AUTH_GID_NOGROUP')) if(!defined('AUTH_NTLM_VALID_USERNAME')) if(!defined( 'AUTH_NTLM_VALID_DOMAINNAME')) if(!defined('AUTH_NTLM_DEFAULT_FORMAT')) if(!defined( 'AUTH_NTLM_FASTPATH_ATTEMPT')) if(!defined('AUTH_NTLM_FASTPATH_YESFORM')) if(!defined( 'AUTH_NTLM_FASTPATH_YESATTEMPT'))	if (!defined( 'LDAP_OPT_DIAGNOSTIC_MESSAGE'))
$plugin	version = 2020061501

Detailed Description

Function Documentation

get_ldap_assignable_role_names()

get_ldap_assignable_role_names

(

$user = null

)

Get a list of system roles assignable by the current or a specified user, including their localised names.

Parameters

integer | object

$user

A user id or object. By default (null) checks the permissions of the current user.

Return values

array::$roles,each

role as an array with id, shortname, localname, and settingname for the config value.

xmldb_auth_ldap_upgrade()

xmldb_auth_ldap_upgrade

(

$oldversion

)

Function to upgrade auth_ldap.

Parameters

int

$oldversion

the version we are upgrading from

Return values

bool

result

Variable Documentation

$tasks

$tasks

Initial value:

= array(
    array(
        'classname' => 'auth_ldap\task\sync_roles',
        'blocking' => 0,
        'minute' => '0',
        'hour' => '0',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 1
    ),
    array(
        'classname' => 'auth_ldap\task\sync_task',
        'blocking' => 0,
        'minute' => '0',
        'hour' => '0',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 1
    )
)