TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider Class Reference

Inheritance diagram for TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider:

Public Member Functions
	get ($key='')
	set ($key, $value)
	setFromArray (array $array)
	reset ()
	unsetKey ($key)
	addToList ($key, $value)
	removeFromList ($key, $value)

Protected Member Functions
	getFromDottedNotation ($key)
	setFromDottedNotation ($key, $value)
	getLastKeyFromDottedNotation ($key)

Detailed Description

ExtDirect DataProvider for BE User Settings

Author

Steffen Kamper steff.nosp@m.en@t.nosp@m.ypo3..nosp@m.org

Definition at line 24 of file BackendUserSettingsDataProvider.php.

Member Function Documentation

addToList()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::addToList	(		$key,
			$value
	)

Adds an value to an Comma-separated list stored $key of user settings

Parameters

string	$key
mixed	$value

Returns

void

Definition at line 100 of file BackendUserSettingsDataProvider.php.

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

get()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::get

(

$key = ''

)

Get user settings

Returns all user settings, if $key is not specified, otherwise it returns the value for $key

Parameters

string

$key

Identifier, allows also dotted notation for subarrays

Returns

mixed Value associated

Definition at line 34 of file BackendUserSettingsDataProvider.php.

References $GLOBALS, and TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider\getFromDottedNotation().

getFromDottedNotation()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::getFromDottedNotation (   $key )

protected

Computes the subarray from dotted notation

Parameters

$key	Dotted notation of subkeys like moduleData.module1.general.checked

Returns

mixed $array value of the settings

Definition at line 135 of file BackendUserSettingsDataProvider.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider\get().

getLastKeyFromDottedNotation()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::getLastKeyFromDottedNotation (   $key )

protected

Gets the last part of of an Dotted Notation

Parameters

string

$key

Returns

void

Definition at line 170 of file BackendUserSettingsDataProvider.php.

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

removeFromList()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::removeFromList	(		$key,
			$value
	)

Removes an value from an Comma-separated list stored $key of user settings

Parameters

string	$key
mixed	$value

Returns

void

Definition at line 120 of file BackendUserSettingsDataProvider.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\removeArrayEntryByValue(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

reset()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::reset

(

)

Resets the user settings to the default

Returns

void

Definition at line 75 of file BackendUserSettingsDataProvider.php.

References $GLOBALS.

set()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::set	(		$key,
			$value
	)

Sets user settings by key/value pair

Parameters

string	$key
mixed	$value

Returns

void

Definition at line 50 of file BackendUserSettingsDataProvider.php.

References $GLOBALS, and TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider\setFromDottedNotation().

setFromArray()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::setFromArray

(

array

$array

)

Sets user settings by array and merges them with current settings

Parameters

array

$array

Returns

void

Definition at line 65 of file BackendUserSettingsDataProvider.php.

References $GLOBALS.

setFromDottedNotation()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::setFromDottedNotation (   $key,   $value  )

protected

Sets the value of a key written in dotted notation

Parameters

string	$key
mixed	$value

Returns

void

Definition at line 151 of file BackendUserSettingsDataProvider.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider\set().

unsetKey()

TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider::unsetKey

(

$key

)

Unsets a key in user settings

Parameters

string

$key

Returns

void

Definition at line 85 of file BackendUserSettingsDataProvider.php.

References $GLOBALS.