TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository Class Reference

Public Member Functions

 __construct ()
 
 getTableManual ($table)
 
 getSingleManual ($table, $field)
 
 getSections ($mode)
 

Protected Member Functions

 renderTableOfContentItem ($mode, $table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)
 
 getTableFieldLabel ($key, $field='', $mergeToken=':')
 
 getTableFieldNames ($key, $field)
 
 getItem ($table, $field, $anchors=false)
 
 getSeeAlsoLinks ($value, $anchorTable='')
 
 isExcludableField ($table, $field)
 
 getImages ($images, $descriptions)
 
 getTableSetup ($table)
 
 getFieldSetup ($table, $field, $allowEmptyField=false)
 
 getLanguageService ()
 

Protected Attributes

 $accessService
 

Detailed Description

Tabble manual repository

Definition at line 23 of file TableManualRepository.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::__construct ( )

Constructor

Definition at line 33 of file TableManualRepository.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ getFieldSetup()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getFieldSetup (   $table,
  $field,
  $allowEmptyField = false 
)
protected

Returns the setup for given table / field

Parameters
string$tableThe table
string$fieldThe field
bool$allowEmptyFieldAllow empty field
Returns
array The field setup

Definition at line 400 of file TableManualRepository.php.

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

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

◆ getImages()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getImages (   $images,
  $descriptions 
)
protected

Returns an array of images with description

Parameters
string$imagesImage file reference (list of)
string$descriptionsDescription string (divided for each image by line break)
Returns
array

Definition at line 353 of file TableManualRepository.php.

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

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

◆ getItem()

TYPO3\CMS\Cshmanual\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$tableCSH key / table name
string$fieldSub key / field name
bool$anchorsIf anchors is to be shown.
Returns
array with the information

Definition at line 238 of file TableManualRepository.php.

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

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

◆ getLanguageService()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getLanguageService ( )
protected

Returns LanguageService

Returns

Definition at line 414 of file TableManualRepository.php.

References $GLOBALS.

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

◆ getSections()

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

Get TOC sections

Parameters
string$mode
Returns
array

Definition at line 91 of file TableManualRepository.php.

References $GLOBALS, TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository\renderTableOfContentItem().

◆ getSeeAlsoLinks()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getSeeAlsoLinks (   $value,
  $anchorTable = '' 
)
protected

Get see-also links

Parameters
string$valueSee-also input codes
string$anchorTableIf $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 263 of file TableManualRepository.php.

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

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

◆ getSingleManual()

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

Get a single manual

Parameters
string$tabletable name
string$fieldfield name
Returns
array

Definition at line 79 of file TableManualRepository.php.

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

◆ getTableFieldLabel()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getTableFieldLabel (   $key,
  $field = '',
  $mergeToken = ': ' 
)
protected

Returns composite label for table/field

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
string$mergeTokenToken to merge the two strings with
Returns
string Labels joined with merge token
See also
getTableFieldNames()

Definition at line 187 of file TableManualRepository.php.

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

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

◆ getTableFieldNames()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getTableFieldNames (   $key,
  $field 
)
protected

Returns labels for a given field in a given structure

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
Returns
array Table and field labels in a numeric array

Definition at line 202 of file TableManualRepository.php.

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

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

◆ getTableManual()

TYPO3\CMS\Cshmanual\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 44 of file TableManualRepository.php.

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

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

◆ getTableSetup()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::getTableSetup (   $table)
protected

Returns the setup for given table

Parameters
string$tableThe table
Returns
array The table setup

Definition at line 384 of file TableManualRepository.php.

References $GLOBALS.

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

◆ isExcludableField()

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::isExcludableField (   $table,
  $field 
)
protected

Check if given table / field is excludable

Parameters
string$tableThe table
string$fieldThe field
Returns
bool TRUE if given field is excludable

Definition at line 337 of file TableManualRepository.php.

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

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

◆ renderTableOfContentItem()

TYPO3\CMS\Cshmanual\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$modeMode
string$tableCSH key / Table name
string$tocCatTOC category keyword: "core", "modules", "tables", "other @param array $outputSections Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference!
array$tocArrayTOC array; Here TOC index elements are created. Passed by reference!
array$CSHkeysCSH 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!
Returns
void

Definition at line 163 of file TableManualRepository.php.

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

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

Member Data Documentation

◆ $accessService

TYPO3\CMS\Cshmanual\Domain\Repository\TableManualRepository::$accessService
protected

Definition at line 28 of file TableManualRepository.php.