LDAP Account Manager

LAMConfig
in package

configuration

This class manages conf files.

ACCESS_ALL = '100'
ACCESS_PASSWORD_CHANGE = '20'
ACCESS_READ_ONLY = '0'
LINE_SEPARATOR = '+::+': line separator
LOGIN_LIST = 'list'
LOGIN_SEARCH = 'search'
PWDRESET_DEFAULT_ALL = '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
PWDRESET_DEFAULT_SMS = '4': send password via SMS by default
$accessLevel : string: access level
$activeTypes : string: Active account types
$Admins : string: list of users with admin rights, separated by semicolon
$adShowDeleted : string: Active Directory: show deleted entries
$defaultLanguage : string: Default language
$followReferrals : string: automatically follow referrals
$hideDnPart : string
$hidePasswordPromptForExpiredPasswords : string: hide password prompt for expired passwords
$httpAuthentication : string: specifies if HTTP authentication should be used
$jobsBindPassword : string|null: LDAP password for jobs
$jobsBindUser : string|null: LDAP user for jobs
$jobsDatabase : string|null: database type for jobs
$jobsDBCaPath : string|null: CA path of job database
$jobsDBHost : string|null: host of job database
$jobsDBName : string|null: name of job database
$jobsDBPassword : string|null: password of job database
$jobsDBPort : string|null: port of job database
$jobsDBUser : string|null: user of job database
$jobSettings : array<string|int, mixed>
$lamProMailAllowAlternateAddress : string: allow sending mails to an alternative address
$lamProMailFrom : string: email address for sender of password reset mails
$lamProMailIsHTML : string: treat password reset mail body as HTML
$lamProMailReplyTo : string: reply-to email address for password reset mails
$lamProMailSubject : string: subject for password reset mails
$lamProMailText : string: mail body for password reset mails
$loginMethod : string: login method
$loginSearchDN : string: bind user for login search
$loginSearchFilter : string: search filter for login
$loginSearchPassword : string: bind password for login search
$loginSearchSuffix : string: search suffix for login
$moduleSettings : array<string|int, mixed>
$name : string: Name of configuration file
$pagedResults : string: use paged results
$Passwd : string|null: Password to edit preferences
$pwdPolicyMinLength : string
$pwdPolicyMinLowercase : string
$pwdPolicyMinNumeric : string
$pwdPolicyMinSymbolic : string
$pwdPolicyMinUppercase : string
$pwdResetAllowScreenPassword : string: password reset page: allow to show password on screen
$pwdResetAllowSpecificPassword : string: password reset page: allow to set a specific password
$pwdResetDefaultPasswordOutput : string: password reset page: default selection for password output PWDRESET_DEFAULT_SCREEN, PWDRESET_DEFAULT_MAIL, PWDRESET_DEFAULT_BOTH
$pwdResetForcePasswordChange : string: password reset page: force password change by default
$referentialIntegrityOverlay : string: overlay for referential integrity is activated
$scriptPath : string: Path to external lamdaemon script on server where it is executed
$scriptRights : string: The rights for the home directory
$scriptServer : string: Servers where lamdaemon script is executed
$scriptSSHKey : string: File name of SSH key for lamdaemon.
$scriptSSHKeyPassword : string: Password for lamdaemon SSH key.
$scriptUserName : string: user name for lamdaemon
$searchLimit : int: LDAP search limit
$serverDisplayName : string: Display name of LDAP server
$ServerURL : string: Server address (e.g. ldap://127.0.0.1:389)
$settings : array<string|int, mixed>
$timeZone : string: time zone
$toolSettings : array<string|int, mixed>
$twoFactorAllowToRememberDevice : string
$twoFactorAuthentication : string
$twoFactorAuthenticationAttribute : string
$twoFactorAuthenticationCaption : string
$twoFactorAuthenticationClientId : string
$twoFactorAuthenticationDomain : string
$twoFactorAuthenticationInsecure : bool
$twoFactorAuthenticationLabel : string
$twoFactorAuthenticationOptional : bool
$twoFactorAuthenticationSecretKey : string
$twoFactorAuthenticationURL : string
$twoFactorRememberDeviceDuration : string
$twoFactorRememberDevicePassword : string
$typeSettings : array<string|int, mixed>
$useTLS : string: enables/disables TLS encryption
check_Passwd() : bool: Checks if the given password matches.
exportData() : array<string, string|int|bool|null|object|array>: Returns the server profile data.
get_AccountModules() : array<string|int, class-string<\baseModule>>: 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, string>: 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 given list.
get_moduleSettings() : array<string, array<string|int, string>>: 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, string>: Returns a list of saved type settings
getAccessLevel() : string: Returns the access level for this profile.
getActiveTypesString() : string: Returns a list of active account types as string.
getAdShowDeleted() : string: Returns if deleted entries should be shown.
getConfiguredScriptServers() : array<string|int, RemoteServerConfiguration>: Returns the list of configured 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.
getJobsDBCaPath() : string: Returns the CA certificate path.
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, array<string|int, string>>: Returns a list of saved job settings.
getLamProMailAllowAlternateAddress() : string: Returns if sending to an alternate address is allowed.
getLamProMailFrom() : string: Returns the sender address for password reset mails.
getLamProMailIsHTML() : string: 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() : string: 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|null: 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, string>: Returns the tool settings.
getTwoFactorAllowToRememberDevice() : string: Returns if remembering devices is allowed.
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.
getTwoFactorRememberDeviceDuration() : string: Returns the duration for device remembering in hours.
getTwoFactorRememberDevicePassword() : string: Returns the password for device remembering.
getUseTLS() : string: Returns if TLS is activated.
hasPasswordSet() : bool: Returns if the server profile has a password set.
importData() : void: 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() : void: Removes any non-existing modules from the configuration.
removeInvalidTypes() : void: Removes any non-existing types from the configuration.
set_ActiveTypes() : void: 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() : void: 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() : void: Sets the settings for the account types.
setAccessLevel() : void: Sets the access level for this profile.
setAdShowDeleted() : void: Sets if deleted entries should be shown.
setFollowReferrals() : void: Sets if referrals should be followed.
setHideDnPart() : void: Sets the DN part to hide.
setHidePasswordPromptForExpiredPasswords() : void: Sets if password prompt for expired passwords is hidden.
setHttpAuthentication() : void: Specifies if HTTP authentication should be used.
setJobsBindPassword() : void: Sets the bind password for jobs.
setJobsBindUser() : void: Sets the bind user for jobs.
setJobsDatabase() : void: Sets the database type for jobs.
setJobsDBCaPath() : void: Sets the CA certificate path.
setJobsDBHost() : void: Sets the host.
setJobsDBName() : void: Sets the database name
setJobsDBPassword() : void: Sets the DB password.
setJobsDBPort() : void: Sets the port.
setJobsDBUser() : void: Sets the DB user.
setJobSettings() : void: Sets the settings for the jobs.
setLamProMailAllowAlternateAddress() : void: Sets if sending to an alternate address is allowed.
setLamProMailFrom() : bool: Sets the sender address for password reset mails.
setLamProMailIsHTML() : void: Sets if the password reset mail content should be treated as HTML.
setLamProMailReplyTo() : bool: Sets the reply-to address for password reset mails.
setLamProMailSubject() : void: Sets the subject for password reset mails.
setLamProMailText() : void: Sets the mail body for password reset mails.
setLoginMethod() : void: Sets the login method.
setLoginSearchDN() : bool: Sets the DN for the login search bind user.
setLoginSearchFilter() : void: Sets the login search filter.
setLoginSearchPassword() : void: Sets the password for the login search bind user.
setLoginSearchSuffix() : void: Sets the login search suffix.
setName() : void: Sets the name of the config file
setPagedResults() : void: Sets if paged results should be used.
setPwdPolicyMinLength() : void: Sets the minimum password length.
setPwdPolicyMinLowercase() : void: Sets the minimum of lowercase characters.
setPwdPolicyMinNumeric() : void: Sets the minimum of numeric characters.
setPwdPolicyMinSymbolic() : void: Sets the minimum of symbolic characters.
setPwdPolicyMinUppercase() : void: Sets the minimum of uppercase characters.
setPwdResetAllowScreenPassword() : void: Sets if displaying password on screen is allowed on password reset page.
setPwdResetAllowSpecificPassword() : void: Sets if setting a specific password is allowed on password reset page.
setPwdResetDefaultPasswordOutput() : void: Sets default password output method on password reset page.
setPwdResetForcePasswordChange() : void: Sets if force password change is set by default on password reset page.
setReferentialIntegrityOverlay() : void: Sets if referential integrity overlay is in place.
setScriptSSHKey() : void: Sets the path to lamdamon SSH key.
setScriptSSHKeyPassword() : void: Sets the password for the lamdamon SSH key.
setScriptUserName() : void: Sets the lamdaemon user name.
setServerDisplayName() : bool: Sets the server display name
setTimeZone() : bool: Sets the time zone name.
setToolSettings() : void: Sets the tool settings.
setTwoFactorAllowToRememberDevice() : void: Sets the user attribute.
setTwoFactorAuthentication() : void: Sets the authentication type.
setTwoFactorAuthenticationAttribute() : void: Sets the user attribute.
setTwoFactorAuthenticationCaption() : void: Sets the caption HTML.
setTwoFactorAuthenticationClientId() : void: Sets the client id.
setTwoFactorAuthenticationDomain() : void: Sets the domain.
setTwoFactorAuthenticationInsecure() : void: Sets if SSL certificate verification is turned off.
setTwoFactorAuthenticationLabel() : void: Sets the authentication label.
setTwoFactorAuthenticationOptional() : void: Sets if 2nd factor is optional.
setTwoFactorAuthenticationSecretKey() : void: Sets the secret key.
setTwoFactorAuthenticationURL() : void: Sets the authentication URL.
setTwoFactorRememberDeviceDuration() : void: Sets the duration for device remembering in hours.
setTwoFactorRememberDevicePassword() : void: Sets the password for device remembering.
setUseTLS() : bool: Sets if TLS is activated.
hashPassword() : string: Returns the hashed password.

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'

LOGIN_SEARCH


    public
        mixed
    LOGIN_SEARCH
    = 'search'

PWDRESET_DEFAULT_ALL

show password on screen and send via email by default


    public
        mixed
    PWDRESET_DEFAULT_ALL
    = '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'

PWDRESET_DEFAULT_SMS

send password via SMS by default


    public
        mixed
    PWDRESET_DEFAULT_SMS
    = '4'

$accessLevel

access level


    private
        string
    $accessLevel
     = \LAMConfig::ACCESS_ALL

$activeTypes

Active account types


    private
        string
    $activeTypes
     = ""

$Admins

list of users with admin rights, separated by semicolon


    private
        string
    $Admins
     = ''

$adShowDeleted

Active Directory: show deleted entries


    private
        string
    $adShowDeleted
     = 'false'

$defaultLanguage

Default language


    private
        string
    $defaultLanguage
     = ''

$followReferrals

automatically follow referrals


    private
        string
    $followReferrals
     = 'false'

$hideDnPart


    private
        string
    $hideDnPart
     = ''

$hidePasswordPromptForExpiredPasswords

hide password prompt for expired passwords


    private
        string
    $hidePasswordPromptForExpiredPasswords
     = 'false'

$httpAuthentication

specifies if HTTP authentication should be used


    private
        string
    $httpAuthentication
     = 'false'

$jobsBindPassword

LDAP password for jobs


    private
        string|null
    $jobsBindPassword
     = ''

$jobsBindUser

LDAP user for jobs


    private
        string|null
    $jobsBindUser
     = ''

$jobsDatabase

database type for jobs


    private
        string|null
    $jobsDatabase
     = ''

$jobsDBCaPath

CA path of job database


    private
        string|null
    $jobsDBCaPath
     = ''

$jobsDBHost

host of job database


    private
        string|null
    $jobsDBHost
     = ''

$jobsDBName

name of job database


    private
        string|null
    $jobsDBName
     = ''

$jobsDBPassword

password of job database


    private
        string|null
    $jobsDBPassword
     = ''

$jobsDBPort

port of job database


    private
        string|null
    $jobsDBPort
     = ''

$jobsDBUser

user of job database


    private
        string|null
    $jobsDBUser
     = ''

$jobSettings


    private
        array<string|int, mixed>
    $jobSettings
     = []

job configuration

$lamProMailAllowAlternateAddress

allow sending mails to an alternative address


    private
        string
    $lamProMailAllowAlternateAddress
     = 'true'

$lamProMailFrom

email address for sender of password reset mails


    private
        string
    $lamProMailFrom
     = ''

$lamProMailIsHTML

treat password reset mail body as HTML


    private
        string
    $lamProMailIsHTML
     = 'false'

$lamProMailReplyTo

reply-to email address for password reset mails


    private
        string
    $lamProMailReplyTo
     = ''

$lamProMailSubject

subject for password reset mails


    private
        string
    $lamProMailSubject
     = ''

$lamProMailText

mail body for password reset mails


    private
        string
    $lamProMailText
     = ''

$loginMethod


    private
        string
    $loginMethod
     = \LAMConfig::LOGIN_LIST

$loginSearchDN

bind user for login search


    private
        string
    $loginSearchDN
     = ''

$loginSearchFilter

search filter for login


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

$loginSearchPassword

bind password for login search


    private
        string
    $loginSearchPassword
     = ''

$loginSearchSuffix

search suffix for login


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

$moduleSettings


    private
        array<string|int, mixed>
    $moduleSettings
     = []

module settings

$name

Name of configuration file


    private
        string
    $name

$pagedResults

use paged results


    private
        string
    $pagedResults
     = 'false'

$Passwd

Password to edit preferences


    private
        string|null
    $Passwd
     = \null

$pwdPolicyMinLength


    private
        string
    $pwdPolicyMinLength
     = ''

$pwdPolicyMinLowercase


    private
        string
    $pwdPolicyMinLowercase
     = ''

$pwdPolicyMinNumeric


    private
        string
    $pwdPolicyMinNumeric
     = ''

$pwdPolicyMinSymbolic


    private
        string
    $pwdPolicyMinSymbolic
     = ''

$pwdPolicyMinUppercase


    private
        string
    $pwdPolicyMinUppercase
     = ''

$pwdResetAllowScreenPassword

password reset page: allow to show password on screen


    private
        string
    $pwdResetAllowScreenPassword
     = 'true'

$pwdResetAllowSpecificPassword

password reset page: allow to set a specific password


    private
        string
    $pwdResetAllowSpecificPassword
     = 'true'

$pwdResetDefaultPasswordOutput

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


    private
        string
    $pwdResetDefaultPasswordOutput
     = \LAMConfig::PWDRESET_DEFAULT_MAIL

$pwdResetForcePasswordChange

password reset page: force password change by default


    private
        string
    $pwdResetForcePasswordChange
     = 'true'

$referentialIntegrityOverlay

overlay for referential integrity is activated


    private
        string
    $referentialIntegrityOverlay
     = 'false'

$scriptPath

Path to external lamdaemon script on server where it is executed


    private
        string
    $scriptPath
     = ''

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

$scriptRights

The rights for the home directory


    private
        string
    $scriptRights
     = '750'

$scriptServer

Servers where lamdaemon script is executed


    private
        string
    $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
        string
    $scriptSSHKey
     = ''

$scriptSSHKeyPassword

Password for lamdaemon SSH key.


    private
        string
    $scriptSSHKeyPassword
     = ''

$scriptUserName

user name for lamdaemon


    private
        string
    $scriptUserName
     = ''

$searchLimit

LDAP search limit


    private
        int
    $searchLimit
     = 0

$serverDisplayName

Display name of LDAP server


    private
        string
    $serverDisplayName
     = ''

$ServerURL

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


    private
        string
    $ServerURL
     = ''

$settings


    private
        array<string|int, mixed>
    $settings
     = ["ServerURL", "useTLS", "followReferrals", 'pagedResults', 'adShowDeleted', "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', 'jobs', 'jobsDBHost', 'jobsDBPort', 'jobsDBCaPath', 'jobsDBUser', 'jobsDBPassword', 'jobsDBName', 'pwdResetAllowSpecificPassword', 'pwdResetAllowScreenPassword', 'pwdResetForcePasswordChange', 'pwdResetDefaultPasswordOutput', 'scriptUserName', 'scriptSSHKey', 'scriptSSHKeyPassword', 'twoFactorAuthentication', 'twoFactorAuthenticationURL', 'twoFactorAuthenticationInsecure', 'twoFactorAuthenticationLabel', 'twoFactorAuthenticationOptional', 'twoFactorAuthenticationCaption', 'twoFactorAuthenticationClientId', 'twoFactorAuthenticationSecretKey', 'twoFactorAuthenticationDomain', 'twoFactorAuthenticationAttribute', 'twoFactorAllowToRememberDevice', 'twoFactorRememberDeviceDuration', 'twoFactorRememberDevicePassword', 'referentialIntegrityOverlay', 'hidePasswordPromptForExpiredPasswords', 'hideDnPart', 'pwdPolicyMinLength', 'pwdPolicyMinLowercase', 'pwdPolicyMinUppercase', 'pwdPolicyMinNumeric', 'pwdPolicyMinSymbolic']

List of all settings in config file

$timeZone

time zone


    private
        string
    $timeZone
     = 'Europe/London'

$toolSettings


    private
        array<string|int, mixed>
    $toolSettings
     = []

tool settings

$twoFactorAllowToRememberDevice


    private
        string
    $twoFactorAllowToRememberDevice
     = 'false'

$twoFactorAuthentication


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

$twoFactorAuthenticationAttribute


    private
        string
    $twoFactorAuthenticationAttribute
     = ''

$twoFactorAuthenticationCaption


    private
        string
    $twoFactorAuthenticationCaption
     = ''

$twoFactorAuthenticationClientId


    private
        string
    $twoFactorAuthenticationClientId
     = ''

$twoFactorAuthenticationDomain


    private
        string
    $twoFactorAuthenticationDomain
     = ''

$twoFactorAuthenticationInsecure


    private
        bool
    $twoFactorAuthenticationInsecure
     = \false

$twoFactorAuthenticationLabel


    private
        string
    $twoFactorAuthenticationLabel
     = ''

$twoFactorAuthenticationOptional


    private
        bool
    $twoFactorAuthenticationOptional
     = \false

$twoFactorAuthenticationSecretKey


    private
        string
    $twoFactorAuthenticationSecretKey
     = ''

$twoFactorAuthenticationURL


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

$twoFactorRememberDeviceDuration


    private
        string
    $twoFactorRememberDeviceDuration
     = '28800'

$twoFactorRememberDevicePassword


    private
        string
    $twoFactorRememberDevicePassword
     = ''

$typeSettings


    private
        array<string|int, mixed>
    $typeSettings
     = []

type settings

$useTLS

enables/disables TLS encryption


    private
        string
    $useTLS
     = 'no'

check_Passwd()

Checks if the given password matches.


    public
                    check_Passwd(string $password) : bool

Parameters

$password : string: password

Return values

bool —

true, if matches

exportData()

Returns the server profile data.


    public
                    exportData() : array<string, string|int|bool|null|object|array>

Return values

data

get_AccountModules()

Returns an array of all selected account modules


    public
                    get_AccountModules(string $scope) : array<string|int, class-string<\baseModule>>

Parameters

$scope : string: account type

Return values

array<string|int, class-string<\baseModule>> —

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, string>

Return values

array<string|int, string> —

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 given list.


    public
                    get_listAttributes(string $typeId) : string

Parameters

$typeId : string: account type ID

Return values

string —

the attribute list

get_moduleSettings()

Returns a list of saved module settings


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

Return values

array<string, array<string|int, string>> —

list of settings: [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, string>

Return values

array<string, string> —

list of settings: [name => value]

getAccessLevel()

Returns the access level for this profile.


    public
                    getAccessLevel() : string

Return values

string —

level

getActiveTypesString()

Returns a list of active account types as string.


    public
                    getActiveTypesString() : string

Return values

string —

list of types

getAdShowDeleted()

Returns if deleted entries should be shown.


    public
                    getAdShowDeleted() : string

Return values

string —

true or false

getConfiguredScriptServers()

Returns the list of configured 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

getJobsDBCaPath()

Returns the CA certificate path.


    public
                    getJobsDBCaPath() : string

Return values

string —

path

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, array<string|int, string>>

Return values

array<string, array<string|int, string>> —

list of settings: [name => value]

getLamProMailAllowAlternateAddress()

Returns if sending to an alternate address is allowed.


    public
                    getLamProMailAllowAlternateAddress() : string

Return values

string —

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() : string

Return values

string —

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

Return values

string —

getLoginSearchDN()

Returns the DN for the login search bind user.


    public
                    getLoginSearchDN() : string

Return values

string —

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() : string

Return values

string —

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|null

Parameters

$serverName : string: server name

Return values

RemoteServerConfiguration|null —

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, string>

Return values

array<string, string> —

$toolSettings tool settings

getTwoFactorAllowToRememberDevice()

Returns if remembering devices is allowed.


    public
                    getTwoFactorAllowToRememberDevice() : string

Return values

string —

remembering allowed

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

getTwoFactorRememberDeviceDuration()

Returns the duration for device remembering in hours.


    public
                    getTwoFactorRememberDeviceDuration() : string

Return values

string —

duration

getTwoFactorRememberDevicePassword()

Returns the password for device remembering.


    public
                    getTwoFactorRememberDevicePassword() : string

Return values

string —

password

getUseTLS()

Returns if TLS is activated.


    public
                    getUseTLS() : string

Return values

string —

yes or no

hasPasswordSet()

Returns if the server profile has a password set.


    public
                    hasPasswordSet() : bool

Return values

bool —

password is set

importData()

Imports server profile data.


    public
                    importData(array<string, string|int|bool|null|object|array> $data) : void

Parameters

$data : array<string, string|int|bool|null|object|array>: config data

Return values

void —

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(string $value) : string|false

Parameters

$value : string: input field value

Return values

string|false —

value to store in configuration

removeInvalidModules()

Removes any non-existing modules from the configuration.


    public
                    removeInvalidModules() : void

Return values

void —

removeInvalidTypes()

Removes any non-existing types from the configuration.


    public
                    removeInvalidTypes() : void

Return values

void —

set_ActiveTypes()

Sets the list of active types.


    public
                    set_ActiveTypes(array<string|int, string> $types) : void

Parameters

$types : array<string|int, string>: list of types

Return values

void —

set_Adminstring()

Sets the admin string


    public
                    set_Adminstring(string|null $value) : bool

Parameters

$value : string|null: 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|null $value) : bool

Parameters

$value : string|null: 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|null $value, string $typeId) : bool

Parameters

$value : string|null: new attribute string
$typeId : string: account type ID

Return values

bool —

true if $value has correct format

set_moduleSettings()

Sets the settings for the account modules.


    public
                    set_moduleSettings(array<string, array<string|int, string>> $settings) : void

Parameters

$settings : array<string, array<string|int, string>>: list of module setting [name => value]

Return values

void —

set_Passwd()

Sets the preferences wizard password


    public
                    set_Passwd(string|null $value) : bool

Parameters

$value : string|null: new password

Return values

bool —

true if $value has correct format

set_scriptPath()

Sets the path to the external script


    public
                    set_scriptPath(string|null $value) : bool

Parameters

$value : string|null: 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|null $value) : bool

Parameters

$value : string|null: 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 $typeId, string|null $value) : bool

Parameters

$typeId : string: account type ID
$value : string|null: 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, string> $settings) : void

Parameters

$settings : array<string, string>: list of type setting [name => value]

Return values

void —

setAccessLevel()

Sets the access level for this profile.


    public
                    setAccessLevel(string $level) : void

Parameters

$level : string: level

Return values

void —

setAdShowDeleted()

Sets if deleted entries should be shown.


    public
                    setAdShowDeleted(string $adShowDeleted) : void

Parameters

$adShowDeleted : string: true or false

Return values

void —

setFollowReferrals()

Sets if referrals should be followed.


    public
                    setFollowReferrals(string $followReferrals) : void

Parameters

$followReferrals : string: true or false

Return values

void —

setHideDnPart()

Sets the DN part to hide.


    public
                    setHideDnPart(string $hideDnPart) : void

Parameters

$hideDnPart : string: DN part

Return values

void —

setHidePasswordPromptForExpiredPasswords()

Sets if password prompt for expired passwords is hidden.


    public
                    setHidePasswordPromptForExpiredPasswords(string $hidePasswordPromptForExpiredPasswords) : void

Parameters

$hidePasswordPromptForExpiredPasswords : string: true or false

Return values

void —

setHttpAuthentication()

Specifies if HTTP authentication should be used.


    public
                    setHttpAuthentication(string $httpAuthentication) : void

Parameters

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

Return values

void —

setJobsBindPassword()

Sets the bind password for jobs.


    public
                    setJobsBindPassword(string $jobsBindPassword) : void

Parameters

$jobsBindPassword : string: password

Return values

void —

setJobsBindUser()

Sets the bind user for jobs.


    public
                    setJobsBindUser(string $jobsBindUser) : void

Parameters

$jobsBindUser : string: bind user

Return values

void —

setJobsDatabase()

Sets the database type for jobs.


    public
                    setJobsDatabase(string $jobsDatabase) : void

Parameters

$jobsDatabase : string: database type

Return values

void —

setJobsDBCaPath()

Sets the CA certificate path.


    public
                    setJobsDBCaPath(string $jobsDBCaPath) : void

Parameters

$jobsDBCaPath : string: path

Return values

void —

setJobsDBHost()

Sets the host.


    public
                    setJobsDBHost(string $jobsDBHost) : void

Parameters

$jobsDBHost : string: host

Return values

void —

setJobsDBName()

Sets the database name


    public
                    setJobsDBName(string $jobsDBName) : void

Parameters

$jobsDBName : string: DB name

Return values

void —

setJobsDBPassword()

Sets the DB password.


    public
                    setJobsDBPassword(string $jobsDBPassword) : void

Parameters

$jobsDBPassword : string: password

Return values

void —

setJobsDBPort()

Sets the port.


    public
                    setJobsDBPort(string $jobsDBPort) : void

Parameters

$jobsDBPort : string: port

Return values

void —

setJobsDBUser()

Sets the DB user.


    public
                    setJobsDBUser(string $jobsDBUser) : void

Parameters

$jobsDBUser : string: user name

Return values

void —

setJobSettings()

Sets the settings for the jobs.


    public
                    setJobSettings(array<string, array<string|int, string>> $settings) : void

Parameters

$settings : array<string, array<string|int, string>>: list of job settings [name => value]

Return values

void —

setLamProMailAllowAlternateAddress()

Sets if sending to an alternate address is allowed.


    public
                    setLamProMailAllowAlternateAddress(string $lamProMailAllowAlternateAddress) : void

Parameters

$lamProMailAllowAlternateAddress : string: alternate address allowed

Return values

void —

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(string $lamProMailIsHTML) : void

Parameters

$lamProMailIsHTML : string: true if HTML

Return values

void —

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) : void

Parameters

$lamProMailSubject : string: subject

Return values

void —

setLamProMailText()

Sets the mail body for password reset mails.


    public
                    setLamProMailText(string $lamProMailText) : void

Parameters

$lamProMailText : string: body

Return values

void —

setLoginMethod()

Sets the login method.


    public
                    setLoginMethod(string $loginMethod) : void

Parameters

$loginMethod : string: login method

Return values

void —

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) : void

Parameters

$loginSearchFilter : string: search filter

Return values

void —

setLoginSearchPassword()

Sets the password for the login search bind user.


    public
                    setLoginSearchPassword(string $loginSearchPassword) : void

Parameters

$loginSearchPassword : string: password

Return values

void —

setLoginSearchSuffix()

Sets the login search suffix.


    public
                    setLoginSearchSuffix(string $loginSearchSuffix) : void

Parameters

$loginSearchSuffix : string: suffix

Return values

void —

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) : void

Parameters

$pagedResults : string: true or false

Return values

void —

setPwdPolicyMinLength()

Sets the minimum password length.


    public
                    setPwdPolicyMinLength(string $pwdPolicyMinLength) : void

Parameters

$pwdPolicyMinLength : string: minimum length

Return values

void —

setPwdPolicyMinLowercase()

Sets the minimum of lowercase characters.


    public
                    setPwdPolicyMinLowercase(string $pwdPolicyMinLowercase) : void

Parameters

$pwdPolicyMinLowercase : string: minimum

Return values

void —

setPwdPolicyMinNumeric()

Sets the minimum of numeric characters.


    public
                    setPwdPolicyMinNumeric(string $pwdPolicyMinNumeric) : void

Parameters

$pwdPolicyMinNumeric : string: minimum

Return values

void —

setPwdPolicyMinSymbolic()

Sets the minimum of symbolic characters.


    public
                    setPwdPolicyMinSymbolic(string $pwdPolicyMinSymbolic) : void

Parameters

$pwdPolicyMinSymbolic : string: minimum

Return values

void —

setPwdPolicyMinUppercase()

Sets the minimum of uppercase characters.


    public
                    setPwdPolicyMinUppercase(string $pwdPolicyMinUppercase) : void

Parameters

$pwdPolicyMinUppercase : string: minimum

Return values

void —

setPwdResetAllowScreenPassword()

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


    public
                    setPwdResetAllowScreenPassword(string $pwdResetAllowScreenPassword) : void

Parameters

$pwdResetAllowScreenPassword : string: 'true' or 'false'

Return values

void —

setPwdResetAllowSpecificPassword()

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


    public
                    setPwdResetAllowSpecificPassword(string $pwdResetAllowSpecificPassword) : void

Parameters

