‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Adminpanel\View\AdminPanelView Class Reference
Inheritance diagram for TYPO3\CMS\Adminpanel\View\AdminPanelView:
TYPO3\CMS\Frontend\View\AdminPanelView

Public Member Functions

 setModules (array $modules)
 
string callDeprecatedHookObject ()
 
string ext_makeToolBar ()
 
string getAdminPanelHeaderData ()
 
bool isAdminModuleEnabled ($key)
 
 saveConfigOptions ()
 
mixed extGetFeAdminValue ($sectionName, $val='')
 
 forcePreview ()
 
bool isAdminModuleOpen ($key)
 
string extGetItem ($title, $content='', $checkbox='', $outerDivClass=null, $innerDivClass=null)
 
string extGetHead ($sectionSuffix)
 
string linkSectionHeader ($sectionSuffix, $sectionTitle, $className='')
 

Protected Member Functions

TYPO3 CMS Core Localization LanguageService getLanguageService ()
 
FrontendBackendUserAuthentication getBackendUser ()
 
string getModule (ModuleInterface $module)
 
string getSectionOpenerLink (ModuleInterface $module)
 
string extGetLL ($key, $convertWithHtmlspecialchars=true)
 

Protected Attributes

bool $ext_forcePreview = false
 
TYPO3 CMS Adminpanel ModuleApi ModuleInterface[] $modules = array( )
 
array $configuration
 

Detailed Description

View class for the admin panel in frontend editing.

Definition at line 33 of file AdminPanelView.php.

Member Function Documentation

◆ callDeprecatedHookObject()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::callDeprecatedHookObject ( )

Backwards compatibility method ensuring hook still gets the same content as before

Deprecated:
‪since TYPO3 v9 - remove when hook can be removed
Returns
‪string
Exceptions

Definition at line 95 of file AdminPanelView.php.

References $GLOBALS, TYPO3\CMS\Adminpanel\View\AdminPanelView\getModule(), and TYPO3\CMS\Adminpanel\Utility\StateUtility\isOpen().

◆ ext_makeToolBar()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::ext_makeToolBar ( )

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

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0. Use EditToolbarService instead or create buttons via fluid
Returns
‪string A string containing images wrapped in -tags linking them to proper functions.

Definition at line 206 of file AdminPanelView.php.

◆ extGetFeAdminValue()

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

Returns the value for an Admin Panel setting.

Parameters
string$sectionName‪Module key
string$val‪Setting key
Returns
‪mixed The setting value
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - implement AdminPanelModules via the new API (see AdminPanelModuleInterface)

Definition at line 323 of file AdminPanelView.php.

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

Referenced by TYPO3\CMS\Feedit\DataHandling\FrontendEditDataHandler\move().

◆ extGetHead()

string TYPO3\CMS\Adminpanel\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$sectionSuffix‪The suffix to the display_ label. Also selects the label from the LOCAL_LANG array.
Returns
‪string HTML table row.
See also
‪extGetItem()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - use new AdminPanel API instead

Definition at line 433 of file AdminPanelView.php.

References TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetLL(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\linkSectionHeader().

◆ extGetItem()

string TYPO3\CMS\Adminpanel\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$title‪Key to label
string$content‪The HTML content for the forth table cell.
string$checkbox‪The HTML for a checkbox or hidden fields.
string$innerDivClass‪The Class attribute for the td element.
string$outerDivClass‪The Class attribute for the tr element.
Returns
‪string HTML table row.
See also
‪extGetHead()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - use new AdminPanel API instead

Definition at line 409 of file AdminPanelView.php.

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

◆ extGetLL()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::extGetLL (   $key,
  $convertWithHtmlspecialchars = true 
)
protected

Translate given key

Parameters
string$key‪Key for a label in the $LOCAL_LANG array of "EXT:core/Resources/Private/Language/locallang_tsfe.xlf
bool$convertWithHtmlspecialchars‪If TRUE the language-label will be sent through htmlspecialchars
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - only used in deprecated methods
Returns
‪string The value for the $key

Definition at line 224 of file AdminPanelView.php.

References TYPO3\CMS\Adminpanel\View\AdminPanelView\getLanguageService().

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetHead(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetItem().

◆ forcePreview()

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

Enables the force preview option.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - see AdminPanelModule: Preview

Definition at line 370 of file AdminPanelView.php.

◆ getAdminPanelHeaderData()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::getAdminPanelHeaderData ( )

Add an additional stylesheet

Returns
‪string
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - implement AdminPanelModules via the new API (see AdminPanelModuleInterface)

Definition at line 239 of file AdminPanelView.php.

References $GLOBALS.

◆ getBackendUser()

FrontendBackendUserAuthentication TYPO3\CMS\Adminpanel\View\AdminPanelView::getBackendUser ( )
protected

Returns the current BE user.

Returns
‪FrontendBackendUserAuthentication

Definition at line 78 of file AdminPanelView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetFeAdminValue(), TYPO3\CMS\Adminpanel\View\AdminPanelView\getSectionOpenerLink(), TYPO3\CMS\Adminpanel\View\AdminPanelView\isAdminModuleOpen(), TYPO3\CMS\Adminpanel\View\AdminPanelView\linkSectionHeader(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\saveConfigOptions().

◆ getLanguageService()

TYPO3 CMS Core Localization LanguageService TYPO3\CMS\Adminpanel\View\AdminPanelView::getLanguageService ( )
protected

Returns LanguageService

Returns
‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 68 of file AdminPanelView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetLL().

◆ getModule()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::getModule ( ModuleInterface  $module)
protected

Render a single module with header panel

Deprecated:
‪since TYPO3 v9 - only used in deprecated hook call (which triggers the corresponding deprecation error)
Parameters
ModuleInterface$module
Returns
‪string

Definition at line 139 of file AdminPanelView.php.

References $output, TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\getSectionOpenerLink().

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\callDeprecatedHookObject().

◆ getSectionOpenerLink()

string TYPO3\CMS\Adminpanel\View\AdminPanelView::getSectionOpenerLink ( ModuleInterface  $module)
protected

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

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0. Only used in deprecated hook call (which triggers the corresponding deprecation error)
Parameters
ModuleInterface$module
Returns
‪string

Definition at line 177 of file AdminPanelView.php.

References $output, TYPO3\CMS\Adminpanel\View\AdminPanelView\getBackendUser(), TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface\getIdentifier(), and TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface\getLabel().

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\getModule().

◆ isAdminModuleEnabled()

bool TYPO3\CMS\Adminpanel\View\AdminPanelView::isAdminModuleEnabled (   $key)

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

Parameters
string$key‪The module key, eg. "edit", "preview", "info" etc.
Returns
‪bool
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - implement AdminPanelModules via the new API (see AdminPanelModuleInterface)

Definition at line 261 of file AdminPanelView.php.

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

◆ isAdminModuleOpen()

bool TYPO3\CMS\Adminpanel\View\AdminPanelView::isAdminModuleOpen (   $key)

Returns TRUE if admin panel module is open

Parameters
string$key‪Module key
Returns
‪bool TRUE, if the admin panel is open for the specified admin panel module key.
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - use new AdminPanel API instead

Definition at line 386 of file AdminPanelView.php.

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

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetFeAdminValue(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\linkSectionHeader().

◆ linkSectionHeader()

string TYPO3\CMS\Adminpanel\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$sectionSuffix‪The code for the display_ label/key
string$sectionTitle‪Title (HTML-escaped)
string$className‪The classname for the tag
Returns
‪string $className Linked input string
See also
‪extGetHead()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - use new AdminPanel API instead

Definition at line 452 of file AdminPanelView.php.

References $output, TYPO3\CMS\Adminpanel\View\AdminPanelView\getBackendUser(), and TYPO3\CMS\Adminpanel\View\AdminPanelView\isAdminModuleOpen().

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\extGetHead().

◆ saveConfigOptions()

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

Saves any change in settings made in the Admin Panel.

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0 - implement AdminPanelModules via the new API (see AdminPanelModuleInterface)

Definition at line 284 of file AdminPanelView.php.

References $GLOBALS, and TYPO3\CMS\Adminpanel\View\AdminPanelView\getBackendUser().

◆ setModules()

TYPO3\CMS\Adminpanel\View\AdminPanelView::setModules ( array  $modules)

Setter for injecting new-style modules

See also
‪\TYPO3\CMS\Adminpanel\Controller\MainController::render()
Parameters
array$modules

Definition at line 58 of file AdminPanelView.php.

References TYPO3\CMS\Adminpanel\View\AdminPanelView\$modules.

Member Data Documentation

◆ $configuration

array TYPO3\CMS\Adminpanel\View\AdminPanelView::$configuration
protected

Definition at line 49 of file AdminPanelView.php.

◆ $ext_forcePreview

bool TYPO3\CMS\Adminpanel\View\AdminPanelView::$ext_forcePreview = false
protected

Force preview

Definition at line 39 of file AdminPanelView.php.

◆ $modules

TYPO3 CMS Adminpanel ModuleApi ModuleInterface [] TYPO3\CMS\Adminpanel\View\AdminPanelView::$modules = array( )
protected

Array of adminPanel modules

Definition at line 45 of file AdminPanelView.php.

Referenced by TYPO3\CMS\Adminpanel\View\AdminPanelView\setModules().