FOSSology  3.2.0rc1
Open Source License Compliance by Open Source Software
Fossology\UI\Ajax\AjaxShowJobs Class Reference

Provide data for jobs table. More...

Inheritance diagram for Fossology\UI\Ajax\AjaxShowJobs:
Inheritance graph
Collaboration diagram for Fossology\UI\Ajax\AjaxShowJobs:
Collaboration graph

Public Member Functions

 OutputOpen ()
 
 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.
 
 __construct ()
 base constructor. Most plugins will just use this More...
 
 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.
 
 OutputOpen ()
 This function is called when user output is requested. This function is responsible for assigning headers.
 
 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 ()
 
 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.)
 
 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...
 
 getShowJobsForEachJob ($jobData)
 Returns an upload job status in array. 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 43 of file AjaxShowJobs.php.

Member Function Documentation

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

Sort compare function to order $JobsInfo by job_pk.

Parameters
$JobsInfo1Result from GetJobInfo
$JobsInfo2Result from GetJobInfo
Returns
<0,==0, >0

Definition at line 95 of file AjaxShowJobs.php.

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

array $jobqueueRec get the jobqueue row color

Returns
string css class

Definition at line 339 of file AjaxShowJobs.php.

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 108 of file AjaxShowJobs.php.

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

get data of all jobs using uploadpk

Returns
a json jobqueue data.

Definition at line 392 of file AjaxShowJobs.php.

Fossology\UI\Ajax\AjaxShowJobs::getShowJobsForEachJob (   $jobData)
protected

Returns an upload job status in array.

Parameters
array$jobData
Returns
Returns an upload job status in array

Definition at line 220 of file AjaxShowJobs.php.

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 323 of file AjaxShowJobs.php.

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 361 of file AjaxShowJobs.php.


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