DocumentController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Documentation\Controller;

use TYPO3\CMS\Core\Utility\GeneralUtility;

class DocumentController extends \TYPO3\CMS\Extbase\Mvc\Controller\ActionController {

    protected $documentRepository;

    protected $documentationService;

    protected $languageUtility;

    protected $signalSlotDispatcher;

    public function listAction() {
        $documents = $this->getDocuments();

        // Filter documents to be shown for current user
        $hideDocuments = $this->getBackendUser()->getTSConfigVal('mod.help_DocumentationDocumentation.documents.hide');
        $hideDocuments = GeneralUtility::trimExplode(',', $hideDocuments, TRUE);
        if (count($hideDocuments) > 0) {
            $documents = array_diff_key($documents, array_flip($hideDocuments));
        }
        $showDocuments = $this->getBackendUser()->getTSConfigVal('mod.help_DocumentationDocumentation.documents.show');
        $showDocuments = GeneralUtility::trimExplode(',', $showDocuments, TRUE);
        if (count($showDocuments) > 0) {
            $documents = array_intersect_key($documents, array_flip($showDocuments));
        }

        $this->view->assign('documents', $documents);
    }

    public function getDocuments() {
        $language = $this->languageUtility->getDocumentationLanguage();
        $documents = $this->documentRepository->findByLanguage($language);

        $documents = $this->emitAfterInitializeDocumentsSignal($language, $documents);

        return $documents;
    }

    protected function emitAfterInitializeDocumentsSignal($language, array $documents) {
        $this->signalSlotDispatcher->dispatch(
            __CLASS__,
            'afterInitializeDocuments',
            array(
                $language,
                &$documents,
            )
        );
        return $documents;
    }

    public function downloadAction() {
        // This action is reserved for admin users. Redirect to default view if not.
        if (!$this->getBackendUser()->isAdmin()) {
            $this->redirect('list');
        }

        // Retrieve the list of official documents
        $documents = $this->documentationService->getOfficialDocuments();

        // Merge with the list of local extensions
        $extensions = $this->documentationService->getLocalExtensions();
        $allDocuments = array_merge($documents, $extensions);

        $this->view->assign('documents', $allDocuments);
    }

    public function fetchAction($url, $key, $version = NULL) {
        // This action is reserved for admin users. Redirect to default view if not.
        if (!$this->getBackendUser()->isAdmin()) {
            $this->redirect('list');
        }

        $language = $this->languageUtility->getDocumentationLanguage();
        try {
            $result = $this->documentationService->fetchNearestDocument($url, $key, $version ?: 'latest', $language);

            if ($result) {
                $this->controllerContext->getFlashMessageQueue()->enqueue(
                    GeneralUtility::makeInstance(
                        'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                        \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate(
                            'downloadSucceeded',
                            'documentation'
                        ),
                        '',
                        \TYPO3\CMS\Core\Messaging\AbstractMessage::OK,
                        TRUE
                    )
                );
            } else {
                $this->controllerContext->getFlashMessageQueue()->enqueue(
                    GeneralUtility::makeInstance(
                        'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                        \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate(
                            'downloadFailedNoArchive',
                            'documentation'
                        ),
                        \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate(
                            'downloadFailed',
                            'documentation'
                        ),
                        \TYPO3\CMS\Core\Messaging\AbstractMessage::ERROR,
                        TRUE
                    )
                );
            }
        } catch (\Exception $e) {
            $this->controllerContext->getFlashMessageQueue()->enqueue(
                GeneralUtility::makeInstance(
                    'TYPO3\\CMS\\Core\\Messaging\\FlashMessage',
                    \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate(
                        'downloadFailedDetails',
                        'documentation',
                        array(
                            $key,
                            $e->getMessage(),
                            $e->getCode()
                        )
                    ),
                    \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate(
                        'downloadFailed',
                        'documentation'
                    ),
                    \TYPO3\CMS\Core\Messaging\AbstractMessage::ERROR,
                    TRUE
                )
            );
        }
        $this->redirect('download');
    }

    protected function getBackendUser() {
        return $GLOBALS['BE_USER'];
    }

}