TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | List of all members
TYPO3\CMS\Backend\Controller\UserSettingsController Class Reference

Public Member Functions

 processAjaxRequest (ServerRequestInterface $request, ResponseInterface $response)
 
 process ($action, $key='', $value='')
 

Protected Member Functions

 get ($key)
 
 getAll ()
 
 set ($key, $value)
 
 addToList ($key, $value)
 
 removeFromList ($key, $value)
 
 clear ()
 
 unsetOption ($key)
 
 getFromDottedNotation ($key)
 
 setFromDottedNotation ($key, $value)
 
 getBackendUser ()
 

Detailed Description

A wrapper class to call BE_USER->uc used for AJAX and TYPO3.Storage JS object

Definition at line 27 of file UserSettingsController.php.

Member Function Documentation

◆ addToList()

TYPO3\CMS\Backend\Controller\UserSettingsController::addToList (   $key,
  $value 
)
protected

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

Parameters
string$key
mixed$value
Returns
void

Definition at line 140 of file UserSettingsController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\process().

◆ clear()

TYPO3\CMS\Backend\Controller\UserSettingsController::clear ( )
protected

Resets the user settings to the default

Returns
void

Definition at line 176 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\process().

◆ get()

TYPO3\CMS\Backend\Controller\UserSettingsController::get (   $key)
protected

Returns a specific user setting

Parameters
string$keyIdentifier, allows also dotted notation for subarrays
Returns
mixed Value associated

Definition at line 99 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser(), and TYPO3\CMS\Backend\Controller\UserSettingsController\getFromDottedNotation().

◆ getAll()

TYPO3\CMS\Backend\Controller\UserSettingsController::getAll ( )
protected

Get all user settings

Returns
mixed all values, usually a multi-dimensional array

Definition at line 109 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\process().

◆ getBackendUser()

TYPO3\CMS\Backend\Controller\UserSettingsController::getBackendUser ( )
protected

Returns the current BE user.

Returns

Definition at line 243 of file UserSettingsController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\clear(), TYPO3\CMS\Backend\Controller\UserSettingsController\get(), TYPO3\CMS\Backend\Controller\UserSettingsController\getAll(), TYPO3\CMS\Backend\Controller\UserSettingsController\getFromDottedNotation(), TYPO3\CMS\Backend\Controller\UserSettingsController\set(), TYPO3\CMS\Backend\Controller\UserSettingsController\setFromDottedNotation(), and TYPO3\CMS\Backend\Controller\UserSettingsController\unsetOption().

◆ getFromDottedNotation()

TYPO3\CMS\Backend\Controller\UserSettingsController::getFromDottedNotation (   $key)
protected

Computes the subarray from dotted notation

Parameters
$keystring Dotted notation of subkeys like moduleData.module1.general.checked
Returns
mixed value of the settings

Definition at line 202 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\get().

◆ process()

TYPO3\CMS\Backend\Controller\UserSettingsController::process (   $action,
  $key = '',
  $value = '' 
)

Process data

Parameters
string$action
string$key
string$value
Returns
mixed

Definition at line 57 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\addToList(), TYPO3\CMS\Backend\Controller\UserSettingsController\clear(), TYPO3\CMS\Backend\Controller\UserSettingsController\getAll(), TYPO3\CMS\Backend\Controller\UserSettingsController\removeFromList(), and TYPO3\CMS\Backend\Controller\UserSettingsController\unsetOption().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\processAjaxRequest().

◆ processAjaxRequest()

TYPO3\CMS\Backend\Controller\UserSettingsController::processAjaxRequest ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

Processes all AJAX calls and returns a JSON for the data

Parameters
ServerRequestInterface$request
ResponseInterface$response
Returns
ResponseInterface

Definition at line 36 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\process().

◆ removeFromList()

TYPO3\CMS\Backend\Controller\UserSettingsController::removeFromList (   $key,
  $value 
)
protected

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

Parameters
string$key
mixed$value
Returns
void

Definition at line 161 of file UserSettingsController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\process().

◆ set()

TYPO3\CMS\Backend\Controller\UserSettingsController::set (   $key,
  $value 
)
protected

Sets user settings by key/value pair

Parameters
string$key
mixed$value
Returns
void

Definition at line 121 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser(), and TYPO3\CMS\Backend\Controller\UserSettingsController\setFromDottedNotation().

◆ setFromDottedNotation()

TYPO3\CMS\Backend\Controller\UserSettingsController::setFromDottedNotation (   $key,
  $value 
)
protected

Sets the value of a key written in dotted notation

Parameters
string$key
mixed$value
Returns
void

Definition at line 224 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\set().

◆ unsetOption()

TYPO3\CMS\Backend\Controller\UserSettingsController::unsetOption (   $key)
protected

Unsets a key in user settings

Parameters
string$key
Returns
void

Definition at line 187 of file UserSettingsController.php.

References TYPO3\CMS\Backend\Controller\UserSettingsController\getBackendUser().

Referenced by TYPO3\CMS\Backend\Controller\UserSettingsController\process().