Can be used by subclasses to add e.g. additional buttons to the top area.
Arguments
Name
Type
Description
Default
$left
\htmlGroup
left part
$right
\htmlGroup
right part
Return value
Type
Description
n/a
n/a
buildLDAPAttributeFilter(
)
:
String
Description
Builds the LDAP filter based on the filter entries in the GUI.
Return value
Type
Description
String
LDAP filter
canBeFiltered(
String
$attr,
)
:
boolean
Description
Returns if the given attribute can be filtered. If filtering is not possible then no filter box will be displayed.
By default all attributes can be filtered.
Arguments
Name
Type
Description
Default
$attr
String
attribute name
Return value
Type
Description
boolean
filtering possible
forceRefresh(
)
:
n/a
Description
Forces a refresh of the LDAP data. Function must be called before $this->refresh option is checked to load new LDAP data (e.g. in listGetParams).
Return value
Type
Description
n/a
n/a
getAdditionalLDAPAttributesToRead(
)
:
array
Description
Returns a list of additional LDAP attributes that should be read. This can be used to show additional data even if the user selected other attributes to show in the list.
Return value
Type
Description
array
additional attribute names
getAdditionalTools(
)
:
\lamListTool[]
Description
Returns a list of lamListTool objects to display next to the edit/delete buttons.
Return value
Type
Description
\lamListTool[]
tools
getFilterAsTextForURL(
)
:
String
Description
Returns the filter as text to be used as URL parameter.
Return value
Type
Description
String
filter text
listBuildFilter(
)
:
n/a
Description
Builds the regular expressions from the filter values.
Return value
Type
Description
n/a
n/a
listConfigurationChanged(
)
:
n/a
Description
Called when the configuration options changed.
Return value
Type
Description
n/a
n/a
listCreateSortMapping(
array
$info,
)
:
n/a
Description
Determines the sort mapping and stores it in $this->sortMapping. The sort mapping is used to display the right rows when the account table is created.
Arguments
Name
Type
Description
Default
$info
array
the account list
Return value
Type
Description
n/a
n/a
listDoPost(
)
:
String
Description
Manages all POST actions (e.g. button pressed) for the account lists.
Return value
Type
Description
String
HTML fragment to insert into beginning of account list
listDrawNavigationBar(
integer
$count,
)
:
n/a
Description
Draws a navigation bar to switch between pages
Arguments
Name
Type
Description
Default
$count
integer
number of account entries
Return value
Type
Description
n/a
n/a
listGetAllConfigOptions(
)
:
array
Description
Returns a list of possible configuration options.
Return value
Type
Description
array
list of lamListOption objects
listGetAttributeDescriptionList(
)
:
array
Description
Returns an hash array containing with all attributes to be shown and their descriptions. Format: array(attribute => description)
Return value
Type
Description
array
attribute list
listGetConfigOptionByID(
String
$ID,
)
:
n/a
Description
Returns the configuration option with the given ID.
Arguments
Name
Type
Description
Default
$ID
String
ID
Return value
Type
Description
n/a
n/a
listGetParams(
)
:
n/a
Description
Sets some internal parameters.
Return value
Type
Description
n/a
n/a
listPrintButtons(
boolean
$createOnly,
)
:
n/a
Description
Prints the create and delete buttons.
Arguments
Name
Type
Description
Default
$createOnly
boolean
true if only the create button should be displayed
Return value
Type
Description
n/a
n/a
listPrintConfigurationPage(
)
:
n/a
Description
Prints the list configuration page.
Return value
Type
Description
n/a
n/a
listPrintFooter(
)
:
n/a
Description
Prints the HTML footer.
Return value
Type
Description
n/a
n/a
listPrintHeader(
)
:
n/a
Description
Prints the HTML header.
Return value
Type
Description
n/a
n/a
listPrintRedirectMessages(
)
:
n/a
Description
Prints messages when another page (e.g. delete/upload) redirects to the list view.
Returns the name of the tool image. The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.
Return value
Type
Description
String
image name
getLinkTarget(
)
:
String
Description
Returns the PHP file (relative to 'templates/lists') which will be the target for this tool. The target page will be opened with two GET parameters: DN and type (e.g. user)
Return value
Type
Description
String
page file (e.g. 'mytool.php')
getName(
)
:
String
Description
Returns the tool name. This is used for the tool tip.