$pwdResetAllowSpecificPassword : string: 'true' or 'false'

Return values

void —

setPwdResetDefaultPasswordOutput()

Sets default password output method on password reset page.


    public
                    setPwdResetDefaultPasswordOutput(string $pwdResetDefaultPasswordOutput) : void

Parameters

$pwdResetDefaultPasswordOutput : string: LAMConfig::PWDRESET_DEFAULT_SCREEN/PWDRESET_DEFAULT_MAIL/PWDRESET_DEFAULT_BOTH

Return values

void —

setPwdResetForcePasswordChange()

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


    public
                    setPwdResetForcePasswordChange(string $pwdResetForcePasswordChange) : void

Parameters

$pwdResetForcePasswordChange : string: 'true' or 'false'

Return values

void —

setReferentialIntegrityOverlay()

Sets if referential integrity overlay is in place.


    public
                    setReferentialIntegrityOverlay(string $referentialIntegrityOverlay) : void

Parameters

$referentialIntegrityOverlay : string: true or false

Return values

void —

setScriptSSHKey()

Sets the path to lamdamon SSH key.


    public
                    setScriptSSHKey(string $value) : void

Parameters

$value : string: key path

Return values

void —

setScriptSSHKeyPassword()

Sets the password for the lamdamon SSH key.


    public
                    setScriptSSHKeyPassword(string $value) : void

Parameters

$value : string: password

Return values

void —

setScriptUserName()

Sets the lamdaemon user name.


    public
                    setScriptUserName(string $value) : void

Parameters

$value : string: user name

Return values

void —

setServerDisplayName()

Sets the server display name


    public
                    setServerDisplayName(string|null $value) : bool

Parameters

$value : string|null: new server display name

Return values

bool —

true if $value has correct format

setTimeZone()

Sets the time zone name.


    public
                    setTimeZone(string|null $value) : bool

Parameters

$value : string|null: new time zone

Return values

bool —

true if $value has correct format

setToolSettings()

Sets the tool settings.


    public
                    setToolSettings(array<string, string> $toolSettings) : void

Parameters

$toolSettings : array<string, string>: tool settings

Return values

void —

setTwoFactorAllowToRememberDevice()

Sets the user attribute.


    public
                    setTwoFactorAllowToRememberDevice(string $twoFactorAllowToRememberDevice) : void

Parameters

$twoFactorAllowToRememberDevice : string: remembering allowed

Return values

void —

setTwoFactorAuthentication()

Sets the authentication type.


    public
                    setTwoFactorAuthentication(string $twoFactorAuthentication) : void

Parameters

$twoFactorAuthentication : string: authentication type

Return values

void —

setTwoFactorAuthenticationAttribute()

Sets the user attribute.


    public
                    setTwoFactorAuthenticationAttribute(string $twoFactorAuthenticationAttribute) : void

Parameters

$twoFactorAuthenticationAttribute : string: user attribute

Return values

void —

setTwoFactorAuthenticationCaption()

