lamListTool
in package
Represents a tool which can be included in the account lists.
Tags
Table of Contents
- $image : mixed
- tool image
- $name : mixed
- tool name
- $target : mixed
- link target
- __construct() : lamListTool
- Constructor
- getImage() : string
- Returns the name of the tool image.
- getLinkTarget() : string
- Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
- getName() : string
- Returns the tool name.
Properties
$image
tool image
private
mixed
$image
$name
tool name
private
mixed
$name
$target
link target
private
mixed
$target
Methods
__construct()
Constructor
public
__construct(string $name, string $image, string $target) : lamListTool
Parameters
- $name : string
-
tool name
- $image : string
-
image file
- $target : string
-
target page
Return values
lamListTool —tool object
getImage()
Returns the name of the tool image.
public
getImage() : string
The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.
Return values
string —image name
getLinkTarget()
Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
public
getLinkTarget() : string
The target page will be opened with two GET parameters: DN and type (e.g. user)
Return values
string —page file (e.g. 'mytool.php')
getName()
Returns the tool name.
public
getName() : string
This is used for the tool tip.
Return values
string —name