BaseTask
- Type
- Abstract Class
- Namespace
- Craft
- Inherits
- Craft\BaseTask » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
- Craft\IComponentType, Craft\ISavableComponentType, Craft\ITask,
IApplicationComponent - Extended by
- Craft\DeleteStaleTemplateCachesTask, Craft\FindAndReplaceTask, Craft\GeneratePendingTransformsTask, Craft\LocalizeRelationsTask, Craft\ResaveAllElementsTask, Craft\ResaveElementsTask, Craft\UpdateElementSlugsAndUrisTask
- Since
- 2.0
Task 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. |
| $model | Craft\BaseModel |
# Protected Properties
| Property | Description |
|---|---|
| $componentType | string (opens new window) |
# $componentType
Signature
protected string $componentType = 'Task'
# 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. |
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| getDescription() | Returns the default description for this task. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| 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. |
| 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. |
| prepSettings() | Preps the settings before they’re saved to the database. |
| raiseEvent() (opens new window) | Raises an event. |
| runStep() | Runs a task step. |
| setSettings() | Sets the setting values. |
# getDescription()
Returns the default description for this task.
ITask::getDescription()
View source (opens new window)
Returns
Signature
public string getDescription ( )
# getTotalSteps()
Returns the total number of steps for this task.
ITask::getTotalSteps()
View source (opens new window)
Returns
Signature
public integer getTotalSteps ( )
# runStep()
Runs a task step.
ITask::runStep()
View source (opens new window)
Arguments
$step(integer (opens new window))
Returns
Signature
public boolean runStep ( $step )
# Protected Methods
| Method | Description |
|---|---|
| defineSettings() | Defines the settings. |
| getSettingsModel() | Returns the settings model. |
| runSubTask() | Creates and runs a subtask. |
# runSubTask()
Creates and runs a subtask.
View source (opens new window)
Arguments
$taskClassName(string (opens new window))$taskDescription(string (opens new window), null (opens new window))$settings(array (opens new window), null (opens new window))
Returns
Signature
protected boolean runSubTask ( $taskClassName, $taskDescription = null, $settings = null )