TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DocumentController Class Reference
Inheritance diagram for DocumentController:
ActionController AbstractController ControllerInterface

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 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 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 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 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 ActionController
 $reflectionService
 
 $cacheService
 
 $view = null
 
 $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
 $viewFormatToObjectNameMap = array()
 
 $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
 $actionMethodName = 'indexAction'
 
 $errorMethodName = 'errorAction'
 
 $mvcPropertyMappingConfigurationService
 
 $request
 
 $response
 
- Protected Attributes inherited from AbstractController
 $signalSlotDispatcher
 
 $objectManager
 
 $uriBuilder
 
 $extensionName
 
 $settings
 
 $request
 
 $response
 
 $validatorResolver
 
 $arguments
 
 $supportedRequestTypes = array(\TYPO3\CMS\Extbase\Mvc\Request::class)
 
 $controllerContext
 
 $configurationManager
 

Additional Inherited Members

- Static Public Member Functions inherited from ActionController
static getActionMethodParameters ($objectManager)
 

Detailed Description

Main controller of the Documentation module.

Definition at line 33 of file DocumentController.php.

Member Function Documentation

downloadAction ( )

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

Returns
void

Definition at line 213 of file DocumentController.php.

References DocumentController\getBackendUser(), and AbstractController\redirect().

emitAfterInitializeDocumentsSignal (   $language,
array  $documents 
)
protected

Emits a signal after the documents are initialized

Parameters
string$language
\TYPO3\CMS\Documentation\Domain\Model\Document[]$documents
Returns
[]

Definition at line 195 of file DocumentController.php.

Referenced by DocumentController\getDocuments().

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 $url, AbstractController\addFlashMessage(), AbstractMessage\ERROR, DocumentController\getBackendUser(), AbstractMessage\OK, AbstractController\redirect(), and LocalizationUtility\translate().

getBackendUser ( )
protected

Get backend user

Returns

Definition at line 296 of file DocumentController.php.

References $GLOBALS.

Referenced by DocumentController\downloadAction(), DocumentController\fetchAction(), and DocumentController\listAction().

getDocuments ( )

Returns available documents.

Returns
[]

Definition at line 178 of file DocumentController.php.

References DocumentController\emitAfterInitializeDocumentsSignal().

Referenced by DocumentController\listAction().

getLanguageService ( )
protected

Returns the LanguageService

Returns
LanguageService

Definition at line 306 of file DocumentController.php.

References $GLOBALS.

injectDocumentationService ( DocumentationService  $documentationService)
Parameters
DocumentationService$documentationService

Definition at line 125 of file DocumentController.php.

References DocumentController\$documentationService.

injectDocumentRepository ( DocumentRepository  $documentRepository)
Parameters
DocumentRepository$documentRepository

Definition at line 117 of file DocumentController.php.

References DocumentController\$documentRepository.

injectLanguageUtility ( LanguageUtility  $languageUtility)
Parameters
LanguageUtility$languageUtility

Definition at line 133 of file DocumentController.php.

References DocumentController\$languageUtility.

injectSignalSlotDispatcher ( Dispatcher  $signalSlotDispatcher)
Parameters
Dispatcher$signalSlotDispatcher

Definition at line 141 of file DocumentController.php.

References DocumentController\$signalSlotDispatcher.

listAction ( )

Lists the available documents.

Returns
void

Definition at line 151 of file DocumentController.php.

References DocumentController\getBackendUser(), DocumentController\getDocuments(), and GeneralUtility\trimExplode().

Member Data Documentation

$defaultViewObjectName = BackendTemplateView::class
protected

Definition at line 60 of file DocumentController.php.

$documentationService
protected
$documentRepository
protected

Definition at line 38 of file DocumentController.php.

Referenced by DocumentController\injectDocumentRepository().

$languageUtility
protected

Definition at line 48 of file DocumentController.php.

Referenced by DocumentController\injectLanguageUtility().

$signalSlotDispatcher
protected
$view
protected

Definition at line 67 of file DocumentController.php.