LDAP Account Manager

selfServiceProfile
in package

Includes all settings of a self-service profile.

Table of Contents

$additionalCSS  : string
list of additional CSS links (separated by \n)
$additionalLDAPFilter  : string|null
additional LDAP filter for accounts
$baseColor  : string
base color
$baseUrl  : string
base URL for the website (e.g. https://example.com) for link generation
$captchaOnLogin  : bool
enable captcha on self-service login
$captchaProvider  : string
provider for captcha (-/google/hCaptcha/friendlyCaptcha)
$enforceLanguage  : bool
disallow user to change language
$followReferrals  : int
$inputFields  : array<string|int, mixed>
$language  : string
language for self-service
$LDAPPassword  : string
LDAP password
$LDAPSuffix  : string
LDAP suffix
$LDAPUser  : string
LDAP user DN
$loginAttributeText  : string
describing text for search attribute
$loginCaption  : string
describing text for user login
$loginFooter  : string|null
describing text for user login
$loginHandler  : string|null
$mainPageFooter  : string|null
describing text for self-service main page
$mainPageText  : string
describing text for self-service main page
$moduleSettings  : array<string|int, mixed>
$pageHeader  : string
header for self-service pages
$passwordLabel  : string|null
label for password input
$readOnlyFields  : array<string|int, mixed>
$reCaptchaSecretKey  : string
Google reCAPTCHA secret key
$reCaptchaSiteKey  : string
Google reCAPTCHA site key
$relabelFields  : array<string|int, mixed>|null
$scriptPath  : string|null
Path to external lamdaemon script on server where it is executed
$scriptRights  : string
The rights for the home directory
$scriptServer  : string|null
Servers where lamdaemon script is executed
$scriptSSHKey  : string|null
File name of SSH key for lamdaemon.
$scriptSSHKeyPassword  : string|null
Password for lamdaemon SSH key.
$scriptUserName  : string|null
user name for lamdaemon
$searchAttribute  : string
LDAP search attribute
$serverURL  : string
server address
$timeZone  : string
$twoFactorAllowToRememberDevice  : string
$twoFactorAuthentication  : string
$twoFactorAuthenticationAttribute  : string
$twoFactorAuthenticationCaption  : string
$twoFactorAuthenticationClientId  : string
$twoFactorAuthenticationDomain  : string
$twoFactorAuthenticationInsecure  : bool
$twoFactorAuthenticationLabel  : string|null
$twoFactorAuthenticationOptional  : bool
$twoFactorAuthenticationSecretKey  : string
$twoFactorAuthenticationURL  : string
$twoFactorRememberDeviceDuration  : string
$twoFactorRememberDevicePassword  : string
$useForAllOperations  : bool|null
use bind user also for read/modify operations
$useTLS  : bool
use TLS
__construct()  : mixed
Constructor
export()  : array<string, string|int>
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()  : void
Sets the server's base URL (e.g. https://www.example.com).

Properties

$additionalCSS

list of additional CSS links (separated by \n)

public string $additionalCSS = ''

$additionalLDAPFilter

additional LDAP filter for accounts

public string|null $additionalLDAPFilter = ''

$baseColor

base color

public string $baseColor = '#fffde2'

$baseUrl

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

public string $baseUrl = ''

$captchaOnLogin

enable captcha on self-service login

public bool $captchaOnLogin = \false

$captchaProvider

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

public string $captchaProvider = '-'

$enforceLanguage

disallow user to change language

public bool $enforceLanguage = \false

$inputFields

public array<string|int, mixed> $inputFields = []

input fields Format: array(
array(array('name' => <group name 1>, 'fields' => array(, ))),
array(array('name' => <group name 2>, 'fields' => array(, )))
)

$language

language for self-service

public string $language = 'en_GB.utf8'

$LDAPPassword

LDAP password

public string $LDAPPassword = ""

$LDAPSuffix

LDAP suffix

public string $LDAPSuffix = "dc=my-domain,dc=com"

$LDAPUser

LDAP user DN

public string $LDAPUser = ""

$loginAttributeText

describing text for search attribute

public string $loginAttributeText = ''

$loginCaption

describing text for user login

public string $loginCaption = ''

$loginFooter

describing text for user login

public string|null $loginFooter = ''

$loginHandler

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

login handler ID

$mainPageFooter

describing text for self-service main page

public string|null $mainPageFooter = ''

$mainPageText

describing text for self-service main page

public string $mainPageText

$moduleSettings

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

configuration settings of modules

$pageHeader

header for self-service pages

public string $pageHeader = '<p><a href="https://www.ldap-account-manager.org/" target="new_window"><img alt="help" class="align-middle" src="../../graphics/logo.svg" style="height:24px; width:24px" /> LDAP Account Manager </a></p><p>&nbsp;</p>'

$passwordLabel

label for password input

public string|null $passwordLabel = ''

$readOnlyFields

public array<string|int, mixed> $readOnlyFields = []

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

$reCaptchaSecretKey

Google reCAPTCHA secret key

public string $reCaptchaSecretKey = ''

$reCaptchaSiteKey

Google reCAPTCHA site key

public string $reCaptchaSiteKey = ''

$relabelFields

public array<string|int, mixed>|null $relabelFields = []

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

$scriptPath

Path to external lamdaemon script on server where it is executed

public string|null $scriptPath = ''

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

$scriptRights

The rights for the home directory

public string $scriptRights = '750'

$scriptServer

Servers where lamdaemon script is executed

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

$scriptSSHKeyPassword

Password for lamdaemon SSH key.

public string|null $scriptSSHKeyPassword = ''

$scriptUserName

user name for lamdaemon

public string|null $scriptUserName = ''

$searchAttribute

LDAP search attribute

public string $searchAttribute = "uid"

$serverURL

server address

public string $serverURL = "localhost"

$timeZone

public string $timeZone = 'Europe/London'

$twoFactorAllowToRememberDevice

public string $twoFactorAllowToRememberDevice = 'false'

$twoFactorAuthentication

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

$twoFactorAuthenticationAttribute

public string $twoFactorAuthenticationAttribute = 'uid'

$twoFactorAuthenticationCaption

public string $twoFactorAuthenticationCaption = ''

$twoFactorAuthenticationClientId

public string $twoFactorAuthenticationClientId = ''

$twoFactorAuthenticationDomain

public string $twoFactorAuthenticationDomain = ''

$twoFactorAuthenticationInsecure

public bool $twoFactorAuthenticationInsecure = \false

$twoFactorAuthenticationLabel

public string|null $twoFactorAuthenticationLabel = ''

$twoFactorAuthenticationOptional

public bool $twoFactorAuthenticationOptional = \false

$twoFactorAuthenticationSecretKey

public string $twoFactorAuthenticationSecretKey = ''

$twoFactorAuthenticationURL

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

$twoFactorRememberDeviceDuration

public string $twoFactorRememberDeviceDuration = '28800'

$twoFactorRememberDevicePassword

public string $twoFactorRememberDevicePassword = ''

$useForAllOperations

use bind user also for read/modify operations

public bool|null $useForAllOperations = \false

Methods

__construct()

Constructor

public __construct() : mixed
Return values
mixed

export()

Returns a representation of the self-service profile.

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

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, string|int|null> $data) : selfServiceProfile
Parameters
$data : array<string, string|int|null>

export data

Return values
selfServiceProfile

profile

setBaseUrl()

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

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

URL

Return values
void

Search results