LDAP Account Manager

LAMTool
in package

Represents a tool.

LAM will scan lib/tools/*.inc for classes which implement this interface. This allows to dynamically plugin additional tools. There will be an entry on the tools page inside LAM for each found class (if it matches the security level). A LAMTool only specifies name, description and location of a tool. The tool functionality is provided by the tool's target page.

Tags
author

Roland Gruber

Table of Contents

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

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 abstract getDescription() : string
Return values
string —

description

getImageLink()

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

public abstract getImageLink() : string
Return values
string —

image URL

getLink()

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

public abstract getLink() : string
Return values
string —

link

getName()

Returns the name of the tool.

public abstract getName() : string
Return values
string —

name

getPosition()

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

public abstract getPosition() : int

The position may be between 0 and 1000. 0 is the top position.

Return values
int —

preferred position

getRequiresPasswordChangeRights()

Returns if the tool requires password change rights.

public abstract getRequiresPasswordChangeRights() : bool
Return values
bool —

true if password change rights are needed

getRequiresWriteAccess()

Returns if the tool requires write access to LDAP.

public abstract getRequiresWriteAccess() : bool
Return values
bool —

true if write access is needed

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 abstract isVisible() : bool
Return values
bool —

visible

Search results