TYPO3\CMS\Adminpanel\Utility\StateUtility Class Reference

Static Public Member Functions
static bool	isActivatedForUser ()
static bool	isOpen ()
static	isActivatedInTypoScript ()
static	isHiddenForUser ()

Detailed Description

Helper class to check if the admin panel is enabled and active from outside

Useful for initialization, checks in early hooks or middleware implementations

Definition at line 27 of file StateUtility.php.

Member Function Documentation

isActivatedForUser()

static bool TYPO3\CMS\Adminpanel\Utility\StateUtility::isActivatedForUser ( )

static

Checks if adminPanel was configured to be shown

Returns

‪bool

Definition at line 34 of file StateUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Controller\MainController\initialize(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isEnabledReturnsFalseIfNoBackendUserExists(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isEnabledReturnsFalseIfNoBackendUserInFrontendContextIsLoggedIn(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isEnabledReturnsFalseIfNoModulesEnabled(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isEnabledReturnsTrueIfAtLeastOneModuleIsEnabled(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelDataPersister\process(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelRenderer\process(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelInitiator\process(), and TYPO3\CMS\Adminpanel\Middleware\SqlLogging\process().

isActivatedInTypoScript()

static TYPO3\CMS\Adminpanel\Utility\StateUtility::isActivatedInTypoScript ( )

static

Definition at line 59 of file StateUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isActivatedInTypoScriptReturnsCorrectValue(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelDataPersister\process(), and TYPO3\CMS\Adminpanel\Middleware\AdminPanelRenderer\process().

isHiddenForUser()

static TYPO3\CMS\Adminpanel\Utility\StateUtility::isHiddenForUser ( )

static

Definition at line 64 of file StateUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isHiddenForUserReturnsCorrectValue(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isHiddenForUserReturnsFalseIfUserIsNotAvailable(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelDataPersister\process(), and TYPO3\CMS\Adminpanel\Middleware\AdminPanelRenderer\process().

isOpen()

static bool TYPO3\CMS\Adminpanel\Utility\StateUtility::isOpen ( )

static

Returns true if admin panel was activated (switched "on" via GUI)

Returns

‪bool

Definition at line 53 of file StateUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isOpenForUserReturnsCorrectValue(), TYPO3\CMS\Adminpanel\Tests\Unit\Utility\StateUtilityTest\isOpenForUserReturnsFalseIfUserIsNotAvailable(), TYPO3\CMS\Adminpanel\Middleware\AdminPanelInitiator\process(), TYPO3\CMS\Adminpanel\Middleware\SqlLogging\process(), TYPO3\CMS\Adminpanel\Controller\MainController\render(), and TYPO3\CMS\Adminpanel\Controller\MainController\storeData().