TYPO3\CMS\Form\Utility\SessionUtility Class Reference

Inheritance diagram for TYPO3\CMS\Form\Utility\SessionUtility:

Public Member Functions
	__construct ()
	initSession ($formPrefix='')
	storeSession ()
	destroySession ()
	setSessionData ($key, $value)
	getSessionData ($key=null, $default=null)
	setFormPrefix ($formPrefix)

Protected Member Functions
	removeFiles ()

Protected Attributes
	$sessionData = []
	$formPrefix = ''
	$frontendController

Detailed Description

A session utility

Definition at line 24 of file SessionUtility.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Form\Utility\SessionUtility::__construct

(

)

Constructor

Definition at line 48 of file SessionUtility.php.

References $GLOBALS.

Member Function Documentation

destroySession()

TYPO3\CMS\Form\Utility\SessionUtility::destroySession

(

)

Destroy the session data for the form

Returns

void

Definition at line 89 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\removeFiles().

getSessionData()

TYPO3\CMS\Form\Utility\SessionUtility::getSessionData	(		$key = null,
			$default = null
	)

Retrieve a member of the $sessionData variable

If no $key is passed, returns the entire $sessionData array

Parameters

string	$key	Parameter to search for
mixed	$default	Default value to use if key not found

Returns

mixed Returns NULL if key does not exist

Definition at line 121 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\$sessionData.

Referenced by TYPO3\CMS\Form\Utility\SessionUtility\removeFiles(), and TYPO3\CMS\Form\Utility\SessionUtility\storeSession().

initSession()

TYPO3\CMS\Form\Utility\SessionUtility::initSession

(

$formPrefix = ''

)

Store the form input in a session

Parameters

string

$formPrefix

Returns

void

Definition at line 59 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\$formPrefix, and TYPO3\CMS\Form\Utility\SessionUtility\setFormPrefix().

removeFiles()

TYPO3\CMS\Form\Utility\SessionUtility::removeFiles ( )

protected

Remove uploaded files from the typo3temp

Returns

void

Definition at line 145 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\$sessionData, TYPO3\CMS\Form\Utility\SessionUtility\getSessionData(), and TYPO3\CMS\Core\Utility\GeneralUtility\unlink_tempfile().

Referenced by TYPO3\CMS\Form\Utility\SessionUtility\destroySession().

setFormPrefix()

TYPO3\CMS\Form\Utility\SessionUtility::setFormPrefix

(

$formPrefix

)

Set the form prefix

Parameters

string

$formPrefix

Returns

array

Definition at line 135 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\$formPrefix.

Referenced by TYPO3\CMS\Form\Utility\SessionUtility\initSession().

setSessionData()

TYPO3\CMS\Form\Utility\SessionUtility::setSessionData	(		$key,
			$value
	)

Set the session Data by $key

Parameters

string	$key
string	$value

Returns

void

Definition at line 107 of file SessionUtility.php.

storeSession()

TYPO3\CMS\Form\Utility\SessionUtility::storeSession

(

)

Store the form input in a session

Returns

void

Definition at line 74 of file SessionUtility.php.

References TYPO3\CMS\Form\Utility\SessionUtility\getSessionData().

Member Data Documentation

$formPrefix

TYPO3\CMS\Form\Utility\SessionUtility::$formPrefix = ''

protected

Definition at line 38 of file SessionUtility.php.

Referenced by TYPO3\CMS\Form\Utility\SessionUtility\initSession(), and TYPO3\CMS\Form\Utility\SessionUtility\setFormPrefix().

$frontendController

TYPO3\CMS\Form\Utility\SessionUtility::$frontendController

protected

Definition at line 43 of file SessionUtility.php.

$sessionData

TYPO3\CMS\Form\Utility\SessionUtility::$sessionData = []

protected

Definition at line 31 of file SessionUtility.php.

Referenced by TYPO3\CMS\Form\Utility\SessionUtility\getSessionData(), and TYPO3\CMS\Form\Utility\SessionUtility\removeFiles().