TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
TYPO3\CMS\Backend\Controller\BackendController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\BackendController:
TYPO3backend

Public Member Functions

 getPageRenderer ()
 
 __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

Class for rendering the TYPO3 backend version 4.2+

Author
Ingo Renner ingo@.nosp@m.typo.nosp@m.3.org

Definition at line 26 of file BackendController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\BackendController::__construct ( )

Constructor

Definition at line 80 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\$menuWidthDefault, debug(), TYPO3\CMS\Backend\Controller\BackendController\executeHook(), TYPO3\CMS\Backend\Controller\BackendController\getLocalLangFileName(), TYPO3\CMS\Backend\Controller\BackendController\initializeCoreToolbarItems(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ addCss()

TYPO3\CMS\Backend\Controller\BackendController::addCss (   $css)

Adds a css snippet to the backend

Parameters
string$cssCss snippet
Returns
void

Definition at line 659 of file BackendController.php.

◆ addCssFile()

TYPO3\CMS\Backend\Controller\BackendController::addCssFile (   $cssFileName,
  $cssFile 
)

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

Parameters
string$cssFileNameThe css file's name with out the .css ending
string$cssFileCss file reference
Returns
boolean TRUE if the css file was added, FALSE otherwise

Definition at line 673 of file BackendController.php.

◆ addJavascript()

TYPO3\CMS\Backend\Controller\BackendController::addJavascript (   $javascript)

Adds a javascript snippet to the backend

Parameters
string$javascriptJavascript snippet
Returns
void
Exceptions

Definition at line 629 of file BackendController.php.

◆ addJavascriptFile()

TYPO3\CMS\Backend\Controller\BackendController::addJavascriptFile (   $javascriptFile)

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

Parameters
string$javascriptFileJavascript file reference
Returns
boolean TRUE if the javascript file was successfully added, FALSE otherwise

Definition at line 643 of file BackendController.php.

◆ addToolbarItem()

TYPO3\CMS\Backend\Controller\BackendController::addToolbarItem (   $toolbarItemName,
  $toolbarItemClassName 
)

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

Parameters
string$toolbarItemNameToolbar item name, f.e. tx_toolbarExtension_coolItem
string$toolbarItemClassNameToolbar item class name, f.e. tx_toolbarExtension_coolItem
Returns
void
Exceptions

Definition at line 690 of file BackendController.php.

◆ executeHook()

TYPO3\CMS\Backend\Controller\BackendController::executeHook (   $identifier,
array  $hookConfiguration = array() 
)
protected

Executes defined hooks functions for the given identifier.

These hook identifiers are valid:

  • constructPostProcess
  • renderPreProcess
  • renderPostProcess
Parameters
string$identifierSpecific hook identifier
array$hookConfigurationAdditional configuration passed to hook functions
Returns
void

Definition at line 714 of file BackendController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct(), and TYPO3\CMS\Backend\Controller\BackendController\render().

◆ generateJavascript()

TYPO3\CMS\Backend\Controller\BackendController::generateJavascript ( )
protected

Generates the JavaScript code for the backend.

Returns
void

Definition at line 454 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\dirname(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Backend\Controller\BackendController\handlePageEditing(), TYPO3\CMS\Backend\Utility\BackendUtility\isModuleSetInTBE_MODULES(), TYPO3\CMS\Backend\Controller\BackendController\setStartupModule(), and TYPO3\CMS\Core\Utility\GeneralUtility\shortMD5().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\render().

◆ generateLocalLang()

TYPO3\CMS\Backend\Controller\BackendController::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 359 of file BackendController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\getLocalLangFileName().

◆ getLocalLangFileName()

TYPO3\CMS\Backend\Controller\BackendController::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 341 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\generateLocalLang(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFileToTypo3tempDir().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct().

◆ getLoggedInUserLabel()

TYPO3\CMS\Backend\Controller\BackendController::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 314 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\$css, $GLOBALS, TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\renderToolbar().

◆ getPageRenderer()

TYPO3\CMS\Backend\Controller\BackendController::getPageRenderer ( )
Returns

Definition at line 73 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\$pageRenderer.

◆ handlePageEditing()

TYPO3\CMS\Backend\Controller\BackendController::handlePageEditing ( )
protected

Checking if the "&edit" variable was sent so we can open it for editing the page.

Returns
void

Definition at line 542 of file BackendController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordsByField(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Backend\Utility\BackendUtility\openPageTree(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\generateJavascript().

◆ initializeCoreToolbarItems()

TYPO3\CMS\Backend\Controller\BackendController::initializeCoreToolbarItems ( )
protected

Initializes the core toolbar items

Returns
void

Definition at line 138 of file BackendController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct().

◆ loadResourcesForRegisteredNavigationComponents()

TYPO3\CMS\Backend\Controller\BackendController::loadResourcesForRegisteredNavigationComponents ( )
protected

Loads the css and javascript files of all registered navigation widgets

Returns
void

Definition at line 228 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\$cssFiles, $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\$jsFiles, $module, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getFilesInDir(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\render().

◆ render()

TYPO3\CMS\Backend\Controller\BackendController::render ( )

Main function generating the BE scaffolding

Returns
void

Definition at line 162 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\$content, $GLOBALS, TYPO3\CMS\Backend\Controller\BackendController\executeHook(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Backend\Controller\BackendController\renderToolbar().

◆ renderToolbar()

TYPO3\CMS\Backend\Controller\BackendController::renderToolbar ( )
protected

Renders the items in the top toolbar

Returns
string top toolbar elements as HTML

Definition at line 276 of file BackendController.php.

References TYPO3\CMS\Backend\Controller\BackendController\getLoggedInUserLabel().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\render().

◆ setStartupModule()

TYPO3\CMS\Backend\Controller\BackendController::setStartupModule ( )
protected

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

Returns
string the JavaScript code for the startup module

Definition at line 585 of file BackendController.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\_GET().

Referenced by TYPO3\CMS\Backend\Controller\BackendController\generateJavascript().

Member Data Documentation

◆ $content

TYPO3\CMS\Backend\Controller\BackendController::$content
protected

Definition at line 28 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\render().

◆ $css

TYPO3\CMS\Backend\Controller\BackendController::$css
protected

Definition at line 30 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\getLoggedInUserLabel().

◆ $cssFiles

TYPO3\CMS\Backend\Controller\BackendController::$cssFiles
protected

Definition at line 32 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents().

◆ $debug

TYPO3\CMS\Backend\Controller\BackendController::$debug
protected

Definition at line 47 of file BackendController.php.

◆ $js

TYPO3\CMS\Backend\Controller\BackendController::$js
protected

Definition at line 34 of file BackendController.php.

◆ $jsFiles

TYPO3\CMS\Backend\Controller\BackendController::$jsFiles
protected

Definition at line 36 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents().

◆ $jsFilesAfterInline

TYPO3\CMS\Backend\Controller\BackendController::$jsFilesAfterInline
protected

Definition at line 38 of file BackendController.php.

◆ $menuWidth

TYPO3\CMS\Backend\Controller\BackendController::$menuWidth
protected

Definition at line 45 of file BackendController.php.

◆ $menuWidthDefault

TYPO3\CMS\Backend\Controller\BackendController::$menuWidthDefault = 190
private

Definition at line 43 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\__construct().

◆ $moduleLoader

TYPO3\CMS\Backend\Controller\BackendController::$moduleLoader
protected

Definition at line 54 of file BackendController.php.

◆ $moduleMenu

TYPO3\CMS\Backend\Controller\BackendController::$moduleMenu
protected

Definition at line 61 of file BackendController.php.

◆ $pageRenderer

TYPO3\CMS\Backend\Controller\BackendController::$pageRenderer
protected

Definition at line 68 of file BackendController.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\getPageRenderer().

◆ $toolbarItems

TYPO3\CMS\Backend\Controller\BackendController::$toolbarItems
protected

Definition at line 40 of file BackendController.php.