lib/tools/ouEditor.inc
Properties
Description
This file includes the OU editor tool specification.Classes
toolOUEditor
Description
OU editorMethods
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) |