Provide data for jobs table. More...

Inheritance diagram for Fossology\UI\Ajax\AjaxShowJobs:

Collaboration diagram for Fossology\UI\Ajax\AjaxShowJobs:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...

	OutputOpen ()
	This function is called when user output is requested. This function is responsible for assigning headers.

	getShowJobsForEachJob ($jobData, $forApi=false)
	Returns an upload job status in array for API or browser. More...

	Output ()
	This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)

Public Member Functions inherited from FO_Plugin
	Install ()
	This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...

	Remove ()
	This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.

	Initialize ()
	dummy stub till all references are removed.

	PostInitialize ()
	This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...

	RegisterMenus ()
	While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...

	Destroy ()
	This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.

	OutputUnSet ()
	Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.

	getResponse ()

	getTemplateName ()

	renderString ($templateName, $vars=null)

	renderScripts ($scripts)
	Render JavaScript in the template's footer. More...

	getRequest ()

	execute ()

	preInstall ()

	postInstall ()

	unInstall ()

	getName ()

	__toString ()

Public Attributes
const	MAX_LOG_OUTPUT = 32768

Public Attributes inherited from FO_Plugin
	$State = PLUGIN_STATE_INVALID

	$Name = ""

	$Version = "1.0"

	$Title = ""

	$DBaccess = PLUGIN_DB_NONE

	$LoginFlag = 0

	$NoMenu = 0

	$NoHeader = 0

	$PluginLevel = 10

	$Dependency = array()

	$InitOrder = 0

	$MenuList = NULL

	$MenuOrder = 0

	$MenuTarget = NULL

	$OutputType = "HTML"

	$OutputToStdout = 0

Protected Member Functions
	compareJobsInfo ($JobsInfo1, $JobsInfo2)
	Sort compare function to order $JobsInfo by job_pk. More...

	getGeekyScanDetailsForJob ($job_pk)
	Returns geeky scan details about the jobqueue item. More...

	isUnfinishedJob ($job)
	Are there any unfinished jobqueues in this job? More...

	getClass ($jobqueueRec)
	array $jobqueueRec get the jobqueue row color More...

	jobqueueStatus ($jobqueueRec)
	Get the status of a jobqueue item If the job isn't known to the scheduler, then report the status based on the jobqueue table. If it is known to the scheduler, use that for the status. More...

	getJobs ($uploadPk)
	get data of all jobs using uploadpk More...

	jsonContent ()

Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)

Private Attributes
	$dbManager

	$showJobsDao

	$userDao

	$clearingDao

Additional Inherited Members
Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Detailed Description

Provide data for jobs table.

Definition at line 33 of file AjaxShowJobs.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\UI\Ajax\AjaxShowJobs::__construct ( )

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns: true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

Definition at line 49 of file AjaxShowJobs.php.

Member Function Documentation

◆ compareJobsInfo()

Fossology\UI\Ajax\AjaxShowJobs::compareJobsInfo	(	$JobsInfo1,
		$JobsInfo2
	)

protected

Sort compare function to order $JobsInfo by job_pk.

Parameters

$JobsInfo1	Result from GetJobInfo
$JobsInfo2	Result from GetJobInfo

Returns: <0,==0, >0

Definition at line 85 of file AjaxShowJobs.php.

◆ getClass()

Fossology\UI\Ajax\AjaxShowJobs::getClass ( $jobqueueRec )

protected

array $jobqueueRec get the jobqueue row color

Returns: string css class

Definition at line 352 of file AjaxShowJobs.php.

◆ getGeekyScanDetailsForJob()

Fossology\UI\Ajax\AjaxShowJobs::getGeekyScanDetailsForJob ( $job_pk )

protected

Returns geeky scan details about the jobqueue item.

Parameters

$job_pk

Returns: Return job and jobqueue record data in an html table.

Definition at line 98 of file AjaxShowJobs.php.

◆ getJobs()

Fossology\UI\Ajax\AjaxShowJobs::getJobs ( $uploadPk )

protected

get data of all jobs using uploadpk

Returns: a json jobqueue data.

Definition at line 405 of file AjaxShowJobs.php.

◆ getShowJobsForEachJob()

Fossology\UI\Ajax\AjaxShowJobs::getShowJobsForEachJob	(	$jobData,
		$forApi = `false`
	)

Returns an upload job status in array for API or browser.

Parameters

array	$jobData
bool	$forApi

Returns: Returns an upload job status in array for API or browser

Definition at line 213 of file AjaxShowJobs.php.

◆ isUnfinishedJob()

Fossology\UI\Ajax\AjaxShowJobs::isUnfinishedJob ( $job )

protected

Are there any unfinished jobqueues in this job?

Parameters

$job

Returns: true if $job contains unfinished jobqueue's

Definition at line 336 of file AjaxShowJobs.php.

◆ jobqueueStatus()

Fossology\UI\Ajax\AjaxShowJobs::jobqueueStatus ( $jobqueueRec )

protected

Get the status of a jobqueue item If the job isn't known to the scheduler, then report the status based on the jobqueue table. If it is known to the scheduler, use that for the status.

Parameters

$jobqueueRec

Returns: a string describing the status

Definition at line 374 of file AjaxShowJobs.php.

The documentation for this class was generated from the following file:

src/www/ui/async/AjaxShowJobs.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compareJobsInfo()

◆ getClass()

◆ getGeekyScanDetailsForJob()

◆ getJobs()

◆ getShowJobsForEachJob()

◆ isUnfinishedJob()

◆ jobqueueStatus()