ToolVariable
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\ToolVariable » Craft\BaseComponentTypeVariable
- Since
- 1.0
Tool template variable.
See also http://craftcms.com
View source (opens new window)
# Protected Properties
| Property | Description |
|---|---|
| $component | Craft\BaseComponentType |
# Public Methods
| Method | Description |
|---|---|
| __construct() | Constructor |
| __toString() | Use the component's name as its string representation. |
| getButtonLabel() | Returns the tool's button label. |
| getClassHandle() | Returns the component's class handle. |
| getIconValue() | Returns the tool's icon value. |
| getName() | Returns the component's name. |
| getOptionsHtml() | Returns the tool's options HTML. |
| getSettingsHtml() | Returns the component's settings HTML. |
| isSelectable() | Returns whether this component should be selectable when choosing a component of this type. |
| populateVariables() | Mass-populates instances of this class with a given set of models. |
# getButtonLabel()
Signature
public string getButtonLabel ( )
# getIconValue()
Signature
public string getIconValue ( )
# getOptionsHtml()
Signature
public string getOptionsHtml ( )