ClearingView Class Reference

Inheritance diagram for ClearingView:

Collaboration diagram for ClearingView:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	getSelectedHighlighting (ItemTreeBounds $itemTreeBounds, $licenseId, $selectedAgentId, $highlightId, $clearingId, $uploadId)
	execute ()
	OutputOpen ()
	This function is called when user output is requested. This function is responsible for assigning headers.
	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...
	updateLastItem ($userId, $groupId, $lastItem, $currentUploadtreeId)
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...
	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 ()
	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 ()
	preInstall ()
	postInstall ()
	unInstall ()
	getName ()
	__toString ()

Private Attributes
	$uploadDao
	$licenseDao
	$clearingDao
	$agentsDao
	$logger
	$highlightDao
	$highlightProcessor
	$highlightRenderer
	$clearingDecisionEventProcessor
	$clearingDecisionFilter
	$invalidParm = false
	$decisionTypes

Additional Inherited Members
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 inherited from FO_Plugin
	render ($templateName, $vars=null)
Protected Attributes inherited from FO_Plugin
	$microMenu
	$renderer
	$vars = array()

Detailed Description

Definition at line 36 of file ui-clearing-view.php.

Constructor & Destructor Documentation

__construct()

ClearingView::__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 63 of file ui-clearing-view.php.

Member Function Documentation

getSelectedHighlighting()

ClearingView::getSelectedHighlighting	(	ItemTreeBounds	$itemTreeBounds,
			$licenseId,
			$selectedAgentId,
			$highlightId,
			$clearingId,
			$uploadId
	)

Parameters

ItemTreeBounds	$itemTreeBounds
	$licenseId
	$selectedAgentId
	$highlightId
int	$clearingId
int	$uploadId

Returns

Highlight[]

Definition at line 101 of file ui-clearing-view.php.

RegisterMenus()

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

Reimplemented from FO_Plugin.

Definition at line 327 of file ui-clearing-view.php.

updateLastItem()

ClearingView::updateLastItem	(		$userId,
			$groupId,
			$lastItem,
			$currentUploadtreeId
	)

Parameters

int	$userId
int	$groupId
int	$lastItem
int	$currentUploadtreeId

Returns

array

Definition at line 348 of file ui-clearing-view.php.

---

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

• src/www/ui/ui-clearing-view.php