ui_demomod Class Reference

browse an upload and display the demomod data (first bytes of the file) More...

Inheritance diagram for ui_demomod:

Collaboration diagram for ui_demomod:

Public Member Functions
	Install ()
	Only used during installation. More...
	RegisterMenus ()
	Customize submenus.
	Initialize ()
	This is called before the plugin is used. More...
	ShowData ($upload_pk, $uploadtree_pk)
	Display the demomod data. More...
	Output ()
	This function returns the scheduler status.
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 = "demomod"
	Mod name.
	$Title = TITLE_UI_DEMOMOD
	Page title.
	$Dependency = array("browse")
	Dependecy for plugin.
	$DBaccess = PLUGIN_DB_READ
	DB access required.
	$uploadtree_tablename
	Upload tree table to use.
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

browse an upload and display the demomod data (first bytes of the file)

Definition at line 32 of file demomod.php.

Member Function Documentation

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

Definition at line 86 of file demomod.php.

ui_demomod::Install

(

)

Only used during installation.

Returns

0 on success, non-zero on failure.

Definition at line 44 of file demomod.php.

ui_demomod::ShowData	(		$upload_pk,
			$uploadtree_pk
	)

Display the demomod data.

Parameters

$upload_pk
$uploadtree_pk

Definition at line 101 of file demomod.php.

---

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

• src/demomod/ui/demomod.php