Public Member Functions
array	getTableManual ($table)

array	getSingleManual ($table, $field)

array	getSections ($mode)

Protected Member Functions
	renderTableOfContentItem ($mode, $table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)

string	getTableFieldLabel ($key, $field='', $mergeToken=':')

array	getTableFieldNames ($key, $field)

array	getItem ($table, $field, $anchors=false)

array	getSeeAlsoLinks ($value, $anchorTable='')

bool	isExcludableField ($table, $field)

array	getImages ($images, $descriptions)

array	getTableSetup ($table)

array	getFieldSetup ($table, $field, $allowEmptyField=false)

bool	checkAccess ($type, $identifier)

BackendUserAuthentication	getBackendUser ()

TYPO3 CMS Core Localization LanguageService	getLanguageService ()

Detailed Description

Table manual repository for csh manual handling

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

Definition at line 29 of file TableManualRepository.php.

Member Function Documentation

◆ checkAccess()

bool TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::checkAccess	(	$type,
		$identifier
	)

protected

Check if current backend user has access to given identifier

Parameters

string	$type	‪The type
string	$identifier	‪The search string in access list

Returns: ‪bool TRUE if the user has access

Definition at line 410 of file TableManualRepository.php.

References TYPO3\CMS\Core\Authentication\BackendUserAuthentication\check(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getBackendUser().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSections(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSeeAlsoLinks(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableManual().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getBackendUser ( )

protected

Returns the current BE user.

Returns: ‪BackendUserAuthentication

Definition at line 423 of file TableManualRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\checkAccess().

◆ getFieldSetup()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getFieldSetup	(	$table,
		$field,
		$allowEmptyField = `false`
	)

protected

Returns the setup for given table / field

Parameters

string	$table	‪The table
string	$field	‪The field
bool	$allowEmptyField	‪Allow empty field

Returns: ‪array The field setup

Definition at line 394 of file TableManualRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableSetup().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\isExcludableField().

◆ getImages()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getImages	(	$images,
		$descriptions
	)

protected

Returns an array of images with description

Parameters

string	$images	‪Image file reference (list of)
string	$descriptions	‪Description string (divided for each image by line break)

Returns: ‪array

Definition at line 347 of file TableManualRepository.php.

References TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getItem().

◆ getItem()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getItem	(	$table,
		$field,
		$anchors = `false`
	)

protected

Gets a single $table/$field information piece If $anchors is set, then seeAlso references to the same table will be page-anchors, not links.

Parameters

string	$table	‪CSH key / table name
string	$field	‪Sub key / field name
bool	$anchors	‪If anchors is to be shown.

Returns: ‪array with the information

Definition at line 231 of file TableManualRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getImages(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSeeAlsoLinks(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldLabel().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSingleManual(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableManual().

◆ getLanguageService()

TYPO3 CMS Core Localization LanguageService TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getLanguageService ( )

protected

Returns LanguageService

Returns: ‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 433 of file TableManualRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSections(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSingleManual(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldLabel(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldNames(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableManual().

◆ getSections()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getSections ( $mode )

Get TOC sections

Parameters

int $mode ‪e.g. HelpController::TOC_ONLY

Returns: ‪array

Definition at line 85 of file TableManualRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\checkAccess(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getLanguageService(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\renderTableOfContentItem(), and TYPO3\CMS\Backend\Controller\HelpController\TOC_ONLY.

◆ getSeeAlsoLinks()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getSeeAlsoLinks	(	$value,
		$anchorTable = `''`
	)

protected

Get see-also links

Parameters

string	$value	‪See-also input codes
string	$anchorTable	‪If $anchorTable is set to a tablename, then references to this table will be made as anchors, not URLs.

Returns: ‪array See-also links

Definition at line 256 of file TableManualRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\checkAccess(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldLabel(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableSetup(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\isExcludableField(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getItem().

◆ getSingleManual()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getSingleManual	(	$table,
		$field
	)

Get a single manual

Parameters

string	$table	‪table name
string	$field	‪field name

Returns: ‪array

Definition at line 73 of file TableManualRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getItem(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getLanguageService().

◆ getTableFieldLabel()

string TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getTableFieldLabel	(	$key,
		$field = `''`,
		$mergeToken = `': '`
	)

protected

Returns composite label for table/field

Parameters

string	$key	‪CSH key / table name
string	$field	‪Sub key / field name
string	$mergeToken	‪Token to merge the two strings with

Returns: ‪string Labels joined with merge token

See also: ‪getTableFieldNames()

Definition at line 181 of file TableManualRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getLanguageService(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldNames().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getItem(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSeeAlsoLinks(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\renderTableOfContentItem().

◆ getTableFieldNames()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getTableFieldNames	(	$key,
		$field
	)

protected

Returns labels for a given field in a given structure

Parameters

string	$key	‪CSH key / table name
string	$field	‪Sub key / field name

Returns: ‪array Table and field labels in a numeric array

Definition at line 196 of file TableManualRepository.php.

References $GLOBALS, and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getLanguageService().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldLabel().

◆ getTableManual()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getTableManual ( $table )

Get the manual of the given table

Parameters

string $table

Returns: ‪array the manual for a TCA table, see getItem() for details

Definition at line 37 of file TableManualRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\checkAccess(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getItem(), TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getLanguageService(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\isExcludableField().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\renderTableOfContentItem().

◆ getTableSetup()

array TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::getTableSetup ( $table )

protected

Returns the setup for given table

Parameters

string $table ‪The table

Returns: ‪array The table setup

Definition at line 378 of file TableManualRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getFieldSetup(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSeeAlsoLinks().

◆ isExcludableField()

bool TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::isExcludableField	(	$table,
		$field
	)

protected

Check if given table / field is excludable

Parameters

string	$table	‪The table
string	$field	‪The field

Returns: ‪bool TRUE if given field is excludable

Definition at line 331 of file TableManualRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getFieldSetup().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSeeAlsoLinks(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableManual().

◆ renderTableOfContentItem()

TYPO3\CMS\Backend\Domain\Repository\TableManualRepository::renderTableOfContentItem	(		$mode,
			$table,
			$tocCat,
		&	$outputSections,
		&	$tocArray,
		&	$CSHkeys
	)

protected

Creates a TOC list element and renders corresponding HELP content if "renderALL" mode is set.

Parameters

int	$mode	‪Mode
string	$table	‪CSH key / Table name
string	$tocCat	‪TOC category keyword: "core", "modules", "tables", "other @param array $outputSections Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference!
array	$tocArray	‪TOC array; Here TOC index elements are created. Passed by reference!
array	$CSHkeys	‪CSH keys array. Every item rendered will be unset in this array so finally we can see what CSH keys are not processed yet. Passed by reference!

Definition at line 157 of file TableManualRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableFieldLabel(), and TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getTableManual().

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSections().

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ checkAccess()

◆ getBackendUser()

◆ getFieldSetup()

◆ getImages()

◆ getItem()

◆ getLanguageService()

◆ getSections()

◆ getSeeAlsoLinks()

◆ getSingleManual()

◆ getTableFieldLabel()

◆ getTableFieldNames()

◆ getTableManual()

◆ getTableSetup()

◆ isExcludableField()

◆ renderTableOfContentItem()