BaseTask

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseTask » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
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

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.
$modelCraft\BaseModel

Protected Properties

PropertyDescription
$componentTypestring

$componentType

Signature

protected string $componentType = 'Task'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()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

Returns

string

Signature

public string getDescription ( )

getTotalSteps()

Returns the total number of steps for this task.

ITask::getTotalSteps()

View source

Returns

integer

Signature

public integer getTotalSteps ( )

runStep()

Runs a task step.

ITask::runStep()

View source

Arguments

Returns

boolean

Signature

public boolean runStep ( $step )

Protected Methods

MethodDescription
defineSettings()Defines the settings.
getSettingsModel()Returns the settings model.
runSubTask()Creates and runs a subtask.

runSubTask()

Creates and runs a subtask.

View source

Arguments

Returns

boolean

Signature

protected boolean runSubTask ( $taskClassName, $taskDescription = null, $settings = null )