lib/types/user.inc

Properties

Description

The account type for user accounts (e.g. Unix, Samba and Kolab).

Classes

user

Properties

 
 
types  
No 
No 

Description

The account type for user accounts (e.g. Unix, Samba and Kolab).

Methods

__construct, buildAccountStatusDialogDiv, buildAccountStatusIcon, getAlias, getDefaultListAttributes, getDescription, getListAttributeDescriptions, getListClassName, getTitleBarSubtitle, getTitleBarTitle, runEditPagePostAction,

__construct( ) : n/a

Description

Constructs a new user type object.

Return value

Type Description
n/a n/a

buildAccountStatusDialogDiv( boolean   $unixAvailable, boolean   $unixLocked, boolean   $sambaAvailable, boolean   $sambaLocked, boolean   $ppolicyAvailable, boolean   $ppolicyLocked, boolean   $windowsAvailable, boolean   $windowsLocked, ) : n/a

Description

Builds the dialog to (un)lock parts of an account.

Arguments

Name Type Description Default
$unixAvailable boolean

Unix part is active

$unixLocked boolean

Unix part is locked

$sambaAvailable boolean

Samba part is active

$sambaLocked boolean

Samba part is locked

$ppolicyAvailable boolean

PPolicy part is active

$ppolicyLocked boolean

PPolicy part is locked

$windowsAvailable boolean

Windows part is active

$windowsLocked boolean

Windows part is locked

Return value

Type Description
n/a n/a

buildAccountStatusIcon( \accountContainer   $container, ) : String

Description

Builds the HTML code for the icon that shows the account status (locked/unlocked).

Arguments

Name Type Description Default
$container \accountContainer

account container

Return value

Type Description
String HTML code for icon

getAlias( ) : string

Description

Returns the alias name of this account type.

Return value

Type Description
string alias name

getDefaultListAttributes( ) : string

Description

Returns the default attribute list for this account type.

Return value

Type Description
string attribute list

getDescription( ) : string

Description

Returns the description of this account type.

Return value

Type Description
string description

getListAttributeDescriptions( ) : array

Description

Returns a list of attributes which have a translated description.
This is used for the head row in the list view.

Return value

Type Description
array list of descriptions

getListClassName( ) : string

Description

Returns the class name for the list object.

Return value

Type Description
string class name

getTitleBarSubtitle( \accountContainer   $container, ) : String

Description

Returns the the title text for the title bar on the new/edit page.

Arguments

Name Type Description Default
$container \accountContainer

account container

Return value

Type Description
String title text

getTitleBarTitle( \accountContainer   $container, ) : String

Description

Returns the the title text for the title bar on the new/edit page.

Arguments

Name Type Description Default
$container \accountContainer

account container

Return value

Type Description
String title text

runEditPagePostAction( \accountContainer   $container, ) : n/a

Description

This function is called after the edit page is processed and before the page content is generated.
This can be used to run custom handlers after each page processing.

Arguments

Name Type Description Default
$container \accountContainer

account container

Return value

Type Description
n/a n/a

lamUserList

Properties

 
 
lists  
No 
No 

Description

Generates the list view.

Methods

__construct, canBeFiltered, getAdditionalLDAPAttributesToRead, getAdditionalTools, injectAccountStatusAttribute, isPPolicyAvailable, isPPolicyLocked, isSambaAvailable, isSambaLocked, isUnixAvailable, isUnixLocked, isWindowsAvailable, isWindowsLocked, listConfigurationChanged, listGetAllConfigOptions, listGetAttributeDescriptionList, listGetParams, listPrintTableCellContent, listRefreshData, printAccountStatus, refreshPrimaryGroupTranslation,

__construct( string   $type, ) : \lamList

Description

Constructor

Arguments

Name Type Description Default
$type string

account type

Return value

Type Description
\lamList list object

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.

The user list allows no filtering for account status.

Arguments

Name Type Description Default
$attr String

attribute name

Return value

Type Description
boolean filtering possible

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.

The user list reads pwdAccountLockedTime, sambaAcctFlags and userPassword

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

injectAccountStatusAttribute( ) : n/a

Description

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

Return value

Type Description
n/a n/a

isPPolicyAvailable( array   $attrs, ) : boolean

Description

Returns if the PPolicy part exists.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean PPolicy part exists

isPPolicyLocked( array   $attrs, ) : boolean

Description

Returns if the PPolicy part is locked.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean PPolicy part is locked

isSambaAvailable( array   $attrs, ) : boolean

Description

Returns if the Samba part exists.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Samba part exists

isSambaLocked( array   $attrs, ) : boolean

Description

Returns if the Samba part is locked.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Samba part is locked

isUnixAvailable( array   $attrs, ) : boolean

Description

Returns if the Unix part exists.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Unix part exists

isUnixLocked( array   $attrs, ) : boolean

Description

Returns if the Unix part is locked.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Unix part locked

isWindowsAvailable( array   $attrs, ) : boolean

Description

Returns if the Windows part exists.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Windows part exists

isWindowsLocked( array   $attrs, ) : boolean

Description

Returns if the Windows part is locked.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
boolean Windows part is locked

listConfigurationChanged( ) : n/a

Description

Called when the configuration options changed.

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)

The user list may display an additional account status column

Return value

Type Description
array attribute list

listGetParams( ) : n/a

Description

Sets some internal parameters.

Return value

Type Description
n/a n/a

listPrintTableCellContent( array   $entry, string   $attribute, ) : n/a

Description

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

Arguments

Name Type Description Default
$entry array

LDAP attributes

$attribute string

attribute name

Return value

Type Description
n/a n/a

listRefreshData( ) : n/a

Description

Rereads the entries from LDAP.

Return value

Type Description
n/a n/a

printAccountStatus( array   $attrs, ) : n/a

Description

Prints the account status.

Arguments

Name Type Description Default
$attrs array

LDAP attributes

Return value

Type Description
n/a n/a

refreshPrimaryGroupTranslation( ) : n/a

Description

Refreshes the GID to group name cache.

Return value

Type Description
n/a n/a

Properties

$showAccountStatus, $trans_primary, $trans_primary_hash,

  private  $showAccountStatus = false

Controls if the account status is shown


  private  $trans_primary = false

Controls if GID number is translated to group name


  private  $trans_primary_hash = array()

translates GID to group name


Constants

  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


  TRANS_PRIMARY_OPTION_NAME = "LU_TP"

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


Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages