Base class for histogram plugins. More...

Inheritance diagram for HistogramBase:

Collaboration diagram for HistogramBase:

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

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

	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.

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

Static Public Member Functions
static	returnSortOrder ()
	Get sorting orders. More...

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

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

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

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

Protected Attributes
	$agentName

	$viewName

Protected Attributes inherited from FO_Plugin
	$microMenu

	$renderer

	$vars = array()

Private Attributes
	$uploadtree_tablename

	$uploadDao

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

Detailed Description

Base class for histogram plugins.

@abstract

Definition at line 17 of file HistogramBase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in KeywordHistogram, IpraHistogram, EmailHistogram, EccHistogram, and CopyrightHistogram.

Definition at line 36 of file HistogramBase.php.

Member Function Documentation

◆ createScriptBlock()

HistogramBase::createScriptBlock ( )

abstractprotected

Create JavaScript block for histogram.

Returns: string JavaScript block

Reimplemented in KeywordHistogram, IpraHistogram, EmailHistogram, EccHistogram, and CopyrightHistogram.

◆ fillTables()

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

abstractprotected

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

Reimplemented in KeywordHistogram, IpraHistogram, EmailHistogram, EccHistogram, and CopyrightHistogram.

◆ getFileListing()

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

protected

Parameters

int	$Uploadtree_pk	Uploadtree id
string	$Uri	URI
string	$uploadtree_tablename	Uploadtree table name
string	$Agent_pk	Agent id
int	$upload_pk	Upload id

Returns: array

Definition at line 312 of file HistogramBase.php.

◆ getTableForSingleType()

HistogramBase::getTableForSingleType	(	$type,
		$description,
		$uploadId,
		$uploadTreeId,
		$filter,
		$agentId
	)

Parameters

string	$type	Type to be fetched
string	$description	Description of the content
int	$uploadId	Upload id to process
int	$uploadTreeId	Uploadtree id of the item
string	$filter	Filter for query
string	$agentId	Id of the agent populated the result

Returns: array

Todo:: Template this! For now I just template the js

Definition at line 60 of file HistogramBase.php.

◆ getTemplateName()

HistogramBase::getTemplateName ( )

See also: FO_Plugin::getTemplateName()

Reimplemented from FO_Plugin.

Definition at line 406 of file HistogramBase.php.

◆ isADirectory()

HistogramBase::isADirectory ( $Uploadtree_pk )

protected

Check if passed element is a directory.

Parameters

int $Uploadtree_pk Uploadtree id of the element

Returns: boolean True if it is a directory, false otherwise

Definition at line 382 of file HistogramBase.php.

◆ Output()

HistogramBase::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.)

See also: FO_Plugin::Output()

Reimplemented from FO_Plugin.

Definition at line 203 of file HistogramBase.php.

◆ OutputOpen()

HistogramBase::OutputOpen ( )

This function is called when user output is requested. This function is responsible for assigning headers.

See also: FO_Plugin::OutputOpen()

Reimplemented from FO_Plugin.

Definition at line 191 of file HistogramBase.php.

◆ returnSortOrder()

static HistogramBase::returnSortOrder ( )

static

Get sorting orders.

Returns: string[][]

Definition at line 393 of file HistogramBase.php.

◆ ShowUploadHist()

HistogramBase::ShowUploadHist	(	$upload_pk,
		$Uploadtree_pk,
		$Uri,
		$filter,
		$uploadtree_tablename,
		$Agent_pk
	)

protected

Given an $Uploadtree_pk, display:
(1) The histogram for the directory BY LICENSE.
(2) The file listing for the directory.

Parameters

int	$Uploadtree_pk	Upload id
string	$Uri	URI
string	$filter	Filter for query
string	$uploadtree_tablename	Uploadtree table to use
array	$Agent_pk	Agent id

Returns: array|void

Definition at line 159 of file HistogramBase.php.

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

src/copyright/ui/HistogramBase.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createScriptBlock()

◆ fillTables()

◆ getFileListing()

◆ getTableForSingleType()

◆ getTemplateName()

◆ isADirectory()

◆ Output()

◆ OutputOpen()

◆ returnSortOrder()

◆ ShowUploadHist()