Scheduler an reunpack. More...

Inheritance diagram for ui_reunpack:

Collaboration diagram for ui_reunpack:

Public Member Functions
	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.) More...

	CheckStatus ($uploadpk, $job_name, $jobqueue_type)
	Given an uploadpk and job_name to check if an reunpack/rewget job is running. More...

	AgentAdd ($uploadpk, $Depends=NULL, $priority=0)
	Given an uploadpk, add a job. More...

	ShowReunpackView ($Item, $Reunpack=0)
	Generate the reunpack view page. Give the unploadtree_pk, return page view output. More...

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 ()

	getTemplateName ()

	renderString ($templateName, $vars=null)

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

	getRequest ()

	execute ()

	preInstall ()

	postInstall ()

	unInstall ()

	getName ()

	__toString ()

Public Attributes
	$Name = "ui_reunpack"

	$Title = TITLE_ui_reunpack

	$Version = "1.2"

	$Dependency = array()

	$DBaccess = PLUGIN_DB_WRITE

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

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

Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Detailed Description

Scheduler an reunpack.

Definition at line 18 of file ui-reunpack.php.

Member Function Documentation

◆ AgentAdd()

ui_reunpack::AgentAdd	(	$uploadpk,
		$Depends = `NULL`,
		$priority = `0`
	)

Given an uploadpk, add a job.

Parameters

int	$uploadpk
array	$Depends	specifying other dependencies. @parablock $Depends can be a jq_pk, or an array of jq_pks, or NULL. @endparablock
int	$priority

Returns: NULL on success, string on failure.

Definition at line 135 of file ui-reunpack.php.

◆ CheckStatus()

ui_reunpack::CheckStatus	(	$uploadpk,
		$job_name,
		$jobqueue_type
	)

Given an uploadpk and job_name to check if an reunpack/rewget job is running.

Parameters

int	$uploadpk	Upload id
string	$job_name	Job name
string	$jobqueue_type	Job queue type for DB

Returns

int

0 no reunpack/rewget job running
1 reunpack/rewget job failed
2 reunpack/rewget job completed
3 reunpack/rewget job running
4 reunpack/rewget job pending

Definition at line 89 of file ui-reunpack.php.

◆ Output()

ui_reunpack::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.)

See also: FO_Plugin::Output()

Reimplemented from FO_Plugin.

Definition at line 31 of file ui-reunpack.php.

◆ ShowReunpackView()

ui_reunpack::ShowReunpackView	(	$Item,
		$Reunpack = `0`
	)

Generate the reunpack view page. Give the unploadtree_pk, return page view output.

Parameters

int	$Item	unploadtree_pk
int	$Reunpack	Set to show reunpack option, 0 to disable.

Definition at line 212 of file ui-reunpack.php.

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

src/ununpack/ui/ui-reunpack.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AgentAdd()

◆ CheckStatus()

◆ Output()

◆ ShowReunpackView()