TYPO3\CMS\Documentation\Controller\DocumentController Class Reference

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

Public Member Functions
	listAction ()
	getDocuments ()
	downloadAction ()
	fetchAction ($url, $key, $version=NULL)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	getControllerContext ()
	__construct ()
	injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	injectFlashMessageContainer (\TYPO3\CMS\Extbase\Mvc\Controller\FlashMessageContainer $flashMessageContainer)
	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)
	initializeControllerArgumentsBaseValidators ()

Protected Member Functions
	emitAfterInitializeDocumentsSignal ($language, array $documents)
	getBackendUser ()
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeActionMethodArguments ()
	initializeActionMethodValidators ()
	resolveActionMethodName ()
	callActionMethod ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
	setViewConfiguration (ViewInterface $view)
	getViewProperty ($extbaseFrameworkConfiguration, $setting, $deprecatedSetting='')
	resolveViewObjectName ()
	initializeView (ViewInterface $view)
	initializeAction ()
	errorAction ()
	getErrorFlashMessage ()
	checkRequestHash ()
	clearCacheOnError ()
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
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	$reflectionService
	$cacheService
	$view = NULL
	$viewObjectNamePattern = 'Tx_@extension_View_@controller_@action@format'
	$namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
	$viewFormatToObjectNameMap = array()
	$defaultViewObjectName = 'TYPO3\\CMS\\Fluid\\View\\TemplateView'
	$actionMethodName = 'indexAction'
	$errorMethodName = 'errorAction'
	$mvcPropertyMappingConfigurationService
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	$signalSlotDispatcher
	$objectManager
	$uriBuilder
	$extensionName
	$settings
	$request
	$response
	$deprecatedPropertyMapper
	$validatorResolver
	$arguments
	$argumentsMappingResults
	$supportedRequestTypes = array('TYPO3\\CMS\\Extbase\\Mvc\\Request')
	$controllerContext
	$flashMessageContainer
	$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.

Author

Andrea Schmuttermair spam@.nosp@m.schm.nosp@m.utt.d.nosp@m.e

Definition at line 24 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 118 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 101 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 142 of file DocumentController.php.

References $result, TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Documentation\Controller\DocumentController\getBackendUser(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), 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 212 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 85 of file DocumentController.php.

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

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

listAction()

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

(

)

Lists the available documents.

Returns

void

Definition at line 61 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

$documentationService

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

protected

Definition at line 38 of file DocumentController.php.

$documentRepository

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

protected

Definition at line 32 of file DocumentController.php.

$languageUtility

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

protected

Definition at line 46 of file DocumentController.php.

$signalSlotDispatcher

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

protected

Definition at line 54 of file DocumentController.php.