Inheritance diagram for AjaxClearingView:

Collaboration diagram for AjaxClearingView:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...

	doClearings ($orderAscending, $groupId, $uploadId, $uploadTreeId)

	Output ()

	getCurrentSelectedLicensesTableData (ItemTreeBounds $itemTreeBounds, $groupId, $orderAscending)

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

	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
const	OPTION_SKIP_FILE = "option_skipFile"

const	OPTION_SKIP_FILE_COPYRIGHT = "option_skipFileCopyRight"

const	OPTION_SKIP_FILE_IPRA = "option_skipFileIpra"

const	OPTION_SKIP_FILE_ECC = "option_skipFileEcc"

const	OPTION_SKIP_FILE_KEYWORD = "option_skipFileKeyword"

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
	doClearingHistory ($groupId, $uploadId, $uploadTreeId)

	doLicenses ($orderAscending, $groupId, $uploadId, $uploadTreeId)

	getBuildClearingsForSingleFile ($uploadTreeId, $licenseId, $forValue, $what, $detectorType=0)

	getAgentInfo ($licenseDecisionResult, $uberUri, $uploadTreeId)

	sortByKeys ($arrayToBeSortedByKeys, $orderAscending)

	doNextPrev ($action, $uploadId, $uploadTreeId, $groupId)

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

Private Member Functions
	createPlainResponse ($output)

	getEventInfo ($licenseDecisionEvent, $uberUri, $uploadTreeId, $licenseEventTypes)

Private Attributes
	$uploadDao

	$licenseDao

	$clearingDao

	$agentsDao

	$logger

	$highlightDao

	$highlightProcessor

	$clearingDecisionEventProcessor

	$urlBuilder

	$decisionTypes

Additional Inherited Members
Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Detailed Description

Definition at line 28 of file ajax-clearing-view.php.

Constructor & Destructor Documentation

◆ __construct()

AjaxClearingView::__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 57 of file ajax-clearing-view.php.

Member Function Documentation

◆ createPlainResponse()

AjaxClearingView::createPlainResponse ( $output )

private

Parameters

$output

Returns: Response

Definition at line 474 of file ajax-clearing-view.php.

◆ doClearingHistory()

AjaxClearingView::doClearingHistory	(	$groupId,
		$uploadId,
		$uploadTreeId
	)

protected

Parameters

int	$groupId
int	$uploadId
int	$uploadTreeId

Returns: string

Definition at line 89 of file ajax-clearing-view.php.

◆ doClearings()

AjaxClearingView::doClearings	(	$orderAscending,
		$groupId,
		$uploadId,
		$uploadTreeId
	)

Parameters

$orderAscending
$groupId
$uploadId
$uploadTreeId

Returns: string

Definition at line 161 of file ajax-clearing-view.php.

◆ doLicenses()

AjaxClearingView::doLicenses	(	$orderAscending,
		$groupId,
		$uploadId,
		$uploadTreeId
	)

protected

Parameters

boolean	$orderAscending
int	$groupId
int	$uploadId
int	$uploadTreeId

Returns: string

Definition at line 128 of file ajax-clearing-view.php.

◆ doNextPrev()

AjaxClearingView::doNextPrev	(	$action,
		$uploadId,
		$uploadTreeId,
		$groupId
	)

protected

Parameters

string	$action
int	$uploadId
int	$uploadTreeId
int	$groupId

Returns: string

Definition at line 430 of file ajax-clearing-view.php.

◆ getAgentInfo()

AjaxClearingView::getAgentInfo	(	$licenseDecisionResult,
		$uberUri,
		$uploadTreeId
	)

protected

Parameters

ClearingResult	$licenseDecisionResult
string	$uberUri
int	$uploadTreeId

Returns: array

Definition at line 370 of file ajax-clearing-view.php.

◆ getBuildClearingsForSingleFile()

AjaxClearingView::getBuildClearingsForSingleFile	(	$uploadTreeId,
		$licenseId,
		$forValue,
		$what,
		$detectorType = `0`
	)

protected

Parameters

id $uploadtreeid,$licenseid

Returns: string with attr

Definition at line 260 of file ajax-clearing-view.php.

◆ getCurrentSelectedLicensesTableData()

AjaxClearingView::getCurrentSelectedLicensesTableData	(	ItemTreeBounds	$itemTreeBounds,
			$groupId,
			$orderAscending
	)

Parameters

ItemTreeBounds	$itemTreeBounds
int	$groupId
boolean	$orderAscending

Returns: array

Definition at line 280 of file ajax-clearing-view.php.

◆ Output()

AjaxClearingView::Output ( )

Returns: Response

Reimplemented from FO_Plugin.

Definition at line 178 of file ajax-clearing-view.php.

◆ sortByKeys()

AjaxClearingView::sortByKeys	(	$arrayToBeSortedByKeys,
		$orderAscending
	)

protected

Parameters

$arrayToBeSortedByKeys
$orderAscending

Returns: array

Definition at line 413 of file ajax-clearing-view.php.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createPlainResponse()

◆ doClearingHistory()

◆ doClearings()

◆ doLicenses()

◆ doNextPrev()

◆ getAgentInfo()

◆ getBuildClearingsForSingleFile()

◆ getCurrentSelectedLicensesTableData()

◆ Output()

◆ sortByKeys()