LDAP Account Manager » \lamUserList

Generates the list view.

package	lists
author	Roland Gruber

Methods

Constructor

__construct(string $type) : \lamList

Parameters

$type

string

account type

Returns

\lamListlist object

Returns if the PPolicy part exists.

isPPolicyAvailable(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanPPolicy part exists

Returns if the PPolicy part is locked.

isPPolicyLocked(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanPPolicy part is locked

Returns if the Samba part exists.

isSambaAvailable(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanSamba part exists

Returns if the Samba part is locked.

isSambaLocked(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanSamba part is locked

Returns if the Unix part exists.

isUnixAvailable(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanUnix part exists

Returns if the Unix part is locked.

isUnixLocked(array $attrs) : boolean

Parameters

$attrs

array

LDAP attributes

Returns

booleanUnix part locked

Prints the HTML code to display the list view.

showPage()

Inherited

inherited_from	\lamList::showPage()

Returns if the given attribute can be filtered.

canBeFiltered(String $attr) : boolean

If filtering is not possible then no filter box will be displayed.

The user list allows no filtering for account status.

Parameters

$attr

String

attribute name

Returns

booleanfiltering possible

Compare function used for usort-method

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

Inherited

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.

inherited_from	\lamList::cmp_array()

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

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.

The user list reads pwdAccountLockedTime, sambaAcctFlags and userPassword

Returns

arrayadditional attribute names

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

getAdditionalTools() : \lamListTool[]

Returns

\lamListTool[]tools

Builds the regular expressions from the filter values.

listBuildFilter()

Inherited

inherited_from	\lamList::listBuildFilter()

Called when the configuration options changed.

listConfigurationChanged()

Manages all POST actions (e.g.

listDoPost() : String

Inherited

button pressed) for the account lists.

inherited_from	\lamList::listDoPost()

Returns

StringHTML fragment to insert into beginning of account list

Draws a navigation bar to switch between pages

listDrawNavigationBar(integer $count)

Inherited

inherited_from	\lamList::listDrawNavigationBar()

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)

The user list may display an additional account status column

Returns

arrayattribute list

Returns the configuration option with the given ID.

listGetConfigOptionByID(String $ID)

Inherited

inherited_from	\lamList::listGetConfigOptionByID()

Parameters

$ID

String

Sets some internal parameters.

listGetParams()

Prints the create and delete buttons.

listPrintButtons(boolean $createOnly)

Inherited

inherited_from	\lamList::listPrintButtons()

Parameters

$createOnly

boolean

true if only the create button should be displayed

Prints the list configuration page.

listPrintConfigurationPage()

Inherited

inherited_from	\lamList::listPrintConfigurationPage()

Prints the HTML footer.

listPrintFooter()

Inherited

inherited_from	\lamList::listPrintFooter()

Prints the HTML header.

listPrintHeader()

Inherited

inherited_from	\lamList::listPrintHeader()

Prints messages when another page (e.g.

listPrintRedirectMessages()

Inherited

delete/upload) redirects to the list view.

inherited_from	\lamList::listPrintRedirectMessages()

Prints the entry list

listPrintTableBody(array $info)

Inherited

inherited_from	\lamList::listPrintTableBody()

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()

Inherited

inherited_from	\lamList::listPrintTableHeader()

Rereads the entries from LDAP.

listRefreshData()

Prints a combobox with possible sub-DNs.

listShowOUSelection()

Inherited

inherited_from	\lamList::listShowOUSelection()

Sorts an account list by a given attribute

listSort(array $info)

Inherited

inherited_from	\lamList::listSort()

Parameters

$info

array

the account list

Refreshes the GID to group name cache.

refreshPrimaryGroupTranslation()

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

injectAccountStatusAttribute()

Prints the tool image links (e.g.

listPrintToolLinks(array $account, String $id)

Inherited

edit and delete) for each account.

inherited_from	\lamList::listPrintToolLinks()

Parameters

$account

array

LDAP attributes

$id

String

account ID

Reads the list options from the cookie value.

listReadOptionsFromCookie()

Inherited

inherited_from	\lamList::listReadOptionsFromCookie()

Prints the account status.

printAccountStatus(array $attrs)

Parameters

$attrs

array

LDAP attributes

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

showPDFPage(String $id)

Inherited

inherited_from	\lamList::showPDFPage()

Parameters

$id

String

account ID

Properties

list of LDAP attributes

$attrArray

Inherited

inherited_from	\lamList::$$attrArray

list of attribute descriptions

$descArray

Inherited

inherited_from	\lamList::$$descArray

LDAP entries

$entries

Inherited

inherited_from	\lamList::$$entries

LDAP filter part which was entered by user via filter boxes

$filterPart

Inherited

inherited_from	\lamList::$$filterPart

filter string to include in URL

$filterText

Inherited

inherited_from	\lamList::$$filterText

list of account specific labels

$labels

Inherited

inherited_from	\lamList::$$labels

maximum count of entries per page

$maxPageEntries

Inherited

inherited_from	\lamList::$$maxPageEntries

current page number

$page

Inherited

inherited_from	\lamList::$$page

list of possible LDAP suffixes(organizational units)

$possibleSuffixes

Inherited

inherited_from	\lamList::$$possibleSuffixes

refresh page switch

$refresh

Inherited

inherited_from	\lamList::$$refresh

sort column name

$sortColumn

Inherited

inherited_from	\lamList::$$sortColumn

sort direction: 1 for ascending, -1 for descending

$sortDirection

Inherited

inherited_from	\lamList::$$sortDirection

LDAP suffix

$suffix

Inherited

inherited_from	\lamList::$$suffix

tabindex for GUI elements

$tabindex

Inherited

inherited_from	\lamList::$$tabindex

Account type

$type

Inherited

inherited_from	\lamList::$$type

configuration options

$configOptions

Inherited

inherited_from	\lamList::$$configOptions

Controls if the account status is shown

$showAccountStatus

Controls if GID number is translated to group name

$trans_primary

translates GID to group name

$trans_primary_hash

Constants

ID for config option to show account status

ACCOUNT_STATUS_OPTION_NAME

virtual attribute name for account status column

ATTR_ACCOUNT_STATUS

ID for list size config option

LIST_SIZE_OPTION_NAME

Inherited

inherited_from	\lamList::LIST_SIZE_OPTION_NAME

ID for config option to translate primary group GIDs to group names

TRANS_PRIMARY_OPTION_NAME

prefix for virtual (non-LDAP) attributes

VIRTUAL_ATTRIBUTE_PREFIX

Inherited

inherited_from	\lamList::VIRTUAL_ATTRIBUTE_PREFIX