‪TYPO3CMS  9.5
TYPO3\CMS\Backend\Controller\PageLayoutController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\PageLayoutController:
TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait

Public Member Functions

ResponseInterface mainAction (ServerRequestInterface $request)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed __call (string $methodName, array $arguments)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool __isset (string $propertyName)
 
mixed __get (string $propertyName)
 
 __set (string $propertyName, $propertyValue)
 
 __unset (string $propertyName)
 

Public Attributes

int $id
 
array $pageinfo
 
array $MOD_SETTINGS = array( )
 

Protected Member Functions

 init (ServerRequestInterface $request=null)
 
 menuConfig (ServerRequestInterface $request=null)
 
array initActions ()
 
 makeActionMenu (array $actions)
 
 clearCache ()
 
string getHeaderFlashMessagesForCurrentPid ()
 
string getPageLinksWhereContentIsAlsoShownOn ($pageId)
 
string getLocalizedPageTitle ()
 
 main (ServerRequestInterface $request=null)
 
string renderContent ()
 
ModuleTemplate getModuleTemplate ()
 
 makeButtons (ServerRequestInterface $request)
 
int getNumberOfHiddenElements (array $contentConfig=[])
 
string local_linkThisScript ($params)
 
bool isPageEditable (int $languageId)
 
bool pageIsNotLockedForEditors ()
 
bool isContentEditable (int $languageId)
 
bool contentIsNotLockedForEditors ()
 
TYPO3 CMS Core Localization LanguageService getLanguageService ()
 
TYPO3 CMS Core Authentication BackendUserAuthentication getBackendUser ()
 
PageRenderer getPageRenderer ()
 
 makeLanguageMenu ()
 
bool currentPageHasSubPages ()
 
array getTargetPageIfVisible (array $targetPage)
 

Protected Attributes

int $pointer
 
string $imagemode
 
string $search_field
 
int $search_levels
 
int $showLimit
 
string $returnUrl
 
bool $clear_cache
 
bool $popView
 
string $perms_clause
 
array $modTSconfig = array( )
 
array $modSharedTSconfig = array( )
 
string $descrTable
 
string $colPosList
 
bool $EDIT_CONTENT
 
int $CALC_PERMS
 
int $current_sys_language
 
array $MCONF = array( )
 
array $MOD_MENU = array( )
 
string $content
 
string $activeColPosList
 
string $editSelect
 
array $languagesInColumnCache = array( )
 
IconFactory $iconFactory
 
string $moduleName = 'web_layout'
 
ModuleTemplate $moduleTemplate
 
ButtonBar $buttonBar
 
string $searchContent
 

Private Attributes

array $deprecatedPublicMethods
 
array $deprecatedPublicProperties
 

Detailed Description

Script Class for Web > Layout module

Definition at line 52 of file PageLayoutController.php.

Member Function Documentation

◆ clearCache()

TYPO3\CMS\Backend\Controller\PageLayoutController::clearCache ( )
protected

Clears page cache for the current id, $this->id

Definition at line 485 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\mainAction().

◆ contentIsNotLockedForEditors()

bool TYPO3\CMS\Backend\Controller\PageLayoutController::contentIsNotLockedForEditors ( )
protected

◆ currentPageHasSubPages()

bool TYPO3\CMS\Backend\Controller\PageLayoutController::currentPageHasSubPages ( )
protected

Checks whether the current page has sub pages

Returns
‪bool

Definition at line 1301 of file PageLayoutController.php.

References TYPO3\CMS\Backend\Controller\PageLayoutController\getBackendUser().

◆ getBackendUser()

◆ getHeaderFlashMessagesForCurrentPid()

string TYPO3\CMS\Backend\Controller\PageLayoutController::getHeaderFlashMessagesForCurrentPid ( )
protected

Generate the flashmessages for current pid

Returns
‪string HTML content with flashmessages

Definition at line 499 of file PageLayoutController.php.

