Documentation

BackgroundTask
in package

AbstractYes

Base class for all background tasks.

Table of Contents

Constants

RECEIVE_NOTIFY_ALERT  = 0x1
RECEIVE_NOTIFY_EMAIL  = 0x2
Constants for notification types.

Properties

$_details  : array<string|int, mixed>

Methods

__construct()  : mixed
The constructor.
execute()  : mixed
The function to actually execute a task
getMinUserInfo()  : array<string|int, mixed>
Loads minimal info for the previously loaded user ids

Constants

RECEIVE_NOTIFY_EMAIL

Constants for notification types.

public mixed RECEIVE_NOTIFY_EMAIL = 0x2

Properties

$_details

protected array<string|int, mixed> $_details

Holds the details for the task

Methods

__construct()

The constructor.

public __construct(array<string|int, mixed> $details) : mixed
Parameters
$details : array<string|int, mixed>

The details for the task

execute()

The function to actually execute a task

public abstract execute() : mixed

getMinUserInfo()

Loads minimal info for the previously loaded user ids

public getMinUserInfo([array<string|int, mixed> $user_ids = [] ]) : array<string|int, mixed>
Parameters
$user_ids : array<string|int, mixed> = []
Tags
throws
Exception
Return values
array<string|int, mixed>

        
On this page

Search results