TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Recycler\Controller\RecyclerModuleController Class Reference
Inheritance diagram for TYPO3\CMS\Recycler\Controller\RecyclerModuleController:
TYPO3\CMS\Backend\Module\BaseScriptClass tx_recycler_module1

Public Member Functions

 __construct ()
 
 initialize ()
 
 render ()
 
 flush ()
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
 init ()
 
 menuConfig ()
 
 mergeExternalItems ($modName, $menuKey, $menuArr)
 
 handleExternalFunctionValue ($MM_key='function', $MS_value=NULL)
 
 getExternalItemConfig ($modName, $menuKey, $value='')
 
 checkExtObj ()
 
 checkSubExtObj ()
 
 extObjHeader ()
 
 extObjContent ()
 

Public Attributes

 $doc
 
- Public Attributes inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
 $MCONF = array()
 
 $id
 
 $CMD
 
 $perms_clause
 
 $MOD_MENU
 
 $MOD_SETTINGS = array()
 
 $modTSconfig
 
 $modMenu_type = ''
 
 $modMenu_dontValidateList = ''
 
 $modMenu_setDefaultList = ''
 
 $extClassConf
 
 $include_once = array()
 
 $content = ''
 
 $doc
 
 $extObj
 

Protected Member Functions

 isCurrentUserAdmin ()
 
 loadHeaderData ()
 
 getJavaScriptConfiguration ()
 
 getJavaScriptLabels ()
 
 getJavaScriptLabelsFromLocallang ($selectionPrefix='js.', $stripFromSelectionName='')
 
 getDocHeaderButtons ()
 
 getShortcutButton ()
 
 getTemplateMarkers ()
 
 getFunctionMenu ()
 
 getDataFromSession ($identifier, $default=NULL)
 
- Protected Member Functions inherited from TYPO3\CMS\Backend\Module\BaseScriptClass
 getLanguageService ()
 
 getBackendUser ()
 

Protected Attributes

 $relativePath
 
 $pageRecord = array()
 
 $isAccessibleForCurrentUser = FALSE
 
 $allowDelete = FALSE
 
 $recordsPageLimit = 50
 
 $pageRenderer
 

Detailed Description

Module 'Recycler' for the 'recycler' extension.

Author
Julian Kleinhans typo3.nosp@m.@kj1.nosp@m.87.de

Definition at line 26 of file RecyclerModuleController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::__construct ( )

Constructor

Definition at line 51 of file RecyclerModuleController.php.

References $GLOBALS.

Member Function Documentation

◆ flush()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::flush ( )

◆ getDataFromSession()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getDataFromSession (   $identifier,
  $default = NULL 
)
protected

Gets data from the session of the current backend user.

Parameters
string$identifier,The identifier to be used to get the data
string$default,The default date to be used if nothing was found in the session
Returns
string The accordant data in the session of the current backend user

Definition at line 278 of file RecyclerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getJavaScriptConfiguration().

◆ getDocHeaderButtons()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getDocHeaderButtons ( )
protected

Gets the buttons that shall be rendered in the docHeader.

Returns
array Available buttons for the docHeader

Definition at line 224 of file RecyclerModuleController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), and TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getShortcutButton().

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\flush().

◆ getFunctionMenu()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getFunctionMenu ( )
protected

Gets the function menu selector for this backend module.

Returns
string The HTML representation of the function menu selector

Definition at line 267 of file RecyclerModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getFuncMenu().

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getTemplateMarkers().

◆ getJavaScriptConfiguration()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getJavaScriptConfiguration ( )
protected

Gets the JavaScript configuration for the Ext JS interface.

Returns
array The JavaScript configuration

Definition at line 157 of file RecyclerModuleController.php.

References $GLOBALS, TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getDataFromSession(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\loadHeaderData().

◆ getJavaScriptLabels()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getJavaScriptLabels ( )
protected

Gets the labels to be used in JavaScript in the Ext JS interface.

Returns
array The labels to be used in JavaScript

Definition at line 178 of file RecyclerModuleController.php.

References $GLOBALS, and TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getJavaScriptLabelsFromLocallang().

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\loadHeaderData().

◆ getJavaScriptLabelsFromLocallang()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getJavaScriptLabelsFromLocallang (   $selectionPrefix = 'js.',
  $stripFromSelectionName = '' 
)
protected

Gets labels to be used in JavaScript fetched from the current locallang file.

Parameters
string$selectionPrefix,Prefix to select the correct labels (default: 'js.')
string$stripFromSelectionName,Sub-prefix to be removed from label names in the result (default: '')
Returns
array Labels to be used in JavaScript of the current locallang file
Todo:
Check, whether this method can be moved in a generic way to $GLOBALS['LANG']

Definition at line 204 of file RecyclerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getJavaScriptLabels().

◆ getShortcutButton()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getShortcutButton ( )
protected

Gets the button to set a new shortcut in the backend (if current user is allowed to).

Returns
string HTML representation of the shortcut button

Definition at line 240 of file RecyclerModuleController.php.

References $GLOBALS, and $result.

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getDocHeaderButtons().

◆ getTemplateMarkers()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::getTemplateMarkers ( )
protected

Gets the filled markers that are used in the HTML template.

Returns
array The filled marker array

Definition at line 253 of file RecyclerModuleController.php.

References $GLOBALS, and TYPO3\CMS\Recycler\Controller\RecyclerModuleController\getFunctionMenu().

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\flush().

◆ initialize()

◆ isCurrentUserAdmin()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::isCurrentUserAdmin ( )
protected

Determines whether the current user is admin.

Returns
boolean Whether the current user is admin

Definition at line 124 of file RecyclerModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recycler\Controller\RecyclerModuleController\initialize().

◆ loadHeaderData()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::loadHeaderData ( )
protected

◆ render()

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::render ( )

Renders the content of the module.

Returns
void

Definition at line 92 of file RecyclerModuleController.php.

References $GLOBALS, and TYPO3\CMS\Recycler\Controller\RecyclerModuleController\loadHeaderData().

Member Data Documentation

◆ $allowDelete

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$allowDelete = FALSE
protected

Definition at line 39 of file RecyclerModuleController.php.

◆ $doc

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$doc

Definition at line 31 of file RecyclerModuleController.php.

◆ $isAccessibleForCurrentUser

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$isAccessibleForCurrentUser = FALSE
protected

Definition at line 37 of file RecyclerModuleController.php.

◆ $pageRecord

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$pageRecord = array()
protected

Definition at line 35 of file RecyclerModuleController.php.

◆ $pageRenderer

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$pageRenderer
protected

Definition at line 46 of file RecyclerModuleController.php.

◆ $recordsPageLimit

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$recordsPageLimit = 50
protected

Definition at line 41 of file RecyclerModuleController.php.

◆ $relativePath

TYPO3\CMS\Recycler\Controller\RecyclerModuleController::$relativePath
protected

Definition at line 33 of file RecyclerModuleController.php.