Help Class Reference

Inheritance diagram for Help:

[legend]

Collaboration diagram for Help:

[legend]

List of all members.

Public Member Functions
	render ()
	getHelpText ()
Protected Member Functions
	_getHelpPageContents ($sHelpPage, $sLang)
Protected Attributes
	$_sThisTemplate = 'help.tpl'
	$_sHelpText = null
	$_sDefaultPage = 'default'
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

---

Detailed Description

Shop help window. Arranges shop help information window, with help texts. (Help text may be changed in file (shop directory) -> help -> default.inc.tpl ). OXID eShop -> HELP.

Definition at line 9 of file help.php.

---

Member Function Documentation

Help._getHelpPageContents	(	$	sHelpPage,
		$	sLang
	)			[protected]

Reads and returns help file contents

Parameters:

	string	$sHelpPage help page name
	string	$sLang help language

Returns:

string | false

Definition at line 62 of file help.php.

Help.getHelpText

(

)

Template variable getter. Returns help text

Returns:

string

Definition at line 88 of file help.php.

Help.render

(

)

Loads help text, executes parent.render() and returns name of template file to render help._sThisTemplate.

Template variables: helptext

Returns:

string $this->_sThisTemplate current template file name

Reimplemented from oxUBase.

Definition at line 45 of file help.php.

---

Member Data Documentation

Help.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 34 of file help.php.

Help.$_sDefaultPage = 'default' [protected]

Definition at line 27 of file help.php.

Help.$_sHelpText = null [protected]

Definition at line 21 of file help.php.

Help.$_sThisTemplate = 'help.tpl' [protected]

Reimplemented from oxView.

Definition at line 15 of file help.php.

---

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

• views/help.php