Sets the caption HTML.


    public
                    setTwoFactorAuthenticationCaption(string $twoFactorAuthenticationCaption) : void

Parameters

$twoFactorAuthenticationCaption : string: caption HTML

Return values

void —

setTwoFactorAuthenticationClientId()

Sets the client id.


    public
                    setTwoFactorAuthenticationClientId(string $clientId) : void

Parameters

$clientId : string: client id

Return values

void —

setTwoFactorAuthenticationDomain()

Sets the domain.


    public
                    setTwoFactorAuthenticationDomain(string $domain) : void

Parameters

$domain : string: domain

Return values

void —

setTwoFactorAuthenticationInsecure()

Sets if SSL certificate verification is turned off.


    public
                    setTwoFactorAuthenticationInsecure(bool $twoFactorAuthenticationInsecure) : void

Parameters

$twoFactorAuthenticationInsecure : bool: SSL certificate verification is turned off

Return values

void —

setTwoFactorAuthenticationLabel()

Sets the authentication label.


    public
                    setTwoFactorAuthenticationLabel(string $twoFactorAuthenticationLabel) : void

Parameters

$twoFactorAuthenticationLabel : string: authentication label

Return values

void —

setTwoFactorAuthenticationOptional()

Sets if 2nd factor is optional.


    public
                    setTwoFactorAuthenticationOptional(bool $twoFactorAuthenticationOptional) : void

Parameters

$twoFactorAuthenticationOptional : bool: 2nd factor is optional

Return values

void —

setTwoFactorAuthenticationSecretKey()

Sets the secret key.


    public
                    setTwoFactorAuthenticationSecretKey(string $secretKey) : void

Parameters

$secretKey : string: secret key

Return values

void —

setTwoFactorAuthenticationURL()

Sets the authentication URL.


    public
                    setTwoFactorAuthenticationURL(string $twoFactorAuthenticationURL) : void

Parameters

$twoFactorAuthenticationURL : string: authentication URL

Return values

void —

setTwoFactorRememberDeviceDuration()

Sets the duration for device remembering in hours.


    public
                    setTwoFactorRememberDeviceDuration(string $twoFactorRememberDeviceDuration) : void

Parameters

$twoFactorRememberDeviceDuration : string: duration in hours

Return values

void —

setTwoFactorRememberDevicePassword()

Sets the password for device remembering.


    public
                    setTwoFactorRememberDevicePassword(string $twoFactorRememberDevicePassword) : void

Parameters

$twoFactorRememberDevicePassword : string: password

Return values

void —

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

LAMConfig in package configuration

Table of Contents

Constants

ACCESS_ALL

ACCESS_PASSWORD_CHANGE

ACCESS_READ_ONLY

LINE_SEPARATOR

LOGIN_LIST

LOGIN_SEARCH

PWDRESET_DEFAULT_ALL

PWDRESET_DEFAULT_MAIL

PWDRESET_DEFAULT_SCREEN

PWDRESET_DEFAULT_SMS

Properties

$accessLevel

$activeTypes

$Admins

$adShowDeleted

$defaultLanguage

$followReferrals

$hideDnPart

$hidePasswordPromptForExpiredPasswords

$httpAuthentication

$jobsBindPassword

$jobsBindUser

$jobsDatabase

$jobsDBCaPath

$jobsDBHost

$jobsDBName

$jobsDBPassword

$jobsDBPort

$jobsDBUser

$jobSettings

$lamProMailAllowAlternateAddress

$lamProMailFrom

$lamProMailIsHTML

$lamProMailReplyTo

$lamProMailSubject

$lamProMailText

$loginMethod

$loginSearchDN

$loginSearchFilter

$loginSearchPassword

$loginSearchSuffix

$moduleSettings

$name

$pagedResults

$Passwd

$pwdPolicyMinLength

$pwdPolicyMinLowercase

$pwdPolicyMinNumeric

$pwdPolicyMinSymbolic

$pwdPolicyMinUppercase

$pwdResetAllowScreenPassword

$pwdResetAllowSpecificPassword

$pwdResetDefaultPasswordOutput

$pwdResetForcePasswordChange

$referentialIntegrityOverlay

$scriptPath

$scriptRights

$scriptServer

$scriptSSHKey

$scriptSSHKeyPassword

$scriptUserName

$searchLimit

$serverDisplayName

$ServerURL

$settings

$timeZone

$toolSettings

$twoFactorAllowToRememberDevice

$twoFactorAuthentication

$twoFactorAuthenticationAttribute

$twoFactorAuthenticationCaption

$twoFactorAuthenticationClientId

$twoFactorAuthenticationDomain

$twoFactorAuthenticationInsecure

$twoFactorAuthenticationLabel

$twoFactorAuthenticationOptional

$twoFactorAuthenticationSecretKey

LAMConfig
in package

configuration