copyright_list Class Reference

Inheritance diagram for copyright_list:

Collaboration diagram for copyright_list:

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...
	GetRows ($Uploadtree_pk, $Agent_pk, &$upload_pk, $hash, $type, $tableName, $filter="")
	Get statement rows for a specified set. More...
	GetRequestedRows ($rows, $excl, &$NumRows, $filter, $hash)
	Remove unwanted rows by hash and type and exclusions and filter. More...
	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 ()

Private Member Functions
	getTableName ($type)
	Get the table name, mod, and view based on type. More...

Private Attributes
	$dbManager
	$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
Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)
Protected Attributes inherited from FO_Plugin
	$microMenu
	$renderer
	$vars = array()

Detailed Description

Definition at line 22 of file list.php.

Constructor & Destructor Documentation

__construct()

copyright_list::__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 34 of file list.php.

Member Function Documentation

GetRequestedRows()

copyright_list::GetRequestedRows	(		$rows,
			$excl,
		&	$NumRows,
			$filter,
			$hash
	)

Remove unwanted rows by hash and type and exclusions and filter.

Parameters

array	$rows
string	$excl
int	$NumRows	the number of instances.
string	$filter
string	$hash

Returns

array new array and $NumRows

Definition at line 156 of file list.php.

GetRows()

copyright_list::GetRows	(		$Uploadtree_pk,
			$Agent_pk,
		&	$upload_pk,
			$hash,
			$type,
			$tableName,
			$filter = ""
	)

Get statement rows for a specified set.

Parameters

int	$Uploadtree_pk	Uploadtree id
string	$Agent_pk	Agent id
int	$upload_pk	Upload id
string	$hash	Content hash
string	$type	Content type
string	$tableName	Content table name (copyright|ecc|author)
string	$filter	Filter activated/deactivated statements

Exceptions

Exception

Returns

array Rows to process, and $upload_pk

Definition at line 87 of file list.php.

getTableName()

copyright_list::getTableName (   $type )

private

Get the table name, mod, and view based on type.

Parameters

string

$type

Type of content

Returns

string[] Table name, mod, and view

Definition at line 435 of file list.php.

getTemplateName()

copyright_list::getTemplateName

(

)

See also

FO_Plugin::getTemplateName()

Reimplemented from FO_Plugin.

Definition at line 425 of file list.php.

Output()

copyright_list::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 260 of file list.php.

OutputOpen()

copyright_list::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 246 of file list.php.

RegisterMenus()

copyright_list::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 54 of file list.php.

---

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

• src/copyright/ui/list.php