‪TYPO3CMS  10.4
TYPO3\CMS\Opendocs\Controller\OpenDocumentController Class Reference

Public Member Functions

 __construct ()
 
ResponseInterface renderMenu ()
 
ResponseInterface closeDocument (ServerRequestInterface $request)
 

Protected Attributes

OpenDocumentService $documents
 
OpendocsToolbarItem $toolbarItem
 

Detailed Description

Controller for documents processing

Contains AJAX endpoints of the open docs toolbar item click actions

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Definition at line 33 of file OpenDocumentController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Opendocs\Controller\OpenDocumentController::__construct ( )

Set up dependencies

Definition at line 46 of file OpenDocumentController.php.

Member Function Documentation

◆ closeDocument()

ResponseInterface TYPO3\CMS\Opendocs\Controller\OpenDocumentController::closeDocument ( ServerRequestInterface  $request)

Closes a document and returns the updated menu

Parameters
ServerRequestInterface$request
Returns
‪ResponseInterface

Definition at line 68 of file OpenDocumentController.php.

References TYPO3\CMS\Opendocs\Controller\OpenDocumentController\renderMenu().

◆ renderMenu()

ResponseInterface TYPO3\CMS\Opendocs\Controller\OpenDocumentController::renderMenu ( )

Renders the menu so that it can be returned as response to an AJAX call

Returns
‪ResponseInterface

Definition at line 57 of file OpenDocumentController.php.

Referenced by TYPO3\CMS\Opendocs\Controller\OpenDocumentController\closeDocument().

Member Data Documentation

◆ $documents

OpenDocumentService TYPO3\CMS\Opendocs\Controller\OpenDocumentController::$documents
protected

Definition at line 37 of file OpenDocumentController.php.

◆ $toolbarItem

OpendocsToolbarItem TYPO3\CMS\Opendocs\Controller\OpenDocumentController::$toolbarItem
protected

Definition at line 41 of file OpenDocumentController.php.