ITool
- Type
- Interface
- Namespace
- Craft
- Extends
- Craft\IComponentType
- Implemented by
- Craft\AssetIndexTool, Craft\BaseTool, Craft\ClearCachesTool, Craft\DbBackupTool, Craft\FindAndReplaceTool, Craft\SearchIndexTool
- Since
- 1.0
Interface ITool
See also http://craftcms.com
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| getButtonLabel() | Returns the tool's button label. |
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| getIconValue() | |
| getName() | Returns the component’s name. |
| getOptionsHtml() | Returns the tool's options HTML. |
| isSelectable() | Returns whether this component should be shown when the user is creating a component of this type. |
| performAction() | Performs the tool's action. |
# getButtonLabel()
Signature
public abstract string getButtonLabel ( )
# getIconValue()
Signature
public abstract string getIconValue ( )
# getOptionsHtml()
Signature
public abstract string getOptionsHtml ( )
# performAction()
Performs the tool's action.
View source (opens new window)
Arguments
$params(array (opens new window))
Returns
Signature
public abstract array performAction ( $params = [] )