LDAP Account Manager

LAMConfig
in package

This class manages conf files.

Table of Contents

ACCESS_ALL  = 100
ACCESS_PASSWORD_CHANGE  = 20
ACCESS_READ_ONLY  = 0
LINE_SEPARATOR  = '+::+'
line separator
LOGIN_LIST  = 'list'
LOGIN_SEARCH  = 'search'
PWDRESET_DEFAULT_BOTH  = 3
show password on screen and send via email by default
PWDRESET_DEFAULT_MAIL  = 2
send password via email by default
PWDRESET_DEFAULT_SCREEN  = 1
show password on screen by default
$accessLevel  : mixed
access level
$activeTypes  : mixed
Active account types
$Admins  : mixed
Array of string: users with admin rights
$defaultLanguage  : mixed
Default language
$followReferrals  : mixed
automatically follow referrals
$hideDnPart  : mixed
$hidePasswordPromptForExpiredPasswords  : mixed
hide password prompt for expired passwords
$httpAuthentication  : mixed
specifies if HTTP authentication should be used
$jobsBindPassword  : mixed
LDAP password for jobs
$jobsBindUser  : mixed
LDAP user for jobs
$jobsDatabase  : mixed
database type for jobs
$jobsDBHost  : mixed
host of job database
$jobsDBName  : mixed
name of job database
$jobsDBPassword  : mixed
password of job database
$jobsDBPort  : mixed
port of job database
$jobsDBUser  : mixed
user of job database
$jobSettings  : mixed
job configuration
$jobToken  : mixed
random job token
$lamProMailAllowAlternateAddress  : mixed
allow sending mails to an alternative address
$lamProMailFrom  : mixed
email address for sender of password reset mails
$lamProMailIsHTML  : mixed
treat password reset mail body as HTML
$lamProMailReplyTo  : mixed
reply-to email address for password reset mails
$lamProMailSubject  : mixed
subject for password reset mails
$lamProMailText  : mixed
mail body for password reset mails
$loginMethod  : mixed
login method
$loginSearchDN  : mixed
bind user for login search
$loginSearchFilter  : mixed
search filter for login
$loginSearchPassword  : mixed
bind password for login search
$loginSearchSuffix  : mixed
search suffix for login
$moduleSettings  : mixed
module settings
$name  : mixed
Name of configuration file
$pagedResults  : mixed
use paged results
$Passwd  : mixed
Password to edit preferences
$pwdPolicyMinLength  : mixed
$pwdPolicyMinLowercase  : mixed
$pwdPolicyMinNumeric  : mixed
$pwdPolicyMinSymbolic  : mixed
$pwdPolicyMinUppercase  : mixed
$pwdResetAllowScreenPassword  : mixed
password reset page: allow to show password on screen
$pwdResetAllowSpecificPassword  : mixed
password reset page: allow to set a specific password
$pwdResetDefaultPasswordOutput  : mixed
password reset page: default selection for password output PWDRESET_DEFAULT_SCREEN, PWDRESET_DEFAULT_MAIL, PWDRESET_DEFAULT_BOTH
$pwdResetForcePasswordChange  : mixed
password reset page: force password change by default
$referentialIntegrityOverlay  : mixed
overlay for referential integrity is activated
$scriptPath  : mixed
Path to external lamdaemon script on server where it is executed
$scriptRights  : mixed
The rights for the home directory
$scriptServer  : mixed
Servers where lamdaemon script is executed
$scriptSSHKey  : mixed
File name of SSH key for lamdaemon.
$scriptSSHKeyPassword  : mixed
Password for lamdaemon SSH key.
$scriptUserName  : mixed
user name for lamdaemon
$searchLimit  : mixed
LDAP search limit
$serverDisplayName  : mixed
Display name of LDAP server
$ServerURL  : mixed
Server address (e.g. ldap://127.0.0.1:389)
$settings  : mixed
List of all settings in config file
$timeZone  : mixed
time zone
$toolSettings  : mixed
tool settings
$twoFactorAuthentication  : mixed
$twoFactorAuthenticationAttribute  : mixed
$twoFactorAuthenticationCaption  : mixed
$twoFactorAuthenticationClientId  : mixed
$twoFactorAuthenticationDomain  : mixed
$twoFactorAuthenticationInsecure  : mixed
$twoFactorAuthenticationLabel  : mixed
$twoFactorAuthenticationOptional  : mixed
$twoFactorAuthenticationSecretKey  : mixed
$twoFactorAuthenticationURL  : mixed
$typeSettings  : mixed
type settings
$useTLS  : mixed
enables/disables TLS encryption
check_Passwd()  : bool
Checks if the given password matches.
exportData()  : array<string|int, mixed>
Returns the server profile data.
get_AccountModules()  : array<string|int, mixed>
Returns an array of all selected account modules
get_ActiveTypes()  : array<string|int, string>
Returns a list of active account types.
get_Admins()  : array<string|int, mixed>
Returns an array of string with all admin names
get_Adminstring()  : string
Returns all admin users separated by semicolons
get_defaultLanguage()  : string
Returns the default language string
get_listAttributes()  : string
Returns the list of attributes to show in user list
get_moduleSettings()  : array<string|int, mixed>
Returns a list of saved module settings
get_scriptPath()  : string
Returns the path to the external script
get_scriptRights()  : string
Returns the chmod value for new home directories.
get_scriptServers()  : string
Returns the servers of the external script as a Array
get_searchLimit()  : int
Returns the LDAP search limit.
get_ServerURL()  : string
Returns the server address as string
get_Suffix()  : string
Returns the LDAP suffix for the given account type
get_typeSettings()  : array<string|int, mixed>
Returns a list of saved type settings
getAccessLevel()  : int
Returns the access level for this profile.
getActiveTypesString()  : string
Returns a list of active account types as string.
getConfiguredScriptServers()  : array<string|int, RemoteServerConfiguration>
Returns the list of configureed servers.
getFollowReferrals()  : string
Returns if referrals should be followed.
getHideDnPart()  : string
Returns the DN part to hide.
getHidePasswordPromptForExpiredPasswords()  : string
Hide password prompt for expired passwords.
getHttpAuthentication()  : string
Returns if HTTP authentication should be used.
getJobsBindPassword()  : string
Returns the bind password for jobs.
getJobsBindUser()  : string
Returns the bind user for jobs.
getJobsDatabase()  : string
Returns the database type for jobs.
getJobsDBHost()  : string
Returns the host.
getJobsDBName()  : string
Returns the database name.
getJobsDBPassword()  : string
Returns the DB password.
getJobsDBPort()  : string
Returns the port.
getJobsDBUser()  : string
Returns the DB user.
getJobSettings()  : array<string|int, mixed>
Returns a list of saved job settings.
getJobToken()  : string
Returns the job token.
getLamProMailAllowAlternateAddress()  : bool
Returns if sending to an alternate address is allowed.
getLamProMailFrom()  : string
Returns the sender address for password reset mails.
getLamProMailIsHTML()  : bool
Returns if the password reset mail content should be treated as HTML.
getLamProMailReplyTo()  : string
Returns the reply-to address for password reset mails.
getLamProMailSubject()  : string
Returns the subject for password reset mails.
getLamProMailText()  : string
Returns the mail body for password reset mails.
getLamProMailTextRaw()  : string
Returns the mail body for password reset mails without formatting.
getLoginMethod()  : string
Returns the login method.
getLoginSearchDN()  : string
Returns the DN for the login search bind user.
getLoginSearchFilter()  : string
Returns the login search filter.
getLoginSearchPassword()  : string
Returns the password for the login search bind user.
getLoginSearchSuffix()  : string
Returns the login search suffix.
getName()  : string
Returns the name of the config file
getPagedResults()  : string
Returns if paged results should be used.
getPasswd()  : string
Returns the password hash.
getPwdPolicyMinLength()  : string
Returns the minimum password length.
getpwdPolicyMinLowercase()  : string
Returns the minimum of lowercase characters.
getPwdPolicyMinNumeric()  : string
Returns the minimum of numeric characters.
getPwdPolicyMinSymbolic()  : string
Returns the minimum of symbolic characters.
getPwdPolicyMinUppercase()  : string
Returns the minimum of uppercase characters.
getPwdResetAllowScreenPassword()  : string
Returns if displaying password on screen is allowed on password reset page.
getPwdResetAllowSpecificPassword()  : string
Returns if setting a specific password is allowed on password reset page.
getPwdResetDefaultPasswordOutput()  : int
Returns default password output method on password reset page.
getPwdResetForcePasswordChange()  : string
Returns if force password change is set by default on password reset page.
getReferentialIntegrityOverlay()  : string
Returns if referential integrity overlay is in place.
getScriptServerByName()  : RemoteServerConfiguration
Returns the script server object for the given name.
getScriptSSHKey()  : string
Returns the path to lamdamon SSH key.
getScriptSSHKeyPassword()  : string
Returns the password for the lamdamon SSH key.
getScriptUserName()  : string
Returns the lamdaemon user name.
getServerDisplayName()  : string
Returns the server display name.
getServerDisplayNameGUI()  : string
Returns the server display name. Defaults to server URL if empty display name.
getTimeZone()  : string
Returns the time zone name.
getToolSettings()  : array<string|int, mixed>
Returns the tool settings.
getTwoFactorAuthentication()  : string
Returns the authentication type.
getTwoFactorAuthenticationAttribute()  : string
Returns the user attribute.
getTwoFactorAuthenticationCaption()  : string
Returns the caption HTML.
getTwoFactorAuthenticationClientId()  : string
Returns the client id.
getTwoFactorAuthenticationDomain()  : string
Returns the domain.
getTwoFactorAuthenticationInsecure()  : bool
Returns if SSL certificate verification is turned off.
getTwoFactorAuthenticationLabel()  : string
Returns the authentication label.
getTwoFactorAuthenticationOptional()  : bool
Returns if 2nd factor is optional.
getTwoFactorAuthenticationSecretKey()  : string
Returns the secret key.
getTwoFactorAuthenticationURL()  : string
Returns the authentication URL.
getTwoFactorAuthenticationURLRaw()  : string
Returns the authentication URL without formatting.
getUseTLS()  : string
Returns if TLS is activated.
importData()  : mixed
Imports server profile data.
isHidePasswordPromptForExpiredPasswords()  : bool
Hide password prompt for expired passwords.
isReferentialIntegrityOverlayActive()  : bool
Returns if referential integrity overlay is in place.
isToolActive()  : bool
Checks if the given tool is activated.
isValidName()  : bool
Checks if the given server profile name is valid.
parseConfiguredScriptServers()  : array<string|int, RemoteServerConfiguration>
Parses the configured server config.
parseScriptServerValue()  : string|false
Parses the script server value from input field.
removeInvalidModules()  : mixed
Removes any non-existing modules from the configuration.
removeInvalidTypes()  : mixed
Removes any non-existing types from the configuration.
set_AccountModules()  : bool
Sets the selected account modules
set_ActiveTypes()  : mixed
Sets the list of active types.
set_Adminstring()  : bool
Sets the admin string
set_defaultLanguage()  : bool
Sets the default language string
set_listAttributes()  : bool
Sets the list of attributes to show in user list
set_moduleSettings()  : bool
Sets the settings for the account modules.
set_Passwd()  : bool
Sets the preferences wizard password
set_scriptPath()  : bool
Sets the path to the external script
set_scriptRights()  : bool
Sets the rights for the home directory.
set_scriptServers()  : bool
Sets the servers of the external script
set_searchLimit()  : bool
Sets the LDAP search limit.
set_ServerURL()  : bool
Sets the server address
set_Suffix()  : bool
Sets the LDAP suffix where accounts are saved
set_typeSettings()  : bool
Sets the settings for the account types.
setAccessLevel()  : mixed
Sets the access level for this profile.
setFollowReferrals()  : mixed
Sets if referrals should be followed.
setHideDnPart()  : mixed
Sets the DN part to hide.
setHidePasswordPromptForExpiredPasswords()  : mixed
Sets if password prompt for expired passwords is hidden.
setHttpAuthentication()  : mixed
Specifies if HTTP authentication should be used.
setJobsBindPassword()  : mixed
Sets the bind password for jobs.
setJobsBindUser()  : mixed
Sets the bind user for jobs.
setJobsDatabase()  : mixed
Sets the database type for jobs.
setJobsDBHost()  : mixed
Sets the host.
setJobsDBName()  : mixed
Sets the database name
setJobsDBPassword()  : mixed
Sets the DB password.
setJobsDBPort()  : mixed
Sets the port.
setJobsDBUser()  : mixed
Sets the DB user.
setJobSettings()  : bool
Sets the settings for the jobs.
setLamProMailAllowAlternateAddress()  : mixed
Sets if sending to an alternate address is allowed.
setLamProMailFrom()  : bool
Sets the sender address for password reset mails.
setLamProMailIsHTML()  : mixed
Sets if the password reset mail content should be treated as HTML.
setLamProMailReplyTo()  : bool
Sets the reply-to address for password reset mails.
setLamProMailSubject()  : mixed
Sets the subject for password reset mails.
setLamProMailText()  : mixed
Sets the mail body for password reset mails.
setLoginMethod()  : mixed
Sets the login method.
setLoginSearchDN()  : bool
Sets the DN for the login search bind user.
setLoginSearchFilter()  : mixed
Sets the login search filter.
setLoginSearchPassword()  : mixed
Sets the password for the login search bind user.
setLoginSearchSuffix()  : mixed
Sets the login search suffix.
setName()  : void
Sets the name of the config file
setPagedResults()  : mixed
Sets if paged results should be used.
setPwdPolicyMinLength()  : mixed
Sets the minimum password length.
setPwdPolicyMinLowercase()  : mixed
Sets the minimum of lowercase characters.
setPwdPolicyMinNumeric()  : mixed
Sets the minimum of numeric characters.
setPwdPolicyMinSymbolic()  : mixed
Sets the minimum of symbolic characters.
setPwdPolicyMinUppercase()  : mixed
Sets the minimum of uppercase characters.
setPwdResetAllowScreenPassword()  : mixed
Sets if displaying password on screen is allowed on password reset page.
setPwdResetAllowSpecificPassword()  : mixed
Sets if setting a specific password is allowed on password reset page.
setPwdResetDefaultPasswordOutput()  : mixed
Sets default password output method on password reset page.
setPwdResetForcePasswordChange()  : mixed
Sets if force password change is set by default on password reset page.
setReferentialIntegrityOverlay()  : mixed
Sets if referential integrity overlay is in place.
setScriptSSHKey()  : mixed
Sets the path to lamdamon SSH key.
setScriptSSHKeyPassword()  : mixed
Sets the password for the lamdamon SSH key.
setScriptUserName()  : mixed
Sets the lamdaemon user name.
setServerDisplayName()  : bool
Sets the server display name
setTimeZone()  : bool
Sets the time zone name.
setToolSettings()  : bool
Sets the tool settings.
setTwoFactorAuthentication()  : mixed
Sets the authentication type.
setTwoFactorAuthenticationAttribute()  : mixed
Sets the user attribute.
setTwoFactorAuthenticationCaption()  : mixed
Sets the caption HTML.
setTwoFactorAuthenticationClientId()  : mixed
Sets the client id.
setTwoFactorAuthenticationDomain()  : mixed
Sets the domain.
setTwoFactorAuthenticationInsecure()  : mixed
Sets if SSL certificate verification is turned off.
setTwoFactorAuthenticationLabel()  : mixed
Sets the authentication label.
setTwoFactorAuthenticationOptional()  : mixed
Sets if 2nd factor is optional.
setTwoFactorAuthenticationSecretKey()  : mixed
Sets the secret key.
setTwoFactorAuthenticationURL()  : mixed
Sets the authentication URL.
setUseTLS()  : bool
Sets if TLS is activated.
hashPassword()  : string
Returns the hashed password.

Constants

ACCESS_ALL

public mixed ACCESS_ALL = 100

ACCESS_PASSWORD_CHANGE

public mixed ACCESS_PASSWORD_CHANGE = 20

ACCESS_READ_ONLY

public mixed ACCESS_READ_ONLY = 0

LINE_SEPARATOR

line separator

public mixed LINE_SEPARATOR = '+::+'

LOGIN_LIST

public mixed LOGIN_LIST = 'list'
public mixed LOGIN_SEARCH = 'search'

PWDRESET_DEFAULT_BOTH

show password on screen and send via email by default

public mixed PWDRESET_DEFAULT_BOTH = 3

PWDRESET_DEFAULT_MAIL

send password via email by default

public mixed PWDRESET_DEFAULT_MAIL = 2

PWDRESET_DEFAULT_SCREEN

show password on screen by default

public mixed PWDRESET_DEFAULT_SCREEN = 1

Properties

$accessLevel

access level

private mixed $accessLevel = \LAMconfig::ACCESS_ALL

$activeTypes

Active account types

private mixed $activeTypes = ""

$Admins

Array of string: users with admin rights

private mixed $Admins

$defaultLanguage

Default language

private mixed $defaultLanguage

$followReferrals

automatically follow referrals

private mixed $followReferrals = 'false'

$hideDnPart

private mixed $hideDnPart = ''

$hidePasswordPromptForExpiredPasswords

hide password prompt for expired passwords

private mixed $hidePasswordPromptForExpiredPasswords = 'false'

$httpAuthentication

specifies if HTTP authentication should be used

private mixed $httpAuthentication = 'false'

$jobsBindPassword

LDAP password for jobs

private mixed $jobsBindPassword = \null

$jobsBindUser

LDAP user for jobs

private mixed $jobsBindUser = \null

$jobsDatabase

database type for jobs

private mixed $jobsDatabase = \null

$jobsDBHost

host of job database

private mixed $jobsDBHost = \null

$jobsDBName

name of job database

private mixed $jobsDBName = \null

$jobsDBPassword

password of job database

private mixed $jobsDBPassword = \null

$jobsDBPort

port of job database

private mixed $jobsDBPort = \null

$jobsDBUser

user of job database

private mixed $jobsDBUser = \null

$jobSettings

job configuration

private mixed $jobSettings = array()

$jobToken

random job token

private mixed $jobToken = \null

$lamProMailAllowAlternateAddress

allow sending mails to an alternative address

private mixed $lamProMailAllowAlternateAddress = 'true'

$lamProMailFrom

email address for sender of password reset mails

private mixed $lamProMailFrom = ''

$lamProMailIsHTML

treat password reset mail body as HTML

private mixed $lamProMailIsHTML = 'false'

$lamProMailReplyTo

reply-to email address for password reset mails

private mixed $lamProMailReplyTo = ''

$lamProMailSubject

subject for password reset mails

private mixed $lamProMailSubject = ''

$lamProMailText

mail body for password reset mails

private mixed $lamProMailText = ''

$loginMethod

login method

private mixed $loginMethod = \LAMconfig::LOGIN_LIST

$loginSearchDN

bind user for login search

private mixed $loginSearchDN = ''

$loginSearchFilter

search filter for login

private mixed $loginSearchFilter = 'uid=%USER%'

$loginSearchPassword

bind password for login search

private mixed $loginSearchPassword = ''

$loginSearchSuffix

search suffix for login

private mixed $loginSearchSuffix = 'dc=yourdomain,dc=org'

$moduleSettings

module settings

private mixed $moduleSettings = array()

$name

Name of configuration file

private mixed $name

$pagedResults

use paged results

private mixed $pagedResults = 'false'

$Passwd

Password to edit preferences

private mixed $Passwd

$pwdPolicyMinLength

private mixed $pwdPolicyMinLength = ''

$pwdPolicyMinLowercase

private mixed $pwdPolicyMinLowercase = ''

$pwdPolicyMinNumeric

private mixed $pwdPolicyMinNumeric = ''

$pwdPolicyMinSymbolic

private mixed $pwdPolicyMinSymbolic = ''

$pwdPolicyMinUppercase

private mixed $pwdPolicyMinUppercase = ''

$pwdResetAllowScreenPassword

password reset page: allow to show password on screen

private mixed $pwdResetAllowScreenPassword = 'true'

$pwdResetAllowSpecificPassword

password reset page: allow to set a specific password

private mixed $pwdResetAllowSpecificPassword = 'true'

$pwdResetDefaultPasswordOutput

password reset page: default selection for password output PWDRESET_DEFAULT_SCREEN, PWDRESET_DEFAULT_MAIL, PWDRESET_DEFAULT_BOTH

private mixed $pwdResetDefaultPasswordOutput = \LAMconfig::PWDRESET_DEFAULT_MAIL

$pwdResetForcePasswordChange

password reset page: force password change by default

private mixed $pwdResetForcePasswordChange = 'true'

$referentialIntegrityOverlay

overlay for referential integrity is activated

private mixed $referentialIntegrityOverlay = 'false'

$scriptPath

Path to external lamdaemon script on server where it is executed

private mixed $scriptPath

This is used for managing quota and home directories. optional setting, may not be defined

$scriptRights

The rights for the home directory

private mixed $scriptRights = '750'

$scriptServer

Servers where lamdaemon script is executed

private mixed $scriptServer

This is used for managing quota and home directories. optional setting, may not be defined

$scriptSSHKey

File name of SSH key for lamdaemon.

private mixed $scriptSSHKey

$scriptSSHKeyPassword

Password for lamdaemon SSH key.

private mixed $scriptSSHKeyPassword

$scriptUserName

user name for lamdaemon

private mixed $scriptUserName

$searchLimit

LDAP search limit

private mixed $searchLimit = 0

$serverDisplayName

Display name of LDAP server

private mixed $serverDisplayName

$ServerURL

Server address (e.g. ldap://127.0.0.1:389)

private mixed $ServerURL

$settings

List of all settings in config file

private mixed $settings = array("ServerURL", "useTLS", "followReferrals", 'pagedResults', "Passwd", "Admins", "defaultLanguage", "scriptPath", "scriptServer", "scriptRights", 'serverDisplayName', "modules", "activeTypes", "types", "tools", "accessLevel", 'loginMethod', 'loginSearchSuffix', 'loginSearchFilter', 'searchLimit', 'lamProMailFrom', 'lamProMailReplyTo', 'lamProMailSubject', 'lamProMailText', 'lamProMailIsHTML', 'lamProMailAllowAlternateAddress', 'httpAuthentication', 'loginSearchDN', 'loginSearchPassword', 'timeZone', 'jobsBindUser', 'jobsBindPassword', 'jobsDatabase', 'jobToken', 'jobs', 'jobsDBHost', 'jobsDBPort', 'jobsDBUser', 'jobsDBPassword', 'jobsDBName', 'pwdResetAllowSpecificPassword', 'pwdResetAllowScreenPassword', 'pwdResetForcePasswordChange', 'pwdResetDefaultPasswordOutput', 'scriptUserName', 'scriptSSHKey', 'scriptSSHKeyPassword', 'twoFactorAuthentication', 'twoFactorAuthenticationURL', 'twoFactorAuthenticationInsecure', 'twoFactorAuthenticationLabel', 'twoFactorAuthenticationOptional', 'twoFactorAuthenticationCaption', 'twoFactorAuthenticationClientId', 'twoFactorAuthenticationSecretKey', 'twoFactorAuthenticationDomain', 'twoFactorAuthenticationAttribute', 'referentialIntegrityOverlay', 'hidePasswordPromptForExpiredPasswords', 'hideDnPart', 'pwdPolicyMinLength', 'pwdPolicyMinLowercase', 'pwdPolicyMinUppercase', 'pwdPolicyMinNumeric', 'pwdPolicyMinSymbolic')

$timeZone

time zone

private mixed $timeZone = 'Europe/London'

$toolSettings

tool settings

private mixed $toolSettings = array()

$twoFactorAuthentication

private mixed $twoFactorAuthentication = \LAM\LIB\TWO_FACTOR\TwoFactorProviderService::TWO_FACTOR_NONE

$twoFactorAuthenticationAttribute

private mixed $twoFactorAuthenticationAttribute = ''

$twoFactorAuthenticationCaption

private mixed $twoFactorAuthenticationCaption = ''

$twoFactorAuthenticationClientId

private mixed $twoFactorAuthenticationClientId = \null

$twoFactorAuthenticationDomain

private mixed $twoFactorAuthenticationDomain = \null

$twoFactorAuthenticationInsecure

private mixed $twoFactorAuthenticationInsecure = \false

$twoFactorAuthenticationLabel

private mixed $twoFactorAuthenticationLabel = \null

$twoFactorAuthenticationOptional

private mixed $twoFactorAuthenticationOptional = \false

$twoFactorAuthenticationSecretKey

private mixed $twoFactorAuthenticationSecretKey = \null

$twoFactorAuthenticationURL

private mixed $twoFactorAuthenticationURL = 'https://localhost'

$typeSettings

type settings

private mixed $typeSettings = array()

$useTLS

enables/disables TLS encryption

private mixed $useTLS

Methods

check_Passwd()

Checks if the given password matches.

public check_Passwd(string $password) : bool
Parameters
$password : string
Return values
bool

true, if matches

exportData()

Returns the server profile data.

public exportData() : array<string|int, mixed>
Return values
array<string|int, mixed>

data

get_AccountModules()

Returns an array of all selected account modules

public get_AccountModules(string $scope) : array<string|int, mixed>
Parameters
$scope : string

account type

Return values
array<string|int, mixed>

user modules

get_ActiveTypes()

Returns a list of active account types.

public get_ActiveTypes() : array<string|int, string>
Return values
array<string|int, string>

list of types

get_Admins()

Returns an array of string with all admin names

public get_Admins() : array<string|int, mixed>
Return values
array<string|int, mixed>

the admin names

get_Adminstring()

Returns all admin users separated by semicolons

public get_Adminstring() : string
Return values
string

the admin string

get_defaultLanguage()

Returns the default language string

public get_defaultLanguage() : string
Return values
string

default language

get_listAttributes()

Returns the list of attributes to show in user list

public get_listAttributes(string $scope) : string
Parameters
$scope : string

account type

Return values
string

the attribute list

get_moduleSettings()

Returns a list of saved module settings

public get_moduleSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

list of settings: array(name => value)

get_scriptPath()

Returns the path to the external script

public get_scriptPath() : string
Return values
string

script path

get_scriptRights()

Returns the chmod value for new home directories.

public get_scriptRights() : string
Return values
string

rights

get_scriptServers()

Returns the servers of the external script as a Array

public get_scriptServers() : string
Return values
string

script servers

get_searchLimit()

Returns the LDAP search limit.

public get_searchLimit() : int
Return values
int

search limit

get_ServerURL()

Returns the server address as string

public get_ServerURL() : string
Return values
string

server address

get_Suffix()

Returns the LDAP suffix for the given account type

public get_Suffix(string $typeId) : string
Parameters
$typeId : string

account type

Return values
string

the LDAP suffix

get_typeSettings()

Returns a list of saved type settings

public get_typeSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

list of settings: array(name => value)

getAccessLevel()

Returns the access level for this profile.

public getAccessLevel() : int
Return values
int

level

getActiveTypesString()

Returns a list of active account types as string.

public getActiveTypesString() : string
Return values
string

list of types

getConfiguredScriptServers()

Returns the list of configureed servers.

public getConfiguredScriptServers() : array<string|int, RemoteServerConfiguration>
Return values
array<string|int, RemoteServerConfiguration>

servers

getFollowReferrals()

Returns if referrals should be followed.

public getFollowReferrals() : string
Return values
string

true or false

getHideDnPart()

Returns the DN part to hide.

public getHideDnPart() : string
Return values
string

DN part

getHidePasswordPromptForExpiredPasswords()

Hide password prompt for expired passwords.

public getHidePasswordPromptForExpiredPasswords() : string
Return values
string

true or false

getHttpAuthentication()

Returns if HTTP authentication should be used.

public getHttpAuthentication() : string
Return values
string

$httpAuthentication use HTTP authentication ('true' or 'false')

getJobsBindPassword()

Returns the bind password for jobs.

public getJobsBindPassword() : string
Return values
string

$jobsBindPassword password

getJobsBindUser()

Returns the bind user for jobs.

public getJobsBindUser() : string
Return values
string

$jobsBindUser bind user

getJobsDatabase()

Returns the database type for jobs.

public getJobsDatabase() : string
Return values
string

$jobsDatabase database type

getJobsDBHost()

Returns the host.

public getJobsDBHost() : string
Return values
string

host

getJobsDBName()

Returns the database name.

public getJobsDBName() : string
Return values
string

DB name

getJobsDBPassword()

Returns the DB password.

public getJobsDBPassword() : string
Return values
string

password

getJobsDBPort()

Returns the port.

public getJobsDBPort() : string
Return values
string

port

getJobsDBUser()

Returns the DB user.

public getJobsDBUser() : string
Return values
string

user name

getJobSettings()

Returns a list of saved job settings.

public getJobSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

list of settings: array(name => value)

getJobToken()

Returns the job token.

public getJobToken() : string
Return values
string

job token

getLamProMailAllowAlternateAddress()

Returns if sending to an alternate address is allowed.

public getLamProMailAllowAlternateAddress() : bool
Return values
bool

alternate address allowed

getLamProMailFrom()

Returns the sender address for password reset mails.

public getLamProMailFrom() : string
Return values
string

mail address

getLamProMailIsHTML()

Returns if the password reset mail content should be treated as HTML.

public getLamProMailIsHTML() : bool
Return values
bool

HTML or text

getLamProMailReplyTo()

Returns the reply-to address for password reset mails.

public getLamProMailReplyTo() : string
Return values
string

mail address

getLamProMailSubject()

Returns the subject for password reset mails.

public getLamProMailSubject() : string
Return values
string

subject

getLamProMailText()

Returns the mail body for password reset mails.

public getLamProMailText() : string
Return values
string

body

getLamProMailTextRaw()

Returns the mail body for password reset mails without formatting.

public getLamProMailTextRaw() : string
Return values
string

body

getLoginMethod()

Returns the login method.

public getLoginMethod() : string
Tags
see
LAMconfig::LOGIN_LIST
see
LAMconfig::LOGIN_SEARCH
Return values
string

login method

getLoginSearchDN()

Returns the DN for the login search bind user.

public getLoginSearchDN() : string
Return values
string

DN

getLoginSearchFilter()

Returns the login search filter.

public getLoginSearchFilter() : string
Return values
string

search filter

getLoginSearchPassword()

Returns the password for the login search bind user.

public getLoginSearchPassword() : string
Return values
string

password

getLoginSearchSuffix()

Returns the login search suffix.

public getLoginSearchSuffix() : string
Return values
string

suffix

getName()

Returns the name of the config file

public getName() : string
Return values
string

name

getPagedResults()

Returns if paged results should be used.

public getPagedResults() : string
Return values
string

true or false

getPasswd()

Returns the password hash.

public getPasswd() : string
Return values
string

password hash

getPwdPolicyMinLength()

Returns the minimum password length.

public getPwdPolicyMinLength() : string
Return values
string

minimum length

getpwdPolicyMinLowercase()

Returns the minimum of lowercase characters.

public getpwdPolicyMinLowercase() : string
Return values
string

minimum

getPwdPolicyMinNumeric()

Returns the minimum of numeric characters.

public getPwdPolicyMinNumeric() : string
Return values
string

minimum

getPwdPolicyMinSymbolic()

Returns the minimum of symbolic characters.

public getPwdPolicyMinSymbolic() : string
Return values
string

minimum

getPwdPolicyMinUppercase()

Returns the minimum of uppercase characters.

public getPwdPolicyMinUppercase() : string
Return values
string

minimum

getPwdResetAllowScreenPassword()

Returns if displaying password on screen is allowed on password reset page.

public getPwdResetAllowScreenPassword() : string
Return values
string

'true' or 'false'

getPwdResetAllowSpecificPassword()

Returns if setting a specific password is allowed on password reset page.

public getPwdResetAllowSpecificPassword() : string
Return values
string

'true' or 'false'

getPwdResetDefaultPasswordOutput()

Returns default password output method on password reset page.

public getPwdResetDefaultPasswordOutput() : int
Return values
int

LAMConfig::PWDRESET_DEFAULT_SCREEN/PWDRESET_DEFAULT_MAIL/PWDRESET_DEFAULT_BOTH

getPwdResetForcePasswordChange()

Returns if force password change is set by default on password reset page.

public getPwdResetForcePasswordChange() : string
Return values
string

'true' or 'false'

getReferentialIntegrityOverlay()

Returns if referential integrity overlay is in place.

public getReferentialIntegrityOverlay() : string
Return values
string

true or false

getScriptServerByName()

Returns the script server object for the given name.

public getScriptServerByName(string $serverName) : RemoteServerConfiguration
Parameters
$serverName : string

server name

Return values
RemoteServerConfiguration

server

getScriptSSHKey()

Returns the path to lamdamon SSH key.

public getScriptSSHKey() : string
Return values
string

key path

getScriptSSHKeyPassword()

Returns the password for the lamdamon SSH key.

public getScriptSSHKeyPassword() : string
Return values
string

password

getScriptUserName()

Returns the lamdaemon user name.

public getScriptUserName() : string
Return values
string

user name

getServerDisplayName()

Returns the server display name.

public getServerDisplayName() : string
Return values
string

server display name

getServerDisplayNameGUI()

Returns the server display name. Defaults to server URL if empty display name.

public getServerDisplayNameGUI() : string
Return values
string

server display name

getTimeZone()

Returns the time zone name.

public getTimeZone() : string
Return values
string

time zone

getToolSettings()

Returns the tool settings.

public getToolSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

$toolSettings tool settings

getTwoFactorAuthentication()

Returns the authentication type.

public getTwoFactorAuthentication() : string
Return values
string

$twoFactorAuthentication authentication type

getTwoFactorAuthenticationAttribute()

Returns the user attribute.

public getTwoFactorAuthenticationAttribute() : string
Return values
string

user attribute

getTwoFactorAuthenticationCaption()

Returns the caption HTML.

public getTwoFactorAuthenticationCaption() : string
Return values
string

caption HTML

getTwoFactorAuthenticationClientId()

Returns the client id.

public getTwoFactorAuthenticationClientId() : string
Return values
string

client id

getTwoFactorAuthenticationDomain()

Returns the domain.

public getTwoFactorAuthenticationDomain() : string
Return values
string

domain

getTwoFactorAuthenticationInsecure()

Returns if SSL certificate verification is turned off.

public getTwoFactorAuthenticationInsecure() : bool
Return values
bool

SSL certificate verification is turned off

getTwoFactorAuthenticationLabel()

Returns the authentication label.

public getTwoFactorAuthenticationLabel() : string
Return values
string

authentication label

getTwoFactorAuthenticationOptional()

Returns if 2nd factor is optional.

public getTwoFactorAuthenticationOptional() : bool
Return values
bool

2nd factor is optional

getTwoFactorAuthenticationSecretKey()

Returns the secret key.

public getTwoFactorAuthenticationSecretKey() : string
Return values
string

secret key

getTwoFactorAuthenticationURL()

Returns the authentication URL.

public getTwoFactorAuthenticationURL() : string
Return values
string

authentication URL

getTwoFactorAuthenticationURLRaw()

Returns the authentication URL without formatting.

public getTwoFactorAuthenticationURLRaw() : string
Return values
string

authentication URL

getUseTLS()

Returns if TLS is activated.

public getUseTLS() : string
Return values
string

yes or no

importData()

Imports server profile data.

public importData(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

config data

Tags
throws
LAMException

import error

Return values
mixed

isHidePasswordPromptForExpiredPasswords()

Hide password prompt for expired passwords.

public isHidePasswordPromptForExpiredPasswords() : bool
Return values
bool

is hidden

isReferentialIntegrityOverlayActive()

Returns if referential integrity overlay is in place.

public isReferentialIntegrityOverlayActive() : bool
Return values
bool

overlay in place

isToolActive()

Checks if the given tool is activated.

public isToolActive(string $toolName) : bool
Parameters
$toolName : string

tool name

Return values
bool

is active

isValidName()

Checks if the given server profile name is valid.

public static isValidName(string $name) : bool
Parameters
$name : string

server profile name

Return values
bool

is valid

parseConfiguredScriptServers()

Parses the configured server config.

public static parseConfiguredScriptServers(string $value, string $scriptPath, string $userName, string $sshKey, string $sshKeyPassword) : array<string|int, RemoteServerConfiguration>
Parameters
$value : string

configured value

$scriptPath : string

script path

$userName : string

user name

$sshKey : string

SSH key path

$sshKeyPassword : string

SSH key password

Return values
array<string|int, RemoteServerConfiguration>

configurations

parseScriptServerValue()

Parses the script server value from input field.

public static parseScriptServerValue( $value) : string|false
Parameters
$value :

input field value

Return values
string|false

value to store in configuration

removeInvalidModules()

Removes any non-existing modules from the configuration.

public removeInvalidModules() : mixed
Return values
mixed

removeInvalidTypes()

Removes any non-existing types from the configuration.

public removeInvalidTypes() : mixed
Return values
mixed

set_AccountModules()

Sets the selected account modules

public set_AccountModules(array<string|int, mixed> $modules, string $scope) : bool
Parameters
$modules : array<string|int, mixed>

array with module names (not aliases!)

$scope : string

account type

Return values
bool

true if $modules has correct format

set_ActiveTypes()

Sets the list of active types.

public set_ActiveTypes(mixed $types) : mixed
Parameters
$types : mixed
Return values
mixed

set_Adminstring()

Sets the admin string

public set_Adminstring(string $value) : bool
Parameters
$value : string

new admin string that contains all admin users separated by semicolons

Return values
bool

true if $value has correct format

set_defaultLanguage()

Sets the default language string

public set_defaultLanguage(string $value) : bool
Parameters
$value : string

new default language

Return values
bool

true if $value has correct format

set_listAttributes()

Sets the list of attributes to show in user list

public set_listAttributes(string $value, string $scope) : bool
Parameters
$value : string

new attribute string

$scope : string

account type

Return values
bool

true if $value has correct format

set_moduleSettings()

Sets the settings for the account modules.

public set_moduleSettings(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>

list of module setting array(name => value)

Return values
bool

true if $settings has correct format

set_Passwd()

Sets the preferences wizard password

public set_Passwd(string $value) : bool
Parameters
$value : string

new password

Return values
bool

true if $value has correct format

set_scriptPath()

Sets the path to the external script

public set_scriptPath(string $value) : bool
Parameters
$value : string

new script path

Return values
bool

true if $value has correct format

set_scriptRights()

Sets the rights for the home directory.

public set_scriptRights(string $chmod) : bool
Parameters
$chmod : string

the rights

Return values
bool

true if values has correct format

set_scriptServers()

Sets the servers of the external script

public set_scriptServers(string $value) : bool
Parameters
$value : string

new script servers

Return values
bool

true if $value has correct format

set_searchLimit()

Sets the LDAP search limit.

public set_searchLimit(int $value) : bool
Parameters
$value : int

new search limit

Return values
bool

true if $value has correct format

set_ServerURL()

Sets the server address

public set_ServerURL(string $value) : bool
Parameters
$value : string

new server address

Return values
bool

true if $value has correct format

set_Suffix()

Sets the LDAP suffix where accounts are saved

public set_Suffix(string $scope, string $value) : bool
Parameters
$scope : string

account type

$value : string

new LDAP suffix

Return values
bool

true if $value has correct format

set_typeSettings()

Sets the settings for the account types.

public set_typeSettings(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>

list of type setting array(name => value)

Return values
bool

true if $settings has correct format

setAccessLevel()

Sets the access level for this profile.

public setAccessLevel(int $level) : mixed
Parameters
$level : int

level

Return values
mixed

setFollowReferrals()

Sets if referrals should be followed.

public setFollowReferrals(string $followReferrals) : mixed
Parameters
$followReferrals : string

true or false

Return values
mixed

setHideDnPart()

Sets the DN part to hide.

public setHideDnPart(string $hideDnPart) : mixed
Parameters
$hideDnPart : string

DN part

Return values
mixed

setHidePasswordPromptForExpiredPasswords()

Sets if password prompt for expired passwords is hidden.

public setHidePasswordPromptForExpiredPasswords(string $hidePasswordPromptForExpiredPasswords) : mixed
Parameters
$hidePasswordPromptForExpiredPasswords : string

true or false

Return values
mixed

setHttpAuthentication()

Specifies if HTTP authentication should be used.

public setHttpAuthentication(string $httpAuthentication) : mixed
Parameters
$httpAuthentication : string

use HTTP authentication ('true' or 'false')

Return values
mixed

setJobsBindPassword()

Sets the bind password for jobs.

public setJobsBindPassword(string $jobsBindPassword) : mixed
Parameters
$jobsBindPassword : string

password

Return values
mixed

setJobsBindUser()

Sets the bind user for jobs.

public setJobsBindUser(string $jobsBindUser) : mixed
Parameters
$jobsBindUser : string

bind user

Return values
mixed

setJobsDatabase()

Sets the database type for jobs.

public setJobsDatabase(string $jobsDatabase) : mixed
Parameters
$jobsDatabase : string

database type

Return values
mixed

setJobsDBHost()

Sets the host.

public setJobsDBHost(string $jobsDBHost) : mixed
Parameters
$jobsDBHost : string

host

Return values
mixed

setJobsDBName()

Sets the database name

public setJobsDBName(string $jobsDBName) : mixed
Parameters
$jobsDBName : string

DB name

Return values
mixed

setJobsDBPassword()

Sets the DB password.

public setJobsDBPassword(string $jobsDBPassword) : mixed
Parameters
$jobsDBPassword : string

password

Return values
mixed

setJobsDBPort()

Sets the port.

public setJobsDBPort(int $jobsDBPort) : mixed
Parameters
$jobsDBPort : int

port

Return values
mixed

setJobsDBUser()

Sets the DB user.

public setJobsDBUser(string $jobsDBUser) : mixed
Parameters
$jobsDBUser : string

user name

Return values
mixed

setJobSettings()

Sets the settings for the jobs.

public setJobSettings(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>

list of job settings array(name => value)

Return values
bool

true if $settings has correct format

setLamProMailAllowAlternateAddress()

Sets if sending to an alternate address is allowed.

public setLamProMailAllowAlternateAddress(bool $lamProMailAllowAlternateAddress) : mixed
Parameters
$lamProMailAllowAlternateAddress : bool

alternate address allowed

Return values
mixed

setLamProMailFrom()

Sets the sender address for password reset mails.

public setLamProMailFrom(string $lamProMailFrom) : bool
Parameters
$lamProMailFrom : string

mail address

Return values
bool

true if address is valid

setLamProMailIsHTML()

Sets if the password reset mail content should be treated as HTML.

public setLamProMailIsHTML(bool $lamProMailIsHTML) : mixed
Parameters
$lamProMailIsHTML : bool

true if HTML

Return values
mixed

setLamProMailReplyTo()

Sets the reply-to address for password reset mails.

public setLamProMailReplyTo(string $lamProMailReplyTo) : bool
Parameters
$lamProMailReplyTo : string

mail address

Return values
bool

true if address is valid

setLamProMailSubject()

Sets the subject for password reset mails.

public setLamProMailSubject(string $lamProMailSubject) : mixed
Parameters
$lamProMailSubject : string

subject

Return values
mixed

setLamProMailText()

Sets the mail body for password reset mails.

public setLamProMailText(string $lamProMailText) : mixed
Parameters
$lamProMailText : string

body

Return values
mixed

setLoginMethod()

Sets the login method.

public setLoginMethod(string $loginMethod) : mixed
Parameters
$loginMethod : string
Return values
mixed

setLoginSearchDN()

Sets the DN for the login search bind user.

public setLoginSearchDN(string $loginSearchDN) : bool
Parameters
$loginSearchDN : string

DN

Return values
bool

true if DN is valid

setLoginSearchFilter()

Sets the login search filter.

public setLoginSearchFilter(string $loginSearchFilter) : mixed
Parameters
$loginSearchFilter : string

search filter

Return values
mixed

setLoginSearchPassword()

Sets the password for the login search bind user.

public setLoginSearchPassword(string $loginSearchPassword) : mixed
Parameters
$loginSearchPassword : string

password

Return values
mixed

setLoginSearchSuffix()

Sets the login search suffix.

public setLoginSearchSuffix(string $loginSearchSuffix) : mixed
Parameters
$loginSearchSuffix : string

suffix

Return values
mixed

setName()

Sets the name of the config file

public setName(string $name) : void
Parameters
$name : string

name

Return values
void

setPagedResults()

Sets if paged results should be used.

public setPagedResults(string $pagedResults) : mixed
Parameters
$pagedResults : string

true or false

Return values
mixed

setPwdPolicyMinLength()

Sets the minimum password length.

public setPwdPolicyMinLength(string $pwdPolicyMinLength) : mixed
Parameters
$pwdPolicyMinLength : string

minimum length

Return values
mixed

setPwdPolicyMinLowercase()

Sets the minimum of lowercase characters.

public setPwdPolicyMinLowercase(string $pwdPolicyMinLowercase) : mixed
Parameters
$pwdPolicyMinLowercase : string

minimum

Return values
mixed

setPwdPolicyMinNumeric()

Sets the minimum of numeric characters.

public setPwdPolicyMinNumeric(string $pwdPolicyMinNumeric) : mixed
Parameters
$pwdPolicyMinNumeric : string

minimum

Return values
mixed

setPwdPolicyMinSymbolic()

Sets the minimum of symbolic characters.

public setPwdPolicyMinSymbolic(string $pwdPolicyMinSymbolic) : mixed
Parameters
$pwdPolicyMinSymbolic : string

minimum

Return values
mixed

setPwdPolicyMinUppercase()

Sets the minimum of uppercase characters.

public setPwdPolicyMinUppercase(string $pwdPolicyMinUppercase) : mixed
Parameters
$pwdPolicyMinUppercase : string

minimum

Return values
mixed

setPwdResetAllowScreenPassword()

Sets if displaying password on screen is allowed on password reset page.

public setPwdResetAllowScreenPassword(string $pwdResetAllowScreenPassword) : mixed
Parameters
$pwdResetAllowScreenPassword : string

'true' or 'false'

Return values
mixed

setPwdResetAllowSpecificPassword()

Sets if setting a specific password is allowed on password reset page.

public setPwdResetAllowSpecificPassword(string $pwdResetAllowSpecificPassword) : mixed
Parameters
$pwdResetAllowSpecificPassword : string

'true' or 'false'

Return values
mixed

setPwdResetDefaultPasswordOutput()

Sets default password output method on password reset page.

public setPwdResetDefaultPasswordOutput(int $pwdResetDefaultPasswordOutput) : mixed
Parameters
$pwdResetDefaultPasswordOutput : int

LAMConfig::PWDRESET_DEFAULT_SCREEN/PWDRESET_DEFAULT_MAIL/PWDRESET_DEFAULT_BOTH

Return values
mixed

setPwdResetForcePasswordChange()

Sets if force password change is set by default on password reset page.

public setPwdResetForcePasswordChange(string $pwdResetForcePasswordChange) : mixed
Parameters
$pwdResetForcePasswordChange : string

'true' or 'false'

Return values
mixed

setReferentialIntegrityOverlay()

Sets if referential integrity overlay is in place.

public setReferentialIntegrityOverlay(string $referentialIntegrityOverlay) : mixed
Parameters
$referentialIntegrityOverlay : string

true or false

Return values
mixed

setScriptSSHKey()

Sets the path to lamdamon SSH key.

public setScriptSSHKey(string $value) : mixed
Parameters
$value : string

key path

Return values
mixed

setScriptSSHKeyPassword()

Sets the password for the lamdamon SSH key.

public setScriptSSHKeyPassword(string $value) : mixed
Parameters
$value : string

password

Return values
mixed

setScriptUserName()

Sets the lamdaemon user name.

public setScriptUserName(string $value) : mixed
Parameters
$value : string

user name

Return values
mixed

setServerDisplayName()

Sets the server display name

public setServerDisplayName(string $value) : bool
Parameters
$value : string

new server display name

Return values
bool

true if $value has correct format

setTimeZone()

Sets the time zone name.

public setTimeZone(string $value) : bool
Parameters
$value : string

new time zone

Return values
bool

true if $value has correct format

setToolSettings()

Sets the tool settings.

public setToolSettings(array<string|int, mixed> $toolSettings) : bool
Parameters
$toolSettings : array<string|int, mixed>

tool settings

Return values
bool

true if ok

setTwoFactorAuthentication()

Sets the authentication type.

public setTwoFactorAuthentication(string $twoFactorAuthentication) : mixed
Parameters
$twoFactorAuthentication : string

authentication type

Return values
mixed

setTwoFactorAuthenticationAttribute()

Sets the user attribute.

public setTwoFactorAuthenticationAttribute(string $twoFactorAuthenticationAttribute) : mixed
Parameters
$twoFactorAuthenticationAttribute : string

user attribute

Return values
mixed

setTwoFactorAuthenticationCaption()

Sets the caption HTML.

public setTwoFactorAuthenticationCaption(string $twoFactorAuthenticationCaption) : mixed
Parameters
$twoFactorAuthenticationCaption : string

caption HTML

Return values
mixed

setTwoFactorAuthenticationClientId()

Sets the client id.

public setTwoFactorAuthenticationClientId(string $clientId) : mixed
Parameters
$clientId : string

client id

Return values
mixed

setTwoFactorAuthenticationDomain()

Sets the domain.

public setTwoFactorAuthenticationDomain(string $domain) : mixed
Parameters
$domain : string

domain

Return values
mixed

setTwoFactorAuthenticationInsecure()

Sets if SSL certificate verification is turned off.

public setTwoFactorAuthenticationInsecure(bool $twoFactorAuthenticationInsecure) : mixed
Parameters
$twoFactorAuthenticationInsecure : bool

SSL certificate verification is turned off

Return values
mixed

setTwoFactorAuthenticationLabel()

Sets the authentication label.

public setTwoFactorAuthenticationLabel(string $twoFactorAuthenticationLabel) : mixed
Parameters
$twoFactorAuthenticationLabel : string

authentication label

Return values
mixed

setTwoFactorAuthenticationOptional()

Sets if 2nd factor is optional.

public setTwoFactorAuthenticationOptional(bool $twoFactorAuthenticationOptional) : mixed
Parameters
$twoFactorAuthenticationOptional : bool

2nd factor is optional

Return values
mixed

setTwoFactorAuthenticationSecretKey()

Sets the secret key.

public setTwoFactorAuthenticationSecretKey(string $secretKey) : mixed
Parameters
$secretKey : string

secret key

Return values
mixed

setTwoFactorAuthenticationURL()

Sets the authentication URL.

public setTwoFactorAuthenticationURL(string $twoFactorAuthenticationURL) : mixed
Parameters
$twoFactorAuthenticationURL : string

authentication URL

Return values
mixed

setUseTLS()

Sets if TLS is activated.

public setUseTLS(string $useTLS) : bool
Parameters
$useTLS : string

yes or no

Return values
bool

true if $useTLS has correct format

hashPassword()

Returns the hashed password.

private hashPassword(string $password, string $salt) : string
Parameters
$password : string

password

$salt : string

salt

Return values
string

hash value

Search results