Public Member Functions | |
| execute () | |
| task () | |
| step () | |
| success () | |
 Public Member Functions inherited from dcMaintenanceTask | |
| __construct (dcMaintenance $maintenance) | |
| perm () | |
| blog () | |
| code ($code) | |
| ts () | |
| expired () | |
| id () | |
| name () | |
| description () | |
| tab () | |
| group () | |
| ajax () | |
| task () | |
| step () | |
| success () | |
| error () | |
| header () | |
| content () | |
| execute () | |
| help () | |
Protected Member Functions | |
| init () | |
| Protected Member Functions inherited from dcMaintenanceTask | |
| init () | |
| log () | |
Protected Attributes | |
| $ajax = true | |
| $group = 'index' | |
| $limit = 500 | |
| $step_task | |
| Protected Attributes inherited from dcMaintenanceTask | |
| $maintenance | |
| $code | |
| $ts = 0 | |
| $expired = 0 | |
| $ajax = false | |
| $blog = false | |
| $perm = null | |
| $id | |
| $name | |
| $description | |
| $tab = 'maintenance' | |
| $group = 'other' | |
| $task | |
| $step | |
| $error | |
| $success | |
Member Function Documentation
◆ init()
|
protected |
Initialize task object.
Reimplemented from dcMaintenanceTask.
References dcMaintenanceTask\description(), dcMaintenanceTask\error(), dcMaintenanceTask\name(), step(), success(), and task().
◆ execute()
| execute | ( | ) |
Execute task.
- Returns
- bool|int
- FALSE on error,
- TRUE if task is finished
- INT if task required a next step
Reimplemented from dcMaintenanceTask.
References dcCore\app(), and dcMaintenanceTask\code().
◆ task()
| task | ( | ) |
Get task message.
This message is used on form button.
- Returns
- string Message
Reimplemented from dcMaintenanceTask.
References dcMaintenanceTask\$task, and dcMaintenanceTask\code().
Referenced by init().
◆ step()
| step | ( | ) |
Get step message.
This message is displayed during task step execution.
- Returns
- mixed Message or null
Reimplemented from dcMaintenanceTask.
References dcMaintenanceTask\code(), and step().
◆ success()
| success | ( | ) |
Get success message.
This message is displayed when task is accomplished.
- Returns
- string Message or null
Reimplemented from dcMaintenanceTask.
References dcMaintenanceTask\$success, dcMaintenanceTask\code(), and step().
Referenced by init().
Field Documentation
◆ $ajax
Use ajax
Is task use maintenance ajax script for steps process.
- Returns
- boolean Use ajax
◆ $group
|
protected |
◆ $limit
|
protected |
◆ $step_task
|
protected |
The documentation for this class was generated from the following file:
- plugins/maintenance/inc/tasks/maintenance.indexposts.php
