AdminCompanyAutomation extends AdminController
Admin Company Automation Settings
Table of Contents
Methods
| clearTask() | Clears the POSTed cron task |
| index() | Automation settings |
| preAction() | Pre-action |
| appendTaskInfo() | Updates the given task objects to append properties representing additional information on the task |
| getIntervals() | Retrieve a list of available cron task intervals (in minutes) |
| groupTasks() | Creates a set of task groups from runnable tasks based on the module or plugin |
Methods
clearTask()
Clears the POSTed cron task
public
clearTask() : mixed
index()
Automation settings
public
index() : mixed
preAction()
Pre-action
public
preAction() : mixed
appendTaskInfo()
Updates the given task objects to append properties representing additional information on the task
private
appendTaskInfo(array<string|int, mixed> $task_runs) : array<string|int, mixed>
Parameters
- $task_runs : array<string|int, mixed>
-
array An array of stdClass objects representing each cron task run
Return values
array<string|int, mixed> —An array of stdClass objects representing each cron task run, but now including:
- last_ran
- is_running
- is_stalled
getIntervals()
Retrieve a list of available cron task intervals (in minutes)
private
getIntervals([mixed $task = null ][, mixed $task_type = null ]) : array<string|int, mixed>
Parameters
- $task : mixed = null
-
The task to fetch the interval (optional)
- $task_type : mixed = null
Return values
array<string|int, mixed> —A list of intervals
groupTasks()
Creates a set of task groups from runnable tasks based on the module or plugin
private
groupTasks(array<string|int, mixed> $task_runs) : array<string|int, mixed>
Parameters
- $task_runs : array<string|int, mixed>
-
array An array of stdClass objects representing each cron task run
Return values
array<string|int, mixed> —An array of plugin/module groups containing the name of the group and the task IDs in that group:
- name The name of the group
- task_ids An array of each task ID in the group