TYPO3  7.6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PageLayoutController Class Reference

Public Member Functions

 init ()
 
 menuConfig ()
 
 clearCache ()
 
 mainAction (ServerRequestInterface $request, ResponseInterface $response)
 
 main ()
 
 getModuleTemplate ()
 
 printContent ()
 
 getNumberOfHiddenElements ()
 
 local_linkThisScript ($params)
 
 exec_languageQuery ($id)
 
 isColumnEmpty ($colPos, $languageId)
 
 getElementsFromColumnAndLanguage ($pageId, $colPos, $languageId)
 
 pageIsNotLockedForEditors ()
 

Public Attributes

 $id
 
 $pointer
 
 $imagemode
 
 $search_field
 
 $search_levels
 
 $showLimit
 
 $returnUrl
 
 $clear_cache
 
 $popView
 
 $edit_record
 
 $new_unique_uid
 
 $perms_clause
 
 $modTSconfig
 
 $modSharedTSconfig
 
 $pageinfo
 
 $descrTable
 
 $colPosList
 
 $EDIT_CONTENT
 
 $CALC_PERMS
 
 $current_sys_language
 
 $MCONF = array()
 
 $MOD_MENU = array()
 
 $MOD_SETTINGS = array()
 
 $externalTables = array()
 
 $content
 
 $activeColPosList
 
 $contentElementCache = array()
 

Protected Member Functions

 makeActionMenu ()
 
 getHeaderFlashMessagesForCurrentPid ()
 
 getLocalizedPageTitle ()
 
 makeButtons ($function= '')
 
 getLanguageService ()
 
 getBackendUser ()
 
 getDatabaseConnection ()
 
 getPageRenderer ()
 
 makeQuickEditMenu ($edit_record)
 
 makeLanguageMenu ()
 

Protected Attributes

 $eRParts = array()
 
 $editSelect
 
 $deleteButton
 
 $undoButton
 
 $undoButtonR
 
 $R_URI
 
 $closeUrl
 
 $languagesInColumnCache = array()
 
 $iconFactory
 
 $moduleName = 'web_layout'
 
 $moduleTemplate
 
 $buttonBar
 
 $searchContent
 

Detailed Description

Script Class for Web > Layout module

Definition at line 50 of file PageLayoutController.php.

Member Function Documentation

clearCache ( )

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

Returns
void

Definition at line 480 of file PageLayoutController.php.

References GeneralUtility\makeInstance().

Referenced by PageLayoutController\mainAction().

exec_languageQuery (   $id)

Returns a SQL query for selecting sys_language records.

Parameters
int$idPage id: If zero, the query will select all sys_language records from root level which are NOT hidden. If set to another value, the query will select all sys_language records that has a pages_language_overlay record on that page (and is not hidden, unless you are admin user)
Returns
string Return query string.

Definition at line 1268 of file PageLayoutController.php.

References PageLayoutController\$id, BackendUtility\deleteClause(), PageLayoutController\getBackendUser(), PageLayoutController\getDatabaseConnection(), and BackendUtility\versioningPlaceholderClause().

Referenced by PageLayoutController\menuConfig().

getBackendUser ( )
protected

Returns the current BE user.

Returns

Definition at line 1368 of file PageLayoutController.php.

References $GLOBALS.

Referenced by PageLayoutController\exec_languageQuery(), PageLayoutController\getElementsFromColumnAndLanguage(), PageLayoutController\init(), PageLayoutController\main(), PageLayoutController\makeActionMenu(), PageLayoutController\makeQuickEditMenu(), PageLayoutController\menuConfig(), and PageLayoutController\pageIsNotLockedForEditors().

getDatabaseConnection ( )
protected

Returns the database connection

Returns

Definition at line 1378 of file PageLayoutController.php.

References $GLOBALS.

Referenced by PageLayoutController\exec_languageQuery(), PageLayoutController\getElementsFromColumnAndLanguage(), PageLayoutController\getLocalizedPageTitle(), PageLayoutController\getNumberOfHiddenElements(), PageLayoutController\makeActionMenu(), PageLayoutController\makeButtons(), PageLayoutController\makeQuickEditMenu(), and PageLayoutController\menuConfig().

getElementsFromColumnAndLanguage (   $pageId,
  $colPos,
  $languageId 
)

Get elements for a column and a language

Parameters
int$pageId
int$colPos
int$languageId
Returns
array

Definition at line 1317 of file PageLayoutController.php.

References BackendUtility\deleteClause(), PageLayoutController\getBackendUser(), and PageLayoutController\getDatabaseConnection().

getHeaderFlashMessagesForCurrentPid ( )
protected

Generate the flashmessages for current pid

Returns
string HTML content with flashmessages

Definition at line 495 of file PageLayoutController.php.

References PageLayoutController\$content, $GLOBALS, $lang, PageRepository\DOKTYPE_SYSFOLDER, GeneralUtility\getFileAbsFileName(), PageLayoutController\getLanguageService(), BackendUtility\getRecord(), BackendUtility\getRecordTitle(), PageLayoutController\local_linkThisScript(), GeneralUtility\makeInstance(), and InfoboxViewHelper\STATE_INFO.

Referenced by PageLayoutController\main().

getLanguageService ( )
protected

Returns LanguageService

Returns

Definition at line 1358 of file PageLayoutController.php.

References $GLOBALS.

Referenced by PageLayoutController\getHeaderFlashMessagesForCurrentPid(), PageLayoutController\init(), PageLayoutController\main(), PageLayoutController\makeActionMenu(), PageLayoutController\makeButtons(), PageLayoutController\makeLanguageMenu(), PageLayoutController\makeQuickEditMenu(), and PageLayoutController\menuConfig().

getLocalizedPageTitle ( )
protected
Returns
string $title

Definition at line 542 of file PageLayoutController.php.

References BackendUtility\deleteClause(), PageLayoutController\getDatabaseConnection(), and BackendUtility\versioningPlaceholderClause().

Referenced by PageLayoutController\main().

getModuleTemplate ( )
Returns
ModuleTemplate

Definition at line 1027 of file PageLayoutController.php.

References PageLayoutController\$moduleTemplate.

getNumberOfHiddenElements ( )

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

Returns
int

Definition at line 1239 of file PageLayoutController.php.

References BackendUtility\BEenableFields(), BackendUtility\deleteClause(), PageLayoutController\getDatabaseConnection(), and BackendUtility\versioningPlaceholderClause().

getPageRenderer ( )
protected

Returns current PageRenderer

Returns
PageRenderer

Definition at line 1388 of file PageLayoutController.php.

References GeneralUtility\makeInstance().

init ( )

Initializing the module

Returns
void

Definition at line 321 of file PageLayoutController.php.

References $GLOBALS, PageLayoutController\$moduleName, PageLayoutController\$search_field, GeneralUtility\_GP(), PageLayoutController\getBackendUser(), PageLayoutController\getLanguageService(), GeneralUtility\makeInstance(), PageLayoutController\menuConfig(), BackendUtility\readPageAccess(), and GeneralUtility\sanitizeLocalUrl().

Referenced by PageLayoutController\mainAction().

isColumnEmpty (   $colPos,
  $languageId 
)

Check if a column of a page for a language is empty. Translation records are ignored here!

Parameters
int$colPos
int$languageId
Returns
bool

Definition at line 1299 of file PageLayoutController.php.

local_linkThisScript (   $params)

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

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

Definition at line 1255 of file PageLayoutController.php.

References GeneralUtility\linkThisScript().

Referenced by PageLayoutController\getHeaderFlashMessagesForCurrentPid(), and PageLayoutController\makeQuickEditMenu().

main ( )

Main function. Creates some general objects and calls other functions for the main rendering of module content.

Returns
void

Definition at line 586 of file PageLayoutController.php.

