tools

# Class: LAMTool

Source Location: /lib/tools.inc

### Interface Overview

Represents a tool.

#### Author(s):

- Roland Gruber

### Methods

- getDescription
- getImageLink
- getLink
- getName
- getPosition
- getRequiresPasswordChangeRights
- getRequiresWriteAccess
- getSubTools
- isVisible

### Class Details

[line 70]
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.

#### Tags:

author: | Roland Gruber

[ Top ]

### Class Methods

### method getDescription [line 84]

`string getDescription( )`

returns a description text for the tool.

#### Tags:

return: | description

[ Top ]

### method getImageLink [line 112]

`string getImageLink( )`

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

#### Tags:

return: | image URL

[ Top ]

### method getLink [line 91]

`string getLink( )`

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

#### Tags:

return: | link

[ Top ]

### method getName [line 77]

`string getName( )`

Returns the name of the tool.

#### Tags:

return: | name

[ Top ]

### method getPosition [line 120]

`int getPosition( )`

Returns the prefered position of this tool on the tools page.

The position may be between 0 and 1000. 0 is the top position.

#### Tags:

return: | prefered position

[ Top ]

### method getRequiresPasswordChangeRights [line 105]

`boolean getRequiresPasswordChangeRights( )`

Returns if the tool requires password change rights.

#### Tags:

return: | true if password change rights are needed

[ Top ]

### method getRequiresWriteAccess [line 98]

`boolean getRequiresWriteAccess( )`

Returns if the tool requires write access to LDAP.

#### Tags:

return: | true if write access is needed

[ Top ]

### method getSubTools [line 127]

`array getSubTools( )`

Returns a list of sub tools or an empty array.

#### Tags:

return: | list of subtools (LAMTool)

[ Top ]

### method isVisible [line 134]

`boolean isVisible( )`

Returns if the tool is visible in the menu.

#### Tags:

return: | visible

[ Top ]

Documentation generated on Tue, 22 Nov 2011 16:30:14 +0100 by phpDocumentor 1.4.1