TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Frontend\View\AdminPanelView Class Reference
Inheritance diagram for TYPO3\CMS\Frontend\View\AdminPanelView:
tslib_AdminPanel

Public Member Functions

 __construct ()
 
 initialize ()
 
 getAdminPanelHeaderData ()
 
 isAdminModuleEnabled ($key)
 
 saveConfigOptions ()
 
 extGetFeAdminValue ($sectionName, $val='')
 
 forcePreview ()
 
 isAdminModuleOpen ($key)
 
 display ()
 
 extGetHead ($sectionSuffix)
 
 linkSectionHeader ($sectionSuffix, $sectionTitle, $className='')
 
 extGetItem ($title, $content='', $checkbox='')
 
 ext_makeToolBar ()
 

Protected Member Functions

 getHiddenFields ($key, array $val)
 
 getPreviewModule ()
 
 getCacheModule ()
 
 getEditModule ()
 
 getTSDebugModule ()
 
 getInfoModule ()
 
 extGetLL ($key, $convertWithHtmlspecialchars=TRUE)
 

Protected Attributes

 $extNeedUpdate = FALSE
 
 $ext_forcePreview = FALSE
 
 $extJSCODE = ''
 

Detailed Description

View class for the admin panel in frontend editing.

Definition at line 24 of file AdminPanelView.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Frontend\View\AdminPanelView::__construct ( )

Constructor

Definition at line 48 of file AdminPanelView.php.

References TYPO3\CMS\Frontend\View\AdminPanelView\initialize().

Member Function Documentation

◆ display()

◆ ext_makeToolBar()

◆ extGetFeAdminValue()

TYPO3\CMS\Frontend\View\AdminPanelView::extGetFeAdminValue (   $sectionName,
  $val = '' 
)

◆ extGetHead()

TYPO3\CMS\Frontend\View\AdminPanelView::extGetHead (   $sectionSuffix)

Returns a row (with colspan=4) which is a header for a section in the Admin Panel. It will have a plus/minus icon and a label which is linked so that it submits the form which surrounds the whole Admin Panel when clicked, alterting the TSFE_ADMIN_PANEL[display_' . $pre . '] value See the functions get*Module

Parameters
string$sectionSuffixThe suffix to the display_ label. Also selects the label from the LOCAL_LANG array.
Returns
string HTML table row.
See also
extGetItem()

Definition at line 547 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Frontend\View\AdminPanelView\extGetLL(), and TYPO3\CMS\Frontend\View\AdminPanelView\linkSectionHeader().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getInfoModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getPreviewModule(), and TYPO3\CMS\Frontend\View\AdminPanelView\getTSDebugModule().

◆ extGetItem()

TYPO3\CMS\Frontend\View\AdminPanelView::extGetItem (   $title,
  $content = '',
  $checkbox = '' 
)

Returns a row (with 4 columns) for content in a section of the Admin Panel. It will take $pre as a key to a label to display and $element as the content to put into the forth cell.

Parameters
string$titleKey to label
string$contentThe HTML content for the forth table cell.
string$checkboxThe HTML for a checkbox or hidden fields
Returns
string HTML table row.
See also
extGetHead()

Definition at line 583 of file AdminPanelView.php.

References TYPO3\CMS\Frontend\View\AdminPanelView\extGetLL().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getPreviewModule(), and TYPO3\CMS\Frontend\View\AdminPanelView\getTSDebugModule().

◆ extGetLL()

TYPO3\CMS\Frontend\View\AdminPanelView::extGetLL (   $key,
  $convertWithHtmlspecialchars = TRUE 
)
protected

Translate given key

Parameters
string$keyKey for a label in the $LOCAL_LANG array of "sysext/lang/locallang_tsfe.xlf
bool$convertWithHtmlspecialcharsIf TRUE the language-label will be sent through htmlspecialchars
Returns
string The value for the $key

Definition at line 665 of file AdminPanelView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Frontend\View\AdminPanelView\ext_makeToolBar(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetItem(), TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), and TYPO3\CMS\Frontend\View\AdminPanelView\getInfoModule().

◆ forcePreview()

TYPO3\CMS\Frontend\View\AdminPanelView::forcePreview ( )

Enables the force preview option.

Returns
void

Definition at line 201 of file AdminPanelView.php.

◆ getAdminPanelHeaderData()

TYPO3\CMS\Frontend\View\AdminPanelView::getAdminPanelHeaderData ( )

Add an additional stylesheet

Returns
string

