LDAP Account Manager

TreeViewTool extends LAMTool
in package

LDAP tree view.

Table of Contents

TREE_SUFFIX_CONFIG  = 'treeViewSuffix'
checkConfigurationOptions()  : array<string|int, mixed>
Checks the configuration options.
getConfigOptions()  : htmlElement|null
Returns the configuration options for this tool.
getDescription()  : string
returns a description text for the tool.
getImageLink()  : string
Returns the link to the tool image (relative to graphics/)
getLink()  : string
Returns a link to the tool page (relative to templates/).
getName()  : string
Returns the name of the tool.
getPosition()  : int
Returns the preferred position of this tool on the tools page.
getRequiresPasswordChangeRights()  : bool
Returns if the tool requires password change rights.
getRequiresWriteAccess()  : bool
Returns if the tool requires write access to LDAP.
getRootDns()  : array<string|int, string>
Returns the list of configured root DNs.
getSubTools()  : array<string|int, mixed>
Returns a list of sub tools or an empty array.
isHideable()  : bool
Returns if a tool may be hidden by configuration in the LAM server profile.
isVisible()  : bool
Returns if the tool is visible in the menu.

Constants

TREE_SUFFIX_CONFIG

public mixed TREE_SUFFIX_CONFIG = 'treeViewSuffix'

Methods

checkConfigurationOptions()

Checks the configuration options.

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

hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.

Return values
array<string|int, mixed>

list of error messages

getConfigOptions()

Returns the configuration options for this tool.

public getConfigOptions(array<string|int, mixed> $settings) : htmlElement|null
Parameters
$settings : array<string|int, mixed>

current tool settings

Return values
htmlElement|null

configuration options

getDescription()

returns a description text for the tool.

public getDescription() : string
Return values
string

description

Returns the link to the tool image (relative to graphics/)

public getImageLink() : string
Return values
string

image URL

Returns a link to the tool page (relative to templates/).

public getLink() : string
Return values
string

link

getName()

Returns the name of the tool.

public getName() : string
Return values
string

name

getPosition()

Returns the preferred position of this tool on the tools page.

public getPosition() : int
Return values
int

preferred position

getRequiresPasswordChangeRights()

Returns if the tool requires password change rights.

public getRequiresPasswordChangeRights() : bool
Return values
bool

true if password change rights are needed

getRequiresWriteAccess()

Returns if the tool requires write access to LDAP.

public getRequiresWriteAccess() : bool
Return values
bool

true if write access is needed

getRootDns()

Returns the list of configured root DNs.

public static getRootDns([array<string|int, mixed>|null $settings = null ]) : array<string|int, string>
Parameters
$settings : array<string|int, mixed>|null = null
Return values
array<string|int, string>

root DNs

getSubTools()

Returns a list of sub tools or an empty array.

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

list of subtools (LAMSubTool)

isHideable()

Returns if a tool may be hidden by configuration in the LAM server profile.

public isHideable() : bool
Return values
bool

hideable

isVisible()

Returns if the tool is visible in the menu.

public isVisible() : bool
Return values
bool

visible

Search results