TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Frontend\View\AdminPanelView Class Reference

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='', $outerDivClass=null, $innerDivClass=null)
 
 ext_makeToolBar ()
 

Protected Member Functions

 getHiddenFields ($key, array $val)
 
 getPreviewModule ()
 
 getCacheModule ()
 
 getEditModule ()
 
 getTSDebugModule ()
 
 getInfoModule ()
 
 extGetLL ($key, $convertWithHtmlspecialchars=true)
 
 getLanguageService ()
 
 getBackendUser ()
 
 getDatabaseConnection ()
 
 getTypoScriptFrontendController ()
 
 getTimeTracker ()
 

Protected Attributes

 $extNeedUpdate = false
 
 $ext_forcePreview = false
 
 $extJSCODE = ''
 
 $iconFactory
 
 $extFeEditLoaded = false
 

Detailed Description

View class for the admin panel in frontend editing.

Definition at line 27 of file AdminPanelView.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

Definition at line 63 of file AdminPanelView.php.

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

Member Function Documentation

◆ display()

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

Creates and returns the HTML code for the Admin Panel in the TSFE frontend.

Exceptions

Definition at line 248 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetLL(), TYPO3\CMS\Frontend\View\AdminPanelView\getAdminPanelHeaderData(), TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getHiddenFields(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Frontend\View\AdminPanelView\getInfoModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getLanguageService(), TYPO3\CMS\Frontend\View\AdminPanelView\getPreviewModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getTSDebugModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleEnabled(), TYPO3\CMS\Frontend\View\AdminPanelView\linkSectionHeader(), TYPO3\CMS\Core\Utility\GeneralUtility\locationHeaderUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\minifyJavaScript(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath().

◆ ext_makeToolBar()

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

Creates the tool bar links for the "edit" section of the Admin Panel.

Returns
string A string containing images wrapped in -tags linking them to proper functions.

Definition at line 650 of file AdminPanelView.php.

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

◆ extGetFeAdminValue()

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

Returns the value for an Admin Panel setting.

Parameters
string$sectionNameModule key
string$valSetting key
Returns
mixed The setting value

Definition at line 183 of file AdminPanelView.php.

References TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleEnabled(), and TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleOpen().

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\initialize(), and TYPO3\CMS\Frontend\View\AdminPanelView\saveConfigOptions().

◆ 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 595 of file AdminPanelView.php.

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

◆ extGetItem()

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

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.
string$innerDivClassThe Class attribute for the td element.
string$outerDivClassThe Class attribute for the tr element.
Returns
string HTML table row.
See also
extGetHead()

Definition at line 635 of file AdminPanelView.php.

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

◆ 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 737 of file AdminPanelView.php.

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

◆ forcePreview()

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

Enables the force preview option.

Returns
void

Definition at line 226 of file AdminPanelView.php.

◆ getAdminPanelHeaderData()

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

Add an additional stylesheet

Returns
string

Definition at line 117 of file AdminPanelView.php.

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

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

◆ getBackendUser()

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

Returns the current BE user.

Returns

Definition at line 761 of file AdminPanelView.php.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getPreviewModule(), TYPO3\CMS\Frontend\View\AdminPanelView\initialize(), TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleEnabled(), TYPO3\CMS\Frontend\View\AdminPanelView\isAdminModuleOpen(), and TYPO3\CMS\Frontend\View\AdminPanelView\saveConfigOptions().

◆ 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 421 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(), TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getDatabaseConnection()

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

Returns the database connection

Returns

Definition at line 771 of file AdminPanelView.php.

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

◆ getEditModule()

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

Creates the content for the "edit" 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 458 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Frontend\View\AdminPanelView\ext_makeToolBar(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetHead(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetItem(), TYPO3\CMS\Backend\Utility\BackendUtility\getBackendScript(), TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\getTypoScriptFrontendController(), TYPO3\CMS\Backend\Utility\BackendUtility\isModuleSetInTBE_MODULES(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

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

◆ 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 360 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 529 of file AdminPanelView.php.

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

◆ getLanguageService()

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

Returns LanguageService

Returns

Definition at line 751 of file AdminPanelView.php.

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 382 of file AdminPanelView.php.

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

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

◆ getTimeTracker()

TYPO3\CMS\Frontend\View\AdminPanelView::getTimeTracker ( )
protected
Returns

Definition at line 787 of file AdminPanelView.php.

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

◆ 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 499 of file AdminPanelView.php.

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

◆ getTypoScriptFrontendController()

TYPO3\CMS\Frontend\View\AdminPanelView::getTypoScriptFrontendController ( )
protected
Returns

Definition at line 779 of file AdminPanelView.php.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Frontend\View\AdminPanelView\getCacheModule(), TYPO3\CMS\Frontend\View\AdminPanelView\getEditModule(), TYPO3\CMS\Frontend\View\AdminPanelView\initialize(), and TYPO3\CMS\Frontend\View\AdminPanelView\saveConfigOptions().

◆ initialize()

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

Initializes settings for the admin panel.

Returns
void

Definition at line 73 of file AdminPanelView.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\getDatabaseConnection(), TYPO3\CMS\Frontend\View\AdminPanelView\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Frontend\View\AdminPanelView\saveConfigOptions().

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

◆ isAdminModuleEnabled()

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

Checks if an 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
bool

Definition at line 133 of file AdminPanelView.php.

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

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
bool TRUE, if the admin panel is open for the specified admin panel module key.

Definition at line 237 of file AdminPanelView.php.

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

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 612 of file AdminPanelView.php.

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

◆ saveConfigOptions()

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

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

Returns
void

Definition at line 153 of file AdminPanelView.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Frontend\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Frontend\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Frontend\View\AdminPanelView\getTimeTracker(), TYPO3\CMS\Frontend\View\AdminPanelView\getTypoScriptFrontendController(), 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 41 of file AdminPanelView.php.

◆ $extFeEditLoaded

TYPO3\CMS\Frontend\View\AdminPanelView::$extFeEditLoaded = false
protected

Definition at line 58 of file AdminPanelView.php.

◆ $extJSCODE

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

Definition at line 46 of file AdminPanelView.php.

◆ $extNeedUpdate

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

Definition at line 34 of file AdminPanelView.php.

◆ $iconFactory

TYPO3\CMS\Frontend\View\AdminPanelView::$iconFactory
protected

Definition at line 51 of file AdminPanelView.php.