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

Public Member Functions

 init ($pObj)
 
string main ()
 
- ‪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 Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed __call (string $methodName, array $arguments)
 

Protected Member Functions

array tableRowData ($label, $data, $field, $id)
 
bool initialize_editor ($pageId, $template_uid=0)
 
 handleExternalFunctionValue ()
 
LanguageService getLanguageService ()
 

Protected Attributes

bool $tce_processed = false
 
TypoScriptTemplateModuleController $pObj
 
array $templateRow
 
ExtendedTemplateService $templateService
 
 $id
 
string $localLangFile = ''
 
array $extClassConf
 
string $function_key = ''
 

Private Attributes

array $deprecatedPublicProperties
 
array $deprecatedPublicMethods
 

Detailed Description

This class displays the Info/Modify screen of the Web > Template module

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

Definition at line 30 of file TypoScriptTemplateInformationModuleFunctionController.php.

Member Function Documentation

◆ getLanguageService()

LanguageService TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::getLanguageService ( )
protected

◆ handleExternalFunctionValue()

TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::handleExternalFunctionValue ( )
protected

If $this->function_key is set (which means there are two levels of object connectivity) then $this->extClassConf is loaded with the TBE_MODULES_EXT configuration for that sub-sub-module

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 260 of file TypoScriptTemplateInformationModuleFunctionController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getModuleData().

◆ init()

TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::init (   $pObj)

◆ initialize_editor()

bool TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::initialize_editor (   $pageId,
  $template_uid = 0 
)
protected

Create an instance of \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService and looks for the first (visible) template record. If $template_uid was given and greater than zero, this record will be checked.

Initializes the module. Done in this function because we may need to re-initialize if data is submitted!

Parameters
int$pageId‪The uid of the current page
int$template_uid‪The uid of the template record to be rendered (only if more than one template on the current page)
Returns
‪bool Returns TRUE if a template record was found, otherwise FALSE

Definition at line 162 of file TypoScriptTemplateInformationModuleFunctionController.php.

Referenced by TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\main().

◆ main()

◆ tableRowData()

array TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::tableRowData (   $label,
  $data,
  $field,
  $id 
)
protected

Gets the data for a row of a HTML table in the fluid template

Parameters
string$label‪The label to be shown (e.g. 'Title:', 'Sitetitle:')
string$data‪The data/information to be shown (e.g. 'Template for my site')
string$field‪The field/variable to be sent on clicking the edit icon (e.g. 'title', 'sitetitle')
int$id‪The field/variable to be sent on clicking the edit icon (e.g. 'title', 'sitetitle')
Returns
‪array Data for a row of a HTML table

Definition at line 127 of file TypoScriptTemplateInformationModuleFunctionController.php.

References TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\$id.

Referenced by TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\main().

Member Data Documentation

◆ $deprecatedPublicMethods

array TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$deprecatedPublicMethods
private
Initial value:
= array(
'initialize_editor' => 'Using TypoScriptTemplateInformationModuleFunctionController::initialize_editor() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'tableRowData' => 'Using TypoScriptTemplateInformationModuleFunctionController::tableRowData() is deprecated and will not be possible anymore in TYPO3 v10.0.',
'handleExternalFunctionValue' => 'Using TypoScriptTemplateInformationModuleFunctionController::handleExternalFunctionValue() is deprecated, method will be removed in TYPO3 v10.0.',
)

Definition at line 45 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $deprecatedPublicProperties

array TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$deprecatedPublicProperties
private
Initial value:
= array(
'pObj' => 'Using TypoScriptTemplateInformationModuleFunctionController::$pObj is deprecated and will not be possible anymore in TYPO3 v10.0.',
'function_key' => 'Using TypoScriptTemplateInformationModuleFunctionController::$function_key is deprecated, property will be removed in TYPO3 v10.0.',
'extClassConf' => 'Using TypoScriptTemplateInformationModuleFunctionController::$extClassConf is deprecated, property will be removed in TYPO3 v10.0.',
'localLangFile' => 'Using TypoScriptTemplateInformationModuleFunctionController::$localLangFile is deprecated, property will be removed in TYPO3 v10.0.',
'tce_processed' => 'Using TypoScriptTemplateInformationModuleFunctionController::$tce_processed is deprecated, property will be removed in TYPO3 v10.0.',
)

Definition at line 35 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $extClassConf

array TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$extClassConf
protected

Contains module configuration parts from TBE_MODULES_EXT if found

See also
handleExternalFunctionValue()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 91 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $function_key

string TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$function_key = ''
protected

If this value is set it points to a key in the TBE_MODULES_EXT array (not on the top level..) where another classname/filepath/title can be defined for sub-subfunctions. This is a little hard to explain, so see it in action; it used in the extension 'func_wizards' in order to provide yet a layer of interfacing with the backend module. The extension 'func_wizards' has this description: 'Adds the 'Wizards' item to the function menu in Web>Func. This is just a framework for wizard extensions.' - so as you can see it is designed to allow further connectivity - 'level 2'

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 100 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $id

◆ $localLangFile

string TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$localLangFile = ''
protected

Can be hardcoded to the name of a locallang.xlf file (from the same directory as the class file) to use/load and is included / added to $GLOBALS['LOCAL_LANG']

See also
init()
Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 83 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $pObj

TypoScriptTemplateModuleController TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$pObj
protected

◆ $tce_processed

bool TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$tce_processed = false
protected

Indicator for t3editor, whether data is stored

Deprecated:
‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 56 of file TypoScriptTemplateInformationModuleFunctionController.php.

◆ $templateRow

array TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$templateRow
protected

◆ $templateService

ExtendedTemplateService TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController::$templateService
protected