TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider:

Public Member Functions
	translateLabels (array $result, array $itemArray, $table, $fieldName)
	sanitizeItemArray ($itemArray, $tableName, $fieldName)
	sanitizeMaxItems ($maxItems)
	getStaticValues ($itemArray, $dynamicItemArray)

Protected Member Functions
	addItemsFromPageTsConfig (array $result, $fieldName, array $items)
	addItemsFromSpecial (array $result, $fieldName, array $items)
	addItemsFromFolder (array $result, $fieldName, array $items)
	removeItemsByKeepItemsPageTsConfig (array $result, $fieldName, array $items)
	removeItemsByRemoveItemsPageTsConfig (array $result, $fieldName, array $items)
	removeItemsByUserLanguageFieldRestriction (array $result, $fieldName, array $items)
	removeItemsByUserAuthMode (array $result, $fieldName, array $items)
	removeItemsByDoktypeUserRestriction (array $result, $fieldName, array $items)
	removeItemsByUserStorageRestriction (array $result, $fieldName, array $items)
	getExcludeFields ()
	getRegisteredFlexForms ($table)
	getExplicitAuthFieldValues ()
	buildForeignTableQuery (array $result, $localFieldName)
	processForeignTableClause (array $result, $foreignTableName, $localFieldName)
	processDatabaseFieldValue (array $row, $fieldName)
	getLiveUid (array $result)
	getLanguageService ()
	getDatabaseConnection ()
	getBackendUser ()

Detailed Description

Contains methods used by Data providers that handle elements with single items like select, radio and some more.

Definition at line 37 of file AbstractItemProvider.php.

Member Function Documentation

addItemsFromFolder()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::addItemsFromFolder ( array  $result,   $fieldName, array  $items  )

protected

TCA config "fileFolder" evaluation. Add them to $items

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Exceptions

Definition at line 381 of file AbstractItemProvider.php.

References $database, $GLOBALS, TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\buildForeignTableQuery(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Core\Utility\GeneralUtility\getAllFilesAndFoldersInPath(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\removePrefixPathFromList(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

addItemsFromPageTsConfig()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::addItemsFromPageTsConfig ( array  $result,   $fieldName, array  $items  )

protected

PageTsConfig addItems:

TCEFORMS.aTable.aField[.types][.aType].addItems.aValue = aLabel, with type specific options merged by pageTsConfig already

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 113 of file AbstractItemProvider.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

addItemsFromSpecial()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::addItemsFromSpecial ( array  $result,   $fieldName, array  $items  )

protected

TCA config "special" evaluation. Add them to $items

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Exceptions

Definition at line 150 of file AbstractItemProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getExcludeFields(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getExplicitAuthFieldValues(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getLanguageService(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

buildForeignTableQuery()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::buildForeignTableQuery ( array  $result,   $localFieldName  )

protected

Build query to fetch foreign records. Helper method of addItemsFromForeignTable(), do not call otherwise.

Parameters

array	$result	Result array
string	$localFieldName	Current handle field name

Returns

array Query array ready to be executed via Database->exec_SELECT_queryArray()

Definition at line 969 of file AbstractItemProvider.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getCommonSelectFields(), and TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\processForeignTableClause().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder().

getBackendUser()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getBackendUser ( )

protected

Returns

BackendUserAuthentication

Definition at line 1398 of file AbstractItemProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\buildForeignTableQuery(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\removeItemsByDoktypeUserRestriction(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\removeItemsByUserAuthMode(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\removeItemsByUserLanguageFieldRestriction(), and TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\removeItemsByUserStorageRestriction().

getDatabaseConnection()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getDatabaseConnection ( )

protected

Returns

DatabaseConnection

Definition at line 1390 of file AbstractItemProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder(), and TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\processForeignTableClause().

getExcludeFields()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getExcludeFields ( )

protected

Returns an array with the exclude fields as defined in TCA and FlexForms Used for listing the exclude fields in be_groups forms.

Returns

array Array of arrays with excludeFields (fieldName, table:fieldName) from TCA and FlexForms (fieldName, table:extKey;sheetName;fieldName)

Definition at line 725 of file AbstractItemProvider.php.

References $extConf, $GLOBALS, TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getLanguageService(), and TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getRegisteredFlexForms().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromSpecial().

getExplicitAuthFieldValues()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getExplicitAuthFieldValues ( )

protected

Returns an array with explicit Allow/Deny fields. Used for listing these field/value pairs in be_groups forms

Returns

array Array with information from all of $GLOBALS['TCA']

Definition at line 903 of file AbstractItemProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromSpecial().

getLanguageService()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getLanguageService ( )

protected

Returns

LanguageService

Definition at line 1382 of file AbstractItemProvider.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addInvalidItemsFromDatabase(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromSpecial(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getExcludeFields(), and TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\translateLabels().

getLiveUid()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getLiveUid ( array  $result )

protected

Gets the record uid of the live default record. If already pointing to the live record, the submitted record uid is returned.

Parameters

array

$result

Result array

Returns

int

Exceptions

Definition at line 1340 of file AbstractItemProvider.php.

References $uid.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\processDatabaseFieldValue().

getRegisteredFlexForms()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getRegisteredFlexForms (   $table )

protected

Returns all registered FlexForm definitions with title and fields

Parameters

string

$table

Table to handle

Returns

array Data structures with speaking extension title

Definition at line 826 of file AbstractItemProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveAllSheetsInDS(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getExcludeFields().

getStaticValues()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::getStaticValues	(		$itemArray,
			$dynamicItemArray
	)

Determine the static values in the item array

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$itemArray	All item records for the select field
array	$dynamicItemArray	Item records from dynamic sources

Returns

array

Definition at line 1368 of file AbstractItemProvider.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

processDatabaseFieldValue()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::processDatabaseFieldValue ( array  $row,   $fieldName  )

protected

Convert the current database values into an array

Parameters

array	$row	database row
string	$fieldName	fieldname to process

Returns

array

Definition at line 1174 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getLiveUid(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

processForeignTableClause()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::processForeignTableClause ( array  $result,   $foreignTableName,   $localFieldName  )

protected

Replace markers in a where clause from TCA foreign_table_where

Parameters

array	$result	Result array
string	$foreignTableName	Name of foreign table
string	$localFieldName	Current handle field name

Returns

array Query parts with keys WHERE, ORDERBY, GROUPBY, LIMIT

Definition at line 1026 of file AbstractItemProvider.php.

References $database, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getDatabaseConnection(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\buildForeignTableQuery().

removeItemsByDoktypeUserRestriction()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByDoktypeUserRestriction ( array  $result,   $fieldName, array  $items  )

protected

Remove items if doktype is handled for non admin users

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 660 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

removeItemsByKeepItemsPageTsConfig()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByKeepItemsPageTsConfig ( array  $result,   $fieldName, array  $items  )

protected

Remove items using "keepItems" pageTsConfig

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 533 of file AbstractItemProvider.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\keepItemsInArray().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

removeItemsByRemoveItemsPageTsConfig()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByRemoveItemsPageTsConfig ( array  $result,   $fieldName, array  $items  )

protected

Remove items using "removeItems" pageTsConfig

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 567 of file AbstractItemProvider.php.

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

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

removeItemsByUserAuthMode()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByUserAuthMode ( array  $result,   $fieldName, array  $items  )

protected

Remove items by user restriction on authMode items

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 629 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

removeItemsByUserLanguageFieldRestriction()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByUserLanguageFieldRestriction ( array  $result,   $fieldName, array  $items  )

protected

Remove items user restriction on language field

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 600 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

removeItemsByUserStorageRestriction()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::removeItemsByUserStorageRestriction ( array  $result,   $fieldName, array  $items  )

protected

Remove items if sys_file_storage is not allowed for non-admin users.

Used by TcaSelectItems data providers

Parameters

array	$result	Result array
string	$fieldName	Current handle field name
array	$items	Incoming items

Returns

array Modified item array

Definition at line 691 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getBackendUser().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData().

sanitizeItemArray()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::sanitizeItemArray	(		$itemArray,
			$tableName,
			$fieldName
	)

Sanitize incoming item array

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

mixed	$itemArray
string	$tableName
string	$fieldName

Exceptions

Definition at line 1294 of file AbstractItemProvider.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

sanitizeMaxItems()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::sanitizeMaxItems

(

$maxItems

)

Make sure maxitems is always filled with a valid integer value.

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

mixed

$maxItems

Returns

int

Definition at line 1319 of file AbstractItemProvider.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().

translateLabels()

TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider::translateLabels	(	array	$result,
		array	$itemArray,
			$table,
			$fieldName
	)

Translate the item labels

Used by TcaSelectItems and TcaSelectTreeItems data providers

Parameters

array	$result	Result array
array	$itemArray	Items
string	$table
string	$fieldName

Returns

array

Definition at line 1254 of file AbstractItemProvider.php.

References TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\getLanguageService().

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectItems\addData(), and TYPO3\CMS\Backend\Form\FormDataProvider\TcaSelectTreeItems\addData().