agent_nomos_once Class Reference

Class to run one-shot nomos. More...

Inheritance diagram for agent_nomos_once:

Collaboration diagram for agent_nomos_once:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	AnalyzeFile ($FilePath, $getHighlightInfo=false)
	Analyze one uploaded file. More...
	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...
	RegisterMenus ()
	Change the type of output based on user-supplied parameters. More...
	Output ()
	Generate the text for this plugin. More...
Public Member Functions inherited from FO_Plugin
	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...
	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
const	FILE_INPUT = 'file_input'
	Resource key for input file.
	$HighlightInfoKeywords = array()
	Highlight info for keywords.
	$HighlightInfoLicenses = array()
	Highlight info for licenses.
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

Class to run one-shot nomos.

Definition at line 23 of file agent-nomos-once.php.

Constructor & Destructor Documentation

__construct()

agent_nomos_once::__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 29 of file agent-nomos-once.php.

Member Function Documentation

AnalyzeFile()

agent_nomos_once::AnalyzeFile	(		$FilePath,
			$getHighlightInfo = false
	)

Analyze one uploaded file.

Parameters

string

$FilePath

the filepath to the file to analyze.

Returns

mixed If $getHighlightInfo is true, returns an array with display html, keyword highlights, and license highlights. If false, returns only display html

Definition at line 49 of file agent-nomos-once.php.

Install()

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

These next variables define required functionality. If the functions exist, then they are called. However, plugins are not required to define any of these.

Note

It may be called multiple times. It must check that changes are needed BEFORE doing any changes. Also, it must check for partial installs in case the user is recovering from an installation failure.

See also

FO_Plugin::Install()

Reimplemented from FO_Plugin.

Definition at line 75 of file agent-nomos-once.php.

Output()

agent_nomos_once::Output

(

)

Generate the text for this plugin.

See also

FO_Plugin::Output()

Reimplemented from FO_Plugin.

Definition at line 159 of file agent-nomos-once.php.

RegisterMenus()

agent_nomos_once::RegisterMenus

(

)

Change the type of output based on user-supplied parameters.

Returns

1 on success.

See also

FO_Plugin::RegisterMenus()

Reimplemented from FO_Plugin.

Definition at line 92 of file agent-nomos-once.php.

---

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

• src/nomos/ui/agent-nomos-once.php