Compare License Browser, list license histogram. More...

Inheritance diagram for ui_nomos_diff:

Collaboration diagram for ui_nomos_diff:

Public Member Functions
	Install ()
	Create and configure database tables. More...

	RegisterMenus ()
	Customize submenus. More...

	Initialize ()
	This is called before the plugin is used. More...

	GetTreeInfo ($Uploadtree_pk)
	get an array with uploadtree record and agent_pk More...

	UploadHist ($Uploadtree_pk, $TreeInfo)
	get history info for the directory BY LICENSE. More...

	ChildElt ($Child, $agent_pk, $OtherChild)
	get the entire `<td> ... </td>` for $Child file listing table More...

	ItemComparisonRows ($Master, $agent_pk1, $agent_pk2)
	get a string with the html table rows comparing the two file lists. More...

	AddLicStr ($TreeInfo, &$Children)
	Add license array to Children array. More...

	filter_samehash (&$Master)
	removes identical files More...

	filter_samelic (&$Master)
	removes files that have the same name and license list.

	filter_samelicfuzzy (&$Master)
	removes files that have the same fuzzyname, and same license list.

	filter_nolics (&$Master)
	removes pairs of "No_license_found" More...

	FilterChildren ($filter, &$Master)
	filter children through same license, same hash, no license, same fuzzy license More...

	HTMLout ($Master, $uploadtree_pk1, $uploadtree_pk2, $in_uploadtree_pk1, $in_uploadtree_pk2, $filter, $TreeInfo1, $TreeInfo2)
	HTML output, returns HTML as string.

	Output ()
	generate output information More...

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.

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

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

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

	execute ()

	preInstall ()

	postInstall ()

	unInstall ()

	getName ()

	__toString ()

Public Attributes
	$Name = "nomosdiff"

	$Title = TITLE_UI_NOMOS_DIFF

	$Version = "1.0"

	$Dependency

	$DBaccess = PLUGIN_DB_READ

	$LoginFlag = 0

	$ColumnSeparatorStyleL = "style='border:solid 0 #006600; border-left-width:2px;padding-left:1em'"

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

Compare License Browser, list license histogram.

Definition at line 31 of file nomos-diff.php.

Member Function Documentation

ui_nomos_diff::AddLicStr	(		$TreeInfo,
		&	$Children
	)

Add license array to Children array.

do not get duplicated licenses

Definition at line 338 of file nomos-diff.php.

ui_nomos_diff::ChildElt	(	$Child,
		$agent_pk,
		$OtherChild
	)

get the entire <td> ... </td> for $Child file listing table

License differences are highlighted.

Returns: string The entire <td> ... </td>

Definition at line 245 of file nomos-diff.php.

ui_nomos_diff::filter_nolics ( & $Master )

removes pairs of "No_license_found"

Or pairs that only have one file and "No_license_found"

Uses fuzzyname.

Definition at line 429 of file nomos-diff.php.

ui_nomos_diff::filter_samehash ( & $Master )

removes identical files

If a child pair are identical remove the master record

Definition at line 358 of file nomos-diff.php.

ui_nomos_diff::FilterChildren	(		$filter,
		&	$Master
	)

filter children through same license, same hash, no license, same fuzzy license

Parameters

$filter none, samelic, samehash An empty or unknown filter is the same as "none"

Definition at line 466 of file nomos-diff.php.

ui_nomos_diff::GetTreeInfo ( $Uploadtree_pk )

get an array with uploadtree record and agent_pk

Parameters

integer $Uploadtree_pk Upload tree id to be retrieved

Returns: array Array with uploadtree record and agent_pk

Definition at line 145 of file nomos-diff.php.

ui_nomos_diff::Initialize ( )

This is called before the plugin is used.

It should assume that Install() was already run one time (possibly years ago and not during this object's creation).

Returns: true on success, false on failure. A failed initialize is not used by the system.

Note: This function must NOT assume that other plugins are installed.

See also: FO_Plugin::Initialize()

Definition at line 122 of file nomos-diff.php.

ui_nomos_diff::Install ( )

Create and configure database tables.

See also: FO_Plugin::Install()

Definition at line 84 of file nomos-diff.php.

ui_nomos_diff::ItemComparisonRows	(	$Master,
		$agent_pk1,
		$agent_pk2
	)

get a string with the html table rows comparing the two file lists.

Each row contains 5 table fields. The third field is just for a column separator. If files match their fuzzyname then put on the same row. Highlight license differences. Unmatched fuzzynames go on a row of their own.

Definition at line 300 of file nomos-diff.php.

ui_nomos_diff::Output ( )

generate output information

filter: optional filter to apply
item1: uploadtree_pk of the column 1 tree
item2: uploadtree_pk of the column 2 tree
freeze: column number (1 or 2) to freeze

Definition at line 659 of file nomos-diff.php.

ui_nomos_diff::RegisterMenus ( )

Customize submenus.

See also: FO_Plugin::RegisterMenus()

Definition at line 100 of file nomos-diff.php.

ui_nomos_diff::UploadHist	(	$Uploadtree_pk,
		$TreeInfo
	)

get history info for the directory BY LICENSE.

Parameters

$Uploadtree_pk	Uploadtree_pk
$TreeInfo	Tree info generated by GetTreeInfo()

Returns: string A string with the histogram for the directory BY LICENSE.

Definition at line 163 of file nomos-diff.php.

Member Data Documentation

string ui_nomos_diff::$ColumnSeparatorStyleL = "style='border:solid 0 #006600; border-left-width:2px;padding-left:1em'"

CSS style for columns

Definition at line 78 of file nomos-diff.php.

string ui_nomos_diff::$DBaccess = PLUGIN_DB_READ

DB access required

Definition at line 66 of file nomos-diff.php.

array ui_nomos_diff::$Dependency

Initial value:

= array(
    "browse",
    "view"
  )

Plugin dependencies

Definition at line 57 of file nomos-diff.php.

integer ui_nomos_diff::$LoginFlag = 0

User need not to be logged-in

Definition at line 72 of file nomos-diff.php.

string ui_nomos_diff::$Name = "nomosdiff"

Name of the UI mod

Definition at line 38 of file nomos-diff.php.

string ui_nomos_diff::$Title = TITLE_UI_NOMOS_DIFF

HTML title

Definition at line 44 of file nomos-diff.php.

string ui_nomos_diff::$Version = "1.0"

Version of the plugin

Definition at line 50 of file nomos-diff.php.

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

src/nomos/ui/nomos-diff.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation