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 ()
 renderToolbar ()
 getLoggedInUserLabel ()
 generateJavascript ()
 handlePageEditing ()
 setStartupModule ()
 getLogo ()

Protected Attributes

 $content
 $css
 $cssFiles
 $js
 $jsFiles
 $toolbarItems
 $menuWidth
 $moduleLoader
 $moduleMenu

Private Attributes

 $menuWidthDefault = 160

Detailed Description

Definition at line 54 of file backend.php.


Constructor & Destructor Documentation

TYPO3backend::__construct (  ) 

constructor

Returns:
void

Definition at line 84 of file backend.php.

References $GLOBALS, 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 692 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 707 of file backend.php.

References t3lib_div::resolveBackPath().

TYPO3backend::addJavascript ( javascript  ) 

adds a javascript snippet to the backend

Parameters:
string javascript snippet
Returns:
void

Definition at line 659 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 674 of file backend.php.

References t3lib_div::resolveBackPath().

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 729 of file backend.php.

References t3lib_div::makeInstanceClassName().

TYPO3backend::generateJavascript (  )  [protected]

Generates the JavaScript code for the backend.

Returns:
void

Definition at line 321 of file backend.php.

TYPO3backend::getLoggedInUserLabel (  )  [protected]

gets the label of the currently loged in BE user

Returns:
string html code snippet displaying the currently logged in user

Definition at line 282 of file backend.php.

References $BACK_PATH, $GLOBALS, and t3lib_extMgm::isLoaded().

TYPO3backend::getLogo (  )  [protected]

generates the code for the TYPO3 logo, either the default TYPO3 logo or a custom one

Returns:
string HTML code snippet to display the TYPO3 logo

Definition at line 635 of file backend.php.

References $GLOBALS.

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 549 of file backend.php.

TYPO3backend::initializeCoreToolbarItems (  )  [protected]

initializes the core toolbar items

Returns:
void

Definition at line 128 of file backend.php.

References t3lib_div::makeInstanceClassName().

Referenced by __construct().

TYPO3backend::render (  ) 

main function generating the BE scaffolding

Returns:
void

Definition at line 159 of file backend.php.

References t3lib_div::makeInstance().

TYPO3backend::renderToolbar (  )  [protected]

renders the items in the top toolbar

Returns:
string top toolbar elements as HTML

Definition at line 257 of file backend.php.

TYPO3backend::setStartupModule (  )  [protected]

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

Returns:
void

Definition at line 604 of file backend.php.


Member Data Documentation

TYPO3backend::$content [protected]

Definition at line 56 of file backend.php.

TYPO3backend::$css [protected]

Definition at line 57 of file backend.php.

TYPO3backend::$cssFiles [protected]

Definition at line 58 of file backend.php.

TYPO3backend::$js [protected]

Definition at line 59 of file backend.php.

TYPO3backend::$jsFiles [protected]

Definition at line 60 of file backend.php.

TYPO3backend::$menuWidth [protected]

Definition at line 63 of file backend.php.

TYPO3backend::$menuWidthDefault = 160 [private]

Definition at line 62 of file backend.php.

TYPO3backend::$moduleLoader [protected]

Definition at line 70 of file backend.php.

TYPO3backend::$moduleMenu [protected]

Definition at line 77 of file backend.php.

TYPO3backend::$toolbarItems [protected]

Definition at line 61 of file backend.php.


The documentation for this class was generated from the following file:
Generated on Sat Jan 3 04:24:13 2009 for TYPO3 API by  doxygen 1.4.7