BaseTool

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseTool » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
Craft\IComponentType, Craft\ITool, IApplicationComponent
Extended by
Craft\AssetIndexTool, Craft\ClearCachesTool, Craft\DbBackupTool, Craft\FindAndReplaceTool, Craft\SearchIndexTool
Since
1.0

Tool base class.

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$behaviors (opens new window) array (opens new window) – The behaviors that should be attached to this component.

# Protected Properties

# $componentType

Signature

protected string $componentType = 'Tool'

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
getButtonLabel() Returns the tool's button label.
getClassHandle() Returns the component’s handle, ideally based on the class name.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getIconValue()
getIsInitialized() (opens new window) Checks if this application component has been initialized.
getName() Returns the component’s name.
getOptionsHtml() Returns the tool's options HTML.
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
init() (opens new window) Initializes the application component.
isInitialized() Checks if this application component has been initialized yet, or not.
isSelectable() Returns whether this component should be shown when the user is creating a component of this type.
performAction() Performs the tool's action.
raiseEvent() (opens new window) Raises an event.

# getButtonLabel()

Returns the tool's button label.

ITool::getButtonLabel()

View source (opens new window)

Returns

string (opens new window)

Signature

public string getButtonLabel ( )

# getIconValue()

Signature

public string getIconValue ( )

# getOptionsHtml()

Returns the tool's options HTML.

ITool::getOptionsHtml()

View source (opens new window)

Returns

string (opens new window)

Signature

public string getOptionsHtml ( )

# performAction()

Performs the tool's action.

ITool::performAction()

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array performAction ( $params = [] )