LDAP Account Manager
Back to top  

Generates the list view.

package lists
author Roland Gruber

 Methods

Constructor

__construct(string $type) : \lamList

Parameters

$type

string

account type

Returns

\lamListlist object

Prints the HTML code to display the list view.

showPage() 

Can be used by subclasses to add e.g.

addExtraInputElementsToTopArea(\htmlGroup $left, \htmlGroup $right) 

additional buttons to the top area.

Parameters

$left

\htmlGroup

left part

$right

\htmlGroup

right part

Builds the LDAP filter based on the filter entries in the GUI.

buildLDAPAttributeFilter() : String

Returns

StringLDAP filter

Returns if the given attribute can be filtered.

canBeFiltered(String $attr) : boolean

If filtering is not possible then no filter box will be displayed. By default all attributes can be filtered.

Parameters

$attr

String

attribute name

Returns

booleanfiltering possible

Compare function used for usort-method

cmp_array(array $a, array $b) : integer

Rows are sorted with the first attribute entry of the sort column. If objects have attributes with multiple values only the first is used for sorting.

Parameters

$a

array

first row which is compared

$b

array

second row which is compared

Returns

integer0 if both are equal, 1 if $a is greater, -1 if $b is greater

Forces a refresh of the LDAP data.

forceRefresh() 

Function must be called before $this->refresh option is checked to load new LDAP data (e.g. in listGetParams).

Returns a list of additional LDAP attributes that should be read.

getAdditionalLDAPAttributesToRead() : array

This can be used to show additional data even if the user selected other attributes to show in the list.

Returns

arrayadditional attribute names

Returns a list of lamListTool objects to display next to the edit/delete buttons.

getAdditionalTools() : \lamListTool[]

Returns

\lamListTool[]tools

Returns the filter as text to be used as URL parameter.

getFilterAsTextForURL() : String

Returns

Stringfilter text

Builds the regular expressions from the filter values.

listBuildFilter() 

Called when the configuration options changed.

listConfigurationChanged() 

Manages all POST actions (e.g.

listDoPost() : String

button pressed) for the account lists.

Returns

StringHTML fragment to insert into beginning of account list

Draws a navigation bar to switch between pages

listDrawNavigationBar(integer $count) 

Parameters

$count

integer

number of account entries

Returns a list of possible configuration options.

listGetAllConfigOptions() : array

Returns

arraylist of lamListOption objects

Returns an hash array containing with all attributes to be shown and their descriptions.

listGetAttributeDescriptionList() : array

Format: array(attribute => description)

Returns

arrayattribute list

Returns the configuration option with the given ID.

listGetConfigOptionByID(String $ID) 

Parameters

$ID

String

ID

Sets some internal parameters.

listGetParams() 

Prints the create and delete buttons.

listPrintButtons(boolean $createOnly) 

Parameters

$createOnly

boolean

true if only the create button should be displayed

Prints the list configuration page.

listPrintConfigurationPage() 

Prints the HTML footer.

listPrintFooter() 

Prints the HTML header.

listPrintHeader() 

Prints messages when another page (e.g.

listPrintRedirectMessages() 

delete/upload) redirects to the list view.

Prints the entry list

listPrintTableBody(array $info) 

Parameters

$info

array

entries

Prints the content of a cell in the account list for a given LDAP entry and attribute.

listPrintTableCellContent(array $entry, string $attribute) 

Parameters

$entry

array

LDAP attributes

$attribute

string

attribute name

Prints the attribute and filter row at the account table head

listPrintTableHeader() 

Rereads the entries from LDAP.

listRefreshData() 

Prints a combobox with possible sub-DNs.

listShowOUSelection() : \htmlGroup

Returns

\htmlGroupOU selection (may be empty)

Sorts an account list by a given attribute

listSort(array $info) 

Parameters

$info

array

the account list

Prints the tool image links (e.g.

listPrintToolLinks(array $account, String $id) 

edit and delete) for each account.

Parameters

$account

array

LDAP attributes

$id

String

account ID

Reads the list options from the cookie value.

listReadOptionsFromCookie() 

Shows the page where the user may select the PDF options.

showPDFPage(String $id) 

Parameters

$id

String

account ID

 Properties

 

list of LDAP attributes

$attrArray 

 

list of attribute descriptions

$descArray 

 

LDAP entries

$entries 

 

list of filters (attribute name => filter input)

$filters 

 

list of account specific labels

$labels 

 

maximum count of entries per page

$maxPageEntries 

 

current page number

$page 

 

list of possible LDAP suffixes(organizational units)

$possibleSuffixes 

 

refresh page switch

$refresh 

 

sort column name

$sortColumn 

 

sort direction: 1 for ascending, -1 for descending

$sortDirection 

 

LDAP suffix

$suffix 

 

tabindex for GUI elements

$tabindex 

 

Account type

$type 

 

configuration options

$configOptions 

 Constants

 

ID for list size config option

LIST_SIZE_OPTION_NAME 

 

prefix for virtual (non-LDAP) attributes

VIRTUAL_ATTRIBUTE_PREFIX