agent_wget_agent Class Reference

UI plugin for WGET_AGENT. More...

Inheritance diagram for agent_wget_agent:

Collaboration diagram for agent_wget_agent:

Public Member Functions
	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...
	AgentHasResults ($upload_pk)
	Check if the upload has results from this agent. More...
	AgentAdd ($job_pk, $upload_pk, &$ErrorMsg, $Dependencies)
	Queue the wget agent. 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...
	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
	$Name = "wget_agent"
	$Title = TITLE_agent_wget_agent
	$Version = "1.0"
	$Dependency = array()
	$DBaccess = PLUGIN_DB_WRITE
	$AgentName = "wget_agent"
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

UI plugin for WGET_AGENT.

Definition at line 19 of file wget_agent.php.

Member Function Documentation

AgentAdd()

agent_wget_agent::AgentAdd	(		$job_pk,
			$upload_pk,
		&	$ErrorMsg,
			$Dependencies
	)

Queue the wget agent.

Before queuing, check if agent needs to be queued. It doesn't need to be queued if:

• It is already queued
• It has already been run by the latest agent version

Parameters

int	$job_pk
int	$upload_pk
string	$ErrorMsg	Error message on failure
array	$Dependencies	Array of plugin names representing dependencies. This is for dependencies that this plugin cannot know about ahead of time.

Returns

• jq_pk Successfully queued
• 0 Not queued, latest version of agent has previously run successfully
• -1 Not queued, error, error string in $ErrorMsg

Definition at line 77 of file wget_agent.php.

AgentHasResults()

agent_wget_agent::AgentHasResults

(

$upload_pk

)

Check if the upload has results from this agent.

Parameters

int

$upload_pk

Upload to check

Returns

• 0 = no
• 1 = yes, from latest agent version
• 2 = yes, from older agent version (does not apply to wget_agent)

Definition at line 53 of file wget_agent.php.

RegisterMenus()

agent_wget_agent::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.

Note

1: Menu registration may be plugin specific!

2: This is intended for cross-plugin registration and not for the main menu.

See also

FO_Plugin::RegisterMenus()

Reimplemented from FO_Plugin.

Definition at line 32 of file wget_agent.php.

---

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

• src/wget_agent/ui/wget_agent.php