SproutCMS

This is the code documentation for the SproutCMS project

More info
Project:
Home   Sprout SproutModules

Search documentation

Search term:

What to search:





Path or filename:

Info Page:

General

Used by

Extends

Source search

Page options:

Inherited members

class WorkerJobAdminController

Handles most processing for Worker Jobs

Variables

NameVisibilityDescription
$add_defaults 
$controller_name 
$friendly_name 
$main_delete 
$main_order 
$navigation_name 

Functions

NameVisibilityDescription
__constructpublicConstructor
_addSavepublic 
_editSavepublic 
_extraManualRunpublicUI for running worker jobs manually
_getAddFormpublic 
_getNavigationpublic 
_getToolspublicReturns the contents of the navigation pane for the list
_getVisibilityFieldspublicReturn the fields to show in the sidebar when adding or editing a record.
jsonStatuspublicReturn the status and log for the worker job edit view ajax update
manualRunActionpublicManually runs a worker job

public __construct

void $WorkerJobAdminController->__construct ( );

Constructor

public _addSave

unknown $WorkerJobAdminController->_addSave ( mixed &$item_id );

This function does not have a description

public _editSave

unknown $WorkerJobAdminController->_editSave ( mixed $item_id );

This function does not have a description

public _extraManualRun

unknown $WorkerJobAdminController->_extraManualRun ( );

UI for running worker jobs manually

public _getAddForm

unknown $WorkerJobAdminController->_getAddForm ( );

This function does not have a description

public _getNavigation

unknown $WorkerJobAdminController->_getNavigation ( );

This function does not have a description

public _getTools

unknown $WorkerJobAdminController->_getTools ( );

Returns the contents of the navigation pane for the list

public _getVisibilityFields

array $WorkerJobAdminController->_getVisibilityFields ( );

Return the fields to show in the sidebar when adding or editing a record.
These fields are shown under a heading of "Visibility"

Key is the field name, value is the field label

public jsonStatus

void $WorkerJobAdminController->jsonStatus ( mixed $job_id );

Return the status and log for the worker job edit view ajax update

public manualRunAction

void $WorkerJobAdminController->manualRunAction ( );

Manually runs a worker job
Extra args can be provided as required.
Powered by Pelzini, version 0.9.0 Documentation is made available under the GNU Free Documentation License 1.2.
Generated: Tuesday, 15th September, 2026 at 10:26 am