Skip to content
Last updated

WHMCS\Scheduling\Task\AbstractTask

Class · extends Model · implements DecoratorItemInterface, TaskInterface

AbstractTask

Traits

  • DecoratorItemTrait
  • RegisterTrait

Methods

createTable

public function createTable($drop = false)

firstOfClassOrNew

public static function firstOfClassOrNew(array $attributes = [])

register

public static function register($allowDuplicates = false)

unregister

public static function unregister(): void

Unregisters the task by removing it from the database. If the task has a status, it will also be deleted.

getDefaultAttributes

public function getDefaultAttributes()

newCollection

public function newCollection(array $models = array())

Parameters

TypeNameDescription
array$models

Returns Collection

getName

public function getName()

setName

public function setName($name)

run

public function run()

getPriority

public function getPriority()

setPriority

public function setPriority($priority)

getDescription

public function getDescription()

setDescription

public function setDescription($description)

getFrequencyMinutes

public function getFrequencyMinutes()

setFrequencyMinutes

public function setFrequencyMinutes($minutes)

anticipatedNextRun

public function anticipatedNextRun(Carbon $date = null)

isEnabled

public function isEnabled()

setEnabled

public function setEnabled($state)

isPeriodic

public function isPeriodic()

setPeriodic

public function setPeriodic($state)

getStatus

public function getStatus()

getStatusAttribute

public function getStatusAttribute($status)

status

public function status()

getSystemName

public function getSystemName()

getAccessLevel

public function getAccessLevel()

getOutputKeys

public function getOutputKeys()

Returns array

isDailyTask

public function isDailyTask()

monthlyDayOfExecution

public function monthlyDayOfExecution()

isSkipDailyCron

public function isSkipDailyCron()

getDetailUrl

public function getDetailUrl()

getFailureUrl

public function getFailureUrl()