References TYPO3\CMS\Backend\Controller\PageLayoutController\$content, $GLOBALS, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_LINK, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SHORTCUT, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SYSFOLDER, TYPO3\CMS\Backend\Controller\PageLayoutController\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getLabelFromItemlist(), TYPO3\CMS\Backend\Controller\PageLayoutController\getLanguageService(), TYPO3\CMS\Backend\Controller\PageLayoutController\getPageLinksWhereContentIsAlsoShownOn(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordPath(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Controller\PageLayoutController\getTargetPageIfVisible(), TYPO3\CMS\Backend\Controller\PageLayoutController\local_linkThisScript(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Frontend\Page\PageRepository\SHORTCUT_MODE_FIRST_SUBPAGE, TYPO3\CMS\Frontend\Page\PageRepository\SHORTCUT_MODE_NONE, TYPO3\CMS\Frontend\Page\PageRepository\SHORTCUT_MODE_PARENT_PAGE, TYPO3\CMS\Frontend\Page\PageRepository\SHORTCUT_MODE_RANDOM_SUBPAGE, TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_ERROR, and TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper\STATE_INFO.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\main().

◆ getLanguageService()

◆ getLocalizedPageTitle()

string TYPO3\CMS\Backend\Controller\PageLayoutController::getLocalizedPageTitle ( )
protected

◆ getModuleTemplate()

ModuleTemplate TYPO3\CMS\Backend\Controller\PageLayoutController::getModuleTemplate ( )
protected
Returns
‪ModuleTemplate

Definition at line 921 of file PageLayoutController.php.

References TYPO3\CMS\Backend\Controller\PageLayoutController\$moduleTemplate.

◆ getNumberOfHiddenElements()

int TYPO3\CMS\Backend\Controller\PageLayoutController::getNumberOfHiddenElements ( array  $contentConfig = [])
protected

Returns the number of hidden elements (including those hidden by start/end times) on the current page (for the current sys_language)

Parameters
array$contentConfig
Returns
‪int

Definition at line 1086 of file PageLayoutController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ getPageLinksWhereContentIsAlsoShownOn()

string TYPO3\CMS\Backend\Controller\PageLayoutController::getPageLinksWhereContentIsAlsoShownOn (   $pageId)
protected

Get all pages with links where the content of a page $pageId is also shown on

Parameters
int$pageId
Returns
‪string

Definition at line 630 of file PageLayoutController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), and TYPO3\CMS\Backend\Controller\PageLayoutController\local_linkThisScript().

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\getHeaderFlashMessagesForCurrentPid().

◆ getPageRenderer()

PageRenderer TYPO3\CMS\Backend\Controller\PageLayoutController::getPageRenderer ( )
protected

Returns current PageRenderer

Returns
‪PageRenderer

Definition at line 1268 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ getTargetPageIfVisible()

array TYPO3\CMS\Backend\Controller\PageLayoutController::getTargetPageIfVisible ( array  $targetPage)
protected

Returns the target page if visible

Parameters
array$targetPage
Returns
‪array

Definition at line 1341 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\getHeaderFlashMessagesForCurrentPid().

◆ init()

◆ initActions()

array TYPO3\CMS\Backend\Controller\PageLayoutController::initActions ( )
protected

◆ isContentEditable()

bool TYPO3\CMS\Backend\Controller\PageLayoutController::isContentEditable ( int  $languageId)
protected

◆ isPageEditable()

◆ local_linkThisScript()

string TYPO3\CMS\Backend\Controller\PageLayoutController::local_linkThisScript (   $params)
protected

Returns URL to the current script. In particular the "popView" and "new_unique_uid" Get vars are unset.

Parameters
array$params‪Parameters array, merged with global GET vars.
Returns
‪string URL

Definition at line 1176 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\getHeaderFlashMessagesForCurrentPid(), and TYPO3\CMS\Backend\Controller\PageLayoutController\getPageLinksWhereContentIsAlsoShownOn().

◆ main()

TYPO3\CMS\Backend\Controller\PageLayoutController::main ( ServerRequestInterface  $request = null)
protected

◆ mainAction()

ResponseInterface TYPO3\CMS\Backend\Controller\PageLayoutController::mainAction ( ServerRequestInterface  $request)

Injects the request object for the current request or subrequest As this controller goes only through the main() method, it is rather simple for now

Parameters
ServerRequestInterface$request‪the current request
Returns
‪ResponseInterface the response with the content

Definition at line 277 of file PageLayoutController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\PageLayoutController\clearCache(), TYPO3\CMS\Backend\Controller\PageLayoutController\init(), and TYPO3\CMS\Backend\Controller\PageLayoutController\main().

◆ makeActionMenu()

TYPO3\CMS\Backend\Controller\PageLayoutController::makeActionMenu ( array  $actions)
protected

This creates the dropdown menu with the different actions this module is able to provide. For now they are Columns, Quick Edit and Languages.

Parameters
array$actions‪array with the available actions

Definition at line 450 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\menuConfig().

◆ makeButtons()

◆ makeLanguageMenu()

TYPO3\CMS\Backend\Controller\PageLayoutController::makeLanguageMenu ( )
protected

Make the LanguageMenu

Definition at line 1276 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\main().

◆ menuConfig()

◆ pageIsNotLockedForEditors()

bool TYPO3\CMS\Backend\Controller\PageLayoutController::pageIsNotLockedForEditors ( )
protected

◆ renderContent()

Member Data Documentation

◆ $activeColPosList

string TYPO3\CMS\Backend\Controller\PageLayoutController::$activeColPosList
protected

List of column-integers accessible to the current BE user. Is set from TSconfig, default is $colPosList

Definition at line 236 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $buttonBar

ButtonBar TYPO3\CMS\Backend\Controller\PageLayoutController::$buttonBar
protected

Definition at line 264 of file PageLayoutController.php.

◆ $CALC_PERMS

int TYPO3\CMS\Backend\Controller\PageLayoutController::$CALC_PERMS
protected

Users permissions integer for this page.

Definition at line 198 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $clear_cache

bool TYPO3\CMS\Backend\Controller\PageLayoutController::$clear_cache
protected

Clear-cache flag - if set, clears page cache for current id.

Definition at line 143 of file PageLayoutController.php.

◆ $colPosList

string TYPO3\CMS\Backend\Controller\PageLayoutController::$colPosList
protected

List of column-integers to edit. Is set from TSconfig, default is "1,0,2,3"

Definition at line 186 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\main().

◆ $content

◆ $current_sys_language

int TYPO3\CMS\Backend\Controller\PageLayoutController::$current_sys_language
protected

Currently selected language for editing content elements

Definition at line 204 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\makeButtons(), and TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $deprecatedPublicMethods

array TYPO3\CMS\Backend\Controller\PageLayoutController::$deprecatedPublicMethods
private
Initial value:
= array(
'init' => 'Using PageLayoutController::init() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'main' => 'Using PageLayoutController::main() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'menuConfig' => 'Using PageLayoutController::menuConfig() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'renderContent' => 'Using PageLayoutController::renderContent() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'clearCache' => 'Using PageLayoutController::clearCache() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'getModuleTemplate' => 'Using PageLayoutController::getModuleTemplate() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'getLocalizedPageTitle' => 'Using PageLayoutController::getLocalizedPageTitle() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'getNumberOfHiddenElements' => 'Using PageLayoutController::getNumberOfHiddenElements() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'local_linkThisScript' => 'Using PageLayoutController::local_linkThisScript() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'pageIsNotLockedForEditors' => 'Using PageLayoutController::pageIsNotLockedForEditors() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'contentIsNotLockedForEditors' => 'Using PageLayoutController::contentIsNotLockedForEditors() is deprecated and will not be possible anymore in TYPO3 v10.0.',
)

Definition at line 57 of file PageLayoutController.php.

◆ $deprecatedPublicProperties

array TYPO3\CMS\Backend\Controller\PageLayoutController::$deprecatedPublicProperties
private
Initial value:
= array(
'pointer' => 'Using PageLayoutController::$pointer is deprecated and will not be possible anymore in TYPO3 v10.0.',
'imagemode' => 'Using PageLayoutController::$imagemode is deprecated and will not be possible anymore in TYPO3 v10.0.',
'search_field' => 'Using PageLayoutController::$search_field is deprecated and will not be possible anymore in TYPO3 v10.0.',
'search_levels' => 'Using PageLayoutController::$search_levels is deprecated and will not be possible anymore in TYPO3 v10.0.',
'showLimit' => 'Using PageLayoutController::$showLimit is deprecated and will not be possible anymore in TYPO3 v10.0.',
'returnUrl' => 'Using PageLayoutController::$returnUrl is deprecated and will not be possible anymore in TYPO3 v10.0.',
'clear_cache' => 'Using PageLayoutController::$clear_cache is deprecated and will not be possible anymore in TYPO3 v10.0.',
'popView' => 'Using PageLayoutController::$popView is deprecated and will not be possible anymore in TYPO3 v10.0.',
'perms_clause' => 'Using PageLayoutController::$perms_clause is deprecated and will not be possible anymore in TYPO3 v10.0.',
'modTSconfig' => 'Using PageLayoutController::$modTSconfig is deprecated and will not be possible anymore in TYPO3 v10.0.',
'modSharedTSconfig' => 'Using PageLayoutController::$modSharedTSconfig is deprecated and will not be possible anymore in TYPO3 v10.0.',
'descrTable' => 'Using PageLayoutController::$descrTable is deprecated and will not be possible anymore in TYPO3 v10.0.',
'colPosList' => 'Using PageLayoutController::$colPosList is deprecated and will not be possible anymore in TYPO3 v10.0.',
'EDIT_CONTENT' => 'Using PageLayoutController::$EDIT_CONTENT is deprecated and will not be possible anymore in TYPO3 v10.0.',
'CALC_PERMS' => 'Using PageLayoutController::$CALC_PERMS is deprecated and will not be possible anymore in TYPO3 v10.0.',
'current_sys_language' => 'Using PageLayoutController::$current_sys_language is deprecated and will not be possible anymore in TYPO3 v10.0.',
'MCONF' => 'Using PageLayoutController::$MCONF is deprecated and will not be possible anymore in TYPO3 v10.0.',
'MOD_MENU' => 'Using PageLayoutController::$MOD_MENU is deprecated and will not be possible anymore in TYPO3 v10.0.',
'content' => 'Using PageLayoutController::$content is deprecated and will not be possible anymore in TYPO3 v10.0.',
'activeColPosList' => 'Using PageLayoutController::$activeColPosList is deprecated and will not be possible anymore in TYPO3 v10.0.',
)

Definition at line 73 of file PageLayoutController.php.

◆ $descrTable

string TYPO3\CMS\Backend\Controller\PageLayoutController::$descrTable
protected

"Pseudo" Description -table name

Definition at line 180 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $EDIT_CONTENT

bool TYPO3\CMS\Backend\Controller\PageLayoutController::$EDIT_CONTENT
protected

Flag: If content can be edited or not.

Definition at line 192 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $editSelect

string TYPO3\CMS\Backend\Controller\PageLayoutController::$editSelect
protected

Definition at line 240 of file PageLayoutController.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Backend\Controller\PageLayoutController::$iconFactory
protected

Definition at line 250 of file PageLayoutController.php.

◆ $id

int TYPO3\CMS\Backend\Controller\PageLayoutController::$id

Page Id for which to make the listing

Definition at line 101 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $imagemode

string TYPO3\CMS\Backend\Controller\PageLayoutController::$imagemode
protected

Thumbnails or not

Definition at line 113 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\renderContent().

◆ $languagesInColumnCache

array TYPO3\CMS\Backend\Controller\PageLayoutController::$languagesInColumnCache = array( )
protected

Caches the available languages in a colPos

Definition at line 246 of file PageLayoutController.php.

◆ $MCONF

array TYPO3\CMS\Backend\Controller\PageLayoutController::$MCONF = array( )
protected

Module configuration

Definition at line 210 of file PageLayoutController.php.

◆ $MOD_MENU

array TYPO3\CMS\Backend\Controller\PageLayoutController::$MOD_MENU = array( )
protected

Menu configuration

Definition at line 216 of file PageLayoutController.php.

◆ $MOD_SETTINGS

array TYPO3\CMS\Backend\Controller\PageLayoutController::$MOD_SETTINGS = array( )

Module settings (session variable)

Definition at line 223 of file PageLayoutController.php.

◆ $modSharedTSconfig

array TYPO3\CMS\Backend\Controller\PageLayoutController::$modSharedTSconfig = array( )
protected

Module shared TSconfig

Definition at line 167 of file PageLayoutController.php.

◆ $modTSconfig

array TYPO3\CMS\Backend\Controller\PageLayoutController::$modTSconfig = array( )
protected

Module TSconfig

Definition at line 161 of file PageLayoutController.php.

◆ $moduleName

string TYPO3\CMS\Backend\Controller\PageLayoutController::$moduleName = 'web_layout'
protected

The name of the module

Definition at line 256 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\init().

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\PageLayoutController::$moduleTemplate
protected

◆ $pageinfo

array TYPO3\CMS\Backend\Controller\PageLayoutController::$pageinfo

Current ids page record

Definition at line 174 of file PageLayoutController.php.

◆ $perms_clause

string TYPO3\CMS\Backend\Controller\PageLayoutController::$perms_clause
protected

Page select perms clause

Definition at line 155 of file PageLayoutController.php.

◆ $pointer

int TYPO3\CMS\Backend\Controller\PageLayoutController::$pointer
protected

Pointer - for browsing list of records.

Definition at line 107 of file PageLayoutController.php.

◆ $popView

bool TYPO3\CMS\Backend\Controller\PageLayoutController::$popView
protected

PopView id - for opening a window with the page

Definition at line 149 of file PageLayoutController.php.

◆ $returnUrl

string TYPO3\CMS\Backend\Controller\PageLayoutController::$returnUrl
protected

Return URL

Definition at line 137 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\init().

◆ $search_field

string TYPO3\CMS\Backend\Controller\PageLayoutController::$search_field
protected

Search-fields

Definition at line 119 of file PageLayoutController.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\init().

◆ $search_levels

int TYPO3\CMS\Backend\Controller\PageLayoutController::$search_levels
protected

Search-levels

Definition at line 125 of file PageLayoutController.php.

◆ $searchContent

string TYPO3\CMS\Backend\Controller\PageLayoutController::$searchContent
protected

◆ $showLimit

int TYPO3\CMS\Backend\Controller\PageLayoutController::$showLimit
protected

Show-limit

Definition at line 131 of file PageLayoutController.php.