TasksVariable
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\TasksVariable
- Since
- 2.0
Task functions.
See also http://craftcms.com
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| areTasksPending() | Returns whether there are any pending tasks. |
| getRunningTask() | Returns the currently running task. |
| getTaskInfo() | Returns info about the background tasks. |
| getTotalTasks() | Returns the total number of active tasks. |
| haveTasksFailed() | Returns whether any tasks that have failed. |
| isTaskRunning() | Returns whether there is a task that is currently running. |
# areTasksPending()
Signature
public boolean areTasksPending ( )
# getRunningTask()
Signature
public Craft\TaskModel, null getRunningTask ( )
# getTaskInfo()
Returns info about the background tasks.
Signature
public void getTaskInfo ( )
# getTotalTasks()
Signature
public boolean getTotalTasks ( )
# haveTasksFailed()
Signature
public boolean haveTasksFailed ( )
# isTaskRunning()
Signature
public boolean isTaskRunning ( )