TasksManager
in package
Class TasksManager
Tags
Table of Contents
- HISTORY_TABLE_NAME = 'scheduler_history'
- STATUS_ERROR = 'error'
- STATUS_SUCCESS = 'success'
- TASKS_TABLE_NAME = 'scheduler_tasks'
- $container : Container
- $database : Context
- __construct() : mixed
- TasksManager constructor.
- findActual() : Selection
- Returns the actual tasks to be performed from the database
- findAll() : Selection
- Returns all tasks from the database
- findHistoryByTask() : Selection
- Returns the task history by its name from the database
- getTaskFromDb() : Selection
- Returns a task entry from the database
- registerTask() : bool
- Register task for scheduler
- runActualTasks() : mixed
- Performs current tasks
- setEnabled() : bool
- Enable or disable task by name for scheduler
- unregisterTask() : bool
- Unregister task for scheduler
- addTaskHistory() : mixed
- Добавляет запись истории задачи в базу данных
- addTaskToDb() : bool
- Добавляет запись о задаче в базу данных
- updateNextRunTime() : mixed
Constants
HISTORY_TABLE_NAME
public
string
HISTORY_TABLE_NAME
= 'scheduler_history'
STATUS_ERROR
public
string
STATUS_ERROR
= 'error'
STATUS_SUCCESS
public
string
STATUS_SUCCESS
= 'success'
TASKS_TABLE_NAME
public
string
TASKS_TABLE_NAME
= 'scheduler_tasks'
Properties
$container
private
Container
$container
$database
private
Context
$database
Methods
__construct()
TasksManager constructor.
public
__construct(Context $database, Container $container) : mixed
Parameters
- $database : Context
- $container : Container
Return values
mixed —findActual()
Returns the actual tasks to be performed from the database
public
findActual() : Selection
Return values
Selection —findAll()
Returns all tasks from the database
public
findAll() : Selection
Return values
Selection —findHistoryByTask()
Returns the task history by its name from the database
public
findHistoryByTask( $name) : Selection
Parameters
Return values
Selection —getTaskFromDb()
Returns a task entry from the database
public
getTaskFromDb( $name) : Selection
Parameters
Return values
Selection —registerTask()
Register task for scheduler
public
registerTask(string $name, string $expression, string|array<string|int, mixed>|callable $function, string $title) : bool
Parameters
- $name : string
-
Uniq name
- $expression : string
-
Time format as Linux cron
- $function : string|array<string|int, mixed>|callable
-
Function for task
- $title : string
-
Title for interface
Tags
Return values
bool —runActualTasks()
Performs current tasks
public
runActualTasks() : mixed
Tags
Return values
mixed —setEnabled()
Enable or disable task by name for scheduler
public
setEnabled(string $name[, bool $enabled = true ]) : bool
Parameters
- $name : string
-
Task name
- $enabled : bool = true
Tags
Return values
bool —unregisterTask()
Unregister task for scheduler
public
unregisterTask(string $name) : bool
Parameters
- $name : string
-
Task name
Tags
Return values
bool —addTaskHistory()
Добавляет запись истории задачи в базу данных
private
addTaskHistory(string $name, DateTime $start_time, DateTime $finish_time, string $status[, string $message = '' ]) : mixed
Parameters
- $name : string
- $start_time : DateTime
- $finish_time : DateTime
- $status : string
- $message : string = ''
Return values
mixed —addTaskToDb()
Добавляет запись о задаче в базу данных
private
addTaskToDb(string $name, string $expression, string|array<string|int, mixed> $function, string $title, DateTime|DateTime $next_run_time) : bool
Parameters
- $name : string
- $expression : string
- $function : string|array<string|int, mixed>
- $title : string
- $next_run_time : DateTime|DateTime
Return values
bool —updateNextRunTime()
private
updateNextRunTime(string $name, DateTime $next_run_time) : mixed
Parameters
- $name : string
- $next_run_time : DateTime