ITask
- Type
- Interface
- Namespace
- Craft
- Extends
- Craft\ISavableComponentType
- Implemented by
- Craft\BaseTask, Craft\DeleteStaleTemplateCachesTask, Craft\FindAndReplaceTask, Craft\GeneratePendingTransformsTask, Craft\LocalizeRelationsTask, Craft\ResaveAllElementsTask, Craft\ResaveElementsTask, Craft\UpdateElementSlugsAndUrisTask
- Since
- 2.0
Interface ITask
See also http://craftcms.com
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| getDescription() | Returns the default description for this task. |
| getName() | Returns the component’s name. |
| getSettings() | Returns the component’s settings model. |
| getSettingsHtml() | Returns the component’s settings HTML. |
| getTotalSteps() | Returns the total number of steps for this task. |
| isSelectable() | Returns whether this component should be shown when the user is creating a component of this type. |
| prepSettings() | Preps the settings before they’re saved to the database. |
| runStep() | Runs a task step. |
| setSettings() | Sets the setting values. |
# getDescription()
Signature
public abstract string getDescription ( )
# getTotalSteps()
Signature
public abstract integer getTotalSteps ( )
# runStep()
Runs a task step.
View source (opens new window)
Arguments
$step(integer (opens new window))
Returns
Signature
public abstract boolean runStep ( $step )