LDAP Account Manager

lamList

in package

• lists

Generates the list view.

Tags

author

Roland Gruber

Table of Contents

ACCOUNT_STATUS_OPTION_NAME  = "LU_AS"

ID for config option to show account status

ATTR_ACCOUNT_STATUS  = 'lam_virtual_account_status'

virtual attribute name for account status column

FILTER_EXPIRED  = 1

filter value for expired accounts

FILTER_LOCKED  = 2

filter value for locked accounts

FILTER_SEMILOCKED  = 3

filter value for partially locked accounts

FILTER_UNLOCKED  = 4

filter value for unlocked accounts

LIST_SIZE_OPTION_NAME  = "L_SIZE"

ID for list size config option

VIRTUAL_ATTRIBUTE_PREFIX  = 'lam_virtual_'

prefix for virtual (non-LDAP) attributes

$accountStatusFilter  : mixed

filter value for account status

$attrArray  : mixed

list of LDAP attributes

$descArray  : mixed

list of attribute descriptions

$entries  : mixed

entries to show

$filters  : mixed

list of filters (attribute name => filter input)

$labels  : mixed

list of account specific labels

$ldapEntries  : mixed

entries from LDAP

$maxPageEntries  : mixed

maximum count of entries per page

$page  : mixed

current page number

$possibleSuffixes  : mixed

list of possible LDAP suffixes(organizational units)

$refresh  : mixed

refresh page switch

$serverSideFilterAttributes  : array<string|int, string>

List of attributes to filter on server side.

$serverSideFilterChanged  : mixed

defines if the server side filter changed

$showAccountStatus  : mixed

Controls if the account status is shown

$sortColumn  : mixed

sort column name

$sortDirection  : mixed

sort direction: 1 for ascending, -1 for descending

$sortMapping  : mixed

sort mapping for entries array(original index => sorted index)

$suffix  : mixed

LDAP suffix

$type  : mixed

Account type

$configOptions  : mixed

configuration options

$supportsPasswordQuickChange  : bool

__construct()  : lamList

Constructor

showPage()  : mixed

Prints the HTML code to display the list view.

addExtraInputElementsToTopArea()  : mixed

Can be used by subclasses to add e.g. additional buttons to the top area.

applyLocalFilters()  : mixed

Applies any local filters for attributes that cannot be filtered server side.

buildLDAPAttributeFilter()  : string

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

canBeFiltered()  : bool

Returns if the given attribute can be filtered.

forceRefresh()  : mixed

Forces a refresh of the LDAP data.

getAccountStatusFilterArea()  : htmlElement

Returns the filter for account status.

getAdditionalLDAPAttributesToRead()  : array<string|int, mixed>

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

getAdditionalTools()  : array<string|int, lamListTool>

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

getFilterArea()  : htmlElement

Prints the content of a single attribute filter area.

getFilterAsTextForURL()  : string

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

getTableCellContent()  : htmlElement

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

isAttributeFilteredByServer()  : bool

Specifies if the given attribute name is used for server side filtering (LDAP filter string).

isFilterMatching()  : mixed

Checks if the given LDAP data matches the filter.

listBuildFilter()  : mixed

Builds the regular expressions from the filter values.

listConfigurationChanged()  : mixed

Called when the configuration options changed.

listCreateSortMapping()  : mixed

Determines the sort mapping and stores it in $this->sortMapping.

listDoPost()  : htmlElement|null

Manages all POST actions (e.g. button pressed) for the account lists.

listDrawNavigationBar()  : mixed

Draws a navigation bar to switch between pages

listGetAllConfigOptions()  : array<string|int, mixed>

Returns a list of possible configuration options.

listGetAttributeDescriptionList()  : array<string|int, mixed>

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

listGetConfigOptionByID()  : mixed

Returns the configuration option with the given ID.

listGetParams()  : mixed

Sets some internal parameters.

listPrintButtons()  : mixed

Prints the create and delete buttons.

listPrintConfigurationPage()  : mixed

Prints the list configuration page.

listPrintRedirectMessages()  : mixed

Prints messages when another page (e.g. delete/upload) redirects to the list view.

listRefreshData()  : mixed

Rereads the entries from LDAP.

listShowOUSelection()  : htmlGroup

Prints a combobox with possible sub-DNs.

printFooterContent()  : mixed

Prints any extra HTML for the footer part.

printHeaderContent()  : mixed

Prints any extra HTML for the header part.

addDataElements()  : mixed

Adds the LDAP data elements to the given array.

addToolLinks()  : mixed

Adds the tool image links (e.g. edit and delete) for each account.

getAccountStatus()  : htmlElement

Returns the account status.

getFilterElements()  : array<string|int, htmlElement>

Returns the elements to show in filter row.

getSortingElements()  : array<string|int, htmlElement>

Returns the elements to show in sorting row.

injectAccountStatusAttribute()  : mixed

Injects values for the virtual account status attribute to make it sortable.

isSupportingAccountStatus()  : bool

Returns if this account supports the account status column.

isSupportingPasswordQuickChange()  : bool

Returns if this account supports the password quick change page.

listReadOptionsFromCookie()  : mixed

Reads the list options from the cookie value.

printAccountTable()  : mixed

Prints the entry list

printFooter()  : mixed

Prints the footer area of the page.

printHeader()  : mixed

Prints the header part of the page.

showPDFPage()  : mixed

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