ui_buckets Class Reference

Inheritance diagram for ui_buckets:

Collaboration diagram for ui_buckets:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	Install ()
	Create and configure database tables. More...
	RegisterMenus ()
	Customize submenus.
	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). More...
	ShowUploadHist ($Uploadtree_pk, $Uri)
	TagBucket ($upload_pk, $uploadtree_pk, $bucketagent_pk, $bucket_pk, $bucketpool_pk, $nomosagent_pk)
	Tag a bucket. More...
Public Member Functions inherited from FO_Plugin
	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.
	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.
	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
	$uploadtree_tablename = ""
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

Install buckets plugin to UI menu

Definition at line 17 of file ui-buckets.php.

Constructor & Destructor Documentation

__construct()

ui_buckets::__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 21 of file ui-buckets.php.

Member Function Documentation

Initialize()

ui_buckets::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

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

Reimplemented from FO_Plugin.

Definition at line 133 of file ui-buckets.php.

Install()

ui_buckets::Install

(

)

Create and configure database tables.

See also

FO_Plugin::Install()

If there are no bucket pools defined, then create a simple demo. Note: that the bucketpool and two simple bucket definitions are created but no user default bucket pools are set. We don't want to automatically set this to be the default bucket pool because this may not be appropiate for the installation. The user or system administrator will have to set the default bucket pool in their account settings.

Reimplemented from FO_Plugin.

Definition at line 35 of file ui-buckets.php.

ShowUploadHist()

ui_buckets::ShowUploadHist	(		$Uploadtree_pk,
			$Uri
	)

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

Parameters

int	$Uploadtree_pk
string	$Uri

Returns

string

Definition at line 159 of file ui-buckets.php.

TagBucket()

ui_buckets::TagBucket	(		$upload_pk,
			$uploadtree_pk,
			$bucketagent_pk,
			$bucket_pk,
			$bucketpool_pk,
			$nomosagent_pk
	)

Tag a bucket.

Parameters

int	$upload_pk
int	$uploadtree_pk
int	$bucketagent_pk
int	$bucket_pk
int	$bucketpool_pk
int	$nomosagent_pk

Definition at line 501 of file ui-buckets.php.

Member Data Documentation

$uploadtree_tablename

ui_buckets::$uploadtree_tablename = ""

Upload tree on which the upload is listed

Definition at line 19 of file ui-buckets.php.

---

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

• src/buckets/ui/ui-buckets.php