TYPO3\CMS\Cshmanual\Controller\HelpController Class Reference

Inheritance diagram for TYPO3\CMS\Cshmanual\Controller\HelpController:

Public Member Functions
	initializeAction ()
	indexAction ()
	allAction ()
	detailAction ($table='', $field=' *')
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
	injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
	injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
	getControllerContext ()
	__construct ()
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
	throwStatus ($statusCode, $statusMessage=null, $content=null)

Public Attributes
const	FULL = 0
const	TOC_ONLY = 1

Protected Member Functions
	getBackendUser ()
	getLanguageService ()
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeActionMethodArguments ()
	resolveActionMethodName ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
	setViewConfiguration (ViewInterface $view)
	getViewProperty ($extbaseFrameworkConfiguration, $setting)
	resolveViewObjectName ()
	initializeView (ViewInterface $view)
	initializeAction ()
	errorAction ()
	clearCacheOnError ()
	addErrorFlashMessage ()
	getErrorFlashMessage ()
	forwardToReferringRequest ()
	getFlattenedValidationErrorMessage ()
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
	redirectToUri ($uri, $delay=0, $statusCode=303)
	addBaseUriIfNecessary ($uri)

Protected Attributes
	$tableManualRepository
	$defaultViewObjectName = BackendTemplateView::class
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	$reflectionService
	$cacheService
	$view = null
	$namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
	$viewFormatToObjectNameMap = []
	$defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
	$actionMethodName = 'indexAction'
	$errorMethodName = 'errorAction'
	$mvcPropertyMappingConfigurationService
	$request
	$response
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	$signalSlotDispatcher
	$objectManager
	$uriBuilder
	$extensionName
	$settings
	$request
	$response
	$validatorResolver
	$arguments
	$supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]
	$controllerContext
	$configurationManager

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static	getActionMethodParameters ($objectManager)

Detailed Description

Main help module controller

Definition at line 31 of file HelpController.php.

Member Function Documentation

allAction()

TYPO3\CMS\Cshmanual\Controller\HelpController::allAction

(

)

Show the table of contents and all manuals

Returns

void

Definition at line 94 of file HelpController.php.

detailAction()

TYPO3\CMS\Cshmanual\Controller\HelpController::detailAction	(		$table = '',
			$field = '*'
	)

Show a single manual

Parameters

string	$table
string	$field

Returns

void

Definition at line 106 of file HelpController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$extensionName, $GLOBALS, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\forward(), TYPO3\CMS\Cshmanual\Controller\HelpController\getBackendUser(), TYPO3\CMS\Cshmanual\Controller\HelpController\getLanguageService(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

getBackendUser()

TYPO3\CMS\Cshmanual\Controller\HelpController::getBackendUser ( )

protected

Returns the currently logged in BE user

Returns

BackendUserAuthentication

Definition at line 183 of file HelpController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpController\detailAction().

getLanguageService()

TYPO3\CMS\Cshmanual\Controller\HelpController::getLanguageService ( )

protected

Returns the LanguageService

Returns

LanguageService

Definition at line 193 of file HelpController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpController\detailAction().

indexAction()

TYPO3\CMS\Cshmanual\Controller\HelpController::indexAction

(

)

Show table of contents

Returns

void

Definition at line 84 of file HelpController.php.

initializeAction()

TYPO3\CMS\Cshmanual\Controller\HelpController::initializeAction

(

)

Initialize the controller

Returns

void

Definition at line 60 of file HelpController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$view, TYPO3\CMS\Extbase\Mvc\View\ViewInterface\assign(), TYPO3\CMS\Extbase\Mvc\Controller\ActionController\initializeView(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Backend\Utility\BackendUtility\TYPO3_copyRightNotice().

Member Data Documentation

$defaultViewObjectName

TYPO3\CMS\Cshmanual\Controller\HelpController::$defaultViewObjectName = BackendTemplateView::class

protected

Definition at line 53 of file HelpController.php.

$tableManualRepository

TYPO3\CMS\Cshmanual\Controller\HelpController::$tableManualRepository

protected

Definition at line 46 of file HelpController.php.

FULL

const TYPO3\CMS\Cshmanual\Controller\HelpController::FULL = 0

Section identifiers

Definition at line 36 of file HelpController.php.

TOC_ONLY

const TYPO3\CMS\Cshmanual\Controller\HelpController::TOC_ONLY = 1

Show only Table of contents

Definition at line 41 of file HelpController.php.