Create histogram plugin for copyright. More...

Inheritance diagram for CopyrightHistogram:

Collaboration diagram for CopyrightHistogram:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this 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...

Public Member Functions inherited from HistogramBase
	getTableForSingleType ($type, $description, $uploadId, $uploadTreeId, $filter, $agentId)

	OutputOpen ()
	This function is called when user output is requested. This function is responsible for assigning headers. More...

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

	getTemplateName ()

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

	renderString ($templateName, $vars=null)

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

	getRequest ()

	execute ()

	preInstall ()

	postInstall ()

	unInstall ()

	getName ()

	__toString ()

Protected Member Functions
	getTableContent ($upload_pk, $uploadtreeId, $filter, $agentId)
	Get contents for copyright table. More...

	fillTables ($upload_pk, $Uploadtree_pk, $filter, $agentId, $VF)
	Get copyright statements and fill the main content table. More...

	createScriptBlock ()
	Create JavaScript block for histogram. More...

Protected Member Functions inherited from HistogramBase
	ShowUploadHist ($upload_pk, $Uploadtree_pk, $Uri, $filter, $uploadtree_tablename, $Agent_pk)
	Given an $Uploadtree_pk, display: (1) The histogram for the directory BY LICENSE. (2) The file listing for the directory. More...

	getFileListing ($Uploadtree_pk, $Uri, $uploadtree_tablename, $Agent_pk, $upload_pk)

	isADirectory ($Uploadtree_pk)
	Check if passed element is a directory. More...

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

Additional Inherited Members
Static Public Member Functions inherited from HistogramBase
static	returnSortOrder ()
	Get sorting orders. More...

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 Attributes inherited from HistogramBase
	$agentName

	$viewName

Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Detailed Description

Create histogram plugin for copyright.

Definition at line 17 of file copyright-hist.php.

Constructor & Destructor Documentation

◆ __construct()

CopyrightHistogram::__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 HistogramBase.

Definition at line 19 of file copyright-hist.php.

Member Function Documentation

◆ createScriptBlock()

CopyrightHistogram::createScriptBlock ( )

protected

Create JavaScript block for histogram.

Returns: string JavaScript block

See also: HistogramBase::createScriptBlock()

Reimplemented from HistogramBase.

Definition at line 105 of file copyright-hist.php.

◆ fillTables()

CopyrightHistogram::fillTables	(	$upload_pk,
		$Uploadtree_pk,
		$filter,
		$agentId,
		$VF
	)

protected

Get copyright statements and fill the main content table.

Parameters

int	$upload_pk	Upload id for fetch request
int	$Uploadtree_pk	Upload tree id of the item
string	$filter	Filter to apply for query
string	$agentId	Agent id which populate the result
array	$VF

Returns: array Output, table variables

See also: HistogramBase::fillTables()

Reimplemented from HistogramBase.

Definition at line 65 of file copyright-hist.php.

◆ getTableContent()

CopyrightHistogram::getTableContent	(	$upload_pk,
		$uploadtreeId,
		$filter,
		$agentId
	)

protected

Get contents for copyright table.

Parameters

int	$upload_pk	Upload id for fetch request
int	$uploadtreeId	Upload tree id of the item
string	$filter	Filter to apply for query
string	$agentId	Agent id which populate the result

Returns: array Copyright contents, upload tree items in result

Definition at line 36 of file copyright-hist.php.

◆ RegisterMenus()

CopyrightHistogram::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 84 of file copyright-hist.php.

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

src/copyright/ui/copyright-hist.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createScriptBlock()

◆ fillTables()

◆ getTableContent()

◆ RegisterMenus()