lib/tools.inc

Properties

Description

This file includes functions to manage LAM tools.

Functions

getTools( ) : array

Description

Returns the tools which are available for LAM.

Return value

Type Description
array list of LAMtool classes

Classes

LAMSubTool

Properties

 
 
tools  
No 
No 

Description

Represents a subtool.

Properties

$description, $image, $link, $name,

  public  $description =

tool description


  public  $image =

image URL (relative to graphics/)


  public  $link =

tool link (relative to templates/)


  public  $name =

visible tool name


Interfaces

LAMTool

Properties

 
 
tools  
 
 

Description

Represents a tool.
LAM will scan lib/tools/*.inc for classes which implement this interface. This alows to dynamically plugin additional tools. There will be an entry on the tools page inside LAM for each found class (if it matches the security level). A LAMTool only specifies name, description and location of a tool. The tool functionality is provided by the tool's target page.

Methods

getDescription, getImageLink, getLink, getName, getPosition, getRequiresPasswordChangeRights, getRequiresWriteAccess, getSubTools, isHideable, isVisible,

getDescription( ) : string

Description

returns a description text for the tool.

Return value

Type Description
string description

getImageLink( ) : string

Description

Returns the link to the tool image (relative to graphics/)

Return value

Type Description
string image URL

getLink( ) : string

Description

Returns a link to the tool page (relative to templates/).

Return value

Type Description
string link

getName( ) : string

Description

Returns the name of the tool.

Return value

Type Description
string name

getPosition( ) : int

Description

Returns the prefered position of this tool on the tools page.
The position may be between 0 and 1000. 0 is the top position.

Return value

Type Description
int prefered position

getRequiresPasswordChangeRights( ) : boolean

Description

Returns if the tool requires password change rights.

Return value

Type Description
boolean true if password change rights are needed

getRequiresWriteAccess( ) : boolean

Description

Returns if the tool requires write access to LDAP.

Return value

Type Description
boolean true if write access is needed

getSubTools( ) : array

Description

Returns a list of sub tools or an empty array.

Return value

Type Description
array list of subtools (LAMTool)

isHideable( ) : boolean

Description

Returns if a tool may be hidden by configuration in the LAM server profile.

Return value

Type Description
boolean hideable

isVisible( ) : boolean

Description

Returns if the tool is visible in the menu.

Return value

Type Description
boolean visible
Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages