‪TYPO3CMS  10.4
TYPO3\CMS\Backend\Controller\Wizard\TableController Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Controller\Wizard\TableController:
TYPO3\CMS\Backend\Controller\Wizard\AbstractWizardController

Public Member Functions

ResponseInterface mainAction (ServerRequestInterface $request)
 

Protected Member Functions

 init (ServerRequestInterface $request)
 
 getButtons ()
 
string ResponseInterface renderTableWizard (ServerRequestInterface $request)
 
array ResponseInterface getConfiguration (array $row, ServerRequestInterface $request)
 
string getTableWizard (array $configuration)
 
 manipulateTable ()
 
string configurationArrayToString (array $cfgArr)
 
array configurationStringToArray (string $configurationCode, int $columns)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Controller\Wizard\AbstractWizardController
bool checkEditAccess ($table, $uid)
 
BackendUserAuthentication getBackendUserAuthentication ()
 
LanguageService getLanguageService ()
 

Protected Attributes

bool $inputStyle = false
 
int $xmlStorage = 0
 
int $numNewRows = 1
 
string $colsFieldName = 'cols'
 
array $P
 
array $TABLECFG
 
string $tableParsing_quote
 
string $tableParsing_delimiter
 
IconFactory $iconFactory
 
ModuleTemplate $moduleTemplate
 

Detailed Description

Script Class for rendering the Table Wizard

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

Definition at line 38 of file TableController.php.

Member Function Documentation

◆ configurationArrayToString()

string TYPO3\CMS\Backend\Controller\Wizard\TableController::configurationArrayToString ( array  $cfgArr)
protected

Converts the input array to a configuration code string

Parameters
array$cfgArr‪Array of table configuration (follows the input structure from the table wizard POST form)
Returns
‪string The array converted into a string with line-based configuration.
See also
configurationStringToArray()

Definition at line 560 of file TableController.php.

References TYPO3\CMS\Backend\Controller\Wizard\TableController\$tableParsing_quote.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\getConfiguration().

◆ configurationStringToArray()

array TYPO3\CMS\Backend\Controller\Wizard\TableController::configurationStringToArray ( string  $configurationCode,
int  $columns 
)
protected

Converts the input configuration code string into an array

Parameters
string$configurationCodeConfiguration code
int$columns‪Default number of columns
Returns
‪array Configuration array
See also
configurationArrayToString()

Definition at line 584 of file TableController.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\getConfiguration().

◆ getButtons()

TYPO3\CMS\Backend\Controller\Wizard\TableController::getButtons ( )
protected

◆ getConfiguration()

array ResponseInterface TYPO3\CMS\Backend\Controller\Wizard\TableController::getConfiguration ( array  $row,
ServerRequestInterface  $request 
)
protected

Will get and return the configuration code string Will also save (and possibly redirect/exit) the content if a save button has been pressed

Parameters
array$row‪Current parent record row
ServerRequestInterface$request
Returns
‪array|ResponseInterface Table config code in an array

Definition at line 241 of file TableController.php.

References TYPO3\CMS\Backend\Controller\Wizard\TableController\$colsFieldName, TYPO3\CMS\Backend\Controller\Wizard\TableController\configurationArrayToString(), TYPO3\CMS\Backend\Controller\Wizard\TableController\configurationStringToArray(), TYPO3\CMS\Backend\Controller\Wizard\TableController\manipulateTable(), and TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\renderTableWizard().

◆ getTableWizard()

string TYPO3\CMS\Backend\Controller\Wizard\TableController::getTableWizard ( array  $configuration)
protected

Creates the HTML for the Table Wizard:

Parameters
array$configuration‪Table config array
Returns
‪string HTML for the table wizard

Definition at line 320 of file TableController.php.

References TYPO3\CMS\Backend\Controller\Wizard\AbstractWizardController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\getLL().

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\renderTableWizard().

◆ init()

TYPO3\CMS\Backend\Controller\Wizard\TableController::init ( ServerRequestInterface  $request)
protected

Initialization of the class

Parameters
ServerRequestInterface$request

Definition at line 147 of file TableController.php.

References TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\mainAction().

◆ mainAction()

ResponseInterface TYPO3\CMS\Backend\Controller\Wizard\TableController::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
Returns
‪ResponseInterface

Definition at line 109 of file TableController.php.

References TYPO3\CMS\Backend\Controller\Wizard\TableController\getButtons(), TYPO3\CMS\Backend\Controller\Wizard\AbstractWizardController\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\includeLLFile(), TYPO3\CMS\Backend\Controller\Wizard\TableController\init(), and TYPO3\CMS\Backend\Controller\Wizard\TableController\renderTableWizard().

◆ manipulateTable()

TYPO3\CMS\Backend\Controller\Wizard\TableController::manipulateTable ( )
protected

Detects if a control button (up/down/around/delete) has been pressed for an item and accordingly it will manipulate the internal TABLECFG array

Definition at line 431 of file TableController.php.

References TYPO3\CMS\Backend\Controller\Wizard\TableController\$numNewRows, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\getConfiguration().

◆ renderTableWizard()

string ResponseInterface TYPO3\CMS\Backend\Controller\Wizard\TableController::renderTableWizard ( ServerRequestInterface  $request)
protected

Member Data Documentation

◆ $colsFieldName

string TYPO3\CMS\Backend\Controller\Wizard\TableController::$colsFieldName = 'cols'
protected

Name of field in parent record which MAY contain the number of columns for the table here hardcoded to the value of tt_content. Should be set by FormEngine parameters (from P)

Definition at line 65 of file TableController.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\getConfiguration().

◆ $iconFactory

IconFactory TYPO3\CMS\Backend\Controller\Wizard\TableController::$iconFactory
protected

Definition at line 94 of file TableController.php.

◆ $inputStyle

bool TYPO3\CMS\Backend\Controller\Wizard\TableController::$inputStyle = false
protected

If TRUE, <input> fields are shown instead of textareas.

Definition at line 44 of file TableController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\Wizard\TableController::$moduleTemplate
protected

ModuleTemplate object

Definition at line 100 of file TableController.php.

◆ $numNewRows

int TYPO3\CMS\Backend\Controller\Wizard\TableController::$numNewRows = 1
protected

Number of new rows to add in bottom of wizard

Definition at line 58 of file TableController.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\manipulateTable().

◆ $P

array TYPO3\CMS\Backend\Controller\Wizard\TableController::$P
protected

Wizard parameters, coming from FormEngine linking to the wizard.

Definition at line 71 of file TableController.php.

◆ $TABLECFG

array TYPO3\CMS\Backend\Controller\Wizard\TableController::$TABLECFG
protected

The array which is constantly submitted by the multidimensional form of this wizard.

Definition at line 77 of file TableController.php.

◆ $tableParsing_delimiter

string TYPO3\CMS\Backend\Controller\Wizard\TableController::$tableParsing_delimiter
protected

delimiter between table cells

Definition at line 90 of file TableController.php.

◆ $tableParsing_quote

string TYPO3\CMS\Backend\Controller\Wizard\TableController::$tableParsing_quote
protected

Table parsing quoting of table cells

Definition at line 84 of file TableController.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\TableController\configurationArrayToString().

◆ $xmlStorage

int TYPO3\CMS\Backend\Controller\Wizard\TableController::$xmlStorage = 0
protected

If set, the string version of the content is interpreted/written as XML instead of the original line-based kind. This variable still needs binding to the wizard parameters - but support is ready!

Definition at line 52 of file TableController.php.