References PageLayoutController\$colPosList, PageLayoutController\$content, $GLOBALS, $lang, PageLayoutController\$searchContent, BackendUtility\BEgetRootLine(), GeneralUtility\callUserFunction(), PageLayoutController\getBackendUser(), GeneralUtility\getFileAbsFileName(), PageLayoutController\getHeaderFlashMessagesForCurrentPid(), PageLayoutController\getLanguageService(), PageLayoutController\getLocalizedPageTitle(), GeneralUtility\intExplode(), PageLayoutController\makeButtons(), GeneralUtility\makeInstance(), PageLayoutController\makeLanguageMenu(), PageLayoutController\pageIsNotLockedForEditors(), GeneralUtility\quoteJSvalue(), InfoboxViewHelper\STATE_INFO, and BackendUtility\viewOnClick().

Referenced by PageLayoutController\mainAction().

mainAction ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

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$requestthe current request
ResponseInterface$response
Returns
ResponseInterface the response with the content

Definition at line 570 of file PageLayoutController.php.

References $GLOBALS, $response, PageLayoutController\clearCache(), MessageInterface\getBody(), PageLayoutController\init(), and PageLayoutController\main().

makeActionMenu ( )
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.

Returns
void

Definition at line 424 of file PageLayoutController.php.

References $GLOBALS, PageLayoutController\getBackendUser(), PageLayoutController\getDatabaseConnection(), PageLayoutController\getLanguageService(), BackendUtility\getModTSconfig(), GeneralUtility\inList(), and BackendUtility\unsetMenuItems().

Referenced by PageLayoutController\menuConfig().

makeButtons (   $function = '')
protected

This creates the buttons for die modules

Parameters
string$functionIdentifier for function of module
Returns
void

Definition at line 1053 of file PageLayoutController.php.

References PageLayoutController\$deleteButton, $GLOBALS, $lang, PageLayoutController\$undoButton, BackendUtility\BEgetRootLine(), ButtonBar\BUTTON_POSITION_LEFT, ButtonBar\BUTTON_POSITION_RIGHT, BackendUtility\calcAge(), MathUtility\canBeInterpretedAsInteger(), Enumeration\cast(), VersionState\DELETE_PLACEHOLDER, BackendUtility\deleteClause(), BackendUtility\editOnClick(), PageLayoutController\getDatabaseConnection(), GeneralUtility\getIndpEnv(), PageLayoutController\getLanguageService(), PageLayoutController\pageIsNotLockedForEditors(), GeneralUtility\quoteJSvalue(), Icon\SIZE_SMALL, BackendUtility\versioningPlaceholderClause(), and BackendUtility\viewOnClick().

Referenced by PageLayoutController\main().

makeLanguageMenu ( )
protected

Make the LanguageMenu

Returns
void

Definition at line 1516 of file PageLayoutController.php.

References $lang, and PageLayoutController\getLanguageService().

Referenced by PageLayoutController\main().

makeQuickEditMenu (   $edit_record)
protected
Parameters
$edit_recordarray
Returns
array

Definition at line 1398 of file PageLayoutController.php.

References PageLayoutController\$edit_record, PageLayoutController\$id, $lang, PageLayoutController\$returnUrl, BackendUtility\BEenableFields(), BackendUtility\deleteClause(), GeneralUtility\fixed_lgd_cs(), PageLayoutController\getBackendUser(), PageLayoutController\getDatabaseConnection(), BackendUtility\getLabelFromItemlist(), PageLayoutController\getLanguageService(), BackendUtility\getRecordsByField(), PageLayoutController\local_linkThisScript(), BackendUtility\versioningPlaceholderClause(), and BackendUtility\workspaceOL().

menuConfig ( )

Initialize menu array

Returns
void

Definition at line 364 of file PageLayoutController.php.

References $lang, GeneralUtility\_GP(), PageLayoutController\exec_languageQuery(), PageLayoutController\getBackendUser(), PageLayoutController\getDatabaseConnection(), PageLayoutController\getLanguageService(), BackendUtility\getModuleData(), and PageLayoutController\makeActionMenu().

Referenced by PageLayoutController\init().

pageIsNotLockedForEditors ( )

Check the editlock access

Returns
bool

Definition at line 1348 of file PageLayoutController.php.

References PageLayoutController\getBackendUser(), and Permission\PAGE_EDIT.

Referenced by PageLayoutController\main(), and PageLayoutController\makeButtons().

printContent ( )

Print accumulated content of module

Returns
void

Definition at line 1037 of file PageLayoutController.php.

Member Data Documentation

$activeColPosList

Definition at line 237 of file PageLayoutController.php.

$buttonBar
protected

Definition at line 309 of file PageLayoutController.php.

$CALC_PERMS

Definition at line 187 of file PageLayoutController.php.

$clear_cache

Definition at line 107 of file PageLayoutController.php.

$closeUrl
protected

Definition at line 272 of file PageLayoutController.php.

$colPosList

Definition at line 173 of file PageLayoutController.php.

Referenced by PageLayoutController\main().

$content

Definition at line 229 of file PageLayoutController.php.

Referenced by PageLayoutController\getHeaderFlashMessagesForCurrentPid(), and PageLayoutController\main().

$contentElementCache = array()

Definition at line 287 of file PageLayoutController.php.

$current_sys_language

Definition at line 194 of file PageLayoutController.php.

$deleteButton
protected

Definition at line 252 of file PageLayoutController.php.

Referenced by PageLayoutController\makeButtons().

$descrTable

Definition at line 166 of file PageLayoutController.php.

$EDIT_CONTENT

Definition at line 180 of file PageLayoutController.php.

$edit_record

Definition at line 122 of file PageLayoutController.php.

Referenced by PageLayoutController\makeQuickEditMenu().

$editSelect
protected

Definition at line 247 of file PageLayoutController.php.

$eRParts = array()
protected

Definition at line 242 of file PageLayoutController.php.

$externalTables = array()

Definition at line 222 of file PageLayoutController.php.

$iconFactory
protected

Definition at line 292 of file PageLayoutController.php.

$id

Definition at line 58 of file PageLayoutController.php.

Referenced by PageLayoutController\exec_languageQuery(), and PageLayoutController\makeQuickEditMenu().

$imagemode

Definition at line 72 of file PageLayoutController.php.

$languagesInColumnCache = array()
protected

Definition at line 279 of file PageLayoutController.php.

$MCONF = array()

Definition at line 201 of file PageLayoutController.php.

$MOD_MENU = array()

Definition at line 208 of file PageLayoutController.php.

$MOD_SETTINGS = array()

Definition at line 215 of file PageLayoutController.php.

$modSharedTSconfig

Definition at line 151 of file PageLayoutController.php.

$modTSconfig

Definition at line 144 of file PageLayoutController.php.

$moduleName = 'web_layout'
protected

Definition at line 299 of file PageLayoutController.php.

Referenced by PageLayoutController\init().

$moduleTemplate
protected

Definition at line 304 of file PageLayoutController.php.

Referenced by PageLayoutController\getModuleTemplate().

$new_unique_uid

Definition at line 130 of file PageLayoutController.php.

$pageinfo

Definition at line 158 of file PageLayoutController.php.

$perms_clause

Definition at line 137 of file PageLayoutController.php.

$pointer

Definition at line 65 of file PageLayoutController.php.

$popView

Definition at line 114 of file PageLayoutController.php.

$R_URI
protected

Definition at line 267 of file PageLayoutController.php.

$returnUrl

Definition at line 100 of file PageLayoutController.php.

Referenced by PageLayoutController\makeQuickEditMenu().

$search_field

Definition at line 79 of file PageLayoutController.php.

Referenced by PageLayoutController\init().

$search_levels

Definition at line 86 of file PageLayoutController.php.

$searchContent
protected

Definition at line 314 of file PageLayoutController.php.

Referenced by PageLayoutController\main().

$showLimit

Definition at line 93 of file PageLayoutController.php.

$undoButton
protected

Definition at line 257 of file PageLayoutController.php.

Referenced by PageLayoutController\makeButtons().

$undoButtonR
protected

Definition at line 262 of file PageLayoutController.php.

Generated on Wed Nov 11 2015 01:52:19 for TYPO3 by   doxygen 1.8.3