Documentation

Executor
in package
Uses UtilsProvider

Execute a server job.

Table of Contents

Properties

$core  : mixed

Methods

__construct()  : mixed
C'tor.
buildErrorMessages()  : mixed
Build error messages based on the "remaining" status.
getPluginConstantPrefix()  : string
Get the prefix of this package so we can utils package natively.
run()  : mixed
Run multiple server jobs by ID.
setupConstants()  : mixed
Make sure the REAL_QUEUE constants are available.
isValidJob()  : mixed
Check if a given job is valid for execution.

Properties

Methods

__construct()

C'tor.

public __construct(Core $core) : mixed
Parameters
$core : Core
Tags
codeCoverageIgnore

buildErrorMessages()

Build error messages based on the "remaining" status.

public buildErrorMessages(array<string|int, mixed> $remaining) : mixed
Parameters
$remaining : array<string|int, mixed>

Result of Query::readRemaining

getPluginConstantPrefix()

Get the prefix of this package so we can utils package natively.

public getPluginConstantPrefix() : string
Return values
string

run()

Run multiple server jobs by ID.

public run(array<string|int, int> $ids, int $maxExecutionTimeMs[, bool $omitClientData = false ]) : mixed
Parameters
$ids : array<string|int, int>
$maxExecutionTimeMs : int
$omitClientData : bool = false

See Query::read

setupConstants()

Make sure the REAL_QUEUE constants are available.

public static setupConstants() : mixed

isValidJob()

Check if a given job is valid for execution.

protected isValidJob(Job $job) : mixed
Parameters
$job : Job 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results