TableManualRepository

class \TYPO3\CMS\Backend\Domain\Repository\TableManualRepository

Table manual repository for csh manual handling

Table of Contents

Methods

getSections()  : array
Get TOC sections
getSingleManual()  : array
Get a single manual
getTableManual()  : array
Get the manual of the given table
checkAccess()  : bool
Check if current backend user has access to given identifier
getBackendUser()  : BackendUserAuthentication
Returns the current BE user.
getFieldSetup()  : array
Returns the setup for given table / field
getImages()  : array
Returns an array of images with description
getItem()  : array
Gets a single $table/$field information piece If $anchors is set, then seeAlso references to the same table will be page-anchors, not links.
getLanguageService()  : LanguageService
Returns LanguageService
getSeeAlsoLinks()  : array
Get see-also links
getTableFieldLabel()  : string
Returns composite label for table/field
getTableFieldNames()  : array
Returns labels for a given field in a given structure
getTableSetup()  : array
Returns the setup for given table
isExcludableField()  : bool
Check if given table / field is excludable
renderTableOfContentItem()  : mixed
Creates a TOC list element and renders corresponding HELP content if "renderALL" mode is set.

Methods

getSections()

Get TOC sections

public getSections(int $mode) : array

Parameters

$mode : int

e.g. HelpController::TOC_ONLY

Return values

array

getSingleManual()

Get a single manual

public getSingleManual(string $table, string $field) : array

Parameters

$table : string

table name

$field : string

field name

Return values

array

getTableManual()

Get the manual of the given table

public getTableManual(string $table) : array

Parameters

$table : string

Return values

array —

the manual for a TCA table, see getItem() for details

checkAccess()

Check if current backend user has access to given identifier

protected checkAccess(string $type, string $identifier) : bool

Parameters

$type : string

The type

$identifier : string

The search string in access list

Return values

bool —

TRUE if the user has access

getFieldSetup()

Returns the setup for given table / field

protected getFieldSetup(string $table, string $field[, bool $allowEmptyField = false ]) : array

Parameters

$table : string

The table

$field : string

The field

$allowEmptyField : bool = false

Allow empty field

Return values

array —

The field setup

getImages()

Returns an array of images with description

protected getImages(string $images, string $descriptions) : array

Parameters

$images : string

Image file reference (list of)

$descriptions : string

Description string (divided for each image by line break)

Return values

array

getItem()

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

protected getItem(string $table, string $field[, bool $anchors = false ]) : array

Parameters

$table : string

CSH key / table name

$field : string

Sub key / field name

$anchors : bool = false

If anchors is to be shown.

Return values

array —

with the information

Get see-also links

protected getSeeAlsoLinks(string $value[, string $anchorTable = '' ]) : array

Parameters

$value : string

See-also input codes

$anchorTable : string = ''

If $anchorTable is set to a tablename, then references to this table will be made as anchors, not URLs.

Return values

array —

See-also links

getTableFieldLabel()

Returns composite label for table/field

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

Parameters

$key : string

CSH key / table name

$field : string = ''

Sub key / field name

$mergeToken : string = ': '

Token to merge the two strings with

Tags

see
getTableFieldNames()

Return values

string —

Labels joined with merge token

getTableFieldNames()

Returns labels for a given field in a given structure

protected getTableFieldNames(string $key, string $field) : array

Parameters

$key : string

CSH key / table name

$field : string

Sub key / field name

Return values

array —

Table and field labels in a numeric array

getTableSetup()

Returns the setup for given table

protected getTableSetup(string $table) : array

Parameters

$table : string

The table

Return values

array —

The table setup

isExcludableField()

Check if given table / field is excludable

protected isExcludableField(string $table, string $field) : bool

Parameters

$table : string

The table

$field : string

The field

Return values

bool —

TRUE if given field is excludable

renderTableOfContentItem()

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

protected renderTableOfContentItem(int $mode, string $table, string $tocCat, array &$outputSections, array &$tocArray, array &$CSHkeys) : mixed

Parameters

$mode : int

Mode

$table : string

CSH key / Table name

$tocCat : string

TOC category keyword: "core", "modules", "tables", "other

$outputSections : array

Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference!

$tocArray : array

TOC array; Here TOC index elements are created. Passed by reference!

$CSHkeys : array

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!

On this page