ui_view Class Reference

Inheritance diagram for ui_view:

Collaboration diagram for ui_view:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	RegisterMenus ()
	Customize submenus.
	GetFileJumpMenu ($Fin, $CurrPage, $PageSize, $Uri)
	Given a file handle and current page, generate the "Next" and "Prev" menu options. Returns String.
	ShowText ($inputFile, $startOffset, $Flowed, $outputLength=-1, $splitPositions=null, $insertBacklink=false)
	Given a file handle, display "strings" of the file. Output goes to stdout!
	getText ($inputFile, $startOffset, $Flowed, $outputLength=-1, $splitPositions=null, $insertBacklink=false, $fromRest=false)
	Given a file handle, display "strings" of the file.
	ShowHex ($inputFile, $startOffset=0, $outputLength=-1, $splitPositions=array())
	Given a file handle, display a "hex dump" of the file. Output goes to stdout!
	getHex ($inputFile, $startOffset=0, $outputLength=-1, $splitPositions=array())
	Given a file handle, display a "hex dump" of the file. Output goes to stdout!
	ShowView ($inputFile=null, $BackMod="browse", $ShowMenu=1, $ShowHeader=1, $ShowText=null, $ViewOnly=false, $DispView=true, $highlightEntries=array(), $insertBacklink=false)
	Generate the view contents in HTML and sends it to stdout. More...
	getView ($inputFile=null, $BackMod="browse", $ShowHeader=1, $ShowText=null, $highlightEntries=array(), $insertBacklink=false, $getPageMenuInline=false)
	Generate the view contents in HTML. 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.)
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.
	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 ()
	getTemplateName ()
	renderString ($templateName, $vars=null)
	renderScripts ($scripts)
	Render JavaScript in the template's footer. More...
	getRequest ()
	execute ()
	preInstall ()
	postInstall ()
	unInstall ()
	getName ()
	__toString ()

Public Attributes
const	NAME = "view"
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
	outputWhenFileNotInRepo ($uploadpk, $item)
Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)

Protected Attributes
	$blockSizeHex = 8192
	$blockSizeText = 81920
Protected Attributes inherited from FO_Plugin
	$microMenu
	$renderer
	$vars = array()

Private Member Functions
	checkAndPrepare ($inputFile, $startOffset, $outputLength)

Private Attributes
	$logger
	$textRenderer
	$highlightProcessor
	$uploadDao

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ui_view::__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 33 of file ui-view.php.

Member Function Documentation

getView()

ui_view::getView	(		$inputFile = null,
			$BackMod = "browse",
			$ShowHeader = 1,
			$ShowText = null,
			$highlightEntries = array(),
			$insertBacklink = false,
			$getPageMenuInline = false
	)

Generate the view contents in HTML.

Parameters

resource	$inputFile
string	$BackMod
int	$ShowHeader
	$ShowText
Highlight[]	$highlightEntries
bool	$insertBacklink
bool	$getPageMenuInline

Note

This function is intended to be called from other plugins.

Returns

array|string|string[]

Definition at line 288 of file ui-view.php.

ShowView()

ui_view::ShowView	(		$inputFile = null,
			$BackMod = "browse",
			$ShowMenu = 1,
			$ShowHeader = 1,
			$ShowText = null,
			$ViewOnly = false,
			$DispView = true,
			$highlightEntries = array(),
			$insertBacklink = false
	)

Generate the view contents in HTML and sends it to stdout.

Parameters

resource	$inputFile
string	$BackMod
int	$ShowMenu
int	$ShowHeader
null	$ShowText
bool	$ViewOnly
bool	$DispView
Highlight[]	$highlightEntries
bool	$insertBacklink

Note

This function is intended to be called from other plugins.

Definition at line 266 of file ui-view.php.

---

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

• src/www/ui/ui-view.php