TYPO3backend Class Reference

List of all members.

Public Member Functions
	__construct ()
	render ()
	addJavascript ($javascript)
	addJavascriptFile ($javascriptFile)
	addCss ($css)
	addCssFile ($cssFileName, $cssFile)
	addToolbarItem ($toolbarItemName, $toolbarItemClassName)
Protected Member Functions
	initializeCoreToolbarItems ()
	loadResourcesForRegisteredNavigationComponents ()
	renderToolbar ()
	getLoggedInUserLabel ()
	getLocalLangFileName ()
	generateLocalLang ()
	generateJavascript ()
	handlePageEditing ()
	setStartupModule ()
	executeHook ($identifier, array $hookConfiguration=array())
Protected Attributes
	$content
	$css
	$cssFiles
	$js
	$jsFiles
	$jsFilesAfterInline
	$toolbarItems
	$menuWidth
	$debug
	$moduleLoader
	$moduleMenu
	$pageRenderer
Private Attributes
	$menuWidthDefault = 190

---

Detailed Description

Definition at line 50 of file backend.php.

---

Constructor & Destructor Documentation

TYPO3backend::__construct

(

)

constructor

Returns:

void

Definition at line 89 of file backend.php.

References $GLOBALS, debug(), executeHook(), getLocalLangFileName(), initializeCoreToolbarItems(), and t3lib_div\makeInstance().

---

Member Function Documentation

TYPO3backend::addCss

(

$

css

)

adds a css snippet to the backend

Parameters:

string

css snippet

Returns:

void

Definition at line 758 of file backend.php.

TYPO3backend::addCssFile	(	$	cssFileName,
		$	cssFile
	)

adds a css file to the backend after it has been checked that it exists

Parameters:

string	the css file's name with out the .css ending
string	css file reference

Returns:

boolean true if the css file was added, false otherwise

Definition at line 773 of file backend.php.

TYPO3backend::addJavascript

(

$

javascript

)

adds a javascript snippet to the backend

Parameters:

string

javascript snippet

Returns:

void

Definition at line 725 of file backend.php.

TYPO3backend::addJavascriptFile

(

$

javascriptFile

)

adds a javscript file to the backend after it has been checked that it exists

Parameters:

string

javascript file reference

Returns:

boolean true if the javascript file was successfully added, false otherwise

Definition at line 740 of file backend.php.

TYPO3backend::addToolbarItem	(	$	toolbarItemName,
		$	toolbarItemClassName
	)

adds an item to the toolbar, the class file for the toolbar item must be loaded at this point

Parameters:

string	toolbar item name, f.e. tx_toolbarExtension_coolItem
string	toolbar item class name, f.e. tx_toolbarExtension_coolItem

Returns:

void

Definition at line 791 of file backend.php.

TYPO3backend::executeHook	(	$	identifier,
		array $	hookConfiguration = array()
	)		[protected]

Executes defined hooks functions for the given identifier.

These hook identifiers are valid: + constructPostProcess + renderPreProcess + renderPostProcess

Parameters:

string	$identifier	Specific hook identifier
array	$hookConfiguration	Additional configuration passed to hook functions

Returns:

void

Definition at line 817 of file backend.php.

References $GLOBALS, and t3lib_div\callUserFunction().

Referenced by __construct(), and render().

TYPO3backend::generateJavascript

(

)

[protected]

Generates the JavaScript code for the backend.

Returns:

void

Definition at line 522 of file backend.php.

References $GLOBALS, t3lib_div\dirname(), t3lib_extMgm\extRelPath(), t3lib_div\getIndpEnv(), handlePageEditing(), t3lib_extMgm\isLoaded(), t3lib_BEfunc\isModuleSetInTBE_MODULES(), setStartupModule(), and t3lib_div\shortMD5().

Referenced by render().

TYPO3backend::generateLocalLang

(

)

[protected]

Reads labels required in JavaScript code from the localization system and returns them as JSON array in TYPO3.LLL.

Returns:

string JavaScript code containing the LLL labels in TYPO3.LLL

Definition at line 418 of file backend.php.

References $GLOBALS.

Referenced by getLocalLangFileName().

TYPO3backend::getLocalLangFileName

(

)

[protected]

Returns the file name to the LLL JavaScript, containing the localized labels, which can be used in JavaScript code.

Returns:

string File name of the JS file, relative to TYPO3_mainDir

Definition at line 400 of file backend.php.

References generateLocalLang(), and t3lib_div\writeFileToTypo3tempDir().

Referenced by __construct().

TYPO3backend::getLoggedInUserLabel

(

)

[protected]

Gets the label of the BE user currently logged in

Returns:

string html code snippet displaying the currently logged in user

Definition at line 366 of file backend.php.

References $BACK_PATH, $BE_USER, $GLOBALS, t3lib_iconWorks\getSpriteIcon(), and t3lib_extMgm\isLoaded().

TYPO3backend::handlePageEditing

(

)

[protected]

Checking if the "&edit" variable was sent so we can open it for editing the page. Code based on code from "alt_shortcut.php"

Returns:

void

Definition at line 624 of file backend.php.

References $GLOBALS, t3lib_div\_GET(), t3lib_div\deprecationLog(), t3lib_BEfunc\getRecordsByField(), t3lib_BEfunc\getRecordWSOL(), t3lib_extMgm\isLoaded(), t3lib_BEfunc\openPageTree(), t3lib_div\testInt(), and t3lib_BEfunc\workspaceOL().

Referenced by generateJavascript().

TYPO3backend::initializeCoreToolbarItems

(

)

[protected]

initializes the core toolbar items

Returns:

void

Definition at line 163 of file backend.php.

References t3lib_div\makeInstance().

Referenced by __construct().

TYPO3backend::loadResourcesForRegisteredNavigationComponents

(

)

[protected]

Loads the css and javascript files of all registered navigation widgets

Returns:

void

Definition at line 284 of file backend.php.

References $cssFiles, $GLOBALS, $jsFiles, $module, t3lib_extMgm\extPath(), t3lib_extMgm\extRelPath(), t3lib_div\getFilesInDir(), t3lib_div\getURL(), and t3lib_div\trimExplode().

Referenced by render().

TYPO3backend::render

(

)

main function generating the BE scaffolding

Returns:

void

Definition at line 191 of file backend.php.

References $GLOBALS, executeHook(), generateJavascript(), loadResourcesForRegisteredNavigationComponents(), t3lib_div\makeInstance(), and renderToolbar().

TYPO3backend::renderToolbar

(

)

[protected]

renders the items in the top toolbar

Returns:

string top toolbar elements as HTML

Definition at line 337 of file backend.php.

Referenced by render().

TYPO3backend::setStartupModule

(

)

[protected]

Sets the startup module from either GETvars module and mpdParams or user configuration.

Returns:

void

Definition at line 696 of file backend.php.

References $GLOBALS, and t3lib_div\_GET().

Referenced by generateJavascript().

---

Member Data Documentation

TYPO3backend::$content [protected]

Definition at line 52 of file backend.php.

TYPO3backend::$css [protected]

Definition at line 53 of file backend.php.

TYPO3backend::$cssFiles [protected]

Definition at line 54 of file backend.php.

Referenced by loadResourcesForRegisteredNavigationComponents().

TYPO3backend::$debug [protected]

Definition at line 61 of file backend.php.

TYPO3backend::$js [protected]

Definition at line 55 of file backend.php.

TYPO3backend::$jsFiles [protected]

Definition at line 56 of file backend.php.

Referenced by loadResourcesForRegisteredNavigationComponents().

TYPO3backend::$jsFilesAfterInline [protected]

Definition at line 57 of file backend.php.

TYPO3backend::$menuWidth [protected]

Definition at line 60 of file backend.php.

TYPO3backend::$menuWidthDefault = 190 [private]

Definition at line 59 of file backend.php.

TYPO3backend::$moduleLoader [protected]

Definition at line 68 of file backend.php.

TYPO3backend::$moduleMenu [protected]

Definition at line 75 of file backend.php.

TYPO3backend::$pageRenderer [protected]

Definition at line 82 of file backend.php.

TYPO3backend::$toolbarItems [protected]

Definition at line 58 of file backend.php.

---

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

• typo3/backend.php