LDAP Account Manager

selfServiceProfile
in package

Includes all settings of a self service profile.

Table of Contents

$additionalCSS  : mixed
list of additional CSS links (separated by \n)
$additionalLDAPFilter  : mixed
additional LDAP filter for accounts
$baseColor  : mixed
base color
$baseUrl  : mixed
base URL for the website (e.g. https://example.com) for link generation
$captchaOnLogin  : mixed
enable captcha on self service login
$captchaProvider  : mixed
provider for captcha (-/google/hCaptcha/friendlyCaptcha)
$enforceLanguage  : mixed
disallow user to change language
$followReferrals  : mixed
$inputFields  : mixed
input fields Format: array( <br> array(array('name' => <group name 1>, 'fields' => array(<field1>, <field2>))), <br> array(array('name' => <group name 2>, 'fields' => array(<field3>, <field4>))) <br> )
$language  : mixed
language for self service
$LDAPPassword  : mixed
LDAP password
$LDAPSuffix  : mixed
LDAP suffix
$LDAPUser  : mixed
LDAP user DN
$loginAttributeText  : mixed
describing text for search attribute
$loginCaption  : mixed
describing text for user login
$loginFooter  : mixed
describing text for user login
$loginHandler  : string|null
$mainPageFooter  : mixed
describing text for self service main page
$mainPageText  : mixed
describing text for self service main page
$moduleSettings  : mixed
configuration settings of modules
$pageHeader  : mixed
header for self service pages
$passwordLabel  : mixed
label for password input
$readOnlyFields  : mixed
List of fields that are set in read-only mode.
$reCaptchaSecretKey  : mixed
Google reCAPTCHA secret key
$reCaptchaSiteKey  : mixed
Google reCAPTCHA site key
$relabelFields  : mixed
List of override values for field labels: array(<field ID> => label)
$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
$searchAttribute  : mixed
LDAP search attribute
$serverURL  : mixed
server address
$timeZone  : mixed
$twoFactorAllowToRememberDevice  : mixed
$twoFactorAuthentication  : mixed
$twoFactorAuthenticationAttribute  : mixed
$twoFactorAuthenticationCaption  : mixed
$twoFactorAuthenticationClientId  : mixed
$twoFactorAuthenticationDomain  : mixed
$twoFactorAuthenticationInsecure  : mixed
$twoFactorAuthenticationLabel  : mixed
$twoFactorAuthenticationOptional  : mixed
$twoFactorAuthenticationSecretKey  : mixed
$twoFactorAuthenticationURL  : mixed
$twoFactorRememberDeviceDuration  : mixed
$twoFactorRememberDevicePassword  : mixed
$useForAllOperations  : mixed
use bind user also for read/modify operations
$useTLS  : mixed
use TLS
__construct()  : selfServiceProfile
Constructor
export()  : array<string|int, mixed>
Returns a representation of the self service profile.
getBaseUrl()  : string
Returns the server's base URL (e.g. https://www.example.com).
getLoginHandler()  : SelfServiceLoginHandler
Returns the login handler.
import()  : selfServiceProfile
Converts the export data back to a self service profile.
setBaseUrl()  : mixed
Sets the server's base URL (e.g. https://www.example.com).

Properties

$additionalCSS

list of additional CSS links (separated by \n)

public mixed $additionalCSS

$additionalLDAPFilter

additional LDAP filter for accounts

public mixed $additionalLDAPFilter

$baseColor

base color

public mixed $baseColor = '#fffde2'

$baseUrl

base URL for the website (e.g. https://example.com) for link generation

public mixed $baseUrl = ''

$captchaOnLogin

enable captcha on self service login

public mixed $captchaOnLogin = \false

$captchaProvider

provider for captcha (-/google/hCaptcha/friendlyCaptcha)

public mixed $captchaProvider = '-'

$enforceLanguage

disallow user to change language

public mixed $enforceLanguage = \false

$inputFields

input fields Format: array( <br> array(array('name' => <group name 1>, 'fields' => array(<field1>, <field2>))), <br> array(array('name' => <group name 2>, 'fields' => array(<field3>, <field4>))) <br> )

public mixed $inputFields

$language

language for self service

public mixed $language = 'en_GB.utf8'

$LDAPPassword

LDAP password

public mixed $LDAPPassword

$loginAttributeText

describing text for search attribute

public mixed $loginAttributeText

$loginCaption

describing text for user login

public mixed $loginCaption

$loginFooter

describing text for user login

public mixed $loginFooter

$loginHandler

public string|null $loginHandler = \SelfServiceUserPasswordLoginHandler::ID

login handler ID

$mainPageFooter

describing text for self service main page

public mixed $mainPageFooter

$mainPageText

describing text for self service main page

public mixed $mainPageText

$moduleSettings

configuration settings of modules

public mixed $moduleSettings

$pageHeader

header for self service pages

public mixed $pageHeader

$passwordLabel

label for password input

public mixed $passwordLabel

$readOnlyFields

List of fields that are set in read-only mode.

public mixed $readOnlyFields

$reCaptchaSecretKey

Google reCAPTCHA secret key

public mixed $reCaptchaSecretKey = ''

$reCaptchaSiteKey

Google reCAPTCHA site key

public mixed $reCaptchaSiteKey = ''

$relabelFields

List of override values for field labels: array(<field ID> => label)

public mixed $relabelFields

$scriptPath

Path to external lamdaemon script on server where it is executed

public mixed $scriptPath

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

$scriptRights

The rights for the home directory

public mixed $scriptRights = '750'

$scriptServer

Servers where lamdaemon script is executed

public 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.

public mixed $scriptSSHKey

$scriptSSHKeyPassword

Password for lamdaemon SSH key.

public mixed $scriptSSHKeyPassword

$scriptUserName

user name for lamdaemon

public mixed $scriptUserName

$searchAttribute

LDAP search attribute

public mixed $searchAttribute

$twoFactorAllowToRememberDevice

public mixed $twoFactorAllowToRememberDevice = 'false'

$twoFactorAuthentication

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

$twoFactorAuthenticationAttribute

public mixed $twoFactorAuthenticationAttribute = 'uid'

$twoFactorAuthenticationCaption

public mixed $twoFactorAuthenticationCaption = ''

$twoFactorAuthenticationClientId

public mixed $twoFactorAuthenticationClientId = ''

$twoFactorAuthenticationDomain

public mixed $twoFactorAuthenticationDomain = ''

$twoFactorAuthenticationInsecure

public mixed $twoFactorAuthenticationInsecure = \false

$twoFactorAuthenticationLabel

public mixed $twoFactorAuthenticationLabel

$twoFactorAuthenticationOptional

public mixed $twoFactorAuthenticationOptional = \false

$twoFactorAuthenticationSecretKey

public mixed $twoFactorAuthenticationSecretKey = ''

$twoFactorAuthenticationURL

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

$twoFactorRememberDeviceDuration

public mixed $twoFactorRememberDeviceDuration = '28800'

$twoFactorRememberDevicePassword

public mixed $twoFactorRememberDevicePassword = ''

$useForAllOperations

use bind user also for read/modify operations

public mixed $useForAllOperations

Methods

export()

Returns a representation of the self service profile.

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

self service profile data

getBaseUrl()

Returns the server's base URL (e.g. https://www.example.com).

public getBaseUrl() : string
Return values
string —

URL

import()

Converts the export data back to a self service profile.

public static import(array<string|int, mixed> $data) : selfServiceProfile
Parameters
$data : array<string|int, mixed>

export data

Return values
selfServiceProfile —

profile

setBaseUrl()

Sets the server's base URL (e.g. https://www.example.com).

public setBaseUrl(string $url) : mixed
Parameters
$url : string

URL

Return values
mixed —

Search results