Definition at line 97 of file AdminPanelView.php.

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

◆ getCacheModule()

TYPO3\CMS\Frontend\View\AdminPanelView::getCacheModule ( )
protected

Creates the content for the "cache" section ("module") of the Admin Panel

Returns
string HTML content for the section. Consists of a string with table-rows with four columns.
See also
display()

Definition at line 388 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetItem(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetLL(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display().

◆ getEditModule()

TYPO3\CMS\Frontend\View\AdminPanelView::getEditModule ( )
protected

◆ getHiddenFields()

TYPO3\CMS\Frontend\View\AdminPanelView::getHiddenFields (   $key,
array  $val 
)
protected

Fetches recursively all GET parameters as hidden fields. Called from display()

Parameters
string$keyCurrent key
array$valCurrent value
Returns
string Hidden fields
See also
display()

Definition at line 329 of file AdminPanelView.php.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display().

◆ getInfoModule()

TYPO3\CMS\Frontend\View\AdminPanelView::getInfoModule ( )
protected

Creates the content for the "info" section ("module") of the Admin Panel

Returns
string HTML content for the section. Consists of a string with table-rows with four columns.
See also
display()

Definition at line 484 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetLL(), and TYPO3\CMS\Core\Utility\GeneralUtility\formatSize().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display().

◆ getPreviewModule()

TYPO3\CMS\Frontend\View\AdminPanelView::getPreviewModule ( )
protected

Creates the content for the "preview" section ("module") of the Admin Panel

Returns
string HTML content for the section. Consists of a string with table-rows with four columns.
See also
display()

Definition at line 350 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), and TYPO3\CMS\Frontend\View\AdminPanelView\extGetItem().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display().

◆ getTSDebugModule()

TYPO3\CMS\Frontend\View\AdminPanelView::getTSDebugModule ( )
protected

Creates the content for the "tsdebug" section ("module") of the Admin Panel

Returns
string HTML content for the section. Consists of a string with table-rows with four columns.
See also
display()

Definition at line 457 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), and TYPO3\CMS\Frontend\View\AdminPanelView\extGetItem().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display().

◆ initialize()

TYPO3\CMS\Frontend\View\AdminPanelView::initialize ( )

◆ isAdminModuleEnabled()

TYPO3\CMS\Frontend\View\AdminPanelView::isAdminModuleEnabled (   $key)

Checks if a Admin Panel section ("module") is available for the user. If so, TRUE is returned.

Parameters
string$keyThe module key, eg. "edit", "preview", "info" etc.
Returns
boolean

Definition at line 112 of file AdminPanelView.php.

References $GLOBALS, and $result.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), and TYPO3\CMS\Frontend\View\AdminPanelView\saveConfigOptions().

◆ isAdminModuleOpen()

TYPO3\CMS\Frontend\View\AdminPanelView::isAdminModuleOpen (   $key)

Returns TRUE if admin panel module is open

Parameters
string$keyModule key
Returns
boolean TRUE, if the admin panel is open for the specified admin panel module key.

Definition at line 211 of file AdminPanelView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue().

◆ linkSectionHeader()

TYPO3\CMS\Frontend\View\AdminPanelView::linkSectionHeader (   $sectionSuffix,
  $sectionTitle,
  $className = '' 
)

Wraps a string in a link which will open/close a certain part of the Admin Panel

Parameters
string$sectionSuffixThe code for the display_ label/key
string$sectionTitleTitle (in HTML-format)
string$classNameThe classname for the tag
Returns
string $className Linked input string
See also
extGetHead()

Definition at line 563 of file AdminPanelView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), and TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead().

◆ saveConfigOptions()

TYPO3\CMS\Frontend\View\AdminPanelView::saveConfigOptions ( )

Saves any change in settings made in the Admin Panel. Called from index_ts.php right after access check for the Admin Panel

Returns
void

Definition at line 131 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), and TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleEnabled().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\initialize().

Member Data Documentation

◆ $ext_forcePreview

TYPO3\CMS\Frontend\View\AdminPanelView::$ext_forcePreview = FALSE
protected

Definition at line 38 of file AdminPanelView.php.

◆ $extJSCODE

TYPO3\CMS\Frontend\View\AdminPanelView::$extJSCODE = ''
protected

Definition at line 43 of file AdminPanelView.php.

◆ $extNeedUpdate

TYPO3\CMS\Frontend\View\AdminPanelView::$extNeedUpdate = FALSE
protected

Definition at line 31 of file AdminPanelView.php.