Documentation

Tasks
in package
implements ActionInterface uses ActionTrait, BackwardCompatibility

This class concerns itself with scheduled tasks management.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$subaction  : string
$subactions  : array<string|int, mixed>
$obj  : static

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
edit()  : void
Method for editing a task.
execute()  : void
Dispatcher to whichever sub-action method is necessary.
getConfigVars()  : array<string|int, mixed>
Gets the configuration variables for this admin area.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
list_getNumTaskLogEntries()  : int
Callback function for SMF\ItemList() in $this->log().
list_getScheduledTasks()  : array<string|int, mixed>
Callback function for SMF\ItemList() in $this->tasks().
list_getTaskLogEntries()  : array<string|int, mixed>
Callback function for SMF\ItemList() in $this->log().
load()  : static
Static wrapper for constructor.
log()  : void
Show the log of all tasks that have taken place.
settings()  : void
This handles settings related to scheduled tasks
subActionProvider()  : null|array<string|int, mixed>
Called by Subs-Compat.php BackwardCompatibility wrapper functions to provide subaction execution for existing mods
tasks()  : void
List all the scheduled task in place on the forum.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().

Properties

$subaction

public string $subaction = 'tasks'

The requested sub-action. This should be set by the constructor.

$subactions

public static array<string|int, mixed> $subactions = ['tasks' => 'tasks', 'taskedit' => 'edit', 'tasklog' => 'log', 'settings' => 'settings']

Available sub-actions.

$obj

protected static static $obj

An instance of this class. This is used by the load() method to prevent multiple instantiations.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

edit()

Method for editing a task.

public edit() : void

execute()

Dispatcher to whichever sub-action method is necessary.

public execute() : void

getConfigVars()

Gets the configuration variables for this admin area.

public static getConfigVars() : array<string|int, mixed>
Return values
array<string|int, mixed> —

$config_vars for the scheduled tasks area.

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

list_getNumTaskLogEntries()

Callback function for SMF\ItemList() in $this->log().

public static list_getNumTaskLogEntries() : int
Return values
int —

The number of log entries

list_getScheduledTasks()

Callback function for SMF\ItemList() in $this->tasks().

public static list_getScheduledTasks(int $start, int $items_per_page, string $sort) : array<string|int, mixed>
Parameters
$start : int

The item to start with (not used here)

$items_per_page : int

The number of items to display per page (not used here)

$sort : string

A string indicating how to sort things (not used here)

Return values
array<string|int, mixed> —

An array of information about available scheduled tasks

list_getTaskLogEntries()

Callback function for SMF\ItemList() in $this->log().

public static list_getTaskLogEntries(int $start, int $items_per_page, string $sort) : array<string|int, mixed>
Parameters
$start : int

The item to start with (for pagination purposes)

$items_per_page : int

How many items to display per page

$sort : string

A string indicating how to sort the results

Return values
array<string|int, mixed> —

An array of info about task log entries

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

log()

Show the log of all tasks that have taken place.

public log() : void

settings()

This handles settings related to scheduled tasks

public settings() : void

subActionProvider()

Called by Subs-Compat.php BackwardCompatibility wrapper functions to provide subaction execution for existing mods

public static subActionProvider([null|string $sa = null ][, bool $return_config = false ][, string|null $activity = null ]) : null|array<string|int, mixed>
Parameters
$sa : null|string = null
$return_config : bool = false
$activity : string|null = null
Return values
null|array<string|int, mixed>

tasks()

List all the scheduled task in place on the forum.

public tasks() : void

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results