Public Member Functions
	__construct ()

ResponseInterface	handleRequest (ServerRequestInterface $request)

Protected Member Functions
	overviewAction ()

	editAction (ServerRequestInterface $request)

ResponseInterface	saveAction (ServerRequestInterface $request)

mixed	validateAndProcessIdentifier (bool $isNew, string $identifier, int $rootPageId)

mixed	validateAndProcessValue (string $tableName, string $fieldName, $fieldValue)

array	validateFullStructure (array $newSysSiteData)

ResponseInterface	deleteAction (ServerRequestInterface $request)

	initializeView (string $templateName)

	configureEditViewDocHeader ()

	configureOverViewDocHeader ()

array	getAllSitePages ()

array	getDuplicatedEntryPoints (array $allSites, array $pages)

LanguageService	getLanguageService ()

BackendUserAuthentication	getBackendUser ()

Protected Attributes
const	ALLOWED_ACTIONS = ['overview', 'edit', 'save', 'delete']

ModuleTemplate	$moduleTemplate

ViewInterface	$view

SiteFinder	$siteFinder

Detailed Description

Backend controller: The "Site management" -> "Sites" module

List all site root pages, CRUD site configuration.

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 60 of file SiteConfigurationController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::__construct ( )

Default constructor

Definition at line 79 of file SiteConfigurationController.php.

Member Function Documentation

◆ configureEditViewDocHeader()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::configureEditViewDocHeader ( )

protected

Create document header buttons of "edit" action

Definition at line 606 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Controller\SiteConfigurationController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\editAction().

◆ configureOverViewDocHeader()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::configureOverViewDocHeader ( )

protected

Create document header buttons of "overview" action

Definition at line 631 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Controller\SiteConfigurationController\getBackendUser(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\overviewAction().

◆ deleteAction()

ResponseInterface TYPO3\CMS\Backend\Controller\SiteConfigurationController::deleteAction ( ServerRequestInterface $request )

protected

Delete an existing configuration

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface

Definition at line 576 of file SiteConfigurationController.php.

◆ editAction()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::editAction ( ServerRequestInterface $request )

protected

Shows a form to create a new site configuration, or edit an existing one.

Parameters

ServerRequestInterface $request

Exceptions

Definition at line 147 of file SiteConfigurationController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureEditViewDocHeader().

◆ getAllSitePages()

array TYPO3\CMS\Backend\Controller\SiteConfigurationController::getAllSitePages ( )

protected

Returns a list of pages that have 'is_siteroot' set

Returns: ‪array

Definition at line 654 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), and TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SYSFOLDER.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\overviewAction().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Controller\SiteConfigurationController::getBackendUser ( )

protected

Returns: ‪BackendUserAuthentication

Definition at line 733 of file SiteConfigurationController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureOverViewDocHeader().

◆ getDuplicatedEntryPoints()

array TYPO3\CMS\Backend\Controller\SiteConfigurationController::getDuplicatedEntryPoints	(	array	$allSites,
		array	$pages
	)

protected

Get all entry duplicates which are used multiple times

Parameters

Site[]	$allSites
array	$pages

Returns: ‪array

Definition at line 697 of file SiteConfigurationController.php.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\overviewAction().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\Controller\SiteConfigurationController::getLanguageService ( )

protected

Returns: ‪LanguageService

Definition at line 725 of file SiteConfigurationController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureEditViewDocHeader(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureOverViewDocHeader(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessIdentifier(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessValue(), and TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateFullStructure().

◆ handleRequest()

ResponseInterface TYPO3\CMS\Backend\Controller\SiteConfigurationController::handleRequest ( ServerRequestInterface $request )

Main entry method: Dispatch to other actions - those method names that end with "Action".

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the response with the content

Definition at line 91 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Controller\SiteConfigurationController\initializeView().

◆ initializeView()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::initializeView ( string $templateName )

protected

Sets up the Fluid View.

Parameters

string $templateName

Definition at line 594 of file SiteConfigurationController.php.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\handleRequest().

◆ overviewAction()

TYPO3\CMS\Backend\Controller\SiteConfigurationController::overviewAction ( )

protected

List pages that have 'is_siteroot' flag set - those that have the globe icon in page tree. Link to Add / Edit / Delete for each.

Definition at line 118 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureOverViewDocHeader(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\getAllSitePages(), and TYPO3\CMS\Backend\Controller\SiteConfigurationController\getDuplicatedEntryPoints().

◆ saveAction()

ResponseInterface TYPO3\CMS\Backend\Controller\SiteConfigurationController::saveAction ( ServerRequestInterface $request )

protected

Save incoming data from editAction and redirect to overview or edit

Parameters

ServerRequestInterface $request

Returns: ‪ResponseInterface

Exceptions

Definition at line 211 of file SiteConfigurationController.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessIdentifier(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessValue(), and TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateFullStructure().

◆ validateAndProcessIdentifier()

mixed TYPO3\CMS\Backend\Controller\SiteConfigurationController::validateAndProcessIdentifier	(	bool	$isNew,
		string	$identifier,
		int	$rootPageId
	)

protected

Validation and processing of site identifier

Parameters

bool	$isNew	‪If true, we're dealing with a new record
string	$identifier	‪Given identifier to validate and process
int	$rootPageId	‪Page uid this identifier is bound to

Returns: ‪mixed Verified / modified value

Definition at line 367 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Controller\SiteConfigurationController\getLanguageService(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessValue(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\saveAction().

◆ validateAndProcessValue()

mixed TYPO3\CMS\Backend\Controller\SiteConfigurationController::validateAndProcessValue	(	string	$tableName,
		string	$fieldName,
			$fieldValue
	)

protected

Simple validation and processing method for incoming form field values.

Note this does not support all TCA "eval" options but only what we really need.

Parameters

string	$tableName	‪Table name
string	$fieldName	‪Field name
mixed	$fieldValue	‪Incoming value from FormEngine

Returns: ‪mixed Verified / modified value

Exceptions

SiteValidationErrorException

Definition at line 434 of file SiteConfigurationController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\SiteConfigurationController\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\saveAction(), and TYPO3\CMS\Backend\Controller\SiteConfigurationController\validateAndProcessIdentifier().

◆ validateFullStructure()

array TYPO3\CMS\Backend\Controller\SiteConfigurationController::validateFullStructure ( array $newSysSiteData )

protected

Last sanitation method after all data has been gathered. Check integrity of full record, manipulate if possible, or throw exception if unfixable broken.

Parameters

array $newSysSiteData ‪Incoming data

Returns: ‪array Updated data if needed

Exceptions

Definition at line 499 of file SiteConfigurationController.php.

References TYPO3\CMS\Backend\Controller\SiteConfigurationController\getLanguageService(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

Referenced by TYPO3\CMS\Backend\Controller\SiteConfigurationController\saveAction().

Member Data Documentation

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\SiteConfigurationController::$moduleTemplate

protected

Definition at line 66 of file SiteConfigurationController.php.

◆ $siteFinder

SiteFinder TYPO3\CMS\Backend\Controller\SiteConfigurationController::$siteFinder

protected

Definition at line 74 of file SiteConfigurationController.php.

◆ $view

ViewInterface TYPO3\CMS\Backend\Controller\SiteConfigurationController::$view

protected

Definition at line 70 of file SiteConfigurationController.php.

◆ ALLOWED_ACTIONS

const TYPO3\CMS\Backend\Controller\SiteConfigurationController::ALLOWED_ACTIONS = ['overview', 'edit', 'save', 'delete']

protected

Definition at line 62 of file SiteConfigurationController.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ configureEditViewDocHeader()

◆ configureOverViewDocHeader()

◆ deleteAction()

◆ editAction()

◆ getAllSitePages()

◆ getBackendUser()

◆ getDuplicatedEntryPoints()

◆ getLanguageService()

◆ handleRequest()

◆ initializeView()

◆ overviewAction()

◆ saveAction()

◆ validateAndProcessIdentifier()

◆ validateAndProcessValue()

◆ validateFullStructure()

Member Data Documentation

◆ $moduleTemplate

◆ $siteFinder

◆ $view

◆ ALLOWED_ACTIONS