TYPO3\CMS\Documentation\Controller\DocumentController Class Reference

Inheritance diagram for TYPO3\CMS\Documentation\Controller\DocumentController:

Public Member Functions
	injectDocumentRepository (DocumentRepository $documentRepository)
	injectDocumentationService (DocumentationService $documentationService)
	injectLanguageUtility (LanguageUtility $languageUtility)
	injectSignalSlotDispatcher (Dispatcher $signalSlotDispatcher)
	listAction ()
	getDocuments ()
	downloadAction ()
	fetchAction ($url, $key, $version=null)
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)

Protected Member Functions
	emitAfterInitializeDocumentsSignal ($language, array $documents)
	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
	$documentRepository
	$documentationService
	$languageUtility
	$signalSlotDispatcher
	$defaultViewObjectName = BackendTemplateView::class
	$view
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 controller of the Documentation module.

Definition at line 33 of file DocumentController.php.

Member Function Documentation

downloadAction()

TYPO3\CMS\Documentation\Controller\DocumentController::downloadAction

(

)

Shows documents to be downloaded/fetched from a remote location.

Returns

void

Definition at line 213 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\getBackendUser(), and TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect().

emitAfterInitializeDocumentsSignal()

TYPO3\CMS\Documentation\Controller\DocumentController::emitAfterInitializeDocumentsSignal (   $language, array  $documents  )

protected

Emits a signal after the documents are initialized

Parameters

string	$language

Definition at line 195 of file DocumentController.php.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\getDocuments().

fetchAction()

TYPO3\CMS\Documentation\Controller\DocumentController::fetchAction	(		$url,
			$key,
			$version = null
	)

Fetches a document from a remote URL.

Parameters

string	$url
string	$key
string	$version

Returns

void

Definition at line 238 of file DocumentController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\addFlashMessage(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Documentation\Controller\DocumentController\getBackendUser(), TYPO3\CMS\Core\Messaging\AbstractMessage\OK, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

getBackendUser()

TYPO3\CMS\Documentation\Controller\DocumentController::getBackendUser ( )

protected

Get backend user

Returns

Definition at line 296 of file DocumentController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\downloadAction(), TYPO3\CMS\Documentation\Controller\DocumentController\fetchAction(), and TYPO3\CMS\Documentation\Controller\DocumentController\listAction().

getDocuments()

TYPO3\CMS\Documentation\Controller\DocumentController::getDocuments

(

)

Returns available documents.

Returns

[]

Definition at line 178 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\emitAfterInitializeDocumentsSignal().

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\listAction().

getLanguageService()

TYPO3\CMS\Documentation\Controller\DocumentController::getLanguageService ( )

protected

Returns the LanguageService

Returns

LanguageService

Definition at line 306 of file DocumentController.php.

References $GLOBALS.

injectDocumentationService()

TYPO3\CMS\Documentation\Controller\DocumentController::injectDocumentationService

(

DocumentationService

$documentationService

)

Parameters

DocumentationService

$documentationService

Definition at line 125 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\$documentationService.

injectDocumentRepository()

TYPO3\CMS\Documentation\Controller\DocumentController::injectDocumentRepository

(

DocumentRepository

$documentRepository

)

Parameters

DocumentRepository

$documentRepository

Definition at line 117 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\$documentRepository.

injectLanguageUtility()

TYPO3\CMS\Documentation\Controller\DocumentController::injectLanguageUtility

(

LanguageUtility

$languageUtility

)

Parameters

LanguageUtility

$languageUtility

Definition at line 133 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\$languageUtility.

injectSignalSlotDispatcher()

TYPO3\CMS\Documentation\Controller\DocumentController::injectSignalSlotDispatcher

(

Dispatcher

$signalSlotDispatcher

)

Parameters

Dispatcher

$signalSlotDispatcher

Definition at line 141 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\$signalSlotDispatcher.

listAction()

TYPO3\CMS\Documentation\Controller\DocumentController::listAction

(

)

Lists the available documents.

Returns

void

Definition at line 151 of file DocumentController.php.

References TYPO3\CMS\Documentation\Controller\DocumentController\getBackendUser(), TYPO3\CMS\Documentation\Controller\DocumentController\getDocuments(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Member Data Documentation

$defaultViewObjectName

TYPO3\CMS\Documentation\Controller\DocumentController::$defaultViewObjectName = BackendTemplateView::class

protected

Definition at line 60 of file DocumentController.php.

$documentationService

TYPO3\CMS\Documentation\Controller\DocumentController::$documentationService

protected

Definition at line 43 of file DocumentController.php.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\injectDocumentationService().

$documentRepository

TYPO3\CMS\Documentation\Controller\DocumentController::$documentRepository

protected

Definition at line 38 of file DocumentController.php.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\injectDocumentRepository().

$languageUtility

TYPO3\CMS\Documentation\Controller\DocumentController::$languageUtility

protected

Definition at line 48 of file DocumentController.php.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\injectLanguageUtility().

$signalSlotDispatcher

TYPO3\CMS\Documentation\Controller\DocumentController::$signalSlotDispatcher

protected

Definition at line 53 of file DocumentController.php.

Referenced by TYPO3\CMS\Documentation\Controller\DocumentController\injectSignalSlotDispatcher().

$view

TYPO3\CMS\Documentation\Controller\DocumentController::$view

protected

Definition at line 67 of file DocumentController.php.