tools

# Class: toolSchemaBrowser

Source Location: /lib/tools/schemaBrowser.inc

### Class Overview

Schema browser

Implements interfaces:

- LAMTool

### Methods

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

### Class Details

[line 36]
Schema browser
[ Top ]

### Class Methods

### method getDescription [line 52]

`string getDescription( )`

returns a description text for the tool.

#### Tags:

return: | description

Implementation of:

LAMTool::getDescription()
  returns a description text for the tool.

[ Top ]

### method getImageLink [line 88]

`string getImageLink( )`

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

#### Tags:

return: | image URL

Implementation of:

LAMTool::getImageLink()
  Returns the link to the tool image (relative to graphics/)

[ Top ]

### method getLink [line 61]

`string getLink( )`

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

#### Tags:

return: | link

Implementation of:

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

[ Top ]

### method getName [line 43]

`string getName( )`

Returns the name of the tool.

#### Tags:

return: | name

Implementation of:

LAMTool::getName()
  Returns the name of the tool.

[ Top ]

### method getPosition [line 98]

`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

Implementation of:

LAMTool::getPosition()
  Returns the prefered position of this tool on the tools page.

[ Top ]

### method getRequiresPasswordChangeRights [line 79]

`boolean getRequiresPasswordChangeRights( )`

Returns if the tool requires password change rights.

#### Tags:

return: | true if password change rights are needed

Implementation of:

LAMTool::getRequiresPasswordChangeRights()
  Returns if the tool requires password change rights.

[ Top ]

### method getRequiresWriteAccess [line 70]

`boolean getRequiresWriteAccess( )`

Returns if the tool requires write access to LDAP.

#### Tags:

return: | true if write access is needed

Implementation of:

LAMTool::getRequiresWriteAccess()
  Returns if the tool requires write access to LDAP.

[ Top ]

Documentation generated on Thu, 28 Oct 2010 21:00:34 +0200 by phpDocumentor 